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

     1  ---
     2  summary: List screenshots
     3  description: List all screenshots for the given project.
     4  operationId: screenshots/list
     5  tags:
     6  - Screenshots
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/page"
    11  - "$ref": "../../parameters.yaml#/per_page"
    12  - description: specify the branch to use
    13    example: my-feature-branch
    14    name: branch
    15    in: query
    16    schema:
    17      type: string
    18  - description: filter by key
    19    example: abcd1234cdef1234abcd1234cdef1234
    20    name: key_id
    21    in: query
    22    schema:
    23      type: string
    24  responses:
    25    '200':
    26      description: OK
    27      content:
    28        application/json:
    29          schema:
    30            type: array
    31            items:
    32              "$ref": "../../schemas/screenshot.yaml#/screenshot"
    33      headers:
    34        X-Rate-Limit-Limit:
    35          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    36        X-Rate-Limit-Remaining:
    37          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    38        X-Rate-Limit-Reset:
    39          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    40        Link:
    41          "$ref": "../../headers.yaml#/Link"
    42        Pagination:
    43          "$ref": "../../headers.yaml#/Pagination"
    44    '400':
    45      "$ref": "../../responses.yaml#/400"
    46    '404':
    47      "$ref": "../../responses.yaml#/404"
    48    '429':
    49      "$ref": "../../responses.yaml#/429"
    50  x-code-samples:
    51  - lang: Curl
    52    source: |-
    53      curl "https://api.phrase.com/v2/projects/:project_id/screenshots?branch=my-feature-branch" \
    54        -u USERNAME_OR_ACCESS_TOKEN
    55  - lang: CLI v2
    56    source: |-
    57      phrase screenshots list \
    58      --project_id <project_id> \
    59      --branch my-feature-branch \
    60      --access_token <token>
    61  x-cli-version: '2.5'