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

     1  ---
     2  summary: Mark a comment as read
     3  description: Mark a comment as read.
     4  operationId: comment/mark/read
     5  tags:
     6  - Comments
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/key_id"
    11  - "$ref": "../../parameters.yaml#/id"
    12  responses:
    13    '204':
    14      "$ref": "../../responses.yaml#/204"
    15    '400':
    16      "$ref": "../../responses.yaml#/400"
    17    '404':
    18      "$ref": "../../responses.yaml#/404"
    19    '429':
    20      "$ref": "../../responses.yaml#/429"
    21  x-code-samples:
    22  - lang: Curl
    23    source: |-
    24      curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:id/read" \
    25        -u USERNAME_OR_ACCESS_TOKEN \
    26        -X PATCH \
    27        -d '{"branch":"my-feature-branch"}' \
    28        -H 'Content-Type: application/json'
    29  - lang: CLI v2
    30    source: |-
    31      phrase comments mark \
    32      --project_id <project_id> \
    33      --key_id <key_id> \
    34      --id <id> \
    35      --data '{"branch":"my-feature-branch"}' \
    36      --access_token <token>
    37  requestBody:
    38    required: true
    39    content:
    40      application/json:
    41        schema:
    42          type: object
    43          title: comment/mark/read/parameters
    44          properties:
    45            branch:
    46              description: specify the branch to use
    47              type: string
    48              example: my-feature-branch
    49  x-cli-version: '2.5'