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

     1  ---
     2  summary: Create a Figma attachment
     3  description: Create a new Figma attachment.
     4  operationId: figma_attachment/create
     5  tags:
     6    - Figma attachments
     7  parameters:
     8    - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9    - "$ref": "../../parameters.yaml#/project_id"
    10    - description: specify the branch to use
    11      example: my-feature-branch
    12      name: branch
    13      in: query
    14      schema:
    15        type: string
    16  responses:
    17    "201":
    18      description: Created
    19      content:
    20        application/json:
    21          schema:
    22            "$ref": "../../schemas/figma_attachment.yaml#/figma_attachment"
    23      headers:
    24        X-Rate-Limit-Limit:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    26        X-Rate-Limit-Remaining:
    27          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    28        X-Rate-Limit-Reset:
    29          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    30    "400":
    31      "$ref": "../../responses.yaml#/400"
    32    "404":
    33      "$ref": "../../responses.yaml#/404"
    34    "429":
    35      "$ref": "../../responses.yaml#/429"
    36  x-code-samples:
    37    - lang: Curl
    38      source: |-
    39        curl "https://api.phrase.com/v2/projects/:project_id/figma_attachments" \
    40          -u USERNAME_OR_ACCESS_TOKEN \
    41          -X POST \
    42          -F branch=my-feature-branch \
    43          -F url=https://figma.com/file/xxxxx/sample \
    44    - lang: CLI v2
    45      source: |-
    46        phrase figma_attachment create \
    47        --project_id <project_id> \
    48        --data '{"branch":"my-feature-branch", "url":"https://figma.com/file/xxxxx/sample"}' \
    49        --access_token <token>
    50  requestBody:
    51    required: true
    52    content:
    53      application/json:
    54        schema:
    55          type: object
    56          title: figma_attachment/create/parameters
    57          required:
    58            - url
    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"