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

     1  ---
     2  summary: Add a target locale to a job
     3  description: Adds a target locale to a job.
     4  operationId: job_locales/create
     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  responses:
    12    '201':
    13      description: Created
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/job_locale.yaml#/job_locale"
    18      headers:
    19        X-Rate-Limit-Limit:
    20          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    21        X-Rate-Limit-Remaining:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    23        X-Rate-Limit-Reset:
    24          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    25    '400':
    26      "$ref": "../../responses.yaml#/400"
    27    '404':
    28      "$ref": "../../responses.yaml#/404"
    29    '429':
    30      "$ref": "../../responses.yaml#/429"
    31  x-code-samples:
    32  - lang: Curl
    33    source: |-
    34      curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales" \
    35        -u USERNAME_OR_ACCESS_TOKEN \
    36        -X POST \
    37        -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \
    38        -H 'Content-Type: application/json'
    39  - lang: CLI v2
    40    source: |-
    41      phrase job_locales create \
    42      --project_id <project_id> \
    43      --job_id <job_id> \
    44      --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \
    45      --access_token <token>
    46  requestBody:
    47    required: true
    48    content:
    49      application/json:
    50        schema:
    51          type: object
    52          title: job_locales/create/parameters
    53          properties:
    54            branch:
    55              description: specify the branch to use
    56              type: string
    57              example: my-feature-branch
    58            locale_id:
    59              description: ID of a locale to be added
    60              type: string
    61              example: abcd1234cdef1234abcd1234cdef1234
    62            user_ids:
    63              description: Array of user ids to be assigned to the job locale as translators
    64              type: array
    65              items:
    66                type: string
    67              example:
    68              - abcd1234cdef1234abcd1234cdef1234
    69            reviewer_ids:
    70              description: Array of reviewer ids to be assigned to the job locale as reviewers
    71              type: array
    72              items:
    73                type: string
    74              example:
    75              - abcd1234cdef1234abcd1234cdef1234
    76            translator_team_ids:
    77              description: Array of team ids to be assigned to the job locale as translators
    78              type: array
    79              items:
    80                type: string
    81              example:
    82              - abcd1234cdef1234abcd1234cdef1234
    83            reviewer_team_ids:
    84              description: Array of team ids to be assigned to the job locale as reviewers
    85              type: array
    86              items:
    87                type: string
    88              example:
    89              - abcd1234cdef1234abcd1234cdef1234
    90          required:
    91          - locale_id
    92  x-cli-version: '2.6.8'