[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: clarify paths
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: clarify paths |
Date: |
Thu, 04 Mar 2021 16:01:56 +0100 |
This is an automated email from the git hooks/post-receive script.
grothoff pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 91ac68e clarify paths
91ac68e is described below
commit 91ac68e9d296bda509e74541a88b74e5621b9ae9
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Thu Mar 4 16:01:53 2021 +0100
clarify paths
---
core/api-merchant.rst | 27 ++++++++++++++++++++++-----
1 file changed, 22 insertions(+), 5 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index a49589c..26f3946 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -72,8 +72,15 @@ Examples:
A public endpoint (explicit "default" instance):
https://merchant-backend.example.com/instances/default/orders
- Endpoint to manage other instances (ONLY for implicit "default" instance):
+ Endpoints to manage other instances (ONLY for implicit "default" instance):
https://merchant-backend.example.com/private/instances
+ https://merchant-backend.example.com/private/instances/$ID
+
+ Endpoints to manage own instance
+ https://merchant-backend.example.com/private
+ https://merchant-backend.example.com/private/auth
+ https://merchant-backend.example.com/instances/$ID/private
+ https://merchant-backend.example.com/instances/$ID/private/auth
Unavailabe endponts (will return 404):
https://merchant-backend.example.com/instances/myinst/private/instances
@@ -918,9 +925,13 @@ Setting up instances
}
+.. http:post:: /private/instances/$INSTANCE/auth
.. http:post:: [/instances/$INSTANCE]/private/auth
- Update the authentication settings for an instance.
+ Update the authentication settings for an instance. POST operations against
+ an instance are authenticated by checking that an authorization is provided
+ that matches either the credential required by the instance being modified
+ OR the 'default' instance, depending on the access path used.
**Request** the request must be an `InstanceAuthConfigurationMessage`.
@@ -950,12 +961,13 @@ Setting up instances
}
+.. http:patch:: /private/instances/$INSTANCE
.. http:patch:: [/instances/$INSTANCE]/private
Update the configuration of a merchant instance. PATCH operations against
an instance are authenticated by checking that an authorization is provided
that matches either the credential required by the instance being modified
- OR the 'default' instance.
+ OR the 'default' instance, depending on the access path used.
**Request**
@@ -1060,9 +1072,13 @@ Inspecting instances
}
+.. http:get:: /private/instances/$INSTANCE
.. http:get:: [/instances/$INSTANCE]/private
- This is used to query a specific merchant instance.
+ This is used to query a specific merchant instance. GET operations against
+ an instance are authenticated by checking that an authorization is provided
+ that matches either the credential required by the instance being modified
+ OR the 'default' instance, depending on the access path used.
**Response:**
@@ -1142,6 +1158,7 @@ Inspecting instances
Deleting instances
------------------
+.. http:delete:: /private/instances/$INSTANCE
.. http:delete:: [/instances/$INSTANCE]/private
This request will be used to delete (permanently disable)
@@ -1152,7 +1169,7 @@ Deleting instances
For deletion, the authentication credentials must match
the instance that is being deleted or the 'default'
- instance.
+ instance, depending on the access path used.
**Request:**
--
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: clarify paths,
gnunet <=