Skip to content

Commit 8b38f7c

Browse files
committed
Added example problem type
1 parent dc105a1 commit 8b38f7c

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

draft-ietf-httpapi-ratelimit-headers.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ entity:
4444
normative:
4545
IANA: RFC8126
4646
HTTP: RFC9110
47-
47+
PROBLEM: RFC9457
48+
4849
informative:
4950
PRIVACY: RFC6973
5051
UNIX:
@@ -105,6 +106,8 @@ The term Origin is to be interpreted as described in Section 7 of{{!WEB-ORIGIN=R
105106

106107
This document uses the terms List, Item and Integer from {{Section 3 of !STRUCTURED-FIELDS=RFC8941}} to specify syntax and parsing, along with the concept of "bare item".
107108

109+
The term "problem type" in this document is to be interpreted as described in [PROBLEM].
110+
108111
# Terminology
109112

110113
Quota:
@@ -294,7 +297,7 @@ This example shows a 300MB remaining quota for an application in the next 60 sec
294297
RateLimit: "default";r=300000000;t=60;pk=:QXBwLTk5OQ==:
295298
~~~
296299

297-
# Problem Types (#problem-types)
300+
# Problem Types {#problem-types}
298301

299302
## Quota Exceeded
300303

@@ -835,15 +838,16 @@ Response:
835838

836839
~~~ http-message
837840
HTTP/1.1 429 Too Many Requests
838-
Content-Type: application/json
841+
Content-Type: application/problem+json
839842
Date: Mon, 05 Aug 2019 09:27:00 GMT
840843
Retry-After: Mon, 05 Aug 2019 09:27:05 GMT
841844
RateLimit: "default";r=0;t=5
842845

843846
{
847+
"type": "https://iana.org/assignments/http-problem-types#quota-exceeded"
844848
"title": "Too Many Requests",
845849
"status": 429,
846-
"detail": "You have exceeded your quota"
850+
"policy-violations": ["default"]
847851
}
848852
~~~
849853

@@ -1248,6 +1252,12 @@ and Julian Reschke.
12481252
# Changes
12491253
{:numbered="false" removeinrfc="true"}
12501254

1255+
## Since draft-ietf-httpapi-ratelimit-headers-08
1256+
{:numbered="false" removeinrfc="true"}
1257+
1258+
* Added Problem Types
1259+
* Clarified when to use RateLimit-Policy vs RateLimit fields
1260+
12511261
## Since draft-ietf-httpapi-ratelimit-headers-07
12521262
{:numbered="false" removeinrfc="true"}
12531263

0 commit comments

Comments
 (0)