docs: show SwaggerUI persistAuthorization in DocsRendererConfig example - #1122
Merged
wolveix merged 1 commit intoSep 27, 2026
Merged
Conversation
## Summary
Adds swagger UI's `persistAuthorization` option to keep credentials
across page reloads. Huma already supports it via the
`DocsRenderConfig`. It just wasn't documented so it was easy to miss
- **Docs:** add `"persistAuthorization": true` to the SwaggerUI
`DocsRendererConfig` example in `docs/docs/features/api-docs.md`.
- **Test:** extend `TestDocsRenderers/SwaggerUIRendererConfig` to check
that the option is serialized into the docs page's `data-config`
attribute.
## Usage
```go
config.DocsRenderer = huma.DocsRendererSwaggerUI
config.DocsRendererConfig = map[string]any{
"persistAuthorization": true,
}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1122 +/- ##
=======================================
Coverage 93.19% 93.19%
=======================================
Files 24 24
Lines 5008 5008
=======================================
Hits 4667 4667
Misses 273 273
Partials 68 68 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds swagger UI's
persistAuthorizationoption to keep credentials across page reloads. Huma already supports it via theDocsRenderConfig. It just wasn't documented so it was easy to miss"persistAuthorization": trueto the SwaggerUIDocsRendererConfigexample indocs/docs/features/api-docs.md.TestDocsRenderers/SwaggerUIRendererConfigto check that the option is serialized into the docs page'sdata-configattribute.Usage