API Version Summary
objectThe API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of this api spec.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
API Specification
objectThe API specification identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
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"}}}}}}
The errors that occurred while parsing the API specification.
Show Child Parameters
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
API Specification Validation Request Payload
objectThe raw content of your API specification (OpenAPI or AsyncAPI), in json or yaml, to be validated.
API Specification Validation Success Response
objectAny informational messages or warnings generated during validation. Empty if none.
Show Child Parameters
API Publication Visibility
stringThe 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