taler-docs

commit 663e5f7948712cfcd69b3d5f3a12e52122d3950e
parent ad3bd0ed52bf8f6379634b1283230fcd93a07199
Author: MS <ms@taler.net>
Date:   Mon,  7 Dec 2020 16:20:26 +0100

document scheduling API (nexus)

Diffstat:
M
libeufin/api-nexus.rst
 | 
42
+++++++++++++++++++++++++++++++++++++++++-

1 file changed, 41 insertions(+), 1 deletion(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
@@ -25,7 +25,6 @@ This API is mostly used by testing jobs.
      }
 
 
-
 Returns configuration values currently used by Nexus.
 
 .. http:get:: {nexusBase}/config
@@ -106,6 +105,7 @@ User Management
 Test API
 --------
 
+
 .. http:post:: {nexusBase}/bank-accounts/{acctid}/test-camt-ingestion/{type}
 
   This call allows tests to **directly** give Nexus a Camt document.  After
@@ -369,6 +369,46 @@ manages payment initiations of the account and tracks the initiations of payment
      }
 
 
+.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}
+  
+  This call returns the information related to the task associated
+  to ``taskId``.
+
+  **Response**
+
+  In case of success, it responds with one `NexusTask` object.
+
+
+.. http:delete:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}
+  
+  This call deletes the task associated to ``taskId``.
+
+.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule
+
+  This call returns a list of all the scheduled tasks, under one bank account.
+  The list is wrapped into a ``tasks`` object, and contains elements of `NexusTask`.
+
+  **Response**
+  
+  .. ts:def:: NexusTask
+
+     // This object is a mere reflection of
+     // what the Nexus database keeps to implement
+     // the scheduling feature.
+
+     interface NexusTask {
+       // FIXME: document all. 
+       resourceType: string;
+       resourceId: string;
+       taskName: string;
+       taskType: string;
+       taskCronSpec: string;
+       taskParams: string;
+       nextScheduledExecutionSec: number;
+       prevScheduledExecutionSec: number;
+     }
+
+
 Bank Connections
 ----------------