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

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