Naming and Description Conventions

The operation name is derived from the schema's path operationId. If missing, it's derived from the HTTP method and resource path.

Implement case consistently for object name definitions, property names, parameter names, and field names in a schema.

The derived Apex class name and Apex object property names require valid Apex identifier characters. Ensure that the object name in the schema object definition section matches the naming convention and the object property names.

External Services can handle up to 1,333 characters for any optional description string used to describe operations and parameters in your JSON or YAML schema definition. If the description string exceeds this limit, External Services stores only the first 1,333 characters of the description. Truncating the operation or parameter description doesn’t affect the integrity of your schema definition.