Skip to content

Commit 11cc24e

Browse files
Clarify README path and header validation constraints
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent 9c3ef46 commit 11cc24e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@ If `HYPERBROWSER_BASE_URL` is set, it must be non-empty.
3838
When `config` is not provided, client constructors also read `HYPERBROWSER_HEADERS`
3939
automatically (same as API key and base URL).
4040
Internal request paths are validated as relative API paths and reject fragments,
41-
unsafe traversal segments, backslashes, and whitespace/control characters.
41+
unsafe traversal segments, encoded query/fragment delimiters, backslashes, and
42+
whitespace/control characters.
4243

4344
You can also pass custom headers (for tracing/correlation) either via
4445
`ClientConfig` or directly to the client constructor.
45-
Header keys/values must be strings; header names are trimmed and control characters are rejected.
46+
Header keys/values must be strings; header names are trimmed, must use valid HTTP
47+
token characters, and control characters are rejected.
4648
Duplicate header names are rejected after normalization (case-insensitive), e.g.
4749
`"X-Trace"` with `" X-Trace "` or `"x-trace"`.
4850

0 commit comments

Comments
 (0)