Bug #44611
open
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 about 4 years ago.
Updated about 3 years ago.
Category:
General - Back-end
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."
Files
Related issues
1 (1 open — 0 closed)
- Parent task set to #40907
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.
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).
- Related to Tasks #47066: mgr/restful: Deprecate the "restful" module in favor of the Ceph Dashboard REST API added
- Translation missing: en.field_tag_list set to low-hanging-fruit
- Project changed from mgr to Dashboard
- Category changed from 146 to General - Back-end
Also available in: Atom
PDF