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

ApiSpecPayload

object
One Of
contentstringrequired

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

Example

ApiSpecContentPayload

object

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

* Additional properties are NOT allowed.
contentstringrequired

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

Example

ApiSpecProviderPayload

object

Represent spec provider information used for fetching the API spec. For raw, provide the raw content in the content property instead of using this provider.

* Additional properties are NOT allowed.
providerOne Of
required
UrlApiSpecProviderobject
Show Child Parameters
Example

API Attributes

object

A set of attributes that describe the API

Default:{}

Example