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

     1  ---
     2  summary: List translations by key
     3  description: List translations for a specific key.
     4  operationId: translations/by_key
     5  tags:
     6  - Translations
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/key_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  - description: 'Sort criteria. Can be one of: key_name, created_at, updated_at.'
    20    example: updated_at
    21    name: sort
    22    in: query
    23    schema:
    24      type: string
    25  - description: 'Order direction. Can be one of: asc, desc.'
    26    example: desc
    27    name: order
    28    in: query
    29    schema:
    30      type: string
    31  - description: |
    32      Specify a query to find translations by content (including wildcards).<br><br>
    33      The following qualifiers are supported in the query:<br>
    34      <ul>
    35        <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>
    36        <li><code>unverified:{true|false}</code> for verification status</li>
    37        <li><code>tags:XYZ</code> for tags on the translation</li>
    38        <li><code>excluded:{true|false}</code> for exclusion status</li>
    39        <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
    40      </ul>
    41      Find more examples <a href="#overview--usage-examples">here</a>.
    42    example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center
    43    name: q
    44    in: query
    45    schema:
    46      type: string
    47  responses:
    48    '200':
    49      description: OK
    50      content:
    51        application/json:
    52          schema:
    53            type: array
    54            items:
    55              "$ref": "../../schemas/translation.yaml#/translation"
    56      headers:
    57        X-Rate-Limit-Limit:
    58          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    59        X-Rate-Limit-Remaining:
    60          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    61        X-Rate-Limit-Reset:
    62          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    63        Link:
    64          "$ref": "../../headers.yaml#/Link"
    65        Pagination:
    66          "$ref": "../../headers.yaml#/Pagination"
    67    '400':
    68      "$ref": "../../responses.yaml#/400"
    69    '404':
    70      "$ref": "../../responses.yaml#/404"
    71    '429':
    72      "$ref": "../../responses.yaml#/429"
    73  x-code-samples:
    74  - lang: Curl
    75    source: |-
    76      curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/translations?branch=my-feature-branch&sort=updated_at&order=desc&q=PhraseApp*%2520unverified:true%2520excluded:true%2520tags:feature,center" \
    77        -u USERNAME_OR_ACCESS_TOKEN
    78  - lang: CLI v2
    79    source: |-
    80      phrase translations by_key \
    81      --project_id <project_id> \
    82      --key_id <key_id> \
    83      --branch my-feature-branch \
    84      --sort updated_at \
    85      --order desc \
    86      --query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \
    87      --access_token <token>
    88  x-cli-version: '2.5'