validation.md

Validation Performed By OpenAPI Reader

Additional Requirements For Membrane.

Specify an OperationId

Membrane requires all Operations to set a unique operationId.

This is used for identification of all available operations across your OpenAPI.

Unambiguous Query Strings

For query parameters (i.e. in:query) with a schema that allows compound types i.e. array or objects there are certain combinations of style and explode that do not use the parameter's name.

These combinations are:

• type:object with style:form and explode:true
• type:object or type:array with style:spaceDelimited
• type:object or type:array with style:pipeDelimited

If an operation only has one query parameter (i.e. in:query) then this is fine. Membrane can safely assume the entire string belongs to that one parameter.

If an operation contains two query parameters, both of which do not use the parameter's name; Membrane cannot ascertain which parameter relates to which part of the query string.

This ambiguity leads to multiple "correct" ways to interpret the query string. Making it impossible to safely assume Membrane has validated it. Therefore, only one parameter, with one of the above combinations, is allowed on any given Operation.

Version 3.0.X

OpenAPI Object

• An OpenAPI Object requires an openapi field.
• An OpenAPI Object requires an info field.
  • The Info Object requires a title.
  • The Info Object requires a version.
• All Path Items must be mapped to by their relative endpoint.

Path Item

• All Operations MUST be mapped to by a method.
• Parameters must be unique. Uniqueness is defined by a combination of "name" and "in".

Operation

• Parameters must be unique. Uniqueness is defined by a combination of "name" and "in".

Parameter

• A Parameter MUST contain a name field.
• A Parameter MUST contain an in field.
  • in MUST be set to path, query, header or cookie.
  • if in:path then the Parameter MUST specify required:true.
  • if style is specified, acceptable values depend on the value of in.
• A Parameter MUST contain a schema or content, but not both.
  • if content is specified, it MUST contain exactly one Media Type
    • A Parameter's MediaType MUST contain a schema.

Schema

• If allOf, anyOf or oneOf are set; They MUST not be empty.