Sphinx-HTTP-domain icon indicating copy to clipboard operation
Sphinx-HTTP-domain copied to clipboard

POST parameters

Open deceze opened this issue 13 years ago • 0 comments

POST parameters can only be marked up using the param keyword, which will show up as Query params. There should be a separate markup for POST parameters, or they should automatically be marked as POST parameters if the method is a POST method and the parameter is not listed in the URL.

E.g.:

.. http:method:: POST /foo/bar/{id}

   :param id: Will be displayed as GET param
   :param baz: Will be displayed as POST param

Or:

.. http:method:: POST /foo/bar/{id}

   :param id: Will be displayed as GET param
   :postparam baz: Will be displayed as POST param

deceze avatar Mar 25 '11 02:03 deceze