IBM MQ REST API — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: IBM MQ REST API — Subscriptions
  description: 'IBM MQ REST API — Subscriptions. 3 operations. Lead operation: List Subscriptions. Self-contained Naftiko
    capability covering one Websphere business surface.'
  tags:
  - Websphere
  - Subscriptions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBSPHERE_API_KEY: WEBSPHERE_API_KEY
capability:
  consumes:
  - type: http
    namespace: mq-rest-subscriptions
    baseUri: https://localhost:9443/ibmmq/rest/v2
    description: IBM MQ REST API — Subscriptions business capability. Self-contained, no shared references.
    resources:
    - name: admin-qmgr-qmgrName-subscription
      path: /admin/qmgr/{qmgrName}/subscription
      operations:
      - name: listsubscriptions
        method: GET
        description: List Subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-qmgr-qmgrName-subscription-subscriptionId
      path: /admin/qmgr/{qmgrName}/subscription/{subscriptionId}
      operations:
      - name: getsubscription
        method: GET
        description: Get Subscription Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: Subscription identifier
          required: true
      - name: deletesubscription
        method: DELETE
        description: Delete a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: LtpaToken2
      value: '{{env.WEBSPHERE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: mq-rest-subscriptions-rest
    port: 8080
    description: REST adapter for IBM MQ REST API — Subscriptions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/admin/qmgr/{qmgrname}/subscription
      name: admin-qmgr-qmgrname-subscription
      description: REST surface for admin-qmgr-qmgrName-subscription.
      operations:
      - method: GET
        name: listsubscriptions
        description: List Subscriptions
        call: mq-rest-subscriptions.listsubscriptions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/qmgr/{qmgrname}/subscription/{subscriptionid}
      name: admin-qmgr-qmgrname-subscription-subscriptionid
      description: REST surface for admin-qmgr-qmgrName-subscription-subscriptionId.
      operations:
      - method: GET
        name: getsubscription
        description: Get Subscription Details
        call: mq-rest-subscriptions.getsubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesubscription
        description: Delete a Subscription
        call: mq-rest-subscriptions.deletesubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: mq-rest-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for IBM MQ REST API — Subscriptions. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-subscriptions
      description: List Subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mq-rest-subscriptions.listsubscriptions
      outputParameters:
      - type: object
        mapping: $.
    - name: get-subscription-details
      description: Get Subscription Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mq-rest-subscriptions.getsubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-subscription
      description: Delete a Subscription
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: mq-rest-subscriptions.deletesubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.