headers.yaml

Link:
  description: |-
    Links to related resources, in the format defined by
    [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).
    This will include a link with relation type `next` to the
    next page, if there is a next page.
  schema:
    type: string
X-PhraseApp-OTP:
  description: The number of allowed requests in the current period
  schema:
    type: string
X-Rate-Limit-Limit:
  description: The number of allowed requests in the current period
  schema:
    type: integer
X-Rate-Limit-Remaining:
  description: The number of remaining requests in the current period
  schema:
    type: integer
X-Rate-Limit-Reset:
  description: Timestamp of end of current time period as UNIX timestamp, see [Rate Limiting](#overview--rate-limiting)
  schema:
    type: integer
Pagination:
  description: Pagination details for navigating through a collection of resources, provided in JSON format.
  schema:
    type: object
    properties:
      total_count:
        description: Total count of items in the collection.
        type: integer
        example: 10
      total_pages_count:
        description: Total number of pages available for the collection.
        type: integer
        example: 2
      current_page:
        description: The current page number.
        type: integer
        example: 1
      current_per_page:
        description: Number of items currently displayed per page.
        type: integer
        example: 5
      previous_page:
        description: Page number of the previous page, if available.
        type: integer
      next_page:
        description: Page number of the next page, if available.
        type: integer
        example: 2