Schema Definitions

When you create your API spec, keep the following in mind.

• You can use the GET, PATCH, PUT, POST, and DELETE methods in a schema. A GET method with an empty request body results in a validation error.
• A property must include a value.
• Each parameter must have a name.
• Request headers are supported.
• Response headers aren’t supported.
• Form parameters are supported.
• Security settings defined in the API spec are ignored and defer to security settings in the Named Credential.

The following OpenAPI schema components are ignored:

• Security requirement objects and security definitions
• Tag objects
• External documentation objects
• For allOf, oneOf, and anyOf, the schema object property discriminator is supported. The discriminator/mapping in OpenApi 3.0 is ignored. The discriminator property determines the schema referenced by its type name. For more information, see the Swagger OpenAPI 3.0 specification Inheritance and Polymorphism.

Supported data types:

• binary
• boolean
• date
• datetime
• double
• enum
• float
• integer
• long
• string
• any type (as Apex Object)
• object: top level named and nested anonymous objects
• anonymous and top-level named lists (can nest both named and anonymous arrays)
  

  Note Nested anonymous arrays generate a List<List<T>> Apex type, which isn't supported as a field on an Apex-defined variable in Flow. For more information, see Flow Considerations for Apex Data Types.
• additionalProperties as maps
• allOf as an object composition
• OpenAPI 3.0 only:
  • anyOf (any of primitive, list, or object schema types; only object schemas can constitute composition types)
  • oneOf (one of primitive, list, or object schema types)