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

     1  ---
     2  summary: Update a translation
     3  description: Update an existing translation.
     4  operationId: translation/update
     5  tags:
     6  - Translations
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/id"
    11  responses:
    12    '200':
    13      description: OK
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/translation_details.yaml#/translation_details"
    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/translations/:id" \
    35        -u USERNAME_OR_ACCESS_TOKEN \
    36        -X PATCH \
    37        -d '{"branch":"my-feature-branch","content":"My translation"}' \
    38        -H 'Content-Type: application/json'
    39  - lang: CLI v2
    40    source: |-
    41      phrase translations update \
    42      --project_id <project_id> \
    43      --id <id> \
    44      --data '{"branch":"my-feature-branch", "content": "My translation"}' \
    45      --access_token <token>
    46  requestBody:
    47    required: true
    48    content:
    49      application/json:
    50        schema:
    51          type: object
    52          title: translation/update/parameters
    53          properties:
    54            branch:
    55              description: specify the branch to use
    56              type: string
    57              example: my-feature-branch
    58            content:
    59              description: Translation content
    60              type: string
    61              example: My translation
    62            plural_suffix:
    63              description: 'Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.'
    64              type: string
    65              example:
    66            unverified:
    67              description: Indicates whether translation is unverified. Part of the <a href="https://support.phrase.com/hc/en-us/articles/5784094755484" target="_blank">Advanced Workflows</a> feature.
    68              type: boolean
    69              example:
    70            excluded:
    71              description: Indicates whether translation is excluded.
    72              type: boolean
    73              example:
    74            autotranslate:
    75              description: Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.
    76              type: boolean
    77              example:
    78  x-cli-version: '2.5'