Bug #40027
Feature #40907: mgr/dashboard: REST API improvements
mgr/dashboard: REST API: OpenAPI docs require internet connection
0%
Description
When running dashboard without internet connection in the client, and tried to access back-end API docs (Help -> API, https://dashboard.example.com/docs), the request triggers a failure (it tries to download several assets from https://unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.*).
In fenced environments, even dashboard consumers might not have direct internet connection.
Related issues
History
#1 Updated by Lenz Grimmer 10 months ago
- Backport set to nautilus
- Affected Versions v14.0.0, v14.2.0, v14.2.1, v15.0.0 added
Ernesto Puerta wrote:
When running dashboard without internet connection in the client, and tried to access back-end API docs (Help -> API, https://dashboard.example.com/docs), the request triggers a failure (it tries to download several assets from
https://unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.*).In fenced environments, even dashboard consumers might not have direct internet connection.
I've noticed that too - would it be possible to bundle these assets with the distribution?
#2 Updated by Lenz Grimmer 10 months ago
Looks like there are ways to bundle the swagger UI to remove that dependency: https://github.com/swagger-api/swagger-ui
#3 Updated by Lenz Grimmer 10 months ago
- Tags set to low-hanging-fruit
#4 Updated by Lenz Grimmer 10 months ago
Another thought: it's actually the user's browser that fetches these assets. So even if the Ceph Dashboard backend is located in a fenced environment, the user should be able to see the API documentation. Regardless, it would be preferred if all assets required are part of the package.
#5 Updated by Lenz Grimmer 9 months ago
- Target version set to v15.0.0
#6 Updated by Lenz Grimmer 9 months ago
- Related to Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstrings added
#7 Updated by Ernesto Puerta 8 months ago
- Subject changed from mgr/dashboard: OpenAPI docs require internet connection to mgr/dashboard: REST API: OpenAPI docs require internet connection
- Parent task set to #40907
#8 Updated by Ernesto Puerta 8 months ago
- Category changed from dashboard/general to dashboard/backend
#9 Updated by Stephan Müller 8 months ago
- Status changed from New to In Progress
- Assignee set to Stephan Müller
#10 Updated by Stephan Müller 8 months ago
- Status changed from In Progress to New
- Assignee deleted (
Stephan Müller)
#11 Updated by Patrick Seidensal 7 months ago
- Assignee set to Patrick Seidensal
#12 Updated by Patrick Seidensal 7 months ago
- Status changed from New to In Progress
#13 Updated by Patrick Seidensal 6 months ago
- Status changed from In Progress to Fix Under Review
- Pull request ID set to 30477
#14 Updated by Lenz Grimmer 6 months ago
- Status changed from Fix Under Review to Pending Backport
#15 Updated by Nathan Cutler 6 months ago
- Copied to Backport #42164: nautilus: mgr/dashboard: REST API: OpenAPI docs require internet connection added
#16 Updated by Nathan Cutler about 9 hours ago
- Status changed from Pending Backport to Resolved
While running with --resolve-parent, the script "backport-create-issue" noticed that all backports of this issue are in status "Resolved" or "Rejected".