Commit c1e5be5
authored
docs: add supported headers reference documentation (#1488)
s## Add comprehensive HTTP headers documentation
This PR adds a new documentation page that provides a complete reference of all HTTP headers supported by Bifrost gateway. The documentation includes context keys, types, descriptions, and usage examples for each header.
## Changes
- Added new documentation page `docs/providers/supported-headers.mdx` with comprehensive header reference
- Updated navigation in `docs/docs.json` to include the new page
- Enhanced existing documentation in provider configuration and context keys pages to reference the new headers documentation
- Added documentation for the passthrough extra parameters feature (`x-bf-passthrough-extra-params` header)
## Type of change
- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI
## Affected areas
- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (Next.js)
- [x] Docs
## How to test
The documentation can be tested by running the docs site locally:
```sh
cd docs
npm install
npm run dev
```
Then navigate to the new page at `/providers/supported-headers` to verify the content.
## Breaking changes
- [x] No
## Related issues
Addresses the need for comprehensive header documentation to help users understand all available request configuration options.
## Checklist
- [x] I read `docs/contributing/README.md` and followed the guidelines
- [x] I updated documentation where needed
- [x] I verified builds succeed (Go and UI)File tree
5 files changed
+919
-1
lines changed- core/schemas
- docs
- providers
- quickstart
- gateway
- go-sdk
5 files changed
+919
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
24 | 31 | | |
25 | 32 | | |
26 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | | - | |
| 117 | + | |
| 118 | + | |
118 | 119 | | |
119 | 120 | | |
120 | 121 | | |
| |||
492 | 493 | | |
493 | 494 | | |
494 | 495 | | |
| 496 | + | |
| 497 | + | |
| 498 | + | |
| 499 | + | |
495 | 500 | | |
496 | 501 | | |
497 | 502 | | |
| |||
0 commit comments