From: David Moreau Simard Date: Tue, 31 Dec 2013 21:48:55 +0000 (-0500) Subject: Be more explicit how to discover available API calls X-Git-Tag: v0.76~53^2~1 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=42e98aca6255f0b868771019be7bf74348454f27;p=ceph.git Be more explicit how to discover available API calls I believe it cannot hurt to be slightly more explicit about how to retrieve API calls and provide examples. Signed-off-by: David Moreau Simard --- diff --git a/doc/man/8/ceph-rest-api.rst b/doc/man/8/ceph-rest-api.rst index 3d6e287e9158e..786833b2952de 100644 --- a/doc/man/8/ceph-rest-api.rst +++ b/doc/man/8/ceph-rest-api.rst @@ -102,7 +102,11 @@ Human-readable discovery of supported commands and parameters, along with a small description of each command, is provided when the requested path is incomplete/partially matching. Requesting / will redirect to the value of **restapi base url**, and that path will give a full list -of all known commands. The command set is very similar to the commands +of all known commands. +For example, requesting ``api/vX.X/mon`` will return the list of API calls for +monitors - ``api/vX.X/osd`` will return the list of API calls for OSD and so on. + +The command set is very similar to the commands supported by the **ceph** tool. One notable exception is that the ``ceph pg `` style of commands is supported here as ``tell//command?args``.