aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNeil Williams <neil.williams@linaro.org>2018-06-28 09:57:35 +0100
committerNeil Williams <neil.williams@linaro.org>2018-07-11 18:32:39 +0100
commit792b63ad3cd538d8afcfb266fa771cba22c0d36e (patch)
treee9db50c4b60f11cf2a924df78c1cfdde02bfbeb0 /doc
parent07889e548b6abefaa9e1ddc3e9e75875c1b2e5c4 (diff)
LAVA-1368 provide access to the callback data
Change-Id: Ib42499f38f1bb86a84844df0afe21d74eb731004
Diffstat (limited to 'doc')
-rw-r--r--doc/v2/user-notifications.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/v2/user-notifications.rst b/doc/v2/user-notifications.rst
index 17420048c..72eaabd49 100644
--- a/doc/v2/user-notifications.rst
+++ b/doc/v2/user-notifications.rst
@@ -79,7 +79,7 @@ The **callbacks** section supports list of the following options:
* **urlencoded** (Default) Will return a standard HTTP POST request, with an
application/x-www-form-urlencoded Content-Type header and data sent as an
urlencoded query string.
- * **json** The data is dumped into JSON and returned with an application/json
+ * **json** The data is dumped into JSON and returned with an application/json
Content-Type header.
Example callback usage:
@@ -88,6 +88,23 @@ Example callback usage:
:code: yaml
:start-after: # notify callbacks block
+.. _debugging_callback:
+
+Debugging notification callbacks
+--------------------------------
+
+The job data can also be retrieved using the :ref:`REST API <rest_api>` (which
+supports authentication. For example::
+
+ $ wget -O job_data.gz http://localhost/scheduler/job/2126/job_data
+
+ $ wget -O job_data.gz "http://localhost/scheduler/job/2127/job_data?user=neil&token=22yj3ls...."
+
+Returns a gzip file containing the job data as JSON.
+
+.. note:: Only test jobs which are configured to use the notification callback
+ will create notification callback data for later retrieval. Other jobs will
+ generate a 404 error.
Using profile settings
----------------------