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

     1  ---
     2  summary: Update a screenshot marker
     3  description: Update an existing screenshot marker.
     4  operationId: screenshot_marker/update
     5  tags:
     6  - Screenshot Markers
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/screenshot_id"
    11  responses:
    12    '200':
    13      description: OK
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/screenshot_marker.yaml#/screenshot_marker"
    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/projects/:project_id/screenshots/:screenshot_id/markers" \
    35        -u USERNAME_OR_ACCESS_TOKEN \
    36        -X PATCH \
    37        -d '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234","presentation":"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }"}' \
    38        -H 'Content-Type: application/json'
    39  - lang: CLI v2
    40    source: |-
    41      phrase screenshot_markers update \
    42      --project_id <project_id> \
    43      --screenshot_id <screenshot_id> \
    44      --data '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234", "presentation": "{ "x": 100, "y": 100, "w": 100, "h": 100 }"}' \
    45      --access_token <token>
    46  requestBody:
    47    required: true
    48    content:
    49      application/json:
    50        schema:
    51          type: object
    52          title: screenshot_marker/update/parameters
    53          properties:
    54            branch:
    55              description: specify the branch to use
    56              type: string
    57              example: my-feature-branch
    58            key_id:
    59              description: Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project.
    60              type: string
    61              example: abcd1234abcd1234abcd1234abcd1234
    62            presentation:
    63              description: Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels).
    64              type: string
    65              example: '{ "x": 100, "y": 100, "w": 100, "h": 100 }'
    66  x-cli-version: '2.5'