feat(openapi): first-class docs UI and OpenAPI enrichment - #131
Merged
Conversation
Ship Scalar/Swagger at /docs, OpenAPI {param} paths with parameters and
bearerAuth, tags/info/servers hooks, and sync __rsgi_init__(loop) via
on_startup so Granian actually runs worker startup. Closes #130.
7 tasks
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
App(..., docs_ui=...)/mount_docs()against/openapi.json:param→{param}+ path parameters, JWTbearerAuth, route/routertags,set_openapi_info/ servers__rsgi_init__(loop)runson_startupvialoop.run_until_complete(fixes never-awaited async override)Closes #130
Test plan
make test(or focused:pytest tests/test_openapi.py tests/test_rsgi_lifespan.py)App(docs_ui="scalar")→ browserGET /docsloads UI against/openapi.json{id}on_startupundergranian --interface rsgiactually runs (no “never awaited”)