RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-29 06:52:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #30847 from rhcs-dashboard/fix-42268-master

Browse Source 
mgr/dashboard: fix typos in HACKING.rst

Reviewed-by: Ricardo Marques <rimarques@suse.com>
This commit is contained in:
Ricardo Dias 2019-10-11 14:06:53 +01:00 committed by GitHub
commit d45f2da40f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/pybind/mgr/dashboard/HACKING.rst
View File

@ -836,7 +836,7 @@ parameter.
For ``POST`` and ``PUT`` methods, all method parameters are considered
body parameters by default. To override this default, one can use the
``path_params`` and ``query_params`` to specify which method parameters are
path and query parameters respectivelly.
path and query parameters respectively.
Body parameters are decoded from the request body, either from a form format, or
from a dictionary in JSON format.
@ -1667,9 +1667,11 @@ API endpoints.However, by default it is not very detailed. There are two
decorators that can be used to add more information:
* ``@EndpointDoc()`` for documentation of endpoints. It has four optional arguments
(explained below): ``description``, ``group``, ``parameters`` and``responses``.
(explained below): ``description``, ``group``, ``parameters`` and
``responses``.
* ``@ControllerDoc()`` for documentation of controller or group associated with
the endpoints. It only takes the two first arguments: ``description`` and``group``.
the endpoints. It only takes the two first arguments: ``description`` and
``group``.
``description``: A a string with a short (1-2 sentences) description of the object.