Search
K
Konnect Service Catalog

RawApiSpecProviderPayload

object
typestringrequired

Allowed values:raw

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

UrlApiSpecProvider

object
typestringrequired

Allowed values:url

configobjectrequired
Show Child Parameters
Example

IntegrationApiSpecProviderPayload

object

API spec provider registered by a catalog integration.

Integrations can function as API spec providers where they register a globally unique
type and config schema which defines the shape of config.

Consult integration documentation to learn more about available API spec providers.

typestringrequired

The globally unique API spec provider type that is registered by a given catalog integration.

>= 1 characters<= 120 characters

Example:swaggerhub_api_version

configobjectrequired

JSON object containing values as defined by integration provider’s config schema.

Example:{"owner":"petco","api":"pet_store","version":"v3"}

* Additional properties are allowed.
integration_instancestringrequired

The integration instance id or name

Example

IntegrationApiSpecProvider

object

API spec provider registered by a catalog integration.

Integrations can function as API spec providers where they register a globally unique
type and config schema which defines the shape of config.

Consult integration documentation to learn more about available API spec providers.

typestringrequired

The globally unique API spec provider type that is registered by a given catalog integration.

>= 1 characters<= 120 characters

Example:swaggerhub_api_version

configobjectrequired

JSON object containing values as defined by integration provider’s config schema.

Example:{"owner":"petco","api":"pet_store","version":"v3"}

* Additional properties are allowed.
integrationobjectrequired

Short-hand descriptor of an integration installed within the catalog.

Show Child Parameters
Example

ResourceBoundIntegrationApiSpecProvider

object

API spec provider registered by a catalog integration.

These providers differ from IntegrationApiSpecProvider in that they
denote a binding relationship between a resource type and the API spec.
This means that the API Spec will automatically be created/deleted for/from a service
as resources of the given type are mapped/unmapped.

Consult integration documentation to learn more about available API spec providers.

typestringrequired

The globally unique API spec provider type that is registered by a given catalog integration.
Resource-bound providers create a 1-to-1 mapping between a resource type and the API Spec.

>= 1 characters<= 120 characters

configobjectrequired
Show Child Parameters
integrationobjectrequired

Short-hand descriptor of an integration installed within the catalog.

Show Child Parameters
Example