We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Hi there,
From what I've tried (v2.9.0), ExternalDocumentation only works on redoc and swagger, among the few litestar examples given in OpenAPI UI Plugins.
v2.9.0
redoc
swagger
Would love to have it on Scalar as well (ScalarRenderPlugin), since I read that it's going to be the default plugin for v3.0.0.
Scalar
v3.0.0
Not sure if this is the correct place to ask, but thanks in advance.
FYI, this is the rough code that I used:
from litestar.app import Litestar from litestar.openapi import OpenAPIConfig from litestar.openapi.plugins ScalarRenderPlugin, from litestar.openapi.spec import ExternalDocumentation Litestar( openapi_config=OpenAPIConfig( title="title", version="version", external_docs=ExternalDocumentation( url=project_metadata["project"]["urls"]["Repository"], description="Repository", ), render_plugins=[ ScalarRenderPlugin(), ], path="/docs", ) )
None
Note
While we are open for sponsoring on GitHub Sponsors and OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.
Check out all issues funded or available for funding on our Polar.sh dashboard
The text was updated successfully, but these errors were encountered:
If this isnt working it may be a bug. I think Scalar supports ExternalDocumentation (https://github.com/search?q=repo%3Ascalar%2Fscalar%20ExternalDocumentation&type=code)
Sorry, something went wrong.
I've downloaded the spec.json and the externalDocs section does exist. It's just that this part is not rendering in the frontend.
spec.json
externalDocs
# within spec.json "externalDocs": { "url": "https://github.com/litestar-org/litestar", "description": "Repository" }
MCVE
app.py
from litestar.app import Litestar from litestar.openapi import OpenAPIConfig from litestar.openapi.plugins import ScalarRenderPlugin from litestar.openapi.spec import ExternalDocumentation app = Litestar( openapi_config=OpenAPIConfig( title="title", version="version", external_docs=ExternalDocumentation( url="https://docs.litestar.dev", description="Repository", ), render_plugins=[ ScalarRenderPlugin(), ], ) )
pip install litestar[standard]
litestar run --debug
open "https://127.0.0.1:8000/schema/"
No docs
No branches or pull requests
Summary
Hi there,
From what I've tried (
v2.9.0
), ExternalDocumentation only works onredoc
andswagger
, among the few litestar examples given in OpenAPI UI Plugins.Would love to have it on
Scalar
as well (ScalarRenderPlugin), since I read that it's going to be the default plugin forv3.0.0
.Not sure if this is the correct place to ask, but thanks in advance.
Basic Example
FYI, this is the rough code that I used:
Drawbacks and Impact
None
Unresolved questions
None
Note
While we are open for sponsoring on GitHub Sponsors and
OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.
Check out all issues funded or available for funding on our Polar.sh dashboard
The text was updated successfully, but these errors were encountered: