Search
K
Konnect Service Catalog

CatalogServiceApiSpec

object
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

descriptionstringrequired

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_idstringrequired

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

Example

ApiSpecContents

object

Represents raw API spec contents

* Additional properties are allowed.
Example

ApiSpecContentsYaml

string

Represents raw API spec contents

RawApiSpecProvider

object
typestringrequired

Allowed values:raw

configobjectrequired
* Additional properties are NOT allowed.
Example

RawApiSpecProviderPayload

object
typestringrequired

Allowed values:raw

configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example