docs/user.rst: make mention of url field in POST
This commit is contained in:
parent
f6e1d1c385
commit
88bd79c228
@ -147,3 +147,15 @@ POST
|
|||||||
|
|
||||||
``POST /users`` creates a new user.
|
``POST /users`` creates a new user.
|
||||||
The request body must conform to the :ref:`User schema<user_schema>`.
|
The request body must conform to the :ref:`User schema<user_schema>`.
|
||||||
|
|
||||||
|
The server will return a ``201 Created`` code with a similar body to this:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
|
{
|
||||||
|
"status": "success",
|
||||||
|
"url": "/users/user"
|
||||||
|
}
|
||||||
|
|
||||||
|
The ``url`` field is the URL to the new user.
|
||||||
|
It can be used in further requests to manage the user's information, or delete it.
|
||||||
|
Loading…
Reference in New Issue
Block a user