commit 40da19ea5bbdef083b6dccf016fd06e132db41a6
parent 46408ec089e4c4ae1ef5632ed332621ea61e9a04
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Mon, 23 Jun 2025 12:10:04 +0200
fix indentation
Diffstat:
| M | core/api-merchant.rst | | | 78 | ++++++++++++++++++++++++++++++++++++++++-------------------------------------- |
1 file changed, 40 insertions(+), 38 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -1165,6 +1165,8 @@ Setting up instances
**Request** the request must be an `InstanceAuthConfigurationMessage`.
+ **Response:**
+
:http:statuscode:`204 No content`:
The backend has successfully created the instance.
:http:statuscode:`404 Not found`:
@@ -1205,13 +1207,14 @@ Setting up instances
.. http:post:: [/instances/$INSTANCE]/private/token
- Retrieve an access token for the merchant API for instance
- ``$INSTANCE```.
- When accessed with a Bearer token for authentication, the token
- must have scope ```token-refresh`` and the requested scope must be a subset
- of the scope of the token.
- When accessed with Basic authentication the instance password must be provided
- along with ``$INSTANCE`` as username.
+ Retrieve an access token for the merchant API for instance
+ ``$INSTANCE```.
+ When accessed with a Bearer token for authentication, the token
+ must have scope ```token-refresh`` and the requested scope must be a subset
+ of the scope of the token.
+ When accessed with Basic authentication the instance password must be provided
+ along with ``$INSTANCE`` as username.
+
**Required permission:** ``token-refresh`` if accessed using a Bearer token.
@@ -1225,46 +1228,45 @@ Setting up instances
The backend is returning the access token in a
`LoginTokenSuccessResponse`.
- **Details:**
-
- .. ts:def:: LoginTokenRequest
+ **Details:**
- interface LoginTokenRequest {
- // Scope of the token (which kinds of operations it will allow)
- scope: "readonly" | "write" | "all" | "order-simple" | "order-pos" | "order-mgmt" | "order-full";
+ .. ts:def:: LoginTokenRequest
- // Server may impose its own upper bound
- // on the token validity duration
- duration?: RelativeTime;
+ interface LoginTokenRequest {
+ // Scope of the token (which kinds of operations it will allow)
+ scope: "readonly" | "write" | "all" | "order-simple" | "order-pos" | "order-mgmt" | "order-full";
- // Can this token be refreshed?
- // Defaults to false. Deprecated since **v19**.
- // Use ":refreshable" scope prefix instead.
- refreshable?: boolean;
- }
+ // Server may impose its own upper bound
+ // on the token validity duration
+ duration?: RelativeTime;
- .. ts:def:: LoginTokenSuccessResponse
+ // Can this token be refreshed?
+ // Defaults to false. Deprecated since **v19**.
+ // Use ":refreshable" scope prefix instead.
+ refreshable?: boolean;
+ }
- interface LoginTokenSuccessResponse {
- // deprecated. See access_token
- token: string;
+ .. ts:def:: LoginTokenSuccessResponse
- // The login token that can be used to access resources
- // that are in scope for some time. Must be prefixed
- // with "Bearer " when used in the "Authorization" HTTP header.
- // Will already begin with the RFC 8959 prefix.
- access_token: string;
+ interface LoginTokenSuccessResponse {
+ // deprecated. See access_token
+ token: string;
- // Scope of the token (which kinds of operations it will allow)
- scope: "readonly" | "write" | "all" | "order-simple" | "order-pos" | "order-mgmt" | "order-full";
+ // The login token that can be used to access resources
+ // that are in scope for some time. Must be prefixed
+ // with "Bearer " when used in the "Authorization" HTTP header.
+ // Will already begin with the RFC 8959 prefix.
+ access_token: string;
+ // Scope of the token (which kinds of operations it will allow)
+ scope: "readonly" | "write" | "all" | "order-simple" | "order-pos" | "order-mgmt" | "order-full";
- // Server may impose its own upper bound
- // on the token validity duration
- expiration: Timestamp;
+ // Server may impose its own upper bound
+ // on the token validity duration
+ expiration: Timestamp;
- // Can this token be refreshed?
- refreshable: boolean;
- }
+ // Can this token be refreshed?
+ refreshable: boolean;
+ }
.. http:get:: [/instances/$INSTANCE]/private/tokens
