Skip to content

Commit 8f599ec

Browse files
committed
Add the events API to the docs
1 parent 04b587b commit 8f599ec

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

ciscosparkapi/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ class CiscoSparkAPI(object):
9696
9797
:class:`roles <_RolesAPI>`
9898
99+
:class:`events <_EventsAPI>`
100+
99101
:class:`access_tokens <_AccessTokensAPI>`
100102
101103
"""

docs/user/api.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,14 @@ roles
101101
.. autoclass:: ciscosparkapi.api.roles.RolesAPI()
102102

103103

104+
.. _events:
105+
106+
events
107+
-----
108+
109+
.. autoclass:: ciscosparkapi.api.events.EventsAPI()
110+
111+
104112
.. _access_tokens:
105113

106114
access_tokens
@@ -232,6 +240,15 @@ Role
232240
:inherited-members:
233241

234242

243+
.. _Event:
244+
245+
Event
246+
-----
247+
248+
.. autoclass:: Event()
249+
:inherited-members:
250+
251+
235252
.. _Access Token:
236253

237254
Access Token

docs/user/quickstart.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,10 @@ structure is provided here.
239239
| | +-------------------------------------+
240240
| | | :meth:`~RolesAPI.create` |
241241
+-----------------------+-------------------------+-------------------------------------+
242+
| | :ref:`events` | :meth:`~EventsAPI.list` |
243+
| | +-------------------------------------+
244+
| | | :meth:`~EventsAPI.get` |
245+
+-----------------------+-------------------------+-------------------------------------+
242246
| | :ref:`access_tokens` | :meth:`~AccessTokensAPI.get` |
243247
| | +-------------------------------------+
244248
| | | :meth:`~AccessTokensAPI.refresh` |

0 commit comments

Comments
 (0)