github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/job_comments/update.yaml (about)

     1  ---
     2  summary: Update a job comment
     3  description: Update an existing job comment.
     4  operationId: job_comment/update
     5  tags:
     6  - Job Comments
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/key_id"
    11  - "$ref": "../../parameters.yaml#/id"
    12  responses:
    13    '200':
    14      description: OK
    15      content:
    16        application/json:
    17          schema:
    18            "$ref": "../../schemas/job_comment.yaml#/job_comment"
    19      headers:
    20        X-Rate-Limit-Limit:
    21          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    22        X-Rate-Limit-Remaining:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    24        X-Rate-Limit-Reset:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    26    '400':
    27      "$ref": "../../responses.yaml#/400"
    28    '404':
    29      "$ref": "../../responses.yaml#/404"
    30    '429':
    31      "$ref": "../../responses.yaml#/429"
    32  x-code-samples:
    33  - lang: Curl
    34    source: |-
    35      curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments/:id" \
    36        -u USERNAME_OR_ACCESS_TOKEN \
    37        -X PATCH \
    38        -d '{"message":"Some message..."}' \
    39        -H 'Content-Type: application/json'
    40  - lang: CLI v2
    41    source: |-
    42      phrase job_comments update \
    43      --project_id <project_id> \
    44      --job_id <job_id> \
    45      --id <id> \
    46      --data '{"message": "Some message..."}' \
    47      --access_token <token>
    48  requestBody:
    49    required: true
    50    content:
    51      application/json:
    52        schema:
    53          type: object
    54          title: job_comment/update/parameters
    55          properties:
    56            message:
    57              description: Comment message
    58              type: string
    59              example: Some message...
    60  x-cli-version: '2.5'