From dd276d4c4dd75e64ca90ac5ddc03ca92faae5db2 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Mon, 7 Dec 2015 16:56:03 +0000 Subject: [PATCH] Add event context module --- specification/feature_profiles.rst | 2 ++ specification/modules/event_context.rst | 17 +++++++++++++++++ specification/targets.yaml | 1 + 3 files changed, 20 insertions(+) create mode 100644 specification/modules/event_context.rst diff --git a/specification/feature_profiles.rst b/specification/feature_profiles.rst index a5d19a61..bb1ee2ad 100644 --- a/specification/feature_profiles.rst +++ b/specification/feature_profiles.rst @@ -27,6 +27,7 @@ Summary `Managing History Visibility`_ Required Required Required Required Optional `Server Side Search`_ 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.* @@ -41,6 +42,7 @@ Summary .. _Managing History Visibility: `module:history-visibility`_ .. _Server Side Search: `module:search`_ .. _Server Administration: `module:admin`_ +.. _Event Context: `module:event-context`_ Clients ------- diff --git a/specification/modules/event_context.rst b/specification/modules/event_context.rst new file mode 100644 index 00000000..2f798caa --- /dev/null +++ b/specification/modules/event_context.rst @@ -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. diff --git a/specification/targets.yaml b/specification/targets.yaml index cbe40dc7..ca3aa215 100644 --- a/specification/targets.yaml +++ b/specification/targets.yaml @@ -36,6 +36,7 @@ groups: # reusable blobs of files when prefixed with 'group:' - modules/tags.rst - modules/account_data.rst - modules/admin.rst + - modules/event_context.rst title_styles: ["=", "-", "~", "+", "^", "`", "@"]