summaryrefslogtreecommitdiff
path: root/en/responses.md
diff options
context:
space:
mode:
Diffstat (limited to 'en/responses.md')
-rw-r--r--en/responses.md73
1 files changed, 0 insertions, 73 deletions
diff --git a/en/responses.md b/en/responses.md
deleted file mode 100644
index d690dd0..0000000
--- a/en/responses.md
+++ /dev/null
@@ -1,73 +0,0 @@
-# Receiving Responses
-
-## Payload
-
-All Server responses contain a root JSON object.
-
-```jsonjson
-{
- "data": {
- "type": "match",
- "id": "skarn",
- "attributes": {
- // ... this matches attributes
- },
- "relationships": {
- // ... this matches relationships
- }
- }
-}
-```
-
-```json
-{
- "data": {
- "type": "match",
- "id": "1"
- }
-}
-```
-
-A response will contain at least one of the following top-level members:
-
- * `data`: the response's “primary data”
- * `errors`: an array of error objects
-
-A response may contain any of these top-level members:
-
- * `links`: a links object related to the primary data.
- * `included`: an array of resource objects that are related to the primary data and/or each other (“included resources”).
-
-If a document does not contain a top-level data key, the included member will not be present either.
-
-Primary data will be either:
-
- * a single [resource object][resource objects], a single [resource identifier object], or `null`
- * an array of [resource objects], an array of [resource identifier objects][resource identifier object], or
- an empty array (`[]`)
-
-For example, the following primary data is a single resource object:
-
-
-The following primary data is a single [resource identifier object] that
-references the same resource:
-
-
-A logical collection of resources will always be represented as an array, even if
-it only contains one item or is empty.
-
-## Rate Limits
->The rate limit headers are defined as follows:
-
-```
-X-RateLimit-Limit - Request limit per day / per minute
-X-RateLimit-Remaining - The number of requests left for the time window
-X-RateLimit-Reset - The remaining window before the rate limit is refilled in UTC epoch nanoseconds.
-* Limit tokens are incrementally filled by 60(sec)/ rate limit. ex: 60(sec)/10(rate) gets rate token every 6 seconds up to max rate limit.
-```
-Be nice. If you're sending too many requests too quickly, we'll send back a
-`429` error code (server unavailable).
-
-<aside class="notice">
-Free for non-commercial use for up to 10 requests per minute! To increase your rate limit, please contact api@superevilmegacorp.com
-</aside>