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

     1  ---
     2  summary: Delete a job comment
     3  description: Delete an existing job comment.
     4  operationId: job_comment/delete
     5  tags:
     6  - Job Comments
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/job_id"
    11  - "$ref": "../../parameters.yaml#/id"
    12  - description: specify the branch to use
    13    example: my-feature-branch
    14    name: branch
    15    in: query
    16    schema:
    17      type: string
    18  responses:
    19    '204':
    20      "$ref": "../../responses.yaml#/204"
    21    '400':
    22      "$ref": "../../responses.yaml#/400"
    23    '404':
    24      "$ref": "../../responses.yaml#/404"
    25    '429':
    26      "$ref": "../../responses.yaml#/429"
    27  x-code-samples:
    28  - lang: Curl
    29    source: |-
    30      curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments/:id" \
    31        -u USERNAME_OR_ACCESS_TOKEN \
    32        -X DELETE \
    33        -d '{"branch":"my-feature-branch"}' \
    34        -H 'Content-Type: application/json'
    35  - lang: CLI v2
    36    source: |-
    37      phrase job_comments delete \
    38      --project_id <project_id> \
    39      --job_id <key_id> \
    40      --id <id> \
    41      --branch my-feature-branch \
    42      --access_token <token>
    43  x-cli-version: '2.5'