Phrase Strings API Reference — Job Comments

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Job Comments
  description: 'Phrase Strings API Reference — Job Comments. 5 operations. Lead operation: List job comments. Self-contained
    Naftiko capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Job Comments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-job-comments
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Job Comments business capability. Self-contained, no shared references.
    resources:
    - name: projects-project_id-jobs-job_id-comments
      path: /projects/{project_id}/jobs/{job_id}/comments
      operations:
      - name: jobcommentslist
        method: GET
        description: List job comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order
          in: query
          type: string
          description: 'Order direction. Can be one of: asc, desc.'
      - name: jobcommentcreate
        method: POST
        description: Create a job comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-project_id-jobs-job_id-comments-id
      path: /projects/{project_id}/jobs/{job_id}/comments/{id}
      operations:
      - name: jobcommentshow
        method: GET
        description: Get a single job comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: jobcommentupdate
        method: PATCH
        description: Update a job comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: jobcommentdelete
        method: DELETE
        description: Delete a job comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.PHRASE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: strings-job-comments-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Job Comments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/projects/{project-id}/jobs/{job-id}/comments
      name: projects-project-id-jobs-job-id-comments
      description: REST surface for projects-project_id-jobs-job_id-comments.
      operations:
      - method: GET
        name: jobcommentslist
        description: List job comments
        call: strings-job-comments.jobcommentslist
        with:
          order: rest.order
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: jobcommentcreate
        description: Create a job comment
        call: strings-job-comments.jobcommentcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/jobs/{job-id}/comments/{id}
      name: projects-project-id-jobs-job-id-comments-id
      description: REST surface for projects-project_id-jobs-job_id-comments-id.
      operations:
      - method: GET
        name: jobcommentshow
        description: Get a single job comment
        call: strings-job-comments.jobcommentshow
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: jobcommentupdate
        description: Update a job comment
        call: strings-job-comments.jobcommentupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: jobcommentdelete
        description: Delete a job comment
        call: strings-job-comments.jobcommentdelete
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-job-comments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Job Comments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-job-comments
      description: List job comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-job-comments.jobcommentslist
      with:
        order: tools.order
      outputParameters:
      - type: object
        mapping: $.
    - name: create-job-comment
      description: Create a job comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-job-comments.jobcommentcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-job-comment
      description: Get a single job comment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-job-comments.jobcommentshow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-job-comment
      description: Update a job comment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-job-comments.jobcommentupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-job-comment
      description: Delete a job comment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-job-comments.jobcommentdelete
      outputParameters:
      - type: object
        mapping: $.