https://tracker.ceph.com/https://tracker.ceph.com/favicon.ico2018-07-04T12:00:49ZCeph Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1161912018-07-04T12:00:49ZLenz Grimmer
<ul><li><strong>Assignee</strong> deleted (<del><i>Lenz Grimmer</i></del>)</li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1247362018-11-19T08:23:40ZLenz Grimmer
<ul><li><strong>Assignee</strong> set to <i>Tina Kallio</i></li><li><strong>Target version</strong> set to <i>v14.0.0</i></li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1263822018-12-19T14:41:09ZTina Kallio
<ul></ul><p>There is no suitable off-the-shelf parser that can be used to accomplish this.</p>
<p>Another way to obtain information for the documentation directly from the code is to use annotations and decorators. This approach will be used instead.</p>
<p>However, function annotations can not be used since it is not compatible with Python2.</p>
<p>It is desirable but not mandatory that the solution includes responses.</p> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1285182019-01-31T14:43:08ZTina Kallio
<ul></ul><p><strong>WIP PR</strong>: <a class="external" href="https://github.com/ceph/ceph/pull/26227">https://github.com/ceph/ceph/pull/26227</a></p> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1285212019-01-31T15:00:08ZLenz Grimmer
<ul><li><strong>Pull request ID</strong> set to <i>26227</i></li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1285222019-01-31T15:00:18ZLenz Grimmer
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>Fix Under Review</i></li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1292802019-02-13T11:35:09ZLenz Grimmer
<ul><li><strong>Subject</strong> changed from <i>dashboard: Automatic generation of REST API documentation based on Python docstrings</i> to <i>mgr/dashboard: Automatic generation of REST API documentation based on Python docstrings</i></li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1305552019-03-04T11:53:18ZTina Kallio
<ul><li><strong>Status</strong> changed from <i>Fix Under Review</i> to <i>Resolved</i></li><li><strong>% Done</strong> changed from <i>0</i> to <i>100</i></li></ul><p>Fix with PR <a class="external" href="https://github.com/ceph/ceph/pull/26227">https://github.com/ceph/ceph/pull/26227</a></p> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1406502019-07-12T16:26:30ZLenz Grimmer
<ul><li><strong>Related to</strong> <i><a class="issue tracker-1 status-5 priority-4 priority-default closed child" href="/issues/40027">Bug #40027</a>: mgr/dashboard: REST API: OpenAPI docs require internet connection</i> added</li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1758272020-09-23T14:11:10ZAlfonso MartÃnezalmartin@redhat.com
<ul><li><strong>Parent task</strong> set to <i>#40907</i></li></ul> Dashboard - Feature #24763: mgr/dashboard: Automatic generation of REST API documentation based on Python docstringshttps://tracker.ceph.com/issues/24763?journal_id=1915552021-04-15T17:26:10ZErnesto Puerta
<ul><li><strong>Project</strong> changed from <i>mgr</i> to <i>Dashboard</i></li><li><strong>Category</strong> changed from <i>132</i> to <i>General</i></li></ul>