feat(docs): enable Swagger UI path filter + request-duration display#283
Merged
Conversation
The /docs Swagger UI was mounted with just \`persistAuthorization\`.
Two small swagger-ui-express options that pull their weight on a
~50-path, 16-entity spec:
- \`filter: true\` — adds a free-text path filter at the top of
the UI. Searching "invoice" / "bulk" / "company" jumps straight
to the relevant block without scrolling. Real navigation aid
for operators browsing the docs.
- \`displayRequestDuration: true\` — shows the round-trip
duration on every "Try it out" response. Cheap latency
eyeball check during exploration; matches the data shape
already exposed at /metrics.
Both are swagger-ui-side; no server change, no test impact.
760 tests still pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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
Two small swagger-ui-express options that pull their weight on a ~50-path, 16-entity spec.
filter: true— adds a free-text path filter at the top of the UI. Searching "invoice" / "bulk" / "company" jumps straight to the relevant block without scrolling. Real navigation aid for operators browsing the docs.displayRequestDuration: true— shows the round-trip duration on every "Try it out" response. Cheap latency eyeball check during exploration; matches the data shape already exposed at/metrics.Both are swagger-ui-side; no server change, no test impact. The existing
persistAuthorization: true(keep authKey across reloads) stays.Test plan
npm run lint && npm test— 760 passing.tests/api/openapi.test.jsSwagger UI mount assertion (expect(res.text).toContain('Swagger')) still passes.Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/