Skip to content

Commit 218141d

Browse files
authored
Merge pull request #148 from Acconut/patch-4
Update SF reference to RFC 9651
2 parents 31e5fae + 25fb37f commit 218141d

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

draft-ietf-httpapi-ratelimit-headers.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The following features are out of the scope of this document:
104104

105105
The term Origin is to be interpreted as described in Section 7 of{{!WEB-ORIGIN=RFC6454}}.
106106

107-
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".
107+
This document uses the terms List, Item and Integer from {{Section 3 of !STRUCTURED-FIELDS=RFC9651}} to specify syntax and parsing, along with the concept of "bare item".
108108

109109
The term "problem type" in this document is to be interpreted as described in [PROBLEM].
110110

@@ -129,25 +129,25 @@ The term "problem type" in this document is to be interpreted as described in [P
129129
: A service limit is the currently remaining quota from a specific quota policy and, if defined, the remaining time before quota is reallocated.
130130

131131
List:
132-
: A {{!STRUCTURED-FIELDS=RFC8941}} list of Items
132+
: A {{!STRUCTURED-FIELDS=RFC9651}} list of Items
133133

134134
Item:
135-
: A {{!STRUCTURED-FIELDS=RFC8941}} item with a set of associated parameters
135+
: A {{!STRUCTURED-FIELDS=RFC9651}} item with a set of associated parameters
136136

137137
# RateLimit-Policy Field {#ratelimit-policy-field}
138138

139-
The "RateLimit-Policy" response header field is a non-empty List{{!RFC8941}} of Quota Policy Items ({{quotapolicy-item}}). The Item{{!RFC8941}} value MUST be a String{{!RFC8941}}.
139+
The "RateLimit-Policy" response header field is a non-empty List{{!RFC9651}} of Quota Policy Items ({{quotapolicy-item}}). The Item{{!RFC9651}} value MUST be a String{{!RFC9651}}.
140140

141141
The field value SHOULD remain consistent over a sequence of HTTP responses. It is this characteristic that differentiates it from the [RateLimit](#ratelimit-field) field that contains information that MAY change on every request. The "RateLimit-Policy" field enables clients to control their own flow of requests based on policy information provided by the server. Situations where throttling constraints are highly dynamic are better served using the (RateLimit field)[{#ratelimit-field}] that communicates the latest service information a client can react to. Both fields can be communicated by the server when appropriate.
142142

143-
Lists of Quota Policy Items ({{quotapolicy-item}}) can be split over multiple "RateLimit-Policy" fields in the same HTTP response as described in {{Section 3.1 of !STRUCTURED-FIELDS=RFC8941}}.
143+
Lists of Quota Policy Items ({{quotapolicy-item}}) can be split over multiple "RateLimit-Policy" fields in the same HTTP response as described in {{Section 3.1 of !STRUCTURED-FIELDS=RFC9651}}.
144144

145145
~~~
146146
RateLimit-Policy: "burst";q=100;w=60,"daily";q=1000;w=86400
147147
~~~
148148

149149
## Quota Policy Item {#quotapolicy-item}
150-
A quota policy Item contains an identifier for the policy and a set of Parameters{{!RFC8941}} that contain information about a server's capacity allocation for the policy.
150+
A quota policy Item contains an identifier for the policy and a set of Parameters{{!RFC9651}} that contain information about a server's capacity allocation for the policy.
151151

152152
The following parameters are defined:
153153

@@ -224,17 +224,17 @@ The following example shows a policy with a partition key and a quota unit:
224224

225225
A server uses the "RateLimit" response header field to communicate the current service limit for a quota policy for a particular partition key.
226226

227-
The field is expressed as a List{{!RFC8941}} of Service Limit Items ({{servicelimit-item}}).
227+
The field is expressed as a List{{!RFC9651}} of Service Limit Items ({{servicelimit-item}}).
228228

229-
Lists of Service Limit Items can be split over multiple "RateLimit" fields in the same HTTP response as described in {{Section 3.1 of !STRUCTURED-FIELDS=RFC8941}}.
229+
Lists of Service Limit Items can be split over multiple "RateLimit" fields in the same HTTP response as described in {{Section 3.1 of !STRUCTURED-FIELDS=RFC9651}}.
230230

231231
~~~
232232
RateLimit: "default";r=50;t=30
233233
~~~
234234

235235
## Service Limit Item {#servicelimit-item}
236236

237-
Each service limit Item{{!RFC8941}} identifies the quota policy ({{quotapolicy-item}}) associated with the request and contains Parameters{{!RFC8941}} with information about the current service limit.
237+
Each service limit Item{{!RFC9651}} identifies the quota policy ({{quotapolicy-item}}) associated with the request and contains Parameters{{!RFC9651}} with information about the current service limit.
238238

239239
The following parameters are defined in this specification:
240240

@@ -560,12 +560,12 @@ IANA is requested to update two registries and create one new registry.
560560
Please add the following entries to the
561561
"Hypertext Transfer Protocol (HTTP) Field Name Registry" registry ({{HTTP}}):
562562

563-
|---------------------|-----------|---------------|
564-
| Field Name | Status | Specification |
565-
|---------------------|-----------|---------------|
566-
| RateLimit | permanent | {{ratelimit-field}} of {{&SELF}} |
567-
| RateLimit-Policy | permanent | {{ratelimit-policy-field}} of {{&SELF}} |
568-
|---------------------|-----------|---------------|
563+
|---------------------|-----------------|-----------|---------------|
564+
| Field Name | Structured Type | Status | Specification |
565+
|---------------------|-----------------|-----------|---------------|
566+
| RateLimit | List | permanent | {{ratelimit-field}} of {{&SELF}} |
567+
| RateLimit-Policy | List | permanent | {{ratelimit-policy-field}} of {{&SELF}} |
568+
|---------------------|-----------------|-----------|---------------|
569569

570570

571571
## Update HTTP Problem Type registry

0 commit comments

Comments
 (0)