ceph/doc/api/index.rst

===================
 API Documentation
===================

Ceph RESTful API
================

See :ref:`mgr ceph api`.

Ceph Storage Cluster APIs
=========================

See :ref:`rados api`


Ceph File System APIs
=====================

See :ref:`cephfs api`


Ceph Block Device APIs
======================

See :ref:`rbd api py`

Ceph RADOS Gateway APIs
=======================

See :ref:`radosgw api`

Ceph Object Store APIs
======================

- See :ref:`S3-compatible API <radosgw s3>`.
- See :ref:`Swift-compatible API <radosgw swift>`.
- See :ref:`Admin Ops API<radosgw admin ops>`.

Ceph MON Command API
====================

- See :doc:`Mon command API <mon_command_api>`.

.. toctree::
    :hidden:
    
    mon_command_api
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00			`===================`
Minor edits. Still WIP. Signed-off-by: John Wilkins <john.wilkins@dreamhost.com> Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com> 2012-04-25 21:50:15 +00:00			`API Documentation`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00			`===================`
Integrate Doxygen into Sphinx docs. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com> 2011-08-29 22:43:41 +00:00
mgr/dashboard/api: generate offline API docs 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> 2020-09-08 15:06:33 +00:00			`Ceph RESTful API`
			`================`

doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			See :ref:`mgr ceph api`.
Integrate Doxygen into Sphinx docs. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com> 2011-08-29 22:43:41 +00:00
doc: Updated with glossary terms. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2013-06-13 21:09:35 +00:00			`Ceph Storage Cluster APIs`
			`=========================`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			See :ref:`rados api`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00

doc: filesystem to file system "Filesystem" is not a word (although fairly common in use). Signed-off-by: Patrick Donnelly <pdonnell@redhat.com> 2019-09-09 19:36:04 +00:00			`Ceph File System APIs`
			`=====================`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			See :ref:`cephfs api`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00

doc: Updated with glossary terms. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2013-06-13 21:09:35 +00:00			`Ceph Block Device APIs`
			`======================`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			See :ref:`rbd api py`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: add doc for pybind of rgw Signed-off-by: Kefu Chai <kchai@redhat.com> 2016-11-08 09:12:26 +00:00			`Ceph RADOS Gateway APIs`
			`=======================`

doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			See :ref:`radosgw api`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: Updated with glossary terms. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2013-06-13 21:09:35 +00:00			`Ceph Object Store APIs`
			`======================`
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			- See :ref:`S3-compatible API <radosgw s3>`.
			- See :ref:`Swift-compatible API <radosgw swift>`.
			- See :ref:`Admin Ops API<radosgw admin ops>`.
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc/api: Add a generated reference of all mon commands. Generate a ReST document which contains all mon commands. Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com> 2020-04-24 09:15:53 +00:00			`Ceph MON Command API`
			`====================`

doc: use :ref: instead relative path for links path is fragile when we move the file around, but link is more stable. Signed-off-by: Kefu Chai <kchai@redhat.com> 2021-03-21 17:01:07 +00:00			- See :doc:`Mon command API <mon_command_api>`.
doc/api: Add a generated reference of all mon commands. Generate a ReST document which contains all mon commands. Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com> 2020-04-24 09:15:53 +00:00
			`.. toctree::`
			`:hidden:`

			`mon_command_api`