Add event context module
This commit is contained in:
parent
f4b9433c7b
commit
dd276d4c4d
3 changed files with 20 additions and 0 deletions
|
@ -27,6 +27,7 @@ Summary
|
||||||
`Managing History Visibility`_ Required Required Required Required Optional
|
`Managing History Visibility`_ Required Required Required Required Optional
|
||||||
`Server Side Search`_ Optional Optional Optional Optional Optional
|
`Server Side Search`_ Optional Optional Optional Optional Optional
|
||||||
`Server Administration`_ Optional Optional Optional Optional Optional
|
`Server Administration`_ Optional Optional Optional Optional Optional
|
||||||
|
`Event Context`_ Optional Optional Optional Optional Optional
|
||||||
===================================== ========== ========== ========== ========== ==========
|
===================================== ========== ========== ========== ========== ==========
|
||||||
|
|
||||||
*Please see each module for more details on what clients need to implement.*
|
*Please see each module for more details on what clients need to implement.*
|
||||||
|
@ -41,6 +42,7 @@ Summary
|
||||||
.. _Managing History Visibility: `module:history-visibility`_
|
.. _Managing History Visibility: `module:history-visibility`_
|
||||||
.. _Server Side Search: `module:search`_
|
.. _Server Side Search: `module:search`_
|
||||||
.. _Server Administration: `module:admin`_
|
.. _Server Administration: `module:admin`_
|
||||||
|
.. _Event Context: `module:event-context`_
|
||||||
|
|
||||||
Clients
|
Clients
|
||||||
-------
|
-------
|
||||||
|
|
17
specification/modules/event_context.rst
Normal file
17
specification/modules/event_context.rst
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
Event Context
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. _module:event-context:
|
||||||
|
|
||||||
|
This API returns a number of events that happened just before and after the
|
||||||
|
specified event. This allows clients to get the context surrounding an event.
|
||||||
|
|
||||||
|
Client behaviour
|
||||||
|
----------------
|
||||||
|
|
||||||
|
{{event_context_http_api}}
|
||||||
|
|
||||||
|
Security considerations
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
The server must only return results that the user has permission to see.
|
|
@ -36,6 +36,7 @@ groups: # reusable blobs of files when prefixed with 'group:'
|
||||||
- modules/tags.rst
|
- modules/tags.rst
|
||||||
- modules/account_data.rst
|
- modules/account_data.rst
|
||||||
- modules/admin.rst
|
- modules/admin.rst
|
||||||
|
- modules/event_context.rst
|
||||||
|
|
||||||
|
|
||||||
title_styles: ["=", "-", "~", "+", "^", "`", "@"]
|
title_styles: ["=", "-", "~", "+", "^", "`", "@"]
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue