Update API Package Operation

Update API Package Operations

patch

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

Body

application/json

JSON Patch Operation

A JSON Patch operation to add or remove an API Operation from a Package.

>= 1 items

* Additional properties are NOT allowed.
opstringrequired

The operation to perform.

Allowed values:addremovereplace

pathstringrequired

The path to the API Operation in the Package, in the format “operations/”.

Match pattern:^operations/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

valueobject
* Additional properties are NOT allowed.
Show Child Parameters

Response

API operations were successfully added or removed to the package.

patch/api-packages/{packageId}/operations

Body

[ { "op": "add", "path": "path" } ]
 

Get API Packages Operation

Get API packages operation

get

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

operationIdstring(uuid)required

The UUID API Operation identifier

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

Response

application/json

API Package Operation

API Package Operation Response

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

The API Operation identifier.

Example:0f5061ce-78f6-4452-9108-ad7c02821fd6

apiobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
methodstringrequiredread-only

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

pathstringrequiredread-only

The path of the API Operation.

Example:/users/{user_id}

rate_limiting_configobject | nullrequiredread-only

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
Show Child Parameters
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

implementation_statusobject

The implementation status of the operation.

* Additional properties are NOT allowed.
Show Child Parameters
get/api-packages/{packageId}/operations/{operationId}
 
application/json

Remove API Package Operation

Remove an operation from an API package.

delete

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

operationIdstring(uuid)required

The UUID API Operation identifier

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

Response

API operation was removed successfully from the package.

delete/api-packages/{packageId}/operations/{operationId}
 

API Package Documentation

Create API Package Document

Publish a new document attached to an API Package.

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

packageIdstring(uuid)required

The UUID API Package 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 Package 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/api-packages/{packageId}/documents

Body

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