---
title: "CatalogServiceApiSpec"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-dev-1/versions/d755cd20-1635-4c78-a12c-5f42a75fa20d/schemas/CatalogServiceApiSpec"
---

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