Update Catalog Service Document
Updates a service document.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Body
application/json
Body
UpdateServiceDocumentPayload
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
Response
application/json
Response
A paginated list response for a collection of documents targeted by a service.
ServiceDocumentContentResponse
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
The service document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
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
Authentication
Path Parameters
Body
Delete Catalog Service Document
Deletes a service document.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Response
Response
Service document was deleted successfully.
Authentication
Path Parameters
Move Catalog Service Document
Moves a service document.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Body
application/json
Body
Move document
move document request payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
Response
Response
The service document has been moved
Authentication
Path Parameters
Body
Suggested Resource Actions
Provides suggested actions to take on resources. Suggested actions are generated from suggestion rules.
List Suggested Resource Actions
Returns a paginated collection of a suggested resource actions.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of suggested resource actions.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
A paginated list response for a collection of suggested resource actions.
returns the pagination information
Show Child Parameters
Contains information about a suggested resource action