taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit 65517585508cfa6166e17d97cc42789cc471b254
parent dae5fc77d64ee72e83b52ced12e7f1d509a6a364
Author: Christian Grothoff <grothoff@gnunet.org>
Date:   Wed, 30 Aug 2023 21:18:29 +0200

otp -> otp-devices is clearer

Diffstat:
Mcore/api-merchant.rst | 33++++++++-------------------------
1 file changed, 8 insertions(+), 25 deletions(-)

diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -969,23 +969,6 @@ Setting up instances } - .. ts:def:: MerchantBankAccount - - interface MerchantBankAccount - // The payto:// URI where the wallet will send coins. - payto_uri: string; - - // Optional base URL for a facade where the - // merchant backend can see incoming wire - // transfers to reconcile its accounting - // with that of the exchange. Used by - // taler-merchant-wirewatch. - credit_facade_url?: string; - - // Credentials for accessing the credit facade. - credit_facade_credentials?: FacadeCredentials; - } - .. http:post:: /management/instances/$INSTANCE/auth .. http:post:: [/instances/$INSTANCE]/private/auth @@ -3010,7 +2993,7 @@ OTP devices can be used to allow offline merchants to validate that a customer made a payment. -.. http:post:: [/instances/$INSTANCE]/private/otp +.. http:post:: [/instances/$INSTANCE]/private/otp-devices This is used to associate an OTP device with an instance. @@ -3046,7 +3029,7 @@ to validate that a customer made a payment. } -.. http:patch:: [/instances/$INSTANCE]/private/otp/$DEVICE_ID +.. http:patch:: [/instances/$INSTANCE]/private/otp-devices/$DEVICE_ID This is used to update an OTP device. It is useful when we need to change information in the OTP device or when we have mistake some information. @@ -3082,7 +3065,7 @@ to validate that a customer made a payment. } -.. http:get:: [/instances/$INSTANCE]/private/otp +.. http:get:: [/instances/$INSTANCE]/private/otp-devices This is used to return the list of all the OTP devices. @@ -3097,8 +3080,8 @@ to validate that a customer made a payment. interface OtpDeviceSummaryResponse { - // List of devices that are present in our backend. - devices_list: OtpDeviceEntry[]; + // Array of devices that are present in our backend. + otp_devices: OtpDeviceEntry[]; } .. ts:def:: OtpDeviceEntry @@ -3106,13 +3089,13 @@ to validate that a customer made a payment. interface OtpDeviceEntry { // Device identifier. - device_id: string; + otp_device_id: string; // Human-readable description for the device. device_description: string; } -.. http:get:: [/instances/$INSTANCE]/private/otp/$DEVICE_ID +.. http:get:: [/instances/$INSTANCE]/private/otp-devices/$DEVICE_ID This is used to obtain detailed information about a specific OTP device. @@ -3140,7 +3123,7 @@ to validate that a customer made a payment. } -.. http:delete:: [/instances/$INSTANCE]/private/otp/$DEVICE_ID +.. http:delete:: [/instances/$INSTANCE]/private/otp-devices/$DEVICE_ID **Response:**