Project

General

Profile

Actions

Bug #40027

closed

Feature #40907: mgr/dashboard: REST API improvements

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

Added by Ernesto Puerta almost 5 years ago. Updated about 3 years ago.

Status:
Closed
Priority:
Normal
Category:
General - Back-end
Target version:
% Done:

0%

Source:
Tags:
Backport:
nautilus
Regression:
No
Severity:
3 - minor
Reviewed:
ceph-qa-suite:
Pull request ID:
Crash signature (v1):
Crash signature (v2):

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 2 (0 open2 closed)

Related to Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringsResolvedTina Kallio

Actions
Copied to Dashboard - Backport #42164: nautilus: mgr/dashboard: REST API: OpenAPI docs require internet connectionResolvedShyukri ShyukrievActions
Actions #1

Updated by Lenz Grimmer almost 5 years 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?

Actions #2

Updated by Lenz Grimmer almost 5 years ago

Looks like there are ways to bundle the swagger UI to remove that dependency: https://github.com/swagger-api/swagger-ui

Actions #3

Updated by Lenz Grimmer almost 5 years ago

  • Translation missing: en.field_tag_list set to low-hanging-fruit
Actions #4

Updated by Lenz Grimmer almost 5 years 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.

Actions #5

Updated by Lenz Grimmer almost 5 years ago

  • Target version set to v15.0.0
Actions #6

Updated by Lenz Grimmer almost 5 years ago

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

Updated by Ernesto Puerta over 4 years 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
Actions #8

Updated by Ernesto Puerta over 4 years ago

  • Category changed from 132 to 146
Actions #9

Updated by Stephan Müller over 4 years ago

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

Updated by Stephan Müller over 4 years ago

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

Updated by Patrick Seidensal over 4 years ago

  • Assignee set to Patrick Seidensal
Actions #12

Updated by Patrick Seidensal over 4 years ago

  • Status changed from New to In Progress
Actions #13

Updated by Patrick Seidensal over 4 years ago

  • Status changed from In Progress to Fix Under Review
  • Pull request ID set to 30477
Actions #14

Updated by Lenz Grimmer over 4 years ago

  • Status changed from Fix Under Review to Pending Backport
Actions #15

Updated by Nathan Cutler over 4 years ago

  • Copied to Backport #42164: nautilus: mgr/dashboard: REST API: OpenAPI docs require internet connection added
Actions #16

Updated by Nathan Cutler about 4 years 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".

Actions #17

Updated by Ernesto Puerta almost 4 years ago

  • Status changed from Resolved to Closed
Actions #18

Updated by Ernesto Puerta about 3 years ago

  • Project changed from mgr to Dashboard
  • Category changed from 146 to General - Back-end
Actions

Also available in: Atom PDF