Working on docs
This commit is contained in:
parent
b43ffc4c92
commit
5ab36beedd
1 changed files with 6 additions and 6 deletions
12
docs/api.rst
12
docs/api.rst
|
|
@ -55,12 +55,12 @@ Optional Settings
|
|||
|
||||
The following are optional query parameter settings:
|
||||
|
||||
- serializer: Either array (the default) or json. If json is selected the data is returned using the `JSON API <http://jsonapi.org/>`_ format.
|
||||
- include: A comma-separated list of nested relationships to include.
|
||||
- client_id: If set the results will be filtered by the client.
|
||||
- page: The page number of results to return when the results are paginated.
|
||||
- per_page: The number of results to return per page.
|
||||
- updated_at: Timestamp used as a filter to only show recently updated records.
|
||||
- **serializer**: Either array (the default) or json. If json is selected the data is returned using the `JSON API <http://jsonapi.org/>`_ format.
|
||||
- **include**: A comma-separated list of nested relationships to include.
|
||||
- **client_id**: If set the results will be filtered by the client.
|
||||
- **page**: The page number of results to return when the results are paginated.
|
||||
- **per_page**: The number of results to return per page.
|
||||
- **updated_at**: Timestamp used as a filter to only show recently updated records.
|
||||
|
||||
Subscriptions
|
||||
"""""""""""""
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue