docs(pydocs): full python wrapper documentation
This commit is contained in:
parent
bb888bb314
commit
d4b1758262
9 changed files with 1150 additions and 0 deletions
15
docs/fields.rst
Normal file
15
docs/fields.rst
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
Field selection
|
||||
===============
|
||||
|
||||
The Szurubooru API supports *Field Selection*. This allows you to select only a subset of fields to return from the API. By default all fields are selected and returned, but if you
|
||||
pass in a list of field names to any of the client methods that support it, only those fields will be populated in the models.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
```python
|
||||
tags = client.list_tags(fields=["version", "names", "category"])
|
||||
assert tags.results[0].description is None
|
||||
```
|
||||
|
||||
Because the ``description`` field was not specified, it's set to ``None``
|
||||
Loading…
Add table
Add a link
Reference in a new issue