OpenAPI Extensions

Callosum makes use of a few extensions to the OpenAPI specification. These extensions help the API Client access resources and share information without needing additional channels or proprietary data formats. All extensions specific to the Callosum tool have been namespaced with x-6a- to ensure compatibility with other OpenAPI tools.

Environments

Environments specify variables and variable-groups that can be used to add optionality and dynamic features to your API interactions.

info.x-6a-default-environment: defines the default environment group to use for variables. Typical examples would be local/dev/qa/production environments in which sets of variables should change together.

servers.*.x-6a-group: defines the group that a specific server should be associated with.

x-6a-environment: define the list of variables available to templates across the API Client.

Templates

paths.*.params.*.x-6a-template: defines a template value for an endpoint parameter, usually either static content or an environment variable.

Authentication

x-6a-security: defines configuration settings for authentication using the security profiles of the OpenAPI document.

Deep linking

info.x-6a-deeplink-id: defines a unique UUID for the OpenAPI document. This opaque identifier allows deep linking to requests as long as both sender and receiver have existing documents with the same UUID.