summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--libeufin/api-nexus.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index d7dfc488..57135d72 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -505,7 +505,24 @@ Scheduling API
**Response**
- In case of success, it responds with one `NexusTask` object.
+ .. code-block:: ts
+
+ interface TaskCollection {
+
+ // This field can contain *multiple* objects of the type sampled below.
+ schedule: {
+
+ 'task-name': {
+ cronspec: string;
+ type: string; // fetch | submit
+
+ // Depends on the type. Submit has it empty, whereas
+ // the fetch type includes the time range and the report
+ // level.
+ params: any;
+ }
+ }
+ }
.. http:delete:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}