CatalogIntegrationApiSpecProvider
objectDefines how an integration behaves as a source provider of Catalog Service API specs.
API specs are entities that can be attached to Catalog Services.
When an integration implements this capability, it can act as a source type for API spec contents.
In this role, the integration becomes the source of truth for the spec.
When a spec is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the spec data.
A null value indicates the given integration does not act as a source provider of API specs.
The globally unique name of the API spec provider that identifies it within the catalog.
Corresponds to the API spec provider type when creating API specs.
Example:konnect_api
A user-friendly name for the API spec provider.
Example:Konnect API
An brief description of the API spec provider.
Defines the shape of the API spec provider config.
Example:{"type":"simple","definition":{"api_id":"string"}}
Show Child Parameters
When non-null, denotes that the API spec provider is bound to the given Resource type.
This means that API specs are auto-created when a Resource of the given type is mapped to a service.
Furthermore, it couples the lifecycle of the API Spec with the given Resource mapping.
When the given Resource is removed, the API spec will be deleted.
CatalogIntegrationEvents
objectDefines the event types across all resource types belonging to the integration that will be ingested into the catalog.
- Keys are the machine-readable, globally unique names of resource types registered by this integration.
- Values are a map of event type definitions.
IntegrationResourceEvents
objectDefines the event types for a given resource type belonging to the integration that will be ingested in the catalog.
- Keys are the machine-readable, globally unique names of resource types registered by this integration.
- Values are the event type definition.
IntegrationResourceEvent
objectDefines a registered event type for a given resource.
User-friendly display name for the event type.
Optional, brief description of the integration event type.
Show Child Parameters
CreateIntegrationInstance
objectThe type of integration instance to create.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda
The machine name of the integration instance that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda-prod
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
Optionally provide a description of the integration instance.
<= 2048 characters
JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.
Default:{}
Example:{"account_region":"eu"}