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

     1  ---
     2  summary: Update a job template locale
     3  description: Update an existing job template locale.
     4  operationId: job_template_locale/update
     5  tags:
     6  - Job Template Locales
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/job_template_id"
    11  - "$ref": "../../parameters.yaml#/job_template_locale_id"
    12  responses:
    13    '200':
    14      description: OK
    15      content:
    16        application/json:
    17          schema:
    18            "$ref": "../../schemas/job_template_locale.yaml#/job_template_locale"
    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/job_templates/:job_template_id/locales/:job_template_locale_id" \
    36        -u USERNAME_OR_ACCESS_TOKEN \
    37        -X PATCH \
    38        -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"],"reviewer_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \
    39        -H 'Content-Type: application/json'
    40  - lang: CLI v2
    41    source: |-
    42      phrase job_template_locales update \
    43      --project_id <project_id> \
    44      --job_template_id <job_template_id> \
    45      --job_template_locale_id <job_template_locale_id> \
    46      --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "reviewer_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \
    47      --access_token <token>
    48  requestBody:
    49    required: true
    50    content:
    51      application/json:
    52        schema:
    53          type: object
    54          title: job_template_locale/update/parameters
    55          properties:
    56            branch:
    57              description: specify the branch to use
    58              type: string
    59              example: my-feature-branch
    60            locale_id:
    61              description: locale id
    62              type: string
    63              example: abcd1234cdef1234abcd1234cdef1234
    64            user_ids:
    65              description: Array of user ids to be assigned to the job template locale
    66              type: array
    67              items:
    68                type: string
    69              example:
    70              - abcd1234cdef1234abcd1234cdef1234
    71            reviewer_ids:
    72              description: Array of reviewer ids to be assigned to the job template locale
    73              type: array
    74              items:
    75                type: string
    76              example:
    77              - abcd1234cdef1234abcd1234cdef1234
    78            translator_team_ids:
    79              description: Array of team ids to be assigned to the job locale as translators
    80              type: array
    81              items:
    82                type: string
    83              example:
    84              - abcd1234cdef1234abcd1234cdef1234
    85            reviewer_team_ids:
    86              description: Array of team ids to be assigned to the job locale as reviewers
    87              type: array
    88              items:
    89                type: string
    90              example:
    91              - abcd1234cdef1234abcd1234cdef1234
    92  x-cli-version: '2.6.8'