Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gateway: document Retry-After header #435

Merged
merged 1 commit into from
Sep 4, 2023
Merged

gateway: document Retry-After header #435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions src/http-gateways/path-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,9 @@ sent by the client.

### `429` Too Many Requests

A
[`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After)
header might be included to this response, indicating how long to wait before
making a new request.
Error to indicate the client has sent too many requests in a given amount of time.

This error response SHOULD include [`Retry-After`](#retry-after-response-header) HTTP header to indicate how long the client should wait before making a follow-up request.

### `451` Unavailable For Legal Reasons

Expand All @@ -308,9 +307,21 @@ See: [Denylists](#denylists)

A generic server error returned when it is not possible to return a better one.

### `502` Bad Gateway

Returned immediately when Gateway was not able to produce response for a known reason.
For example, when gateway failed to find any providers for requested data.

This error response SHOULD include [`Retry-After`](#retry-after-response-header) HTTP header to indicate how long the client should wait before retrying.

### `504` Gateway Timeout

Returned when Gateway was not able to produce response under set limits.
Returned when Gateway was not able to produce response under set time limits.
For example, when gateway failed to retrieve data from a remote provider.

There is no generic timeout, Gateway implementations SHOULD set timeouts based on specific use cases.

This error response SHOULD include [`Retry-After`](#retry-after-response-header) HTTP header to indicate how long the client should wait before retrying.

## Response Headers

Expand Down Expand Up @@ -551,6 +562,14 @@ Optional, present in certain response types:
non-executable binary response types are not used in `<script>` and `<style>`
HTML tags.

### `Retry-After` (response header)

Gateway returns this header with error responses such as [`429 Too Many Requests`](#429-too-many-requests) or [`504 Gateway Timeout`](#504-gateway-timeout).

The "Retry-After" header indicates how long the user agent ought to wait before making a follow-up request.

See Section 10.2.3 of :cite[rfc9110].

### `Server-Timing` (response header)

Optional. Implementations MAY use this header to communicate one or more
Expand Down