serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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.
post
Path Parameters
Body
application/json
Body
application/json
PreviewCatalogServiceApiSpec
* Additional properties are NOT allowed.
provider
One Ofrequired
Represents the provider, or source, of an API spec
UrlApiSpecProviderobject
Show Child Parameters
Response
Response
Response object containing raw API spec contents
ApiSpecContents
ApiSpecContentsobject
Represents raw API spec contents
* Additional properties are allowed.
post/catalog-services/{serviceId}/api-specs/preview
Authentication
Path Parameters
Body
{
"provider": {
"type": "url",
"config": {
"url": "https://my-company.com/api-specs/openapi.yaml"
}
}
}
Get an API spec
Returns the API spec for the given service.
get
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
apiSpecIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
application/json
A response containing a single API spec.
CatalogServiceApiSpec
idstring(uuid)required
The API spec ID
Example:eadb88fe-e8eb-45c2-9591-dc783f93f29b
service_idstring(uuid)required
The ID of the service the API spec is associated to.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
descriptionstring | nullrequired
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.
resource_idstring | nullrequired
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
provider
Any Ofrequired
Represents the provider, or source, of API spec contents.
UrlApiSpecProviderobject
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
get/catalog-services/{serviceId}/api-specs/{apiSpecId}
Authentication
Path Parameters
application/json
Update API Spec
Updates the API spec for the given service.
patch
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
apiSpecIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
application/json
UpdateCatalogServiceApiSpec
* Additional properties are NOT allowed.
namestring
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
descriptionstring | null
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
provider
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.
UrlApiSpecProviderobject
Show Child Parameters
Response
application/json
Response
application/json
A response containing a single API spec.
CatalogServiceApiSpec
idstring(uuid)required
The API spec ID
Example:eadb88fe-e8eb-45c2-9591-dc783f93f29b
service_idstring(uuid)required
The ID of the service the API spec is associated to.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the API
>= 1 characters<= 120 characters
Example:Pet Store
descriptionstring | nullrequired
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.
resource_idstring | nullrequired
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
provider
Any Ofrequired
Represents the provider, or source, of API spec contents.
UrlApiSpecProviderobject
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
patch/catalog-services/{serviceId}/api-specs/{apiSpecId}
Authentication
Path Parameters
Body
{
"name": "api-spec-name",
"description": "API Spec Description"
}
application/json
Delete API Spec
Deletes the API spec for the given service.
delete
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
apiSpecIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
API Spec was deleted successfully.
delete/catalog-services/{serviceId}/api-specs/{apiSpecId}
Authentication
Path Parameters
Get an API Spec Contents
Returns the API spec for the given service.
Specify Accept: application/json to retrieve the contents as JSON.
Specify Accept: application/yaml to retrieve the contents as YAML.
Defaults to JSON format.
get
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
apiSpecIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
Response object containing raw API spec contents
ApiSpecContents
ApiSpecContentsobject
Represents raw API spec contents
* Additional properties are allowed.
get/catalog-services/{serviceId}/api-specs/{apiSpecId}/contents