List Catalog Service API Specs
Returns a paginated collection of API Specs for the given service.
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 API specs belonging to a service.
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
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A paginated list response for a collection of API specs.
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Preview API Spec
Previews the contents of an API spec as JSON or YAML.
Specify Accept: application/json to retrieve the contents as JSON.
Specify Accept: application/yaml to retrieve the contents as YAML.
Defaults to JSON format.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
PreviewCatalogServiceApiSpec
One OfRepresents the provider, or source, of an API spec
Show Child Parameters
Response
Response
Response object containing raw API spec contents
ApiSpecContents
Represents raw API spec contents
Authentication
Path Parameters
Body
Get an API spec
Returns the API spec for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A response containing a single API spec.
CatalogServiceApiSpec
The API spec ID
Example:eadb88fe-e8eb-45c2-9591-dc783f93f29b
The ID of the service the API spec is associated to.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
The description of the API.
<= 2048 characters
Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification.
The ID of the Resource that is bound to the API spec.
Only set when the given provider.type requires a 1-to-1 mapping between Resource
and API Spec.
Example:IqkHvMdyHukxcwAs
Any OfRepresents the provider, or source, of API spec contents.
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
Authentication
Path Parameters
Update API Spec
Updates the API spec for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
UpdateCatalogServiceApiSpec
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
The description of the API
<= 2048 characters
Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification
One OfRepresents the provider, or source, of an API specs.
Note that provider cannot be patched for API specs that are bound to a resource.
Trying to do so will result in a 400 response.
Show Child Parameters
Response
application/json
Response
A response containing a single API spec.
CatalogServiceApiSpec
The API spec ID
Example:eadb88fe-e8eb-45c2-9591-dc783f93f29b
The ID of the service the API spec is associated to.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
The description of the API.
<= 2048 characters
Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification.
The ID of the Resource that is bound to the API spec.
Only set when the given provider.type requires a 1-to-1 mapping between Resource
and API Spec.
Example:IqkHvMdyHukxcwAs
Any OfRepresents the provider, or source, of API spec contents.
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
Authentication
Path Parameters
Body
Delete API Spec
Deletes the API spec for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
API Spec was deleted successfully.