Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Jump to bottom

feature: Ensure Swagger/Redoc docs is accessible offline #4063

Closed
bilalabbad opened this issue Aug 12, 2024 · 1 comment
Closed

feature: Ensure Swagger/Redoc docs is accessible offline #4063

bilalabbad opened this issue Aug 12, 2024 · 1 comment
Assignees
@ogenstad
Labels
group/backend Issue related to the backend (API Server, Git Agent) type/feature New feature or request
Milestone
Infrahub - 0.15.3

Comments

@bilalabbad
Copy link
Contributor

bilalabbad commented Aug 12, 2024 •
edited
Loading

Component

API Server / GraphQL

Describe the Feature Request

Make Swagger accessible from an environment that is blocking every external request / is offline:

Describe the Use Case

Swagger docs accessible at /api/docs download source code from CDN. Thus if you have a restricted environment or are working offline, you cannot access it.

https://fastapi.tiangolo.com/img/favicon.png
https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js
https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css

Additional Information

Related doc: https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/#self-hosting-javascript-and-css-for-docs
@bilalabbad bilalabbad added type/feature New feature or request group/backend Issue related to the backend (API Server, Git Agent) labels Aug 12, 2024
@bilalabbad bilalabbad changed the title feature: Ensure Swagger docs is accessible offline feature: Ensure Swagger/Redoc docs is accessible offline Aug 12, 2024
@ogenstad ogenstad self-assigned this Aug 12, 2024
@ogenstad ogenstad added this to the Infrahub - 0.15.3 milestone Aug 12, 2024
ogenstad added a commit that referenced this issue Aug 12, 2024
@ogenstad
Serve Swagger & Redoc files locally so that the REST-API docs work of…
25e3492 
…fline or when isolated from the internet

Fixes #4063
@ogenstad ogenstad mentioned this issue Aug 12, 2024
Merged
ogenstad added a commit that referenced this issue Aug 12, 2024
@ogenstad
Serve Swagger & Redoc files locally so that the REST-API docs work of…
e5d46e0 
…fline or when isolated from the internet

Fixes #4063
@ogenstad
Copy link
Contributor

Fixed in #4065.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ogenstad ogenstad

Labels
group/backend Issue related to the backend (API Server, Git Agent) type/feature New feature or request
Projects
None yet
Milestone
Infrahub - 0.15.3
Development

No branches or pull requests
2 participants
@ogenstad @bilalabbad