diff options
author | Martin Schanzenbach <mschanzenbach@posteo.de> | 2020-09-16 11:31:06 +0200 |
---|---|---|
committer | Martin Schanzenbach <mschanzenbach@posteo.de> | 2020-09-16 11:31:06 +0200 |
commit | 11ca00cdfc9150d299e600a6787b9bb22c34ee75 (patch) | |
tree | 1c6f366e78e1a3960ea2582bdc6a9a8a1c5dde09 | |
parent | 83a6c2d7a784f79cae448f283ccb4a1460f1ca9d (diff) | |
download | gnunet-rest-api-11ca00cdfc9150d299e600a6787b9bb22c34ee75.tar.gz gnunet-rest-api-11ca00cdfc9150d299e600a6787b9bb22c34ee75.zip |
update to recent API change in 0.13.3
-rw-r--r-- | source/conf.py | 2 | ||||
-rw-r--r-- | source/reclaim.rst | 44 |
2 files changed, 23 insertions, 23 deletions
diff --git a/source/conf.py b/source/conf.py index f8cb651..28b0aad 100644 --- a/source/conf.py +++ b/source/conf.py | |||
@@ -26,7 +26,7 @@ author = 'Philippe Buschmann, Martin Schanzenbach' | |||
26 | # The short X.Y version | 26 | # The short X.Y version |
27 | version = '0.13' | 27 | version = '0.13' |
28 | # The full version, including alpha/beta/rc tags | 28 | # The full version, including alpha/beta/rc tags |
29 | release = '0.13.0' | 29 | release = '0.13.3' |
30 | 30 | ||
31 | 31 | ||
32 | # -- General configuration --------------------------------------------------- | 32 | # -- General configuration --------------------------------------------------- |
diff --git a/source/reclaim.rst b/source/reclaim.rst index 70f959f..5288391 100644 --- a/source/reclaim.rst +++ b/source/reclaim.rst | |||
@@ -8,16 +8,16 @@ Variables in single quotes ``'...'`` can or must be changed according to your sp | |||
8 | 8 | ||
9 | ``ego`` is the name of an identity. | 9 | ``ego`` is the name of an identity. |
10 | 10 | ||
11 | ``name`` is the attribute or attestation name. | 11 | ``name`` is the attribute or credential name. |
12 | 12 | ||
13 | ``value`` is the attribute or attestation value. | 13 | ``value`` is the attribute or credential value. |
14 | 14 | ||
15 | ``type`` is the attribute or attestation type. | 15 | ``type`` is the attribute or credential type. |
16 | 16 | ||
17 | ``id`` is the attribute or attestation ID. This ID is the name under which the attribute can | 17 | ``id`` is the attribute or credential ID. This ID is the name under which the attribute can |
18 | be found in the namestore. | 18 | be found in the namestore. |
19 | 19 | ||
20 | ``attestation`` is the attestation id corresponding to an attribute. | 20 | ``credential`` is the credential ID corresponding to an attribute. |
21 | 21 | ||
22 | ``flag`` is the attribute flag. It provides insights, whether the attribute is | 22 | ``flag`` is the attribute flag. It provides insights, whether the attribute is |
23 | third-party attested. | 23 | third-party attested. |
@@ -29,11 +29,11 @@ An ``Attribute`` JSON object is defined as follows :: | |||
29 | "name": string, | 29 | "name": string, |
30 | "type": string, | 30 | "type": string, |
31 | "value": string, | 31 | "value": string, |
32 | "attestation": string, | 32 | "credential": string, |
33 | "flag": string | 33 | "flag": string |
34 | } | 34 | } |
35 | 35 | ||
36 | An ``Attestation`` JSON object is defined as follows :: | 36 | A ``Credential`` JSON object is defined as follows :: |
37 | 37 | ||
38 | { | 38 | { |
39 | "id": string, | 39 | "id": string, |
@@ -43,7 +43,7 @@ An ``Attestation`` JSON object is defined as follows :: | |||
43 | "attributes": Attribute[] | 43 | "attributes": Attribute[] |
44 | } | 44 | } |
45 | 45 | ||
46 | the ``attributes`` property can be omitted when modifying an attestation. | 46 | the ``attributes`` property can be omitted when modifying a credential. |
47 | It will be populated in read requests for convenience only. | 47 | It will be populated in read requests for convenience only. |
48 | 48 | ||
49 | A ``Ticket`` JSON object is defined as follows :: | 49 | A ``Ticket`` JSON object is defined as follows :: |
@@ -99,13 +99,13 @@ Requests | |||
99 | Attribute Management | 99 | Attribute Management |
100 | -------------------- | 100 | -------------------- |
101 | 101 | ||
102 | In order to add a self-asserted attribute make sure "attestation" is empty | 102 | In order to add a self-asserted attribute make sure "credential" is empty |
103 | and specity the attribute value in the "value" parameter. | 103 | and specity the attribute value in the "value" parameter. |
104 | 104 | ||
105 | In order to add an attribute which is attested by an attestation, add the id | 105 | In order to add an attribute which is attested by a credential, add the id |
106 | of the attestation to the "attestation" field and specify the attribute in the | 106 | of the credential to the "credential" field and specify the attribute in the |
107 | attestation as attribute "value". | 107 | credential as attribute "value". |
108 | The attestation must exist. | 108 | The credential must exist. |
109 | 109 | ||
110 | +--------------------+---------------------------------------------------------------+ | 110 | +--------------------+---------------------------------------------------------------+ |
111 | |**Title** |Returns all attributes for an identity | | 111 | |**Title** |Returns all attributes for an identity | |
@@ -162,13 +162,13 @@ The attestation must exist. | |||
162 | |**Error Response** | {"error":"*error_desc*"} :sup:`2; 5` | | 162 | |**Error Response** | {"error":"*error_desc*"} :sup:`2; 5` | |
163 | +--------------------+---------------------------------------------------------------+ | 163 | +--------------------+---------------------------------------------------------------+ |
164 | 164 | ||
165 | Attestation Management | 165 | Credential Management |
166 | ---------------------- | 166 | ---------------------- |
167 | 167 | ||
168 | +--------------------+---------------------------------------------------------------+ | 168 | +--------------------+---------------------------------------------------------------+ |
169 | |**Title** |Returns all attestations for an identity | | 169 | |**Title** |Returns all credentials for an identity | |
170 | +--------------------+---------------------------------------------------------------+ | 170 | +--------------------+---------------------------------------------------------------+ |
171 | |**URL** |:literal:`/reclaim/attestation/'ego'` | | 171 | |**URL** |:literal:`/reclaim/credential/'ego'` | |
172 | +--------------------+---------------------------------------------------------------+ | 172 | +--------------------+---------------------------------------------------------------+ |
173 | |**Method** |**GET** | | 173 | |**Method** |**GET** | |
174 | +--------------------+---------------------------------------------------------------+ | 174 | +--------------------+---------------------------------------------------------------+ |
@@ -176,7 +176,7 @@ Attestation Management | |||
176 | +--------------------+---------------------------------------------------------------+ | 176 | +--------------------+---------------------------------------------------------------+ |
177 | |**Data Params** |none | | 177 | |**Data Params** |none | |
178 | +--------------------+---------------------------------------------------------------+ | 178 | +--------------------+---------------------------------------------------------------+ |
179 | |**Success Response**|``Attestation[]`` | | 179 | |**Success Response**|``Credential[]`` | |
180 | +--------------------+---------------------------------------------------------------+ | 180 | +--------------------+---------------------------------------------------------------+ |
181 | |**Error Response** | {"error":"*error_desc*"} :sup:`2` | | 181 | |**Error Response** | {"error":"*error_desc*"} :sup:`2` | |
182 | +--------------------+---------------------------------------------------------------+ | 182 | +--------------------+---------------------------------------------------------------+ |
@@ -186,15 +186,15 @@ Attestation Management | |||
186 | | | 186 | | |
187 | 187 | ||
188 | +--------------------+----------------------------------------------------------------+ | 188 | +--------------------+----------------------------------------------------------------+ |
189 | |**Title** |Add an attestation to an identity | | 189 | |**Title** |Add a credential to an identity | |
190 | +--------------------+----------------------------------------------------------------+ | 190 | +--------------------+----------------------------------------------------------------+ |
191 | |**URL** |:literal:`/reclaim/attestation/'ego'` | | 191 | |**URL** |:literal:`/reclaim/credential/'ego'` | |
192 | +--------------------+----------------------------------------------------------------+ | 192 | +--------------------+----------------------------------------------------------------+ |
193 | |**Method** |**POST** | | 193 | |**Method** |**POST** | |
194 | +--------------------+----------------------------------------------------------------+ | 194 | +--------------------+----------------------------------------------------------------+ |
195 | |**URL Params** |none | | 195 | |**URL Params** |none | |
196 | +--------------------+----------------------------------------------------------------+ | 196 | +--------------------+----------------------------------------------------------------+ |
197 | |**Data Params** |``Attestation`` | | 197 | |**Data Params** |``Credential`` | |
198 | +--------------------+----------------------------------------------------------------+ | 198 | +--------------------+----------------------------------------------------------------+ |
199 | |**Success Response**|Response Code: :literal:` b) 200 OK` | | 199 | |**Success Response**|Response Code: :literal:` b) 200 OK` | |
200 | +--------------------+----------------------------------------------------------------+ | 200 | +--------------------+----------------------------------------------------------------+ |
@@ -204,9 +204,9 @@ Attestation Management | |||
204 | | | 204 | | |
205 | 205 | ||
206 | +--------------------+---------------------------------------------------------------+ | 206 | +--------------------+---------------------------------------------------------------+ |
207 | |**Title** |Delete an attestation from an identity | | 207 | |**Title** |Delete a credential from an identity | |
208 | +--------------------+---------------------------------------------------------------+ | 208 | +--------------------+---------------------------------------------------------------+ |
209 | |**URL** |:literal:`/reclaim/attestation/'ego'/'id'` | | 209 | |**URL** |:literal:`/reclaim/credential/'ego'/'id'` | |
210 | +--------------------+---------------------------------------------------------------+ | 210 | +--------------------+---------------------------------------------------------------+ |
211 | |**Method** |**DELETE** | | 211 | |**Method** |**DELETE** | |
212 | +--------------------+---------------------------------------------------------------+ | 212 | +--------------------+---------------------------------------------------------------+ |