Project

General

Profile

Bug #40027

Feature #40907: mgr/dashboard: REST API improvements

mgr/dashboard: REST API: OpenAPI docs require internet connection

Added by Ernesto Puerta 3 months ago. Updated 25 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
dashboard/backend
Target version:
Ceph - v15.0.0
Start date:
05/27/2019
Due date:
% Done:

0%

Source:
Tags:
Backport:
nautilus
Regression:
No
Severity:
3 - minor
Reviewed:
Affected Versions:
Ceph - v14.0.0, Ceph - v14.2.0, Ceph - v14.2.1, Ceph - v15.0.0
ceph-qa-suite:
Pull request ID:
Tags:
low-hanging-fruit

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

Related to mgr - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstrings Resolved 07/04/2018

History

#1 Updated by Lenz Grimmer 3 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 3 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 3 months ago

  • Tags set to low-hanging-fruit

#4 Updated by Lenz Grimmer 3 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 about 1 month ago

  • Target version set to v15.0.0

#6 Updated by Lenz Grimmer about 1 month ago

  • Related to Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstrings added

#7 Updated by Ernesto Puerta about 1 month 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 about 1 month ago

  • Category changed from dashboard/general to dashboard/backend

#9 Updated by Stephan Müller 25 days ago

  • Status changed from New to In Progress
  • Assignee set to Stephan Müller

#10 Updated by Stephan Müller 25 days ago

  • Status changed from In Progress to New
  • Assignee deleted (Stephan Müller)

Also available in: Atom PDF