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

     1  ---
     2  summary: Remove tags from collection of keys
     3  description: Removes specified tags from keys matching query.
     4  operationId: keys/untag
     5  tags:
     6  - Keys
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  responses:
    11    '200':
    12      description: OK
    13      content:
    14        application/json:
    15          schema:
    16            "$ref": "../../schemas/affected_resources.yaml#/affected_resources"
    17      headers:
    18        X-Rate-Limit-Limit:
    19          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    20        X-Rate-Limit-Remaining:
    21          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    22        X-Rate-Limit-Reset:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    24    '400':
    25      "$ref": "../../responses.yaml#/400"
    26    '404':
    27      "$ref": "../../responses.yaml#/404"
    28    '429':
    29      "$ref": "../../responses.yaml#/429"
    30  x-code-samples:
    31  - lang: Curl
    32    source: |-
    33      curl "https://api.phrase.com/v2/projects/:project_id/keys/untag" \
    34        -u USERNAME_OR_ACCESS_TOKEN \
    35        -X PATCH \
    36        -d '{"branch":"my-feature-branch","q":"mykey* translated:true","locale_id":"abcd1234abcd1234abcd1234abcd1234","tags":"landing-page,release-1.2"}' \
    37        -H 'Content-Type: application/json'
    38  - lang: CLI v2
    39    source: |-
    40      phrase keys untag \
    41      --project_id <project_id> \
    42      --data '{"branch":"my-feature-branch", "q":"'mykey* translated:true'", "locale_id":"abcd1234abcd1234abcd1234abcd1234", "tags":"landing-page,release-1.2"}' \
    43      --access_token <token>
    44  requestBody:
    45    required: true
    46    content:
    47      application/json:
    48        schema:
    49          type: object
    50          title: keys/untag/parameters
    51          properties:
    52            branch:
    53              description: specify the branch to use
    54              type: string
    55              example: my-feature-branch
    56            q:
    57              description: |
    58                Specify a query to do broad search for keys by name (including wildcards).<br><br>
    59                The following qualifiers are also supported in the search term:<br>
    60                <ul>
    61                  <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>
    62                  <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>
    63                  <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
    64                  <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
    65                  <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
    66                  <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
    67                </ul>
    68                Find more examples <a href="#overview--usage-examples">here</a>.
    69              type: string
    70              example: mykey* translated:true
    71            locale_id:
    72              description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
    73              type: string
    74              example: abcd1234abcd1234abcd1234abcd1234
    75            tags:
    76              description: Tag or comma-separated list of tags to remove from the matching collection of keys
    77              type: string
    78              example: landing-page,release-1.2
    79  x-cli-version: '2.5'