[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] 03/11: add "target audience" comment
From: |
gnunet |
Subject: |
[taler-docs] 03/11: add "target audience" comment |
Date: |
Wed, 11 Aug 2021 04:48:05 +0200 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a commit to branch master
in repository docs.
commit ab3fe71e062512041358702957d53fa6e4dc173b
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Tue Aug 10 22:34:44 2021 -0400
add "target audience" comment
---
libeufin/api-nexus.rst | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 0a0b73e..1c51372 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -1,3 +1,5 @@
+.. target audience: core developer
+
Nexus API
###########
@@ -82,7 +84,7 @@ User Management
.. code-block:: ts
interface UserChangePassword {
- newPassword: string;
+ newPassword: string;
}
.. http:post:: {nexusBase}/users
@@ -201,7 +203,7 @@ Test API
``C53``.
**Response**
-
+
The successful case should respond with a ``200 OK`` and a empty JSON body.
@@ -378,7 +380,7 @@ manages payment initiations of the account and tracks the
initiations of payment
.. code-block:: ts
interface NewTransactions {
- newTransactions: number;
+ newTransactions: number;
}
.. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions
@@ -414,7 +416,7 @@ manages payment initiations of the account and tracks the
initiations of payment
// FIXME
valueDate: string;
-
+
// When this payment got booked. In the form YYYY-MM-DD
bookingDate: string;
@@ -468,14 +470,14 @@ Scheduling API
--------------
.. http:post:: {nexusBase}/bank-accounts/{acctid}/schedule
-
+
This endpoint allows the caller to define a recurrent
execution of a task.
**Request**
.. ts:def:: ScheduleTask
-
+
interface ScheduleTask {
name: string;
@@ -499,7 +501,7 @@ Scheduling API
.. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId}
-
+
**Response**
.. ts:def:: NexusTask
@@ -509,7 +511,7 @@ Scheduling API
// the scheduling feature.
interface NexusTask {
- // FIXME: document all.
+ // FIXME: document all.
resourceType: string;
resourceId: string;
taskName: string;
@@ -522,7 +524,7 @@ 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
@@ -758,7 +760,7 @@ to the real bank.
code: string;
// the unique identifier of the message.
- messageId: string;
+ messageId: string;
// bytes length of the message.
length: number;
@@ -804,7 +806,7 @@ Facades
}
.. http:delete:: {nexus}/facades/{fcid}
-
+
Delete a facade.
.. http:post:: {nexus}/facades
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [taler-docs] branch master updated (6e6793d -> 32b310e), gnunet, 2021/08/10
- [taler-docs] 11/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 07/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 03/11: add "target audience" comment,
gnunet <=
- [taler-docs] 10/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 06/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 02/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 05/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 08/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 04/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 09/11: add "target audience" comment, gnunet, 2021/08/10
- [taler-docs] 01/11: add "target audience" comment, gnunet, 2021/08/10