IBM MQ REST API — Channels

naftiko: 1.0.0-alpha2
info:
  label: IBM MQ REST API — Channels
  description: 'IBM MQ REST API — Channels. 6 operations. Lead operation: List Channels. Self-contained Naftiko capability
    covering one Websphere business surface.'
  tags:
  - Websphere
  - Channels
  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-channels
    baseUri: https://localhost:9443/ibmmq/rest/v2
    description: IBM MQ REST API — Channels business capability. Self-contained, no shared references.
    resources:
    - name: admin-qmgr-qmgrName-channel
      path: /admin/qmgr/{qmgrName}/channel
      operations:
      - name: listchannels
        method: GET
        description: List Channels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Channel name filter
        - name: type
          in: query
          type: string
          description: Channel type filter
      - name: createchannel
        method: POST
        description: Create a Channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: admin-qmgr-qmgrName-channel-channelName
      path: /admin/qmgr/{qmgrName}/channel/{channelName}
      operations:
      - name: getchannel
        method: GET
        description: Get Channel Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: channelName
          in: path
          type: string
          description: Channel name
          required: true
      - name: deletechannel
        method: DELETE
        description: Delete a Channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: channelName
          in: path
          type: string
          required: true
    - name: admin-qmgr-qmgrName-channel-channelName-start
      path: /admin/qmgr/{qmgrName}/channel/{channelName}/start
      operations:
      - name: startchannel
        method: POST
        description: Start a Channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: channelName
          in: path
          type: string
          required: true
    - name: admin-qmgr-qmgrName-channel-channelName-stop
      path: /admin/qmgr/{qmgrName}/channel/{channelName}/stop
      operations:
      - name: stopchannel
        method: POST
        description: Stop a Channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: channelName
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: LtpaToken2
      value: '{{env.WEBSPHERE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: mq-rest-channels-rest
    port: 8080
    description: REST adapter for IBM MQ REST API — Channels. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/admin/qmgr/{qmgrname}/channel
      name: admin-qmgr-qmgrname-channel
      description: REST surface for admin-qmgr-qmgrName-channel.
      operations:
      - method: GET
        name: listchannels
        description: List Channels
        call: mq-rest-channels.listchannels
        with:
          name: rest.name
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createchannel
        description: Create a Channel
        call: mq-rest-channels.createchannel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/qmgr/{qmgrname}/channel/{channelname}
      name: admin-qmgr-qmgrname-channel-channelname
      description: REST surface for admin-qmgr-qmgrName-channel-channelName.
      operations:
      - method: GET
        name: getchannel
        description: Get Channel Details
        call: mq-rest-channels.getchannel
        with:
          channelName: rest.channelName
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletechannel
        description: Delete a Channel
        call: mq-rest-channels.deletechannel
        with:
          channelName: rest.channelName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/qmgr/{qmgrname}/channel/{channelname}/start
      name: admin-qmgr-qmgrname-channel-channelname-start
      description: REST surface for admin-qmgr-qmgrName-channel-channelName-start.
      operations:
      - method: POST
        name: startchannel
        description: Start a Channel
        call: mq-rest-channels.startchannel
        with:
          channelName: rest.channelName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/qmgr/{qmgrname}/channel/{channelname}/stop
      name: admin-qmgr-qmgrname-channel-channelname-stop
      description: REST surface for admin-qmgr-qmgrName-channel-channelName-stop.
      operations:
      - method: POST
        name: stopchannel
        description: Stop a Channel
        call: mq-rest-channels.stopchannel
        with:
          channelName: rest.channelName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: mq-rest-channels-mcp
    port: 9090
    transport: http
    description: MCP adapter for IBM MQ REST API — Channels. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-channels
      description: List Channels
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mq-rest-channels.listchannels
      with:
        name: tools.name
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: create-channel
      description: Create a Channel
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mq-rest-channels.createchannel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-channel-details
      description: Get Channel Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mq-rest-channels.getchannel
      with:
        channelName: tools.channelName
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-channel
      description: Delete a Channel
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: mq-rest-channels.deletechannel
      with:
        channelName: tools.channelName
      outputParameters:
      - type: object
        mapping: $.
    - name: start-channel
      description: Start a Channel
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mq-rest-channels.startchannel
      with:
        channelName: tools.channelName
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-channel
      description: Stop a Channel
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mq-rest-channels.stopchannel
      with:
        channelName: tools.channelName
      outputParameters:
      - type: object
        mapping: $.