0192a4ab0c
This patch set is one of many to add api reference documentation to valet. This specifc patch adds the /v1/groups/ api documentation. User can generate the documentation by ``tox -eapi-ref``. Change-Id: Ic5016abd9f95de98effeaceb4b9f8c1fc7943d6a Signed-off-by: Tin Lam <tin@irrational.io>
41 lines
498 B
ReStructuredText
41 lines
498 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
======
|
|
Groups
|
|
======
|
|
|
|
List groups
|
|
===========
|
|
|
|
.. rest_method:: GET /v1/groups
|
|
|
|
Lists groups.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/something.json
|
|
:language: javascript
|