get-config.rst (1937B)
1 .. http:get:: /config 2 3 Obtain the key configuration settings of the storage service. 4 5 **Response:** 6 7 :http:statuscode:`200 OK`: 8 Response is a `ChallengerConfigurationResponse`. 9 10 .. ts:def:: ChallengerConfigurationResponse 11 12 interface ChallengerConfigurationResponse { 13 // Name of the service 14 name: "challenger"; 15 16 // libtool-style representation of the Challenger protocol version, see 17 // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning 18 // The format is "current:revision:age". 19 version: string; 20 21 // URN of the implementation (needed to interpret 'revision' in version). 22 // @since v0, may become mandatory in the future. 23 implementation?: string; 24 25 // @since **v2**. 26 // Object; map of keys (names of the fields of the address 27 // to be entered by the user) to objects with a "regex" (string) 28 // containing an extended Posix regular expression for allowed 29 // address field values, and a "hint"/"hint_i18n" giving a 30 // human-readable explanation to display if the value entered 31 // by the user does not match the regex. Keys that are not mapped 32 // to such an object have no restriction on the value provided by 33 // the user. See "ADDRESS_RESTRICTIONS" in the challenger configuration. 34 restrictions: Object; 35 36 // @since **v6** 37 // Defines the set of fields asked to the user. 38 // The field names are registered via GANA at 39 // https://git.taler.net/gana.git/tree/gnu-taler-form-attributes 40 // email: CONTACT_EMAIL 41 // phone: CONTACT_PHONE 42 // postal: CONTACT_NAME, ADDRESS_LINES, ADDRESS_COUNTRY 43 // postal-ch: CONTACT_NAME, ADDRESS_LINES 44 address_type: "email" | "phone" | "postal" | "postal-ch"; 45 46 // Hint to show in the address bar for the user as an example for 47 // the format of the address. 48 address_hint: string; 49 }