From 1804e3e8cf3b8f1bb14e197dada1697c40bed144 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Sun, 16 Apr 2017 10:40:39 +0200
Subject: Specify result-url value in task response manifest

---
 doc/manual.cli | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

(limited to 'doc')

diff --git a/doc/manual.cli b/doc/manual.cli
index 3617ca0..5da684a 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -391,7 +391,7 @@ starts with the task request manifest followed by a list of machine manifests.
 
 \li|\n\c{agent: <agent-name>}\n
 
-  The name of the agent host (\c{hostname}). These should be unique in a
+  The name of the agent host (\c{hostname}). This should be unique in a
   particular \c{bbot} deployment.|
 
 \li|\n\c{fingerprint: <agent-fingerprint>}\n
@@ -404,8 +404,9 @@ starts with the task request manifest followed by a list of machine manifests.
 \
 SYNOPSIS
 
-session:   <session-id>
-challenge: <text>
+session:    <session-id>
+challenge:  <text>
+result-url: <url>
 \
 
 A controller sends the task response manifest in response to the task request
@@ -418,18 +419,22 @@ followed by a task manifest.
 \li|\n\c{session: <session-id>}\n
 
   An identifier assigned to this session by the controller. An empty value
-  indicates that the controller has no tasks at this time in which case the
-  task manifest is absent.|
+  indicates that the controller has no tasks at this time in which case all
+  the following values as well as the task manifest are absent.|
 
 \li|\n\c{challenge: <text>}\n
 
-  A random text (nonce) used to challenge the agent's private key. If present,
+  Random text (nonce) used to challenge the agent's private key. If present,
   then the agent must sign this text with its private key and include the
   signature in the result request.
 
   The signature should be derived by calculating the SHA256 checksum of the
   text, encrypting it with the agent's private key, and then base64-encoding
-  the result.||
+  the result.|
+
+\li|\n\c{result-url: <url>}\n
+
+  The URL to post the result (upload) request to.||
 
 
 \h#arch-result-req-manifest|Result Request Manifest|
@@ -442,10 +447,10 @@ challenge: <text>
 \
 
 On completion of a task an agent (or controller acting as an agent) sends a
-result (upload) request to its controller via HTTP/HTTPS POST method (@@
-URL/API endpoint). The result request starts with the result request manifest
-followed by a result manifest. Note that there is no result response and
-only a successful but empty POST result is returned.
+result (upload) request to the controller via HTTP/HTTPS POST method using the
+URL returned in the task response. The result request starts with the
+result request manifest followed by a result manifest. Note that there is no
+result response and only a successful but empty POST result is returned.
 
 \dl|
 
-- 
cgit v1.1