Update API Package Operation
Update API Package Operations
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
JSON Patch Operation
A JSON Patch operation to add or remove an API Operation from a Package.
>= 1 items
The operation to perform.
Allowed values:addremovereplace
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}$
Show Child Parameters
Response
Response
API operations were successfully added or removed to the package.
Authentication
Path Parameters
Body
Get API Packages Operation
Get API packages operation
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The UUID API Operation identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
API Package Operation
API Package Operation Response
The API Operation identifier.
Example:0f5061ce-78f6-4452-9108-ad7c02821fd6
Show Child Parameters
The HTTP method of an API Operation.
Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE
The path of the API Operation.
Example:/users/{user_id}
Rate limit configuration that can be applied to an API Package or an API Package Operation.
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
The implementation status of the operation.
Show Child Parameters
Authentication
Path Parameters
Remove API Package Operation
Remove an operation from an API package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The UUID API Operation identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
Response
API operation was removed successfully from the package.
Authentication
Path Parameters
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.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Document
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.
Example:null
Response
application/json
Response
API Package document
API Document
The 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.
Example:null
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