You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ When a resource is created (with a `POST` request), the response must contain a
80
80
81
81
### Resource on update and create actions
82
82
83
-
When a resource is created or modified (e.g., with a POST, PUT or PATCH request), the response must contain the created or updated respresentation of the resource.
83
+
When a resource is created or modified (e.g., with a POST, PUT or PATCH request), the response must contain the created or updated representation of the resource.
84
84
85
85
## 5. Status codes
86
86
@@ -102,11 +102,11 @@ The server must respond with the following status codes, according to the situat
102
102
| 403 Forbidden | Authenticated user does not have access |
103
103
| 404 Not Found | Page or resource not found |
104
104
| 405 Method Not Allowed | The request HTTP method is not allowed for the authenticated user |
105
-
| 410 Gone | The endpoint is no longer available. Usefull for old API versions |
105
+
| 410 Gone | The endpoint is no longer available. Useful for old API versions |
106
106
| 415 Unsupported Media Type| POST/PUT/PATCH request occurred without a application/json content type |
107
107
| 422 Unprocessable Entry | A request to modify or create a resource failed due to a validation error |
108
108
| 429 Too Many Requests | Request rejected due to rate limiting |
109
-
| 500 Internal Server Error | An internal server error occured|
109
+
| 500 Internal Server Error | An internal server error occurred|
110
110
| 502 Bad Gateway | The server was acting as a gateway or proxy and received an invalid response from the upstream server |
111
111
| 503 Service Unavailable | The server is currently unable to handle the request. |
112
112
@@ -117,7 +117,7 @@ The server must respond with the following status codes, according to the situat
117
117
118
118
- This code must be human readable, and identical over the same kinds of errors.
119
119
120
-
- The body should also contain a `message` key, containing a more detailled description of the error.
120
+
- The body should also contain a `message` key, containing a more detailed description of the error.
121
121
122
122
```HTTP
123
123
GET /unicorns/4 HTTP/1.1
@@ -192,7 +192,7 @@ For example, for rate limiting, the `X-Rate-Limit-Limit`, `X-Rate-Limit-Remainin
192
192
193
193
## 9. Versioning
194
194
195
-
The API must be versioned, and must not have breaking changes whitout version change.
195
+
The API must be versioned, and must not have breaking changes without version change.
196
196
197
197
- The client must be able to set the requested version trough the `Accept` header. (e.g., `Accept: application/vnd.myapp.v2+json`).
When the job process is done, the request of the url in the `Content-Location` header should return a `303 See other` status code with the created resource link in `Location` header.
496
+
When the job process is done, requesting the link in the `Content-Location` header should return a `303 See other` status code with the created resource link in `Location` header.
0 commit comments