--- title: "CatalogServiceApiSpec" url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/CatalogServiceApiSpec" --- > Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md # CatalogServiceApiSpec ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: Konnect Service Catalog version: 1.3.0 servers: - url: https://us.api.konghq.com/v1 description: United-States Production region - url: https://eu.api.konghq.com/v1 description: Europe Production region - url: https://au.api.konghq.com/v1 description: Australia Production region - url: https://me.api.konghq.com/v1 description: Middle-East Production region - url: https://in.api.konghq.com/v1 description: India Production region - url: https://sg.api.konghq.com/v1 description: Singapore Production region components: schemas: UrlApiSpecProvider: type: object required: - type - config properties: type: type: string enum: - url config: type: object required: - url properties: url: type: string format: uri description: | Public URL that resolves to the raw API spec contents. Supported formats are JSON and YAML. example: https://api.petstore.com/v3/openapi.json RawApiSpecProvider: type: object required: - type - config properties: type: type: string enum: - raw config: type: object additionalProperties: false minProperties: 0 maxProperties: 0 IntegrationApiSpecProvider: description: > 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. type: object required: - type - config - integration properties: type: type: string description: The globally unique API spec provider type that is registered by a given catalog integration. minLength: 1 maxLength: 120 example: swaggerhub_api_version config: type: object additionalProperties: true minProperties: 1 description: JSON object containing values as defined by integration provider's config schema. example: owner: petco api: pet_store version: v3 integration: $ref: "#/components/schemas/IntegrationRef" ResourceBoundIntegrationApiSpecProvider: description: > 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. type: object required: - type - config - integration properties: type: type: string description: > 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. minLength: 1 maxLength: 120 config: type: object required: - resource_id properties: resource_id: type: string description: ID of the associated Resource the API spec is bound to. example: IqkHvMdyHukxcwAs integration: $ref: "#/components/schemas/IntegrationRef" CreatedAt: type: string format: date-time example: 2022-11-04T20:10:06.927Z description: An ISO-8601 timestamp representation of entity creation date. readOnly: true x-speakeasy-param-suppress-computed-diff: true UpdatedAt: type: string format: date-time example: 2022-11-04T20:10:06.927Z description: An ISO-8601 timestamp representation of entity update date. readOnly: true x-speakeasy-param-suppress-computed-diff: true IntegrationRef: type: object description: Short-hand descriptor of an integration installed within the catalog. required: - name - display_name - instance properties: name: type: string example: gateway-manager display_name: type: string example: gateway-manager instance: $ref: "#/components/schemas/IntegrationInstanceRef" IntegrationInstanceRef: type: object description: Short-hand descriptor of an integration instance. required: - id - name - display_name properties: id: type: string format: uuid example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351 description: The integration instance ID. name: type: string description: > The machine name of the integration instance that uniquely identifies it within the catalog. pattern: ^[0-9a-z.-]+$ example: aws-lambda-prod display_name: type: string description: The display name of the integration instance. example: AWS (prod) CatalogServiceApiSpec: type: object required: - id - service_id - name - description - resource_id - provider - created_at - updated_at properties: id: type: string format: uuid example: eadb88fe-e8eb-45c2-9591-dc783f93f29b description: The API spec ID service_id: type: string format: uuid example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 description: The ID of the service the API spec is associated to. name: type: string description: The name of the API minLength: 1 maxLength: 120 example: Pet Store description: type: string description: The description of the API. nullable: true maxLength: 2048 example: > A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification. resource_id: type: string nullable: true description: > 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: title: ApiSpecProvider description: Represents the provider, or source, of API spec contents. x-convert-oneOf: true anyOf: - $ref: "#/components/schemas/UrlApiSpecProvider" - $ref: "#/components/schemas/RawApiSpecProvider" - $ref: "#/components/schemas/IntegrationApiSpecProvider" - $ref: "#/components/schemas/ResourceBoundIntegrationApiSpecProvider" created_at: $ref: "#/components/schemas/CreatedAt" updated_at: $ref: "#/components/schemas/UpdatedAt" ```