Skip to content

doc: reinstate header_read_timeout documentation #8789

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

Merged
carodewig merged 3 commits into from
Jan 5, 2026
Merged

doc: reinstate header_read_timeout documentation #8789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9500dda
doc: put back missing header read timeout
carodewig Jan 5, 2026
f36b8f3
doc: backticks
carodewig Jan 5, 2026
75ccffa
Merge branch 'dev' into caroline/docs-server-read
carodewig Jan 5, 2026
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
7 changes: 7 additions & 0 deletions docs/shared/config/server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### `server`

```yaml title="server"
server:
http:
header_read_timeout: 30s
```
11 changes: 11 additions & 0 deletions docs/source/routing/configuration/yaml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import PreviewFileUploads from '../../../shared/config/preview_file_uploads.mdx';
import Rhai from '../../../shared/config/rhai.mdx';
import Sandbox from '../../../shared/config/sandbox.mdx';
import Server from '../../../shared/config/server.mdx';
import Subscription from '../../../shared/config/subscription.mdx';
import Supergraph from '../../../shared/config/supergraph.mdx';
import Telemetry from '../../../shared/config/telemetry.mdx';
Expand Down Expand Up @@ -309,6 +310,16 @@

---

<Server />

#### Header Read Timeout

Check warning on line 315 in docs/source/routing/configuration/yaml.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/configuration/yaml.mdx#L315 

Use sentence casing for headings.

```suggestion
#### Header read timeout
```

The header read timeout is the amount of time the Router will wait to receive the complete request headers from a client before timing out. It applies both when the connection is fully idle and when a request has been started but sending the headers has not been completed.

Check warning on line 317 in docs/source/routing/configuration/yaml.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/configuration/yaml.mdx#L317 

Use present tense ("waits" instead of "will wait") and active voice. Use lowercase "router" to refer to the instance.

```suggestion
The header read timeout is the duration the router waits to receive complete request headers from a client. This applies when the connection is idle and when a request starts but the client hasn't finished sending headers.
```

By default, the header read timeout is set to 10 seconds. A longer timeout can be configured using the `server.http.header_read_timeout` configuration option.

Check warning on line 319 in docs/source/routing/configuration/yaml.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/configuration/yaml.mdx#L319 

Use active voice ("Configure..." instead of "can be configured"). Use words for numbers zero through ten ("ten seconds").

```suggestion
The default header read timeout is ten seconds. Configure the timeout with the `server.http.header_read_timeout` option.
```

---

<Subscription />

Learn more in [Subscriptions](/graphos/routing/operations/subscriptions).
Expand Down