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

     1  ---
     2  summary: List job comments
     3  description: List all comments for a job.
     4  operationId: job_comments/list
     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  - description: specify the branch to use
    12    example: my-feature-branch
    13    name: branch
    14    in: query
    15    schema:
    16      type: string
    17  - description: 'Order direction. Can be one of: asc, desc.'
    18    name: order
    19    in: query
    20    example: desc
    21    schema:
    22      type: string
    23  responses:
    24    '200':
    25      description: OK
    26      content:
    27        application/json:
    28          schema:
    29            type: array
    30            items:
    31              "$ref": "../../schemas/job_comment.yaml#/job_comment"
    32      headers:
    33        X-Rate-Limit-Limit:
    34          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    35        X-Rate-Limit-Remaining:
    36          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    37        X-Rate-Limit-Reset:
    38          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    39        Link:
    40          "$ref": "../../headers.yaml#/Link"
    41        Pagination:
    42          "$ref": "../../headers.yaml#/Pagination"
    43    '400':
    44      "$ref": "../../responses.yaml#/400"
    45    '404':
    46      "$ref": "../../responses.yaml#/404"
    47    '429':
    48      "$ref": "../../responses.yaml#/429"
    49  x-code-samples:
    50  - lang: Curl
    51    source: |-
    52      curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments?branch=my-feature-branch&order=desc" \
    53        -u USERNAME_OR_ACCESS_TOKEN
    54  - lang: CLI v2
    55    source: |-
    56      phrase job_comments list \
    57      --project_id <project_id> \
    58      --job_id <key_id> \
    59      --branch my-feature-branch \
    60      --order desc \
    61      --access_token <token>
    62  x-cli-version: '2.5'