[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: document scheduling API (nexus)
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: document scheduling API (nexus) |
Date: |
Mon, 07 Dec 2020 16:20:52 +0100 |
This is an automated email from the git hooks/post-receive script.
ms pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 663e5f7 document scheduling API (nexus)
663e5f7 is described below
commit 663e5f7948712cfcd69b3d5f3a12e52122d3950e
Author: MS <ms@taler.net>
AuthorDate: Mon Dec 7 16:20:26 2020 +0100
document scheduling API (nexus)
---
libeufin/api-nexus.rst | 42 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 41 insertions(+), 1 deletion(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index f47101f..f907435 100644
--- 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
----------------
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: document scheduling API (nexus),
gnunet <=