taler-docs

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

commit 98080756b2419ff5b75202a1257227739207576b
parent 9d62ae91b8d623e76ec847111013ac3fc08a1363
Author: Christian Grothoff <grothoff@gnunet.org>
Date:   Sat,  8 Nov 2025 08:17:40 +0100

fix #10562

Diffstat:
Mcore/api-common.rst | 12++++++------
Mcore/api-exchange.rst | 12++++++------
Mcore/api-mailbox.rst | 2+-
Mcore/api-merchant.rst | 32++++++++++++++++----------------
Mcore/api-sync.rst | 2+-
Mcore/api-taldir.rst | 2+-
6 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/core/api-common.rst b/core/api-common.rst @@ -100,7 +100,7 @@ handle the error as if an internal error (500) had been returned. // Numeric `error code <error-codes>` unique to the condition. // The other arguments are specific to the error value reported here. - code: number; + code: Integer; // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ... // Should give a human-readable hint about the error's nature. Optional, may change without notice! @@ -406,7 +406,7 @@ the range that is safely representable in JavaScript. // Subset of numbers: Integers in the // inclusive range 0 .. (2^53 - 1). - type SafeUint64 = number; + type SafeUint64 = Integer; Large numbers ^^^^^^^^^^^^^ @@ -436,7 +436,7 @@ Timestamps are represented by the following structure: // Seconds since epoch, or the special // value "never" to represent an event that will // never happen. - t_s: number | "never"; + t_s: Integer | "never"; } .. ts:def:: RelativeTime @@ -445,7 +445,7 @@ Timestamps are represented by the following structure: // Duration in microseconds or "forever" // to represent an infinite duration. Numeric // values are capped at 2^53 - 1 inclusive. - d_us: number | "forever"; + d_us: Integer | "forever"; } @@ -474,7 +474,7 @@ Ages .. ts:def:: Age // An age is an integer between 0 and 255 measured in years. - type Age = number; + type Age = Integer; .. ts:def:: AgeMask @@ -930,7 +930,7 @@ body. // Numeric `error code <error-codes>` unique to the condition. // Should always be ``TALER_EC_EXCHANGE_GENERIC_KYC_REQUIRED``. - code: number; + code: Integer; // Human-readable description of the error, i.e. "missing parameter", // "commitment violation", ... Should give a human-readable hint diff --git a/core/api-exchange.rst b/core/api-exchange.rst @@ -1477,7 +1477,7 @@ This part of the API is for the use by auditors interacting with the exchange. // Taler error code // ``TALER_EC_EXCHANGE_GENERIC_DENOMINATION_KEY_UNKNOWN`` - code: number; + code: Integer; // Signature by the exchange over a // `TALER_DenominationUnknownAffirmationPS`. @@ -1681,7 +1681,7 @@ exchange. // for the withdrawal and MUST set an appropriate value for ``max_age`` // The value represents a valid age group from the list of permissible // age groups as defined by the exchange's output to /keys. - maximum_age_group?: number; + maximum_age_group?: Integer; } @@ -1854,7 +1854,7 @@ exchange. // 2.) ``coin_evs`` MUST be an array of ``n*kappa`` // 3.) the denominations in ``denoms_h`` MUST support // age restriction. - max_age?: number; + max_age?: Integer; // Master seed for the Clause-Schnorr R-value creation. // MUST match the /blinding-prepare request. @@ -1954,7 +1954,7 @@ exchange. // - ``TALER_EC_EXCHANGE_GENERIC_DENOMINATION_VALIDITY_IN_FUTURE`` // - ``TALER_EC_EXCHANGE_GENERIC_DENOMINATION_EXPIRED`` // - ``TALER_EC_EXCHANGE_GENERIC_DENOMINATION_REVOKED`` - code: number; + code: Integer; // Signature by the exchange over a // `TALER_DenominationExpiredAffirmationPS`. @@ -2251,7 +2251,7 @@ Reserve History // If set, gives the maximum age group that the client is required to set // during withdrawal. - maximum_age_group: number; + maximum_age_group: Integer; // Transaction history for this reserve. // May be partial (!). @@ -3240,7 +3240,7 @@ proof to the seller for the escrow of sufficient fund. // - Type 2 refers to an auction with two winners, paying // the third-highest price, // - etc. - auction_type: number; + auction_type: Integer; // The vector of prices for the Brandt-Vickrey auction. The values MUST // be in strictly increasing order. diff --git a/core/api-mailbox.rst b/core/api-mailbox.rst @@ -125,7 +125,7 @@ Sending messages interface MailboxRateLimitedResponse { // Taler error code, TALER_EC_MAILBOX_DELIVERY_RATE_LIMITED. - code: number; + code: Integer; // When the client should retry. retry_delay: RelativeTime; diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -2133,7 +2133,7 @@ Getting statistics // Sum of all counters falling under the given // SLUG within this timeframe. - cumulative_counter: number; + cumulative_counter: Integer; } @@ -2148,7 +2148,7 @@ Getting statistics // Sum of all counters falling under the given // SLUG within this timeframe. - cumulative_counter: number; + cumulative_counter: Integer; } @@ -2298,7 +2298,7 @@ KYC status checks // HTTP status code returned by the exchange when we asked for // information about the KYC status. // Since protocol **v17**. - exchange_http_status: number; + exchange_http_status: Integer; // Set to true if we did not get a ``/keys`` response from // the exchange and thus cannot do certain checks, such as @@ -2314,7 +2314,7 @@ KYC status checks // returned, or TALER_EC_INVALID for none. // Optional (as there may not always have // been an error code). Since protocol **v17**. - exchange_code?: number; + exchange_code?: Integer; // Access token needed to open the KYC SPA and/or // access the ``/kyc-info/`` endpoint. @@ -3132,7 +3132,7 @@ Inspecting inventory interface MerchantPosProductDetail { // A unique numeric ID of the product - product_serial: number; + product_serial: Integer; // A merchant-internal unique identifier for the product. product_id: string; @@ -3143,7 +3143,7 @@ Inspecting inventory // A list of category IDs this product belongs to. // Typically, a product only belongs to one category, but more than one is supported. - categories: number[]; + categories: Integer[]; // Human-readable product description. description: string; @@ -3190,7 +3190,7 @@ Inspecting inventory interface MerchantCategory { // A unique numeric ID of the category - id: number; + id: Integer; // The name of the category. This will be shown to users and used in the order summary. name: string; @@ -3757,7 +3757,7 @@ Inspecting orders order_id: string; // Row ID of the order in the database. - row_id: number; + row_id: Integer; // When the order was created. timestamp: Timestamp; @@ -3839,12 +3839,12 @@ Inspecting orders // encountered tracking the wire transfer for this purchase (before // we even got to specific coin issues). // 0 if there were no issues. - exchange_code: number; + exchange_code: Integer; // HTTP status code returned by the exchange when we asked for // information to track the wire transfer for this purchase. // 0 if there were no issues. - exchange_http_status: number; + exchange_http_status: Integer; // Total amount that was refunded, 0 if refunded is false. refund_amount: Amount; @@ -3974,16 +3974,16 @@ Inspecting orders interface TransactionWireReport { // Numerical `error code <error-codes>`. - code: number; + code: Integer; // Human-readable error description. hint: string; // Numerical `error code <error-codes>` from the exchange. - exchange_code: number; + exchange_code: Integer; // HTTP status code received from the exchange. - exchange_http_status: number; + exchange_http_status: Integer; // Public key of the coin for which we got the exchange error. coin_pub: CoinPublicKey; @@ -4253,7 +4253,7 @@ Querying known wire transfers // Serial number identifying the transfer in the merchant backend. // Used for filtering via ``offset``. - transfer_serial_id: number; + transfer_serial_id: Integer; // Time of the execution of the wire transfer. execution_time: Timestamp; @@ -4338,7 +4338,7 @@ Querying expected wire transfers // Serial number identifying the expected transfer in the backend. // Used for filtering via ``offset``. - expected_transfer_serial_id: number; + expected_transfer_serial_id: Integer; // Expected time of the execution of the wire transfer // by the exchange, according to the exchange. @@ -4360,7 +4360,7 @@ Querying expected wire transfers // Last HTTP status we received from the exchange, 0 for // none (incl. timeout) - last_http_status: number; + last_http_status: Integer; // Last Taler error code we got from the exchange. last_ec: ErrorCode; diff --git a/core/api-sync.rst b/core/api-sync.rst @@ -128,7 +128,7 @@ Receiving Configuration name: "sync"; // Maximum backup size supported. - storage_limit_in_megabytes: number; + storage_limit_in_megabytes: Integer; // Fee for an account, per year. annual_fee: Amount; diff --git a/core/api-taldir.rst b/core/api-taldir.rst @@ -151,7 +151,7 @@ Alias registration interface RateLimitedResponse { // Taler error code, TALER_EC_TALDIR_REGISTER_RATE_LIMITED. - code: number; + code: Integer; // At what frequency are new registrations allowed. request_frequency: RelativeTime;