Project

General

Profile

Actions
Copy link

Feature #23898

closed

Improve dashboard REST API documentation

Added by Ricardo Marques almost 6 years ago. Updated about 3 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Ricardo Dias
Category:
General
Target version:
-
% Done:

0%

Source:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Currently we already have a browsable API implementation, useful for development propose.

You can try it by accessing:

  http://<CEPH_DASHBOARD_HOST>:<CEPH_DASHBOARD_PORT>/api/block/image

But the current implementation requires the interception of all HTTP request, even on production environment.

An alternative approach would be to collect all the information during module load time, avoiding the interception of all HTTP requests, and use some external tool to document the API.

We should consider using a tool like https://swagger.io/ that uses a specification file to generaet the documentation:

  https://editor.swagger.io//?_ga=2.88673627.1361634586.1524820439-533980631.1524820439#/
Actions
Copy link
 #1

Updated by Patrick Seidensal almost 6 years ago

  • Description updated (diff)
Actions
Copy link
 #2

Updated by Ricardo Dias almost 6 years ago

  • Status changed from New to In Progress
  • Assignee set to Ricardo Dias
Actions
Copy link
 #3

Updated by Ricardo Marques almost 6 years ago

  • Status changed from In Progress to Fix Under Review
Actions
Copy link
 #4

Updated by Lenz Grimmer almost 6 years ago

  • Status changed from Fix Under Review to Resolved
Actions
Copy link
 #5

Updated by Ernesto Puerta about 3 years ago

  • Project changed from mgr to Dashboard
  • Category changed from 132 to General
Actions
Copy link

Also available in: Atom PDF