Gravitee.io APIM Management API — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: Gravitee.io APIM Management API — Subscriptions
  description: 'Gravitee.io APIM Management API — Subscriptions. 6 operations. Lead operation: List Subscriptions for an API.
    Self-contained Naftiko capability covering one Gravitee business surface.'
  tags:
  - Gravitee
  - Subscriptions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GRAVITEE_API_KEY: GRAVITEE_API_KEY
capability:
  consumes:
  - type: http
    namespace: apim-subscriptions
    baseUri: https://{host}/management/v2
    description: Gravitee.io APIM Management API — Subscriptions business capability. Self-contained, no shared references.
    resources:
    - name: environments-envId-apis-apiId-subscriptions
      path: /environments/{envId}/apis/{apiId}/subscriptions
      operations:
      - name: listapisubscriptions
        method: GET
        description: List Subscriptions for an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: environments-envId-subscriptions
      path: /environments/{envId}/subscriptions
      operations:
      - name: listsubscriptions
        method: GET
        description: List Subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsubscription
        method: POST
        description: Create a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: environments-envId-subscriptions-subscriptionId
      path: /environments/{envId}/subscriptions/{subscriptionId}
      operations:
      - name: getsubscription
        method: GET
        description: Get a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          required: true
    - name: environments-envId-subscriptions-subscriptionId-_accept
      path: /environments/{envId}/subscriptions/{subscriptionId}/_accept
      operations:
      - name: acceptsubscription
        method: POST
        description: Accept a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          required: true
    - name: environments-envId-subscriptions-subscriptionId-_reject
      path: /environments/{envId}/subscriptions/{subscriptionId}/_reject
      operations:
      - name: rejectsubscription
        method: POST
        description: Reject a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.GRAVITEE_API_KEY}}'
  exposes:
  - type: rest
    namespace: apim-subscriptions-rest
    port: 8080
    description: REST adapter for Gravitee.io APIM Management API — Subscriptions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/environments/{envid}/apis/{apiid}/subscriptions
      name: environments-envid-apis-apiid-subscriptions
      description: REST surface for environments-envId-apis-apiId-subscriptions.
      operations:
      - method: GET
        name: listapisubscriptions
        description: List Subscriptions for an API
        call: apim-subscriptions.listapisubscriptions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environments/{envid}/subscriptions
      name: environments-envid-subscriptions
      description: REST surface for environments-envId-subscriptions.
      operations:
      - method: GET
        name: listsubscriptions
        description: List Subscriptions
        call: apim-subscriptions.listsubscriptions
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsubscription
        description: Create a Subscription
        call: apim-subscriptions.createsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environments/{envid}/subscriptions/{subscriptionid}
      name: environments-envid-subscriptions-subscriptionid
      description: REST surface for environments-envId-subscriptions-subscriptionId.
      operations:
      - method: GET
        name: getsubscription
        description: Get a Subscription
        call: apim-subscriptions.getsubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environments/{envid}/subscriptions/{subscriptionid}/accept
      name: environments-envid-subscriptions-subscriptionid-accept
      description: REST surface for environments-envId-subscriptions-subscriptionId-_accept.
      operations:
      - method: POST
        name: acceptsubscription
        description: Accept a Subscription
        call: apim-subscriptions.acceptsubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environments/{envid}/subscriptions/{subscriptionid}/reject
      name: environments-envid-subscriptions-subscriptionid-reject
      description: REST surface for environments-envId-subscriptions-subscriptionId-_reject.
      operations:
      - method: POST
        name: rejectsubscription
        description: Reject a Subscription
        call: apim-subscriptions.rejectsubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: apim-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gravitee.io APIM Management API — Subscriptions. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-subscriptions-api
      description: List Subscriptions for an API
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: apim-subscriptions.listapisubscriptions
      outputParameters:
      - type: object
        mapping: $.
    - name: list-subscriptions
      description: List Subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: apim-subscriptions.listsubscriptions
      outputParameters:
      - type: object
        mapping: $.
    - name: create-subscription
      description: Create a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: apim-subscriptions.createsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-subscription
      description: Get a Subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: apim-subscriptions.getsubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.
    - name: accept-subscription
      description: Accept a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: apim-subscriptions.acceptsubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.
    - name: reject-subscription
      description: Reject a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: apim-subscriptions.rejectsubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.