Search
K
Konnect Service Catalog

List Catalog Service API Specs

Returns a paginated collection of API Specs for the given service.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of API specs belonging to a service.

Show Child Parameters
sortstring

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

idstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

A paginated list response for a collection of API specs.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/catalog-services/{id}/api-specs
 
application/json

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

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Body

application/json

PreviewCatalogServiceApiSpec

* Additional properties are NOT allowed.
providerOne Of
required

Represents the provider, or source, of an API spec

UrlApiSpecProviderobject
Show Child Parameters

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

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

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

providerAny Of
required

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}
 
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

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

providerOne Of

Represents 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

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

providerAny Of
required

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}

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

API Spec was deleted successfully.

delete/catalog-services/{serviceId}/api-specs/{apiSpecId}