API Documentation

Create API Document

Publish a new document attached to an API.

All configuration options may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the POST request will take precedence.

post

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Body

application/json

API Document

* Additional properties are NOT allowed.
contentstringrequired

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 | null(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.

Example:null

Response

application/json

API document

API Document

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

The API document identifier.

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

contentstringrequired

Raw markdown content to display in your Portal

titlestringrequired

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

Example:API Document

slugstringrequired

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

Defaults to slugify(title)

Match pattern:^[\w-]+$

Example:api-document

statusstringrequired

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

Allowed values:publishedunpublished

Default:unpublished

parent_document_idstring | null(uuid)required

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.

Example:null

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

post/apis/{apiId}/documents

Body

{ "slug": "api-document", "status": "published", "title": "API Document", "content": "# API Document Header" }
 
application/json

List API Documents

Returns a collection of all documents for an API.

get

Query Parameters

filterobject

Filters API Documents in the response.

Show Child Parameters

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

List of API documents

* Additional properties are NOT allowed.
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}/documents
 
application/json

Get an API Document

Returns a document for the API.

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

documentIdstring(uuid)required

The document identifier related to the API

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

Response

application/json

API document

API Document

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

The API document identifier.

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

contentstringrequired

Raw markdown content to display in your Portal

titlestringrequired

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

Example:API Document

slugstringrequired

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

Defaults to slugify(title)

Match pattern:^[\w-]+$

Example:api-document

statusstringrequired

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

Allowed values:publishedunpublished

Default:unpublished

parent_document_idstring | null(uuid)required

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.

Example:null

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

get/apis/{apiId}/documents/{documentId}
 
application/json

Update API Document

Updates a document for an API.

patch

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

documentIdstring(uuid)required

The document identifier related to the API

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

Body

application/json

API Document

* Additional properties are NOT allowed.
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 | null(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.

Example:null

Response

application/json

API document

API Document

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

The API document identifier.

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

contentstringrequired

Raw markdown content to display in your Portal

titlestringrequired

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

Example:API Document

slugstringrequired

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

Defaults to slugify(title)

Match pattern:^[\w-]+$

Example:api-document

statusstringrequired

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

Allowed values:publishedunpublished

Default:unpublished

parent_document_idstring | null(uuid)required

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.

Example:null

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

patch/apis/{apiId}/documents/{documentId}

Body

{ "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2", "slug": "api-document", "status": "published", "title": "API Document" }
 
application/json