]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Be more explicit how to discover available API calls
authorDavid Moreau Simard <dmsimard@iweb.com>
Tue, 31 Dec 2013 21:48:55 +0000 (16:48 -0500)
committerDavid Moreau Simard <dmsimard@iweb.com>
Tue, 31 Dec 2013 21:48:55 +0000 (16:48 -0500)
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 <dmsimard@iweb.com>
doc/man/8/ceph-rest-api.rst

index 3d6e287e9158e89071f15349ff5a9c7b83b3baf4..786833b2952de466a91badb3fa0f4a6a46326c7c 100644 (file)
@@ -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 <pgid> <command>`` style of commands is supported here
 as ``tell/<pgid>/command?args``.