Tyk Gateway API — Tyk OAS APIs

naftiko: 1.0.0-alpha2
info:
  label: Tyk Gateway API — Tyk OAS APIs
  description: 'Tyk Gateway API — Tyk OAS APIs. 10 operations. Lead operation: List All Apis in Tyk Oas Api Format.. Self-contained
    Naftiko capability covering one Tyk business surface.'
  tags:
  - Tyk
  - Tyk OAS APIs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYK_API_KEY: TYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: gateway-tyk-oas-apis
    baseUri: https://{tenant}
    description: Tyk Gateway API — Tyk OAS APIs business capability. Self-contained, no shared references.
    resources:
    - name: tyk-apis-oas
      path: /tyk/apis/oas
      operations:
      - name: listapisoas
        method: GET
        description: List All Apis in Tyk Oas Api Format.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: mode
          in: query
          type: string
          description: 'By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway
            part. '
      - name: createapioas
        method: POST
        description: Create an Api With Tyk Oas Format.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: base_api_id
          in: query
          type: string
          description: The base API which the new version will be linked to.
        - name: base_api_version_name
          in: query
          type: string
          description: The version name of the base API while creating the first version. This doesn't have to be sent for
            the next versions but if it is set, it will override base AP
        - name: new_version_name
          in: query
          type: string
          description: The version name of the created version.
        - name: set_default
          in: query
          type: boolean
          description: If true, the new version is set as default version.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: tyk-apis-oas-export
      path: /tyk/apis/oas/export
      operations:
      - name: downloadapisoaspublic
        method: GET
        description: Download All Tyk Oas Format Apis.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: mode
          in: query
          type: string
          description: 'By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway
            part. '
    - name: tyk-apis-oas-import
      path: /tyk/apis/oas/import
      operations:
      - name: importoas
        method: POST
        description: Import an Api in Tyk Oas Format.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: base_api_id
          in: query
          type: string
          description: The base API which the new version will be linked to.
        - name: base_api_version_name
          in: query
          type: string
          description: The version name of the base API while creating the first version. This doesn't have to be sent for
            the next versions but if it is set, it will override base AP
        - name: new_version_name
          in: query
          type: string
          description: The version name of the created version.
        - name: set_default
          in: query
          type: boolean
          description: If true, the new version is set as default version.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: tyk-apis-oas-apiID
      path: /tyk/apis/oas/{apiID}
      operations:
      - name: deleteoasapi
        method: DELETE
        description: Deleting a Tyk Oas Api.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiID
          in: path
          type: string
          description: The API ID.
          required: true
      - name: getoasapi
        method: GET
        description: Get a Tyk Oas Api Definition.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: mode
          in: query
          type: string
          description: 'By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway
            part. '
        - name: apiID
          in: path
          type: string
          description: ID of the API you want to fetch
          required: true
      - name: patchapioas
        method: PATCH
        description: Patch Api in Tyk Oas Format.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiID
          in: path
          type: string
          description: ID of the API you want to fetch.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updateapioas
        method: PUT
        description: Update a Tyk Oas Api Definition.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiID
          in: path
          type: string
          description: ID of the API you want to fetch
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: tyk-apis-oas-apiID-export
      path: /tyk/apis/oas/{apiID}/export
      operations:
      - name: downloadapioaspublic
        method: GET
        description: Download a Tyk Oas Format Api.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiID
          in: path
          type: string
          description: ID of the API you want to fetch.
          required: true
        - name: mode
          in: query
          type: string
          description: 'By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway
            part. '
    - name: tyk-apis-oas-apiID-versions
      path: /tyk/apis/oas/{apiID}/versions
      operations:
      - name: listoasapiversions
        method: GET
        description: Listing Versions of a Tyk Oas Api.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiID
          in: path
          type: string
          description: ID of the API you want to fetch.
          required: true
    authentication:
      type: apikey
      key: X-Tyk-Authorization
      value: '{{env.TYK_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: gateway-tyk-oas-apis-rest
    port: 8080
    description: REST adapter for Tyk Gateway API — Tyk OAS APIs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/tyk/apis/oas
      name: tyk-apis-oas
      description: REST surface for tyk-apis-oas.
      operations:
      - method: GET
        name: listapisoas
        description: List All Apis in Tyk Oas Api Format.
        call: gateway-tyk-oas-apis.listapisoas
        with:
          mode: rest.mode
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapioas
        description: Create an Api With Tyk Oas Format.
        call: gateway-tyk-oas-apis.createapioas
        with:
          base_api_id: rest.base_api_id
          base_api_version_name: rest.base_api_version_name
          new_version_name: rest.new_version_name
          set_default: rest.set_default
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tyk/apis/oas/export
      name: tyk-apis-oas-export
      description: REST surface for tyk-apis-oas-export.
      operations:
      - method: GET
        name: downloadapisoaspublic
        description: Download All Tyk Oas Format Apis.
        call: gateway-tyk-oas-apis.downloadapisoaspublic
        with:
          mode: rest.mode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tyk/apis/oas/import
      name: tyk-apis-oas-import
      description: REST surface for tyk-apis-oas-import.
      operations:
      - method: POST
        name: importoas
        description: Import an Api in Tyk Oas Format.
        call: gateway-tyk-oas-apis.importoas
        with:
          base_api_id: rest.base_api_id
          base_api_version_name: rest.base_api_version_name
          new_version_name: rest.new_version_name
          set_default: rest.set_default
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tyk/apis/oas/{apiid}
      name: tyk-apis-oas-apiid
      description: REST surface for tyk-apis-oas-apiID.
      operations:
      - method: DELETE
        name: deleteoasapi
        description: Deleting a Tyk Oas Api.
        call: gateway-tyk-oas-apis.deleteoasapi
        with:
          apiID: rest.apiID
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getoasapi
        description: Get a Tyk Oas Api Definition.
        call: gateway-tyk-oas-apis.getoasapi
        with:
          mode: rest.mode
          apiID: rest.apiID
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchapioas
        description: Patch Api in Tyk Oas Format.
        call: gateway-tyk-oas-apis.patchapioas
        with:
          apiID: rest.apiID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateapioas
        description: Update a Tyk Oas Api Definition.
        call: gateway-tyk-oas-apis.updateapioas
        with:
          apiID: rest.apiID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tyk/apis/oas/{apiid}/export
      name: tyk-apis-oas-apiid-export
      description: REST surface for tyk-apis-oas-apiID-export.
      operations:
      - method: GET
        name: downloadapioaspublic
        description: Download a Tyk Oas Format Api.
        call: gateway-tyk-oas-apis.downloadapioaspublic
        with:
          apiID: rest.apiID
          mode: rest.mode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tyk/apis/oas/{apiid}/versions
      name: tyk-apis-oas-apiid-versions
      description: REST surface for tyk-apis-oas-apiID-versions.
      operations:
      - method: GET
        name: listoasapiversions
        description: Listing Versions of a Tyk Oas Api.
        call: gateway-tyk-oas-apis.listoasapiversions
        with:
          apiID: rest.apiID
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gateway-tyk-oas-apis-mcp
    port: 9090
    transport: http
    description: MCP adapter for Tyk Gateway API — Tyk OAS APIs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-all-apis-tyk-oas
      description: List All Apis in Tyk Oas Api Format.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.listapisoas
      with:
        mode: tools.mode
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-tyk-oas-format
      description: Create an Api With Tyk Oas Format.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gateway-tyk-oas-apis.createapioas
      with:
        base_api_id: tools.base_api_id
        base_api_version_name: tools.base_api_version_name
        new_version_name: tools.new_version_name
        set_default: tools.set_default
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: download-all-tyk-oas-format
      description: Download All Tyk Oas Format Apis.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.downloadapisoaspublic
      with:
        mode: tools.mode
      outputParameters:
      - type: object
        mapping: $.
    - name: import-api-tyk-oas-format
      description: Import an Api in Tyk Oas Format.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gateway-tyk-oas-apis.importoas
      with:
        base_api_id: tools.base_api_id
        base_api_version_name: tools.base_api_version_name
        new_version_name: tools.new_version_name
        set_default: tools.set_default
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deleting-tyk-oas-api
      description: Deleting a Tyk Oas Api.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gateway-tyk-oas-apis.deleteoasapi
      with:
        apiID: tools.apiID
      outputParameters:
      - type: object
        mapping: $.
    - name: get-tyk-oas-api-definition
      description: Get a Tyk Oas Api Definition.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.getoasapi
      with:
        mode: tools.mode
        apiID: tools.apiID
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-api-tyk-oas-format
      description: Patch Api in Tyk Oas Format.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.patchapioas
      with:
        apiID: tools.apiID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-tyk-oas-api-definition
      description: Update a Tyk Oas Api Definition.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.updateapioas
      with:
        apiID: tools.apiID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: download-tyk-oas-format-api
      description: Download a Tyk Oas Format Api.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.downloadapioaspublic
      with:
        apiID: tools.apiID
        mode: tools.mode
      outputParameters:
      - type: object
        mapping: $.
    - name: listing-versions-tyk-oas-api
      description: Listing Versions of a Tyk Oas Api.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-tyk-oas-apis.listoasapiversions
      with:
        apiID: tools.apiID
      outputParameters:
      - type: object
        mapping: $.