Edit an External Service

You can register a new version of an API specification over an existing registration. This update works only if active operations and their associated schema objects aren’t removed in the new specification. Deactivate operations before making incompatible changes to the API specification.

When updating a schema that has active operations, non-structural changes, such as updating a description, are allowed. However, structural changes, such as updating an object's properties or parameters, require you to first deactivate the associated operation.

Tip If the new schema version isn’t compatible, the edit workflow notifies you which operations and schema objects are active and must be deactivated before making incompatible changes. With this information, you can deactivate the necessary operations before saving your updated registration.

A component is active based on these rules.

• Operation—if the operation was set to active through the registration UI
• Object—if the object is referenced directly or indirectly from an active operation
• Parameter—if the parameter's parent operation is active
• Property—if the property's parent object is active

For details about supported and non-supported changes, see Schema Update Support.

1. From Setup, in the Quick Find box, enter External Services and select External Services.
2. Click the arrow in the service’s Actions column, and then select Edit. You can modify these service settings.
   • Named Credential
   • Description
   • Service Schema
   • Operations
3. Optionally update the schema with a new version by submitting a new schema, or by using the inline text editor to make changes.
4. Use the instructions in Register an External Service to submit an updated schema, validate, and select operations for your edited external service.