Confluence Cloud REST API v2 — Comment

naftiko: 1.0.0-alpha2
info:
  label: Confluence Cloud REST API v2 — Comment
  description: 'Confluence Cloud REST API v2 — Comment. 8 operations. Lead operation: Get Comment by Id. Self-contained Naftiko
    capability covering one Confluence business surface.'
  tags:
  - Confluence
  - Comment
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CONFLUENCE_API_KEY: CONFLUENCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-v2-comment
    baseUri: https://{domain}.atlassian.net/wiki/api/v2
    description: Confluence Cloud REST API v2 — Comment business capability. Self-contained, no shared references.
    resources:
    - name: comments-id
      path: /comments/{id}
      operations:
      - name: getcommentbyid
        method: GET
        description: Get Comment by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the comment.
          required: true
      - name: updatecomment
        method: PUT
        description: Update Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the comment.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecomment
        method: DELETE
        description: Delete Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the comment.
          required: true
    - name: comments-id-children
      path: /comments/{id}/children
      operations:
      - name: getchildcomments
        method: GET
        description: Get Child Comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the parent comment.
          required: true
    - name: footer-comments
      path: /footer-comments
      operations:
      - name: createfootercomment
        method: POST
        description: Create Footer Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: inline-comments
      path: /inline-comments
      operations:
      - name: createinlinecomment
        method: POST
        description: Create Inline Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: pages-id-footer-comments
      path: /pages/{id}/footer-comments
      operations:
      - name: getfootercomments
        method: GET
        description: Get Footer Comments for Page
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: pages-id-inline-comments
      path: /pages/{id}/inline-comments
      operations:
      - name: getinlinecomments
        method: GET
        description: Get Inline Comments for Page
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.CONFLUENCE_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-v2-comment-rest
    port: 8080
    description: REST adapter for Confluence Cloud REST API v2 — Comment. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/comments/{id}
      name: comments-id
      description: REST surface for comments-id.
      operations:
      - method: GET
        name: getcommentbyid
        description: Get Comment by Id
        call: cloud-v2-comment.getcommentbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecomment
        description: Update Comment
        call: cloud-v2-comment.updatecomment
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecomment
        description: Delete Comment
        call: cloud-v2-comment.deletecomment
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/comments/{id}/children
      name: comments-id-children
      description: REST surface for comments-id-children.
      operations:
      - method: GET
        name: getchildcomments
        description: Get Child Comments
        call: cloud-v2-comment.getchildcomments
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/footer-comments
      name: footer-comments
      description: REST surface for footer-comments.
      operations:
      - method: POST
        name: createfootercomment
        description: Create Footer Comment
        call: cloud-v2-comment.createfootercomment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/inline-comments
      name: inline-comments
      description: REST surface for inline-comments.
      operations:
      - method: POST
        name: createinlinecomment
        description: Create Inline Comment
        call: cloud-v2-comment.createinlinecomment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pages/{id}/footer-comments
      name: pages-id-footer-comments
      description: REST surface for pages-id-footer-comments.
      operations:
      - method: GET
        name: getfootercomments
        description: Get Footer Comments for Page
        call: cloud-v2-comment.getfootercomments
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pages/{id}/inline-comments
      name: pages-id-inline-comments
      description: REST surface for pages-id-inline-comments.
      operations:
      - method: GET
        name: getinlinecomments
        description: Get Inline Comments for Page
        call: cloud-v2-comment.getinlinecomments
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-v2-comment-mcp
    port: 9090
    transport: http
    description: MCP adapter for Confluence Cloud REST API v2 — Comment. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-comment-id
      description: Get Comment by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-v2-comment.getcommentbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-comment
      description: Update Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-v2-comment.updatecomment
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-comment
      description: Delete Comment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloud-v2-comment.deletecomment
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-child-comments
      description: Get Child Comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-v2-comment.getchildcomments
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-footer-comment
      description: Create Footer Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-v2-comment.createfootercomment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-inline-comment
      description: Create Inline Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-v2-comment.createinlinecomment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-footer-comments-page
      description: Get Footer Comments for Page
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-v2-comment.getfootercomments
      outputParameters:
      - type: object
        mapping: $.
    - name: get-inline-comments-page
      description: Get Inline Comments for Page
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-v2-comment.getinlinecomments
      outputParameters:
      - type: object
        mapping: $.