API Document
objectThe API document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Raw markdown content to display in your Portal
The title of the document. Used to populate the <title> tag for the page
Example:API Document
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(title)
Match pattern:^[\w-]+$
Example:api-document
If status=published the document will be visible in your live portal
Allowed values:publishedunpublished
Default:unpublished
API Documents may be rendered as a tree of files.
Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.
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
Move document
objectmove document request payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
API Version
objectThe API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
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 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