From ab3fe71e062512041358702957d53fa6e4dc173b Mon Sep 17 00:00:00 2001
From: Thien-Thi Nguyen <ttn@gnuvola.org>
Date: Tue, 10 Aug 2021 22:34:44 -0400
Subject: add "target audience" comment

---
 libeufin/api-nexus.rst | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

(limited to 'libeufin/api-nexus.rst')

diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 0a0b73ea..1c51372a 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
-- 
cgit v1.2.3