commit 54321d879cca081ecb1f905a7d4ef399a14cb3a9
parent f56e97acae2c1550d572191202e5b6235b38110a
Author: Sebastian <sebasjm@gmail.com>
Date: Tue, 5 Aug 2025 13:32:40 +0200
the default instance name has been renamed to admin
Diffstat:
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -1216,7 +1216,7 @@ Instance management
-------------------
Instances allow one merchant backend to be shared by multiple merchants.
-Every backend must have at least one instance, typically the "default"
+Every backend must have at least one instance, typically the "admin"
instance setup before it can be used to manage inventory or process payments.
@@ -1252,7 +1252,7 @@ Setting up instances
.. http:post:: /management/instances
This request will be used to create a new merchant instance in the backend.
- It is only available for the implicit ``default`` instance.
+ It is only available for the implicit ``admin`` instance.
**Required permission:** ``instances-write``
@@ -1331,7 +1331,7 @@ Setting up instances
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.
+ OR the ``admin`` instance, depending on the access path used.
**Required permission:** ``instances-auth-write``
@@ -1556,7 +1556,7 @@ Setting up instances
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, depending on the access path used.
+ OR the ``admin`` instance, depending on the access path used.
**Required permission:** ``instances-token-write``
@@ -1627,7 +1627,7 @@ Inspecting instances
.. http:get:: /management/instances
This is used to return the list of all the merchant instances.
- It is only available for the implicit ``default`` instance.
+ It is only available for the implicit ``admin`` instance.
**Required permission:** ``instances-read``
@@ -1684,7 +1684,7 @@ Inspecting instances
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.
+ OR the ``admin`` instance, depending on the access path used.
This endpoint may be used even when mandatory TAN channels
were not validated yet.
@@ -1930,11 +1930,11 @@ Deleting instances
This request will be used to delete (permanently disable)
or purge merchant instance in the backend. Purging will
delete all offers and payments associated with the instance,
- while disabling (the default) only deletes the private key
+ while disabling (the default behavior) only deletes the private key
and makes the instance unusable for new orders or payments.
For deletion, the authentication credentials must match
- the instance that is being deleted or the ``default``
+ the instance that is being deleted or the ``admin``
instance, depending on the access path used.
**Required permission:** ``instances-write``
@@ -1950,7 +1950,7 @@ Deleting instances
The backend has successfully removed the instance. The body is empty.
:http:statuscode:`401 Unauthorized`:
The request is unauthorized. Note that for already deleted instances,
- the request must be authorized using the ``default`` instance.
+ the request must be authorized using the ``admin`` instance.
:http:statuscode:`404 Not found`:
The instance is unknown to the backend.
:http:statuscode:`409 Conflict`:
