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

     1  ---
     2  summary: Update a term base
     3  description: 'Update an existing term base (previously: glossary).'
     4  operationId: glossary/update
     5  tags:
     6  - Glossaries
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/account_id"
    10  - "$ref": "../../parameters.yaml#/id"
    11  responses:
    12    '200':
    13      description: OK
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/glossary.yaml#/glossary"
    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/accounts/:account_id/glossaries/:id" \
    35        -u USERNAME_OR_ACCESS_TOKEN \
    36        -X PATCH \
    37        -d '{"name":"My glossary","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"]}' \
    38        -H 'Content-Type: application/json'
    39  - lang: CLI v2
    40    source: |-
    41      phrase glossaries update \
    42      --account_id <account_id> \
    43      --id <id> \
    44      --data '{"name": "My glossary", "project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235"}' \
    45      --access_token <token>
    46  requestBody:
    47    required: true
    48    content:
    49      application/json:
    50        schema:
    51          type: object
    52          title: glossary/update/parameters
    53          properties:
    54            name:
    55              description: Name of the glossary
    56              type: string
    57              example: My glossary
    58            project_ids:
    59              description: List of project ids the glossary should be assigned to.
    60              type: string
    61              example: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
    62            space_ids:
    63              description: List of space ids the glossary should be assigned to.
    64              type: array
    65              items:
    66                type: string
    67              example:
    68              - abcd1234abcd1234abcd1234
    69              - abcd1234abcd1234abcd1235
    70  x-cli-version: '2.5'