aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2017-11-21 14:33:04 +0100
committerLorenz Diener <[email protected]>2017-11-21 14:33:04 +0100
commite1a1592575d2aa8d5d719269bca4ca3effc8dc31 (patch)
tree6d8a9d9814f592937e983ef30920e19b30329f04
parentc072b2e24766c3f4b1f92e33436874f02175d400 (diff)
downloadmastodon.py-e1a1592575d2aa8d5d719269bca4ca3effc8dc31.tar.gz
Documented report dicts
-rw-r--r--docs/index.rst14
-rw-r--r--mastodon/Mastodon.py3
2 files changed, 17 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 5fc47ac..c74f8f6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -329,6 +329,20 @@ Instance dicts
329 'urls': # Additional URLs dict, presently only 'streaming_api' with the stream websocket address. 329 'urls': # Additional URLs dict, presently only 'streaming_api' with the stream websocket address.
330 } 330 }
331 331
332Report dicts
333~~~~~~~~~~~~
334.. code-block:: python
335
336 mastodon.reports()[0]
337 # Returns the folowing dictionary
338 {
339 'id': # Numerical id of the report
340 'action_taken': # True if a moderator or admin has processed the
341 # report, False otherwise. Note that no indication as to what action was taken is given
342 # and that an admin simply marking the report as processed and not doing anything else
343 # will set this field to True.
344 }
345
332App registration and user authentication 346App registration and user authentication
333---------------------------------------- 347----------------------------------------
334Before you can use the mastodon API, you have to register your 348Before you can use the mastodon API, you have to register your
diff --git a/mastodon/Mastodon.py b/mastodon/Mastodon.py
index 9456495..49d7e9b 100644
--- a/mastodon/Mastodon.py
+++ b/mastodon/Mastodon.py
@@ -470,6 +470,9 @@ class Mastodon:
470 Fetch a list of reports made by the authenticated user. 470 Fetch a list of reports made by the authenticated user.
471 471
472 Returns a list of report dicts. 472 Returns a list of report dicts.
473
474 Warning: According to the official API documentation, this
475 method is to be treated as not finalized as of Mastodon 2.0.0.
473 """ 476 """
474 return self.__api_request('GET', '/api/v1/reports') 477 return self.__api_request('GET', '/api/v1/reports')
475 478
Powered by cgit v1.2.3 (git 2.41.0)