mirror of
https://github.com/ceph/ceph
synced 2024-12-22 11:31:55 +00:00
ca2261781e
Generate Sphinx documentation from OpenAPI YAML spec: - Fixed Docs controller doc generation - Now dashboard Python doesn't fails if dashboard/frontend/dist doesn't exist - OpenAPI added to @ceph/api CODEOWNERS - Renamed Ceph-Dashboard API to Ceph REST or RESTful API. - OpenAPI Docs: fixed decorators and docstrings. - Sphinx Docs: updated dashboard and dev ones. Co-authored-by: Ernesto Puerta <epuertat@redhat.com> Fixes: https://tracker.ceph.com/issues/45863 Signed-off-by: Courtney Caldwell <ccaldwel@redhat.com> Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
63 lines
994 B
ReStructuredText
63 lines
994 B
ReStructuredText
===================
|
|
API Documentation
|
|
===================
|
|
|
|
Ceph RESTful API
|
|
================
|
|
|
|
See `Ceph REST API`_.
|
|
|
|
.. _Ceph REST API: ../mgr/ceph_api/
|
|
|
|
Ceph Storage Cluster APIs
|
|
=========================
|
|
|
|
See `Ceph Storage Cluster APIs`_.
|
|
|
|
.. _Ceph Storage Cluster APIs: ../rados/api/
|
|
|
|
|
|
Ceph File System APIs
|
|
=====================
|
|
|
|
See `libcephfs`_
|
|
|
|
.. _libcephfs: ../cephfs/api
|
|
|
|
Ceph Block Device APIs
|
|
======================
|
|
|
|
See `librbdpy`_.
|
|
|
|
.. _librbdpy: ../rbd/api/librbdpy
|
|
|
|
Ceph RADOS Gateway APIs
|
|
=======================
|
|
|
|
See `librgw-py`_.
|
|
|
|
.. _librgw-py: ../radosgw/api
|
|
|
|
Ceph Object Store APIs
|
|
======================
|
|
|
|
- See `S3-compatible API`_.
|
|
- See `Swift-compatible API`_.
|
|
- See `Admin Ops API`_.
|
|
|
|
Ceph MON Command API
|
|
====================
|
|
|
|
- See `Mon command API`_.
|
|
|
|
.. _S3-compatible API: ../radosgw/s3/
|
|
.. _Swift-compatible API: ../radosgw/swift/
|
|
.. _Admin Ops API: ../radosgw/adminops
|
|
.. _Mon command API: mon_command_api
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
mon_command_api
|