---
title: "ApiSpecPayload"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b/schemas/ApiSpecPayload"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b.md

# ApiSpecPayload

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.2
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    ApiSpecContentPayload:
      description: >
        The raw content of API specification, in json or yaml format (OpenAPI or
        AsyncAPI).
      type: object
      properties:
        content:
          example: '{"openapi":"3.0.3","info":{"title":"Example
            API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example
            endpoint","responses":{"200":{"description":"Successful
            response"}}}}}}'
          type: string
      additionalProperties: false
      required:
        - content
      title: ApiSpecContentPayload
    ApiSpecProviderPayload:
      description: >
        Represent spec provider information used for fetching the API spec. For
        raw, provide the raw content in the `content` property instead of using
        this provider.
      type: object
      properties:
        provider:
          oneOf:
            - $ref: "#/components/schemas/UrlApiSpecProvider"
            - $ref: "#/components/schemas/IntegrationApiSpecProviderPayload"
            - $ref: "#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"
      additionalProperties: false
      required:
        - provider
      title: ApiSpecProviderPayload
    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
    IntegrationApiSpecProviderPayload:
      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_instance:
          description: The integration instance id or name
          type: string
      required:
        - type
        - config
        - integration_instance
    ResourceBoundIntegrationApiSpecProviderPayload:
      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
      required:
        - type
        - config
    ApiSpecPayload:
      type: object
      oneOf:
        - $ref: "#/components/schemas/ApiSpecContentPayload"
        - $ref: "#/components/schemas/ApiSpecProviderPayload"
      title: ApiSpecPayload
      writeOnly: true
```
