Skip to content

Commit e5d72ec

Browse files
committed
Expand sunset header explanation, fix formating missing `.
1 parent ea340ba commit e5d72ec

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/rest.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ first second and then get one call back every second. With
8484
``api_calls_per_interval = 60`` and ``api_interval_in_sec = 3600`` (1
8585
hour) they can use all 60 calls in the first second and they get one
8686
additional call every 10 seconds. ``api_calls_per_interval`` is the
87-
burst rate that you are willing to allow within `api_interval_in_sec``
87+
burst rate that you are willing to allow within ``api_interval_in_sec``
8888
seconds. The average rate of use is the ratio of
8989
``api_calls_per_interval/api_interval_in_sec``. So you can have many
9090
values that permit one call per second on average: 1/1, 60/60,
@@ -134,7 +134,9 @@ Also if the user has exceeded the rate limit, this header is added:
134134

135135
If the client has requested a deprecated API endpoint, the header:
136136

137-
**Sunset**: an http date after which the end point will not be available.
137+
**Sunset**: an http date after which the end point will not be
138+
available. This is not returned by current code, but can be used
139+
when `Programming the REST API`_.
138140

139141
will be returned. It should be used as a hint that the REST endpoint
140142
will be going away. See https://tools.ietf.org/html/rfc8594 for

0 commit comments

Comments
 (0)