API Document

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

The API document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

contentstring

Raw markdown content to display in your Portal

titlestring

The title of the document. Used to populate the <title> tag for the page

Example:API Document

slugstring

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

Match pattern:^[\w-]+$

Example:api-document

statusstring

If status=published the document will be visible in your live portal

Allowed values:publishedunpublished

Default:unpublished

parent_document_idstring(uuid)

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.

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

Move document

object

move document request payload

parent_document_idstring(uuid)

parent document id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

indexinteger

index of the document in the parent document’s children

Example:1

Example

API Version

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

The API version identifier.

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

versionstring

The version of the api.

Example:1.0.0

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 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