Project

General

Profile

Bug #44611

Feature #40907: mgr/dashboard: REST API improvements

mgr/dashboard: REST API Docs state that the API is un-official and non-stable

Added by Ernesto Puerta over 2 years ago. Updated over 1 year ago.

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

0%

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

Description

Despite one the goals for Octopus was to declare Dashboard REST API as: the official & stable Ceph Management REST API, the Docs page still states:

"Please note that this API is not an official Ceph REST API to be used by third-party applications. It's primary purpose is to serve the requirements of the Ceph Dashboard and is subject to change at any time. Use at your own risk."

stable_rest_api.png View (26.3 KB) Ernesto Puerta, 03/13/2020 07:26 PM


Related issues

Related to Dashboard - Tasks #47066: mgr/restful: Deprecate the "restful" module in favor of the Ceph Dashboard REST API In Progress

History

#1 Updated by Ernesto Puerta over 2 years ago

  • Parent task set to #40907

#2 Updated by Patrick Seidensal over 2 years ago

Maybe something like that?

Ceph Dashboard is on the way to become the official REST API. Currently, we cannot guarantee that the API will not change, but we're working on a guarantee, that he API will, wihtin once Ceph release cycle, not introduce any breaking changes. This will be the next step towards becoming the official REST API. That said, currently Ceph Dashboard has the most comprehensive API to manage a Ceph Cluster.

#3 Updated by Ernesto Puerta over 2 years ago

Aligned with the stability issue, another approaches could be to:
  • add "stable" or "unstable" tags: to identify which subsets of the API are stable, or even better, which ones are considered subject to changed
  • add "last-changed-in" tag: to indicate from which Ceph release every API call remains unchanged (this could help us fight the fear to commit maintaining something that we think is mostly unstable while it could be the opposite).

#4 Updated by Lenz Grimmer about 2 years ago

  • Related to Tasks #47066: mgr/restful: Deprecate the "restful" module in favor of the Ceph Dashboard REST API added

#5 Updated by Ernesto Puerta over 1 year ago

  • Tags set to low-hanging-fruit

#6 Updated by Ernesto Puerta over 1 year ago

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

Also available in: Atom PDF