Project

General

Profile

Feature #23898

Improve dashboard REST API documentation

Added by Ricardo Marques almost 2 years ago. Updated over 1 year ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
dashboard/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#/

History

#1 Updated by Patrick Seidensal almost 2 years ago

  • Description updated (diff)

#2 Updated by Ricardo Dias almost 2 years ago

  • Status changed from New to In Progress
  • Assignee set to Ricardo Dias

#3 Updated by Ricardo Marques over 1 year ago

  • Status changed from In Progress to Fix Under Review

#4 Updated by Lenz Grimmer over 1 year ago

  • Status changed from Fix Under Review to Resolved

Also available in: Atom PDF