Skip to main content

OpenAPI Properties in Use

This appendix lists the properties of the OpenAPI 2.0 specificationOpens in a new window that the API management tools use when generating the REST service classes. Properties not listed here are ignored. There are several extension properties; these have names that start with x-ISC.

Swagger

  • basePath

  • consumes

  • host

  • produces

  • definitions (note that the API management tools do not use any properties of the Schema object when generating code)

  • parameters (for details, see “Parameter Object”)

  • paths (for details, see “Path Item Object”)

  • info (for details, see “Info Object”)

  • swagger (must be "2.0")

For details on these properties, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-objectOpens in a new window.

Info Object

  • title

  • description

  • x-ISC_RequiredResource (a comma-separated list of defined resources and their access modes (resource:mode) that are required for access to any endpoint of the REST service)

  • version

For details on the standard properties, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-objectOpens in a new window.

Path Item Object

For details on these properties, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemObjectOpens in a new window.

Operation Object

  • operationId

  • summary

  • description

  • consumes

  • produces

  • parameters (for details, see “Parameter Object”)

  • x-ISC_CORS (a flag to indicate that CORS requests for this endpoint/method combination should be supported)

  • x-ISC_RequiredResource (a comma-separated list of defined resources and their access modes (resource:mode) that are required for access to this endpoint of the REST service)

  • x-ISC_ServiceMethod (name of the class method called on the back end to service this operation; default is operationId, which is normally suitable)

  • responses (note that within the response object, status may be HTTP status code or "default")

For details on the standard properties, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operationObjectOpens in a new window.

Parameter Object

  • name

  • in

  • description

  • required

  • $ref

  • type (cannot be "formData"; other types are permitted)

  • format

  • allowEmptyValue

  • maxLength

  • minLength

  • pattern

  • maximum

  • minimum

  • exclusiveMaximum

  • exclusiveMinimum

  • multipleOf

  • collectionFormat

  • minItems

  • maxItems

  • uniqueItems

  • items (for details, see “Items Object”)

For details on these properties, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-objectOpens in a new window.

Items Object

  • type

  • format

  • allowEmptyValue

  • maxLength

  • minLength

  • pattern

  • maximum

  • minimum

  • exclusiveMaximum

  • exclusiveMinimum

  • multipleOf

  • collectionFormat

  • minItems

  • maxItems

  • uniqueItems

For details on these properties, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#items-objectOpens in a new window.

FeedbackOpens in a new window