strings-openapi/responses.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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
200:
  description: OK
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
201:
  description: The resource has been created
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
202:
  description: Accepted
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
204:
  description: The resource was deleted successfully.
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
400:
  description: >-
    Bad request. The request could not be parsed or a parameter failed
    validation. Verify the request body, the content type, and the parameter
    types, then retry.
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
401:
  description: >-
    Unauthorized. Authentication failed because the access token is missing,
    expired, or invalid. Supply a valid access token and retry.
403:
  description: >-
    Forbidden. The credentials are valid but not permitted for this request:
    the access token may lack the required scope, the user may lack permission
    on the resource, or the account plan may not include the feature. Use a
    token with the required scope on an account and user that hold the
    necessary permissions.
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
404:
  description: >-
    Not found. The requested resource does not exist or is not visible to the
    authenticated user. Verify the identifiers in the request path and that the
    token has access to them, then retry.
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
409:
  description: >-
    Conflict. The request conflicts with the current state of the resource.
    Reconcile the conflicting state and retry.
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
422:
  description: >-
    Unprocessable entity. The request was well-formed but failed validation.
    The response body lists each offending field in the `errors` array, with
    its resource, field, and a human-readable message. Correct the listed
    fields and retry.
  content:
    application/json:
      schema:
        $ref: "./schemas/errors.yaml#/errors"
  headers:
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
429:
  description: >-
    Too many requests. The rate limit has been exceeded. Wait until the time
    indicated by the `X-Rate-Limit-Reset` response header before retrying.
  headers:
    X-Rate-Limit-Reason:
      $ref: "./headers.yaml#/X-Rate-Limit-Reason"
    X-Rate-Limit-Limit:
      $ref: "./headers.yaml#/X-Rate-Limit-Limit"
    X-Rate-Limit-Remaining:
      $ref: "./headers.yaml#/X-Rate-Limit-Remaining"
    X-Rate-Limit-Reset:
      $ref: "./headers.yaml#/X-Rate-Limit-Reset"
503:
  description: Server error
504:
  description: Gateway timeout