From e30fc0b8816c06d2e057f7c7f1c7945ba942f950 Mon Sep 17 00:00:00 2001
From: Curtis Rueden <ctrueden@wisc.edu>
Date: Mon, 23 Sep 2024 16:53:17 -0500
Subject: [PATCH] Resolve documentation TODOs in Appose class

---
 src/appose/__init__.py | 92 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 88 insertions(+), 4 deletions(-)

diff --git a/src/appose/__init__.py b/src/appose/__init__.py
index d3ac816..570d1c9 100644
--- a/src/appose/__init__.py
+++ b/src/appose/__init__.py
@@ -42,8 +42,6 @@
 
 ## Examples
 
-* TODO - move the below code somewhere linkable, for succinctness here.
-
 Here is a very simple example written in Python:
 
     import appose
@@ -127,8 +125,94 @@ def task_listener(event):
 2. The worker must issue responses in Appose's response format on its
    standard output (stdout) stream.
 
-TODO - write up the request and response formats in detail here!
-JSON, one line per request/response.
+### Requests to worker from service
+
+A *request* is a single line of JSON sent to the worker process via
+its standard input stream. It has a `task` key taking the form of a
+UUID, and a `requestType` key with one of the following values:
+
+#### EXECUTE
+
+Asynchronously execute a script within the worker process. E.g.:
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "requestType" : "EXECUTE",
+       "script" : "task.outputs[\"result\"] = computeResult(gamma)\n",
+       "inputs" : {"gamma": 2.2}
+    }
+
+#### CANCEL
+
+Cancel a running script. E.g.:
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "requestType" : "CANCEL"
+    }
+
+### Responses from worker to service
+
+A *response* is a single line of JSON with a `task` key taking the form
+of a UUID, and a `responseType` key with one of the following values:
+
+#### LAUNCH
+
+A LAUNCH response is issued to confirm the success of an EXECUTE
+request.
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "responseType" : "LAUNCH"
+    }
+
+#### UPDATE
+
+An UPDATE response is issued to convey that a task has somehow made
+progress. The UPDATE response typically comes bundled with a
+`message` string indicating what has changed, `current` and/or
+`maximum` progress indicators conveying the step the task has
+reached, or both.
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "responseType" : "UPDATE",
+       "message" : "Processing step 0 of 91",
+       "current" : 0,
+       "maximum" : 91
+    }
+
+#### COMPLETION
+
+A COMPLETION response is issued to convey that a task has successfully
+completed execution, as well as report the values of any task outputs.
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "responseType" : "COMPLETION",
+       "outputs" : {"result" : 91}
+    }
+
+#### CANCELATION
+
+A CANCELATION response is issued to confirm the success of a CANCEL
+request.
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "responseType" : "CANCELATION"
+    }
+
+#### FAILURE
+
+A FAILURE response is issued to convey that a task did not completely
+and successfully execute, such as an exception being raised.
+
+    {
+       "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
+       "responseType" : "FAILURE",
+       "error", "Invalid gamma value"
+    }
 '''
 
 from pathlib import Path