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

     1  ---
     2  summary: List replies
     3  description: List all replies for a comment.
     4  operationId: replies/list
     5  tags:
     6  - Comment Replies
     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#/comment_id"
    12  - "$ref": "../../parameters.yaml#/page"
    13  - "$ref": "../../parameters.yaml#/per_page"
    14  - description: specify the branch to use
    15    example: my-feature-branch
    16    name: branch
    17    in: query
    18    schema:
    19      type: string
    20  - description: Search query for comment messages
    21    example: Some comment content
    22    name: query
    23    in: query
    24    schema:
    25      type: string
    26  - description: Specify the filter for the comments
    27    name: filters
    28    in: query
    29    schema:
    30      type: array
    31      example: [read, unread]
    32      items:
    33        type: string
    34  - description: 'Order direction. Can be one of: asc, desc.'
    35    name: order
    36    in: query
    37    example: desc
    38    schema:
    39      type: string
    40  responses:
    41    '200':
    42      description: OK
    43      content:
    44        application/json:
    45          schema:
    46            type: array
    47            items:
    48              "$ref": "../../schemas/comment.yaml#/comment"
    49      headers:
    50        X-Rate-Limit-Limit:
    51          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    52        X-Rate-Limit-Remaining:
    53          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    54        X-Rate-Limit-Reset:
    55          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    56        Link:
    57          "$ref": "../../headers.yaml#/Link"
    58        Pagination:
    59          "$ref": "../../headers.yaml#/Pagination"
    60    '400':
    61      "$ref": "../../responses.yaml#/400"
    62    '403':
    63      "$ref": "../../responses.yaml#/403"
    64    '404':
    65      "$ref": "../../responses.yaml#/404"
    66    '429':
    67      "$ref": "../../responses.yaml#/429"
    68  x-code-samples:
    69  - lang: Curl
    70    source: |-
    71      curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something&order=desc" \
    72        -u USERNAME_OR_ACCESS_TOKEN \
    73        -X GET \
    74        -H 'Content-Type: application/json'
    75  - lang: CLI v2
    76    source: |-
    77      phrase replies list \
    78      --project_id <project_id> \
    79      --key_id <key_id> \
    80      --comment_id <comment_id> \
    81      --branch "my-feature-branch" \
    82      --filters unread \
    83      --order desc \
    84      --query "Some comment content" \
    85      --access_token <token>
    86  requestBody:
    87    required: true
    88    content:
    89      application/json:
    90        schema:
    91          type: object
    92          title: replies/list/parameters
    93          properties:
    94            branch:
    95              description: Specify the branch to use
    96              type: string
    97              example: my-feature-branch
    98            query:
    99              description: Search query for comment messages
   100              type: string
   101              example: Some comment content
   102            filters:
   103              description: Specify filters to find comments by
   104              type: array
   105              items:
   106                type: string
   107              example: [read, unread]
   108            order:
   109              description: Specify ordering of comments
   110              type: string
   111              example: desc
   112  x-cli-version: '2.10'