Skip to content

Commit 00399e9

Browse files
committed
📝 doc about the default headers
Signed-off-by: moznion <moznion@mail.moznion.net>
1 parent 931065b commit 00399e9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,13 @@ If your default headers already include **all** required headers for the endpoin
225225
client.getUsersBulkJobid({path: {jobId: "123"}});
226226
```
227227
228+
NOTE:
229+
230+
In this context, the "default HTTP headers" are different from the headers in `ClientOptions`.
231+
The headers in `ClientOptions` are always sent implicitly, regardless of the header parameters specified in endpoint methods.
232+
In contrast, the "default HTTP headers" mechanism is intended to reduce the need to repeatedly specify common header parameters
233+
in each endpoint method when their values are already known.
234+
228235
## Articles
229236
230237
- [openapi-fetch-gen – Generate TypeScript API client from OpenAPI TypeScript interface definitions created by openapi-typescript - DEV Community](https://dev.to/moznion/openapi-fetch-gen-generate-typescript-api-client-from-openapi-typescript-interface-definitions-kjd)

0 commit comments

Comments
 (0)