ceph/doc/api/index.rst

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


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
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

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: Updated with glossary terms. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2013-06-13 21:09:35 +00:00			See `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: 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: ../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/cephfs: add python binding doc and restructure cephfs/api to move the javadoc for cephfs to this directory Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-03-12 10:14:31 +00:00			See `libcephfs`_
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc/cephfs: add python binding doc and restructure cephfs/api to move the javadoc for cephfs to this directory Signed-off-by: Kefu Chai <kchai@redhat.com> 2020-03-12 10:14:31 +00:00			`.. _libcephfs: ../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
add calamari to the api/index section Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com> 2014-08-14 14:02:07 +00:00			See `librbdpy`_.
doc: Added links to APIs. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2012-11-16 23:13:57 +00:00
doc: correct the path of librbd python APIs * update the API Documentation page for librbdpy with the correct path. * fix a typo. Signed-off-by: songweibin <song.weibin@zte.com.cn> 2017-12-26 11:59:17 +00:00			`.. _librbdpy: ../rbd/api/librbdpy`
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`
			`=======================`

			See `librgw-py`_.

			`.. _librgw-py: ../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: Updated with glossary terms. Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2013-06-13 21:09:35 +00:00			- See `S3-compatible API`_.
			- See `Swift-compatible API`_.
add calamari to the api/index section Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com> 2014-08-14 14:02:07 +00:00			- See `Admin Ops API`_.
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`
			`====================`

			- See `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			`.. _S3-compatible API: ../radosgw/s3/`
doc: Added entry for the RGW Admin Ops API. fixes: #5002 Signed-off-by: John Wilkins <john.wilkins@inktank.com> 2013-05-10 18:30:48 +00:00			`.. _Swift-compatible API: ../radosgw/swift/`
add calamari to the api/index section Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com> 2014-08-14 14:02:07 +00:00			`.. _Admin Ops API: ../radosgw/adminops`
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			`.. _Mon command API: mon_command_api`


			`.. toctree::`
			`:hidden:`

			`mon_command_api`