OpenAPI

IMPORTANT

• Sensedia CLI: available from version 2.10.0 onwards.
• API Platform / API Management (Sensedia Platform): available from version 4.14.2.0 onwards.

OpenAPI .yaml file structure

NOTE

The attributes field is available from Sensedia CLI version 2.12.0 onwards and requires Adaptive Governance to be enabled.

Guidelines for using the customJavaScript field

• Available from Sensedia CLI version 2.14.0 onwards.

• The abortRequestOnFailure and debug fields are optional and their default value is false.

• The source field is optional, but its usage determines how the interceptor will be added to the API flow:

  • With source specified, the defined interceptor will be created directly in the API context only, not being one of the interceptors available in the Manager's list of interceptors.
  • Without source specified, the command will look for an interceptor already created in the Manager, using the name field as a reference for the search. This interceptor will then be added to the API flow with its respective fields filled in as previously defined in the script used for its creation.

• The source field has two usage alternatives:

  • Providing the JavaScript code for the interceptor through a .js or .txt file, specifying its path with the file attribute:

• Providing the JavaScript code for the interceptor directly, using the script attribute:

Example of openapi.yaml file referenced in the previous file

Kind OpenAPI Schema