strings-openapi/headers.yaml at main · phrase/strings-openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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-Reason:
  description: >-
    Indicates why the request was rate limited. Present only on 429
    responses. `global-rate` means the per-user request-rate quota was
    exceeded; `global-concurrency` means the concurrent-request limit was
    exceeded.
  schema:
    type: string
    enum:
      - global-rate
      - global-concurrency
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](/en/api/strings/pagination#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