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

     1  ---
     2  summary: Search translations
     3  description: Search translations for the given project. Provides the same search interface as <code>translations#index</code> but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
     4  operationId: translations/search
     5  tags:
     6  - Translations
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/page"
    11  - "$ref": "../../parameters.yaml#/per_page"
    12  responses:
    13    '200':
    14      description: OK
    15      content:
    16        application/json:
    17          schema:
    18            type: array
    19            items:
    20              "$ref": "../../schemas/translation.yaml#/translation"
    21      headers:
    22        X-Rate-Limit-Limit:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    24        X-Rate-Limit-Remaining:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    26        X-Rate-Limit-Reset:
    27          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    28    '400':
    29      "$ref": "../../responses.yaml#/400"
    30    '404':
    31      "$ref": "../../responses.yaml#/404"
    32    '429':
    33      "$ref": "../../responses.yaml#/429"
    34  x-code-samples:
    35  - lang: Curl
    36    source: |-
    37      curl "https://api.phrase.com/v2/projects/:project_id/translations/search" \
    38        -u USERNAME_OR_ACCESS_TOKEN \
    39        -X POST \
    40        -d '{"branch":"my-feature-branch","sort":"updated_at","order":"desc","q":"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center"}' \
    41        -H 'Content-Type: application/json'
    42  - lang: CLI v2
    43    source: |-
    44      phrase translations search \
    45      --project_id <project_id> \
    46      --data '{"branch":"my-feature-branch", "sort":"updated_at", "order":"desc", "q":"'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center'"}' \
    47      --access_token <token>
    48  requestBody:
    49    required: true
    50    content:
    51      application/json:
    52        schema:
    53          type: object
    54          title: translations/search/parameters
    55          properties:
    56            branch:
    57              description: specify the branch to use
    58              type: string
    59              example: my-feature-branch
    60            sort:
    61              description: 'Sort criteria. Can be one of: key_name, created_at, updated_at.'
    62              type: string
    63              example: updated_at
    64            order:
    65              description: 'Order direction. Can be one of: asc, desc.'
    66              type: string
    67              example: desc
    68            q:
    69              description: |
    70                Specify a query to find translations by content (including wildcards).<br><br>
    71                <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br>
    72                The following qualifiers are supported in the query:<br>
    73                <ul>
    74                  <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>
    75                  <li><code>tags:XYZ</code> for tags on the translation</li>
    76                  <li><code>unverified:{true|false}</code> for verification status</li>
    77                  <li><code>excluded:{true|false}</code> for exclusion status</li>
    78                  <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
    79                </ul>
    80                Find more examples <a href="#overview--usage-examples">here</a>.
    81              type: string
    82              example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center
    83  x-cli-version: '2.5'