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

     1  Link:
     2    description: |-
     3      Links to related resources, in the format defined by
     4      [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).
     5      This will include a link with relation type `next` to the
     6      next page, if there is a next page.
     7    schema:
     8      type: string
     9  X-PhraseApp-OTP:
    10    description: The number of allowed requests in the current period
    11    schema:
    12      type: string
    13  X-Rate-Limit-Limit:
    14    description: The number of allowed requests in the current period
    15    schema:
    16      type: integer
    17  X-Rate-Limit-Remaining:
    18    description: The number of remaining requests in the current period
    19    schema:
    20      type: integer
    21  X-Rate-Limit-Reset:
    22    description: The number of seconds left in the current period
    23    schema:
    24      type: integer
    25  Pagination:
    26    description: Pagination details for navigating through a collection of resources, provided in JSON format.
    27    schema:
    28      type: object
    29      properties:
    30        total_count:
    31          description: Total count of items in the collection.
    32          type: integer
    33          example: 10
    34        total_pages_count:
    35          description: Total number of pages available for the collection.
    36          type: integer
    37          example: 2
    38        current_page:
    39          description: The current page number.
    40          type: integer
    41          example: 1
    42        current_per_page:
    43          description: Number of items currently displayed per page.
    44          type: integer
    45          example: 5
    46        previous_page:
    47          description: Page number of the previous page, if available.
    48          type: integer
    49        next_page:
    50          description: Page number of the next page, if available.
    51          type: integer
    52          example: 2