API Version Summary

object
* Additional properties are NOT allowed.
idstring(uuid)read-only

The API version identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

versionstring

The version of this api spec.

specobject
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

API Specification

object
* Additional properties are NOT allowed.
idstring(uuid)read-only

The API specification identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

contentstring

The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

validation_messagesarray[object]read-only

The errors that occurred while parsing the API specification.

* Additional properties are NOT allowed.
Show Child Parameters
typestring

The type of specification being stored. This allows us to render the specification correctly.

Allowed values:oas2oas3asyncapi

Example:oas3

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

API Specification Validation Request Payload

object
* Additional properties are NOT allowed.
contentstringrequired

The raw content of your API specification (OpenAPI or AsyncAPI), in json or yaml, to be validated.

Example

API Specification Validation Success Response

object
* Additional properties are NOT allowed.
validation_messagesarray[object]required

Any informational messages or warnings generated during validation. Empty if none.

* Additional properties are NOT allowed.
Show Child Parameters
Example

API Publication Visibility

string

The visibility of the API in the portal.
Public API publications do not require authentication to view and retrieve information about them.
Private API publications require authentication to retrieve information about them.

Allowed values:publicprivate

Default:private