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

     1  ---
     2  summary: Remove keys from job
     3  description: Remove multiple keys from existing job.
     4  operationId: job/keys/delete
     5  tags:
     6  - Jobs
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/id"
    11  - description: specify the branch to use
    12    example: my-feature-branch
    13    name: branch
    14    in: query
    15    schema:
    16      type: string
    17  - description: ids of keys that should added to the job
    18    example:
    19    - abcd1234cdef1234abcd1234cdef1234
    20    name: translation_key_ids
    21    in: query
    22    schema:
    23      type: array
    24      items:
    25        type: string
    26  responses:
    27    '204':
    28      "$ref": "../../responses.yaml#/204"
    29    '400':
    30      "$ref": "../../responses.yaml#/400"
    31    '404':
    32      "$ref": "../../responses.yaml#/404"
    33    '429':
    34      "$ref": "../../responses.yaml#/429"
    35  x-code-samples:
    36  - lang: Curl
    37    source: |-
    38      curl "https://api.phrase.com/v2/projects/:project_id/jobs/:id/keys" \
    39        -u USERNAME_OR_ACCESS_TOKEN \
    40        -X DELETE \
    41        -d '{"branch":"my-feature-branch","translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \
    42        -H 'Content-Type: application/json'
    43  - lang: CLI v2
    44    source: |-
    45      phrase jobs keys_delete \
    46      --project_id <project_id> \
    47      --id <id> \
    48      --branch my-feature-branch \
    49      --translation_key_ids "abcd1234cdef1234abcd1234cdef1234" \
    50      --access_token <token>
    51  x-cli-version: '2.5'