taler-docs

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

commit 874bca09e7d87567bba4a1456c0add7180ead9a2
parent cba57e82a38cd2b8b33c9b6ad973da65712657e5
Author: Christian Grothoff <christian@grothoff.org>
Date:   Mon, 16 Sep 2024 13:30:44 +0200

-typos

Diffstat:
Mcore/api-challenger.rst | 28++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/core/api-challenger.rst b/core/api-challenger.rst @@ -122,7 +122,7 @@ Receiving Configuration // @since v0, may become mandatory in the future. implementation?: string; - // @since v2. + // @since **v2**. // Object; map of keys (names of the fields of the address // to be entered by the user) to objects with a "regex" (string) // containing an extended Posix regular expression for allowed @@ -133,7 +133,7 @@ Receiving Configuration // the user. See "ADDRESS_RESTRICTIONS" in the challenger configuration. restrictions: Object; - // @since v2. + // @since **v2**. address_type: "email" | "phone"; } @@ -194,8 +194,8 @@ Login :query redirect_uri: URI-encoded redirection URI to use upon authorization. :query state: Arbitrary client state to associate with the request. :query scope: Not supported, any value is accepted. - :query code_challenge: A string to enhance security using PKCE (available since v3). - :query code_challenge_method: The method used for the code_challenge. Options are S256 (SHA-256) or plain (available since v3). + :query code_challenge: A string to enhance security using PKCE (available since **v3**). + :query code_challenge_method: The method used for the code_challenge. Options are S256 (SHA-256) or plain (available since **v3**). **Response:** @@ -221,7 +221,7 @@ Login .. ts:def:: ChallengeStatus interface ChallengeStatus { - // @deprecated since v2, use /config + // @deprecated since **v2**, use /config restrictions?: Object; // indicates if the given address cannot be changed anymore, the @@ -242,19 +242,19 @@ Login // when we would re-transmit the challenge the next // time (at the earliest) if requested by the user // only present if challenge already created - // @since v2 + // @since **v2** retransmission_time: Timestamp; // how many times might the PIN still be retransmitted // how many times might the PIN still be retransmitted // only present if challenge already created - // @since v2 + // @since **v2** pin_transmissions_left?: Integer; // how many times might the user still try entering the PIN code // only present if challenge already created - // @since v2 + // @since **v2** auth_attempts_left?: Integer; } @@ -317,7 +317,7 @@ Challenge .. ts:def:: ChallengeRedirect - // @since v2 + // @since **v2** interface ChallengeRedirect { // Union discriminator field. type: "completed"; @@ -345,12 +345,12 @@ Challenge // might make a useful hint to the user transmitted: boolean; - // @deprecated in v2, use retransmission_time + // @deprecated in **v2**, use retransmission_time next_tx_time?: string; // when we would re-transmit the challenge the next // time (at the earliest) if requested by the user - // @since v2 + // @since **v2** retransmission_time: Timestamp; } @@ -469,7 +469,7 @@ Auth ``authorization_code``. The ``redirect_uri`` must match the URI from ``/authorize``. The ``code`` must be the authorization code that ``/solve`` returned to the user. The ``client_id`` and ``client_secret`` must match - the usual client credentials. Since version v3, ``code_verifier`` can also be included. + the usual client credentials. Since protocol **v3**, ``code_verifier`` can also be included. **Response:** @@ -478,8 +478,8 @@ Auth :http:statuscode:`200 OK`: The body will be a `ChallengerAuthResponse` - :http:statuscode:`401 Unathorized`: - The ``code_verifier`` is not matching the saved ones. (Since v3) + :http:statuscode:`401 Unauthorized`: + The ``code_verifier`` is not matching the saved ones. (Since **v3**) :http:statuscode:`403 Forbidden`: The credentials of the client are invalid. :http:statuscode:`404 Not found`: