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

Delete API Documentation

Removes a document from an API.

delete

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

Document for the API was deleted successfully.

delete/apis/{apiId}/documents/{documentId}
 

Move API Documentation

This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.

post

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

move document

Move document

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

Response

Document for the API was moved successfully.

post/apis/{apiId}/documents/{documentId}/move

Body

{}
 

API Specification

Validate API Specification

Validates the content and type (OpenAPI or AsyncAPI) of a potential API specification without associating it with a specific API.

post

Body

application/json

Specification content and type for validation.

API Specification Validation Request Payload

* Additional properties are NOT allowed.
contentstringrequired

The raw content of your API specification (OpenAPI or AsyncAPI), in json or yaml, to be validated.

Response

application/json

API specification (OpenAPI or AsyncAPI) validation successful

API Specification Validation Success Response

* Additional properties are NOT allowed.
validation_messagesarray[object]required

Any informational messages or warnings generated during validation. Empty if none.

* Additional properties are NOT allowed.
Show Child Parameters
post/apis/validate-specification

Body

{ "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Valid API\",\"version\":\"1.0.0\"},\"paths\":{\"/health\":{\"get\":{\"summary\":\"Health check\",\"responses\":{\"200\":{\"description\":\"OK\"}}}}}}" }
 
application/json