happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📌 Pin Swagger UI version to 5.9.0 temporarily to handle a bug crashing it in 5.9.1 (#10529) 

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Alejandra Klachquin 2023-10-30 06:58:58 -03:00 committed by GitHub
parent e4b21c6eab
commit 758a8f29e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/docs/how-to/custom-docs-ui-assets.md
View File

@ -96,8 +96,8 @@ You can probably right-click each link and select an option similar to `Save lin
**Swagger UI** uses the files: **Swagger UI** uses the files:
* <a href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js" class="external-link" target="_blank">`swagger-ui-bundle.js`</a> * <a href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui-bundle.js" class="external-link" target="_blank">`swagger-ui-bundle.js`</a>
* <a href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css" class="external-link" target="_blank">`swagger-ui.css`</a> * <a href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css" class="external-link" target="_blank">`swagger-ui.css`</a>
And **ReDoc** uses the file: And **ReDoc** uses the file:

4
docs_src/custom_docs_ui/tutorial001.py
View File

@ -14,8 +14,8 @@ async def custom_swagger_ui_html():
openapi_url=app.openapi_url, openapi_url=app.openapi_url,
title=app.title + " - Swagger UI", title=app.title + " - Swagger UI",
oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url, oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
swagger_js_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js", swagger_js_url="https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui-bundle.js",
swagger_css_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css", swagger_css_url="https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui.css",
) )

4
fastapi/openapi/docs.py
View File

@ -53,7 +53,7 @@ def get_swagger_ui_html(
It is normally set to a CDN URL. It is normally set to a CDN URL.
""" """
), ),
] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js", ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui-bundle.js",
swagger_css_url: Annotated[ swagger_css_url: Annotated[
str, str,
Doc( Doc(
@ -63,7 +63,7 @@ def get_swagger_ui_html(
It is normally set to a CDN URL. It is normally set to a CDN URL.
""" """
), ),
] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css", ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css",
swagger_favicon_url: Annotated[ swagger_favicon_url: Annotated[
str, str,
Doc( Doc(

6
tests/test_tutorial/test_custom_docs_ui/test_tutorial001.py
View File

@ -20,8 +20,10 @@ def client():
def test_swagger_ui_html(client: TestClient): def test_swagger_ui_html(client: TestClient):
response = client.get("/docs") response = client.get("/docs")
assert response.status_code == 200, response.text assert response.status_code == 200, response.text
assert "https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js" in response.text assert (
assert "https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" in response.text "https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui-bundle.js" in response.text
)
assert "https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui.css" in response.text
def test_swagger_ui_oauth2_redirect_html(client: TestClient): def test_swagger_ui_oauth2_redirect_html(client: TestClient):