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

     1  ---
     2  summary: Update a Figma attachment
     3  description: Update an existing Figma attachment.
     4  operationId: figma_attachment/update
     5  tags:
     6    - Figma attachments
     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  responses:
    18    "200":
    19      description: OK
    20      content:
    21        application/json:
    22          schema:
    23            "$ref": "../../schemas/figma_attachment.yaml#/figma_attachment"
    24      headers:
    25        X-Rate-Limit-Limit:
    26          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    27        X-Rate-Limit-Remaining:
    28          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    29        X-Rate-Limit-Reset:
    30          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    31    "400":
    32      "$ref": "../../responses.yaml#/400"
    33    "404":
    34      "$ref": "../../responses.yaml#/404"
    35    "429":
    36      "$ref": "../../responses.yaml#/429"
    37  x-code-samples:
    38    - lang: Curl
    39      source: |-
    40        curl "https://api.phrase.com/v2/projects/:project_id/figma_attachments/:id" \
    41          -u USERNAME_OR_ACCESS_TOKEN \
    42          -X PATCH \
    43          -F branch=my-feature-branch \
    44          -F url=https://figma.com/file/xxxxx/sample \
    45    - lang: CLI v2
    46      source: |-
    47        phrase figma_attachment update \
    48        --project_id <project_id> \
    49        --id <id> \
    50        --data '{"branch":"my-feature-branch", "url":"https://figma.com/file/xxxxx/sample" }' \
    51        --access_token <token>
    52  requestBody:
    53    required: true
    54    content:
    55      application/json:
    56        schema:
    57          type: object
    58          title: figma_attachment/update/parameters
    59          properties:
    60            branch:
    61              description: specify the branch to use
    62              type: string
    63              example: my-feature-branch
    64            url:
    65              description: Figma file url
    66              type: string
    67              example: https://figma.com/file/xxxxx/sample
    68  x-cli-version: "2.13"