taler-docs

commit af11ed5ff33defdb3b01e14b2c2be146848a8abc
parent be6eb544fdedc716cfe5d0643932499191d38b19
Author: MS <ms@taler.net>
Date:   Thu,  9 Feb 2023 16:49:31 +0100

addressing #7669

Diffstat:
A
libeufin/api-common.rst
 | 
28
++++++++++++++++++++++++++++
M
libeufin/api-sandbox.rst
 | 
4
++--
M
libeufin/index.rst
 | 
1
+

3 files changed, 31 insertions(+), 2 deletions(-)
diff --git a/libeufin/api-common.rst b/libeufin/api-common.rst
@@ -0,0 +1,28 @@
+====================================
+Common LibEuFin HTTP API Conventions
+====================================
+
+
+Contact details
+^^^^^^^^^^^^^^^
+
+.. ts:def:: EmailAddress
+
+  type EmailAddress = string;
+
+.. ts:def:: PhoneNumber
+
+  type PhoneNumber = string;
+
+Phone numbers should start with the ``+`` symbol and the country code.
+
+Amounts
+^^^^^^^
+
+.. ts:def:: Amount
+
+  type Amount = string;
+
+Amounts have the ``$currency:X.Y`` format, where the
+fractional part is optional and may contain at most two
+digits.
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
@@ -83,10 +83,10 @@ Accounts
      interface CircuitContactData {
 
        // E-Mail address
-       email?: string;
+       email?: EmailAddress;
 
        // Phone number.
-       phone?: string;
+       phone?: PhoneNumber;
      }
 
 
diff --git a/libeufin/index.rst b/libeufin/index.rst
@@ -8,6 +8,7 @@ LibEuFin is a project providing free software tooling for European FinTech.
 
   concepts
   bank-transport-ebics
+  api-common
   api-nexus
   api-sandbox
   ebics