summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMS <ms@taler.net>2021-05-14 12:12:15 +0200
committerMS <ms@taler.net>2021-05-14 12:12:15 +0200
commitf2781e14caa3b8bac7ee387cd47a0da00906c0af (patch)
treefe304c988146ee5ed4d7be49da8b46c26706a766 /libeufin
parent3616296242138e6be03ae44bb9fa221af36f9063 (diff)
downloaddocs-f2781e14caa3b8bac7ee387cd47a0da00906c0af.tar.gz
docs-f2781e14caa3b8bac7ee387cd47a0da00906c0af.tar.bz2
docs-f2781e14caa3b8bac7ee387cd47a0da00906c0af.zip
fix Nexus API
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-nexus.rst58
1 files changed, 26 insertions, 32 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 57135d72..910fe45b 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -500,8 +500,32 @@ Scheduling API
.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}
- This call returns the information related to the task associated
- to ``taskId``.
+ **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;
+ }
+
+
+.. http:delete:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}
+
+ This call deletes the task associated to ``taskId``.
+
+.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule
**Response**
@@ -525,36 +549,6 @@ Scheduling API
}
-.. 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
----------------