commit 027a9eae2a7a3c4ee79fcf31b88a45c66c1f4222
parent 2367a3504e4267a29f43ffe0f8b99b25335f8d60
Author: Sebastian <sebasjm@gmail.com>
Date: Fri, 19 Mar 2021 08:59:33 -0300
add index
Diffstat:
2 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/design-documents/015-merchant-backoffice-routing.rst b/design-documents/015-merchant-backoffice-routing.rst
@@ -5,9 +5,11 @@ Design Doc 015: Merchant backoffice Routing
Motivation
==========
-A well defined routing will allow users to share backoffice links pointing directly into instance pages (settings, orders, products, etc...)
-The backoffice should load from the instance URL and then allow a internal
-rounting of the views with the posibility to accessing them directly when
+A well defined routing will allow users to share backoffice links pointing
+directly into instance pages (settings, orders, products, etc...)
+
+The backoffice should load from the instance URL and then allow a internal
+rounting of the views with the posibility to accessing them directly when
sharing a link.
@@ -17,8 +19,8 @@ Application rounting
There are 2 type of rounting: external and internal
external: define how the pathname of the URL will be interpreted to infer
- which instance is being accessed. Also the full URL is used as default when
- no BACKEND_URL exist yet in localStorage. After login, the BACKEND_URL is saved
+ which instance is being accessed. Also the full URL is used as default when no
+ BACKEND_URL exist yet in localStorage. After login, the BACKEND_URL is saved
in localStorage and the pathname is parsed to infer the instance id.
internal: define wich view will be rendered. It is implemented using a hash
@@ -144,10 +146,11 @@ backend token have the key ``backend-token``.
Default instance user is expected to jump from one instance to another in the
same session so all queries to the backend will be to
-``${BACKEND_URL}/instances/${CURRENT_INSTANCE_ID}`` with the ``BACKEND_URL`` provided in
-the login form and using the token expected to ``$CURRENT_INSTANCE_ID``.
+``${BACKEND_URL}/instances/${CURRENT_INSTANCE_ID}`` with the ``BACKEND_URL``
+provided in the login form and using the token expected to
+``$CURRENT_INSTANCE_ID``.
-Queries from a normal user will be done directly to ``$BACKEND_URL`` and using token
-from the login form.
+Queries from a normal user will be done directly to ``$BACKEND_URL`` and using
+token from the login form.
diff --git a/design-documents/index.rst b/design-documents/index.rst
@@ -24,3 +24,4 @@ and protocol.
012-fee-schedule-metrics
013-peer-to-peer-payments
014-merchant-backoffice-ui
+ 015-merchant-backoffice-routing
