Tyk Gateway API — Organisation Quotas

naftiko: 1.0.0-alpha2
info:
  label: Tyk Gateway API — Organisation Quotas
  description: 'Tyk Gateway API — Organisation Quotas. 5 operations. Lead operation: Tyk List Organisation Keys. Self-contained
    Naftiko capability covering one Tyk business surface.'
  tags:
  - Tyk
  - Organisation Quotas
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYK_API_KEY: TYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: gateway-organisation-quotas
    baseUri: https://{tenant}
    description: Tyk Gateway API — Organisation Quotas business capability. Self-contained, no shared references.
    resources:
    - name: tyk-org-keys
      path: /tyk/org/keys
      operations:
      - name: listorgkeys
        method: GET
        description: Tyk List Organisation Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Retrieves all keys starting with the specified filter(filter is a prefix - e.g. default* or default
            will return all keys starting with default  like defaultbd,d
    - name: tyk-org-keys-keyID
      path: /tyk/org/keys/{keyID}
      operations:
      - name: deleteorgkey
        method: DELETE
        description: Tyk Delete Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyID
          in: path
          type: string
          description: The Key ID
          required: true
      - name: getorgkey
        method: GET
        description: Tyk Get an Organisation Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgID
          in: query
          type: string
          description: The Org ID
        - name: keyID
          in: path
          type: string
          description: The Key ID
          required: true
      - name: addorgkey
        method: POST
        description: Tyk Create an Organisation Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyID
          in: path
          type: string
          description: The Key ID
          required: true
        - name: reset_quota
          in: query
          type: string
          description: Adding the reset_quota parameter and setting it to 1, will cause Tyk reset the organisations quota
            in the live quota manager, it is recommended to use this mech
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updateorgkey
        method: PUT
        description: Tyk Update Organisation Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reset_quota
          in: query
          type: string
          description: Adding the reset_quota parameter and setting it to 1, will cause Tyk reset the organisations quota
            in the live quota manager, it is recommended to use this mech
        - name: keyID
          in: path
          type: string
          description: The Key ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-Tyk-Authorization
      value: '{{env.TYK_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: gateway-organisation-quotas-rest
    port: 8080
    description: REST adapter for Tyk Gateway API — Organisation Quotas. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/tyk/org/keys
      name: tyk-org-keys
      description: REST surface for tyk-org-keys.
      operations:
      - method: GET
        name: listorgkeys
        description: Tyk List Organisation Keys
        call: gateway-organisation-quotas.listorgkeys
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tyk/org/keys/{keyid}
      name: tyk-org-keys-keyid
      description: REST surface for tyk-org-keys-keyID.
      operations:
      - method: DELETE
        name: deleteorgkey
        description: Tyk Delete Key
        call: gateway-organisation-quotas.deleteorgkey
        with:
          keyID: rest.keyID
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getorgkey
        description: Tyk Get an Organisation Key
        call: gateway-organisation-quotas.getorgkey
        with:
          orgID: rest.orgID
          keyID: rest.keyID
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addorgkey
        description: Tyk Create an Organisation Key
        call: gateway-organisation-quotas.addorgkey
        with:
          keyID: rest.keyID
          reset_quota: rest.reset_quota
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorgkey
        description: Tyk Update Organisation Key
        call: gateway-organisation-quotas.updateorgkey
        with:
          reset_quota: rest.reset_quota
          keyID: rest.keyID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gateway-organisation-quotas-mcp
    port: 9090
    transport: http
    description: MCP adapter for Tyk Gateway API — Organisation Quotas. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: tyk-list-organisation-keys
      description: Tyk List Organisation Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-organisation-quotas.listorgkeys
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: tyk-delete-key
      description: Tyk Delete Key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gateway-organisation-quotas.deleteorgkey
      with:
        keyID: tools.keyID
      outputParameters:
      - type: object
        mapping: $.
    - name: tyk-get-organisation-key
      description: Tyk Get an Organisation Key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gateway-organisation-quotas.getorgkey
      with:
        orgID: tools.orgID
        keyID: tools.keyID
      outputParameters:
      - type: object
        mapping: $.
    - name: tyk-create-organisation-key
      description: Tyk Create an Organisation Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gateway-organisation-quotas.addorgkey
      with:
        keyID: tools.keyID
        reset_quota: tools.reset_quota
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: tyk-update-organisation-key
      description: Tyk Update Organisation Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: gateway-organisation-quotas.updateorgkey
      with:
        reset_quota: tools.reset_quota
        keyID: tools.keyID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.