summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhil <phil.buschmann@tum.de>2018-08-10 03:40:54 +0200
committerPhil <phil.buschmann@tum.de>2018-08-10 03:40:54 +0200
commitf61530615e0be70e389a5f84006ad047a1a7168c (patch)
tree92594df8742b50f471b360124f9fcf40457b25c4
parent804493770fe509e3abff60e16e93429e06ad593c (diff)
downloadgnunet-rest-api-f61530615e0be70e389a5f84006ad047a1a7168c.tar.gz
gnunet-rest-api-f61530615e0be70e389a5f84006ad047a1a7168c.zip
Changed identity, wip namestore
Diffstat
-rw-r--r--source/identity.rst232
-rw-r--r--source/namestore.rst120
2 files changed, 192 insertions, 160 deletions
diff --git a/source/identity.rst b/source/identity.rst
index 79120c3..dd68fae 100644
--- a/source/identity.rst
+++ b/source/identity.rst
@@ -16,7 +16,7 @@ GET Requests
16+--------------------+---------------------------------------------------------------+ 16+--------------------+---------------------------------------------------------------+
17|**Title** |Returns all identities with name and public key | 17|**Title** |Returns all identities with name and public key |
18+--------------------+---------------------------------------------------------------+ 18+--------------------+---------------------------------------------------------------+
19|**URL** |:literal:`/identity` | 19|**URL** |:literal:`/identity/all` |
20+--------------------+---------------------------------------------------------------+ 20+--------------------+---------------------------------------------------------------+
21|**Method** |**GET** | 21|**Method** |**GET** |
22+--------------------+---------------------------------------------------------------+ 22+--------------------+---------------------------------------------------------------+
@@ -28,49 +28,33 @@ GET Requests
28+--------------------+---------------------------------------------------------------+ 28+--------------------+---------------------------------------------------------------+
29|**Error Response** |{"error":"*error_desc*"} | 29|**Error Response** |{"error":"*error_desc*"} |
30+--------------------+---------------------------------------------------------------+ 30+--------------------+---------------------------------------------------------------+
31|**Attention** | The response in this request is an array! |
32+--------------------+---------------------------------------------------------------+
31 33
32| 34|
33 35
34+--------------------+----------------------------------------------------+ 36+--------------------+----------------------------------------------------------------+
35|**Title** |Returns only a specific identity | 37|**Title** |Returns only a specific identity |
36+--------------------+----------------------------------------------------+ 38+--------------------+----------------------------------------------------------------+
37|**URL** |:literal:`/identity?pubkey='public_key'` | 39|**URL** | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
38+--------------------+----------------------------------------------------+ 40+--------------------+----------------------------------------------------------------+
39|**Method** |**GET** | 41|**Method** |**GET** |
40+--------------------+----------------------------------------------------+ 42+--------------------+----------------------------------------------------------------+
41|**URL Params** |none | 43|**URL Params** |none |
42+--------------------+----------------------------------------------------+ 44+--------------------+----------------------------------------------------------------+
43|**Data Params** |none | 45|**Data Params** |none |
44+--------------------+----------------------------------------------------+ 46+--------------------+----------------------------------------------------------------+
45|**Success Response**|[{"pubkey":"*public_key*", "name":"*name*"}] | 47|**Success Response**|{"pubkey":"*public_key*", "name":"*name*"} |
46+--------------------+----------------------------------------------------+ 48+--------------------+----------------------------------------------------------------+
47|**Error Response** |{"error":"*error_desc*"} | 49|**Error Response** |{"error":"*error_desc*"} |
48+--------------------+----------------------------------------------------+ 50+--------------------+----------------------------------------------------------------+
49
50|
51
52+--------------------+----------------------------------------------------+
53|**Title** |Returns only a specific identity |
54+--------------------+----------------------------------------------------+
55|**URL** |:literal:`/identity?name='name'` |
56+--------------------+----------------------------------------------------+
57|**Method** |**GET** |
58+--------------------+----------------------------------------------------+
59|**URL Params** |none |
60+--------------------+----------------------------------------------------+
61|**Data Params** |none |
62+--------------------+----------------------------------------------------+
63|**Success Response**|[{"pubkey":"*public_key*", "name":"*name*"}] |
64+--------------------+----------------------------------------------------+
65|**Error Response** |{"error":"*error_desc*"} |
66+--------------------+----------------------------------------------------+
67 51
68| 52|
69 53
70+--------------------+---------------------------------------------------------------+ 54+--------------------+---------------------------------------------------------------+
71|**Title** |Returns default identity for specific subsystem | 55|**Title** |Returns default identity for specific subsystem |
72+--------------------+---------------------------------------------------------------+ 56+--------------------+---------------------------------------------------------------+
73|**URL** |:literal:`/identity?subsystem='subsystem'` | 57|**URL** |:literal:`/identity/subsystem/'subsystem'` |
74+--------------------+---------------------------------------------------------------+ 58+--------------------+---------------------------------------------------------------+
75|**Method** |**GET** | 59|**Method** |**GET** |
76+--------------------+---------------------------------------------------------------+ 60+--------------------+---------------------------------------------------------------+
@@ -82,8 +66,6 @@ GET Requests
82+--------------------+---------------------------------------------------------------+ 66+--------------------+---------------------------------------------------------------+
83|**Error Response** |{"error":"*error_desc*"} | 67|**Error Response** |{"error":"*error_desc*"} |
84+--------------------+---------------------------------------------------------------+ 68+--------------------+---------------------------------------------------------------+
85|**Attention** |The response in this request is NOT an array! |
86+--------------------+---------------------------------------------------------------+
87 69
88 70
89POST Request 71POST Request
@@ -110,134 +92,68 @@ POST Request
110PUT Request 92PUT Request
111----------- 93-----------
112 94
113+--------------------+----------------------------------------------------+ 95+--------------------+----------------------------------------------------------------+
114|**Title** |Changes name of identity | 96|**Title** |Changes name of identity |
115+--------------------+----------------------------------------------------+ 97+--------------------+----------------------------------------------------------------+
116|**URL** |:literal:`/identity` | 98|**URL** | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
117+--------------------+----------------------------------------------------+ 99+--------------------+----------------------------------------------------------------+
118|**Method** |**PUT** | 100|**Method** |**PUT** |
119+--------------------+----------------------------------------------------+ 101+--------------------+----------------------------------------------------------------+
120|**URL Params** |none | 102|**URL Params** |none |
121+--------------------+----------------------------------------------------+ 103+--------------------+----------------------------------------------------------------+
122|**Data Params** | {"newname":'*newname*', "pubkey": '*public_key*'} | 104|**Data Params** | {"newname":'*newname*'} |
123+--------------------+----------------------------------------------------+ 105+--------------------+----------------------------------------------------------------+
124|**Success Response**|Response Code: :literal:`204` (No Content) | 106|**Success Response**|Response Code: :literal:`204` (No Content) |
125+--------------------+----------------------------------------------------+ 107+--------------------+----------------------------------------------------------------+
126|**Error Response** | | {"error":"*error_desc*"} | 108|**Error Response** | | {"error":"*error_desc*"} |
127| | | *or* | 109| | | *or* |
128| | | Response Code: :literal:`404` (Not Found) | 110| | | Response Code: :literal:`404` (Not Found) |
129| | | *or* | 111| | | *or* |
130| | | Response Code: :literal:`409` (Conflict) | 112| | | Response Code: :literal:`409` (Conflict) |
131+--------------------+----------------------------------------------------+ 113+--------------------+----------------------------------------------------------------+
132
133|
134
135+--------------------+----------------------------------------------------+
136|**Title** |Changes name of identity |
137+--------------------+----------------------------------------------------+
138|**URL** |:literal:`/identity` |
139+--------------------+----------------------------------------------------+
140|**Method** |**PUT** |
141+--------------------+----------------------------------------------------+
142|**URL Params** |none |
143+--------------------+----------------------------------------------------+
144|**Data Params** | {"newname":'*newname*', "name": '*name*'} |
145+--------------------+----------------------------------------------------+
146|**Success Response**|Response Code: :literal:`204` (No Content) |
147+--------------------+----------------------------------------------------+
148|**Error Response** | | {"error":"*error_desc*"} |
149| | | *or* |
150| | | Response Code: :literal:`404` (Not Found) |
151| | | *or* |
152| | | Response Code: :literal:`409` (Conflict) |
153+--------------------+----------------------------------------------------+
154
155|
156
157+--------------------+------------------------------------------------------+
158|**Title** |Sets identity as default for a subsystem |
159+--------------------+------------------------------------------------------+
160|**URL** |:literal:`/identity` |
161+--------------------+------------------------------------------------------+
162|**Method** |**PUT** |
163+--------------------+------------------------------------------------------+
164|**URL Params** |none |
165+--------------------+------------------------------------------------------+
166|**Data Params** | {"subsystem":'*subsystem*', "pubkey": '*public_key*'}|
167+--------------------+------------------------------------------------------+
168|**Success Response**|Response Code: :literal:`204` (No Content) |
169+--------------------+------------------------------------------------------+
170|**Error Response** | | {"error":"*error_desc*"} |
171| | | *or* |
172| | | Response Code: :literal:`404` (Not Found) |
173| | | *or* |
174| | | Response Code: :literal:`409` (Conflict) |
175+--------------------+------------------------------------------------------+
176 114
177| 115|
178 116
179+--------------------+----------------------------------------------------+ 117+--------------------+----------------------------------------------------------------+
180|**Title** |Sets identity as default for a subsystem | 118|**Title** |Sets identity as default for a subsystem |
181+--------------------+----------------------------------------------------+ 119+--------------------+----------------------------------------------------------------+
182|**URL** |:literal:`/identity` | 120|**URL** | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
183+--------------------+----------------------------------------------------+ 121+--------------------+----------------------------------------------------------------+
184|**Method** |**PUT** | 122|**Method** |**PUT** |
185+--------------------+----------------------------------------------------+ 123+--------------------+----------------------------------------------------------------+
186|**URL Params** |none | 124|**URL Params** |none |
187+--------------------+----------------------------------------------------+ 125+--------------------+----------------------------------------------------------------+
188|**Data Params** | {"subsystem":'*subsystem*', "name": '*name*'} | 126|**Data Params** | {"subsystem":'*subsystem*'} |
189+--------------------+----------------------------------------------------+ 127+--------------------+----------------------------------------------------------------+
190|**Success Response**|Response Code: :literal:`204` (No Content) | 128|**Success Response**|Response Code: :literal:`204` (No Content) |
191+--------------------+----------------------------------------------------+ 129+--------------------+----------------------------------------------------------------+
192|**Error Response** | | {"error":"*error_desc*"} | 130|**Error Response** | | {"error":"*error_desc*"} |
193| | | *or* | 131| | | *or* |
194| | | Response Code: :literal:`404` (Not Found) | 132| | | Response Code: :literal:`404` (Not Found) |
195| | | *or* | 133| | | *or* |
196| | | Response Code: :literal:`409` (Conflict) | 134| | | Response Code: :literal:`409` (Conflict) |
197+--------------------+----------------------------------------------------+ 135+--------------------+----------------------------------------------------------------+
198
199 136
200DELETE Request 137DELETE Request
201-------------- 138--------------
202 139
203+--------------------+----------------------------------------------------+ 140+--------------------+----------------------------------------------------------------+
204|**Title** |Deletes specific identity | 141|**Title** |Deletes specific identity |
205+--------------------+----------------------------------------------------+ 142+--------------------+----------------------------------------------------------------+
206|**URL** |:literal:`/identity?pubkey='public_key'` | 143|**URL** | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
207+--------------------+----------------------------------------------------+ 144+--------------------+----------------------------------------------------------------+
208|**Method** |**DELETE** | 145|**Method** |**DELETE** |
209+--------------------+----------------------------------------------------+ 146+--------------------+----------------------------------------------------------------+
210|**URL Params** |none | 147|**URL Params** |none |
211+--------------------+----------------------------------------------------+ 148+--------------------+----------------------------------------------------------------+
212|**Data Params** |none | 149|**Data Params** |none |
213+--------------------+----------------------------------------------------+ 150+--------------------+----------------------------------------------------------------+
214|**Success Response**|Response Code: :literal:`204` (No Content) | 151|**Success Response**|Response Code: :literal:`204` (No Content) |
215+--------------------+----------------------------------------------------+ 152+--------------------+----------------------------------------------------------------+
216|**Error Response** | | {"error":"*error_desc*"} | 153|**Error Response** | | {"error":"*error_desc*"} |
217| | | *or* | 154| | | *or* |
218| | | Response Code: :literal:`404` (Not Found) | 155| | | Response Code: :literal:`404` (Not Found) |
219+--------------------+----------------------------------------------------+ 156+--------------------+----------------------------------------------------------------+
220
221|
222
223+--------------------+----------------------------------------------------+
224|**Title** |Deletes specific identity |
225+--------------------+----------------------------------------------------+
226|**URL** |:literal:`/identity?name='name'` |
227+--------------------+----------------------------------------------------+
228|**Method** |**DELETE** |
229+--------------------+----------------------------------------------------+
230|**URL Params** |none |
231+--------------------+----------------------------------------------------+
232|**Data Params** |none |
233+--------------------+----------------------------------------------------+
234|**Success Response**|Response Code: :literal:`204` (No Content) |
235+--------------------+----------------------------------------------------+
236|**Error Response** | | {"error":"*error_desc*"} |
237| | | *or* |
238| | | Response Code: :literal:`404` (Not Found) |
239+--------------------+----------------------------------------------------+
240
241 157
242OPTIONS Request 158OPTIONS Request
243--------------- 159---------------
diff --git a/source/namestore.rst b/source/namestore.rst
index 35eb104..cd2be42 100644
--- a/source/namestore.rst
+++ b/source/namestore.rst
@@ -3,7 +3,7 @@ GNUnet Namestore API Service
3 3
4Variables in single quotes ``'...'`` can or must be changed according to your specific case. 4Variables in single quotes ``'...'`` can or must be changed according to your specific case.
5 5
6Namestore communicates with GNS records. 6Namestore communicates with GNS records:
7 7
8``type`` is the type of the record, e.g. "PKEY" for private key. Possible types are listed in :ref:`ref-type`. 8``type`` is the type of the record, e.g. "PKEY" for private key. Possible types are listed in :ref:`ref-type`.
9 9
@@ -15,14 +15,20 @@ Namestore communicates with GNS records.
15 15
16``label`` is the name of the record. No duplicates are allowed. 16``label`` is the name of the record. No duplicates are allowed.
17 17
18Other variables used in the requests:
19
18``error_desc`` is the description of the returned error. 20``error_desc`` is the description of the returned error.
19 21
22``public_key`` is the public key of an identity.
23
24``name`` is the name of an identity.
25
20 26
21GET Request 27GET Request
22------------ 28------------
23 29
24+--------------------+---------------------------------------------------------------------------------------------------------------------------+ 30+--------------------+---------------------------------------------------------------------------------------------------------------------------+
25|**Title** |Returns all namestore entries | 31|**Title** |Returns all namestore entries from all zones |
26+--------------------+---------------------------------------------------------------------------------------------------------------------------+ 32+--------------------+---------------------------------------------------------------------------------------------------------------------------+
27|**URL** |:literal:`/namestore` | 33|**URL** |:literal:`/namestore` |
28+--------------------+---------------------------------------------------------------------------------------------------------------------------+ 34+--------------------+---------------------------------------------------------------------------------------------------------------------------+
@@ -37,6 +43,41 @@ GET Request
37|**Error Response** |{"error":"*error_desc*"} | 43|**Error Response** |{"error":"*error_desc*"} |
38+--------------------+---------------------------------------------------------------------------------------------------------------------------+ 44+--------------------+---------------------------------------------------------------------------------------------------------------------------+
39 45
46|
47
48+--------------------+---------------------------------------------------------------------------------------------------------------------------+
49|**Title** |Returns all namestore entries for one zone specified by its public key |
50+--------------------+---------------------------------------------------------------------------------------------------------------------------+
51|**URL** |:literal:`/namestore?pubkey='pubkey'` |
52+--------------------+---------------------------------------------------------------------------------------------------------------------------+
53|**Method** |**GET** |
54+--------------------+---------------------------------------------------------------------------------------------------------------------------+
55|**URL Params** |none |
56+--------------------+---------------------------------------------------------------------------------------------------------------------------+
57|**Data Params** |none |
58+--------------------+---------------------------------------------------------------------------------------------------------------------------+
59|**Success Response**|[{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"},...] |
60+--------------------+---------------------------------------------------------------------------------------------------------------------------+
61|**Error Response** |{"error":"*error_desc*"} |
62+--------------------+---------------------------------------------------------------------------------------------------------------------------+
63
64|
65
66+--------------------+---------------------------------------------------------------------------------------------------------------------------+
67|**Title** |Returns all namestore entries for one zone specified by its name |
68+--------------------+---------------------------------------------------------------------------------------------------------------------------+
69|**URL** |:literal:`/namestore?name='name'` |
70+--------------------+---------------------------------------------------------------------------------------------------------------------------+
71|**Method** |**GET** |
72+--------------------+---------------------------------------------------------------------------------------------------------------------------+
73|**URL Params** |none |
74+--------------------+---------------------------------------------------------------------------------------------------------------------------+
75|**Data Params** |none |
76+--------------------+---------------------------------------------------------------------------------------------------------------------------+
77|**Success Response**|[{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"},...] |
78+--------------------+---------------------------------------------------------------------------------------------------------------------------+
79|**Error Response** |{"error":"*error_desc*"} |
80+--------------------+---------------------------------------------------------------------------------------------------------------------------+
40 81
41POST Request 82POST Request
42------------ 83------------
@@ -59,6 +100,46 @@ POST Request
59| | | Response Code: :literal:`409` (Conflict) | 100| | | Response Code: :literal:`409` (Conflict) |
60+--------------------+------------------------------------------------------------------------------------------------------+ 101+--------------------+------------------------------------------------------------------------------------------------------+
61 102
103|
104
105+--------------------+------------------------------------------------------------------------------------------------------+
106|**Title** |Creates a namestore entry for one zone specified by its public key |
107+--------------------+------------------------------------------------------------------------------------------------------+
108|**URL** |:literal:`/namestore?pubkey='pubkey'` |
109+--------------------+------------------------------------------------------------------------------------------------------+
110|**Method** |**POST** |
111+--------------------+------------------------------------------------------------------------------------------------------+
112|**URL Params** |none |
113+--------------------+------------------------------------------------------------------------------------------------------+
114|**Data Params** |{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"}|
115+--------------------+------------------------------------------------------------------------------------------------------+
116|**Success Response**|Response Code: :literal:`204` (No Content) |
117+--------------------+------------------------------------------------------------------------------------------------------+
118|**Error Response** | | {"error":"*error_desc*"} |
119| | | *or* |
120| | | Response Code: :literal:`409` (Conflict) |
121+--------------------+------------------------------------------------------------------------------------------------------+
122
123|
124
125+--------------------+------------------------------------------------------------------------------------------------------+
126|**Title** |Creates a namestore entry for one zone specified by its name |
127+--------------------+------------------------------------------------------------------------------------------------------+
128|**URL** |:literal:`/namestore?name='name'` |
129+--------------------+------------------------------------------------------------------------------------------------------+
130|**Method** |**POST** |
131+--------------------+------------------------------------------------------------------------------------------------------+
132|**URL Params** |none |
133+--------------------+------------------------------------------------------------------------------------------------------+
134|**Data Params** |{"value": "*value*", "type": "*type*", "expiration_time": "*time*", "flag": *flag*, "label": "*name*"}|
135+--------------------+------------------------------------------------------------------------------------------------------+
136|**Success Response**|Response Code: :literal:`204` (No Content) |
137+--------------------+------------------------------------------------------------------------------------------------------+
138|**Error Response** | | {"error":"*error_desc*"} |
139| | | *or* |
140| | | Response Code: :literal:`409` (Conflict) |
141+--------------------+------------------------------------------------------------------------------------------------------+
142
62 143
63DELETE Request 144DELETE Request
64-------------- 145--------------
@@ -79,3 +160,38 @@ DELETE Request
79|**Error Response** | {"error":"*error_desc*"} | 160|**Error Response** | {"error":"*error_desc*"} |
80+--------------------+----------------------------------------------------+ 161+--------------------+----------------------------------------------------+
81 162
163|
164
165+--------------------+----------------------------------------------------+
166| **Title** | Deletes specific namestore entry in specific zone |
167+--------------------+----------------------------------------------------+
168|**URL** |:literal:`/namestore?label='label'&pubkey='pubkey'` |
169+--------------------+----------------------------------------------------+
170|**Method** | **DELETE** |
171+--------------------+----------------------------------------------------+
172|**URL Params** | none |
173+--------------------+----------------------------------------------------+
174|**Data Params** | none |
175+--------------------+----------------------------------------------------+
176|**Success Response**| Response Code: :literal:`204` (No Content) |
177+--------------------+----------------------------------------------------+
178|**Error Response** | {"error":"*error_desc*"} |
179+--------------------+----------------------------------------------------+
180
181|
182
183+--------------------+----------------------------------------------------+
184| **Title** | Deletes specific namestore entry in specific zone |
185+--------------------+----------------------------------------------------+
186|**URL** |:literal:`/namestore?label='label'&name='name'` |
187+--------------------+----------------------------------------------------+
188|**Method** | **DELETE** |
189+--------------------+----------------------------------------------------+
190|**URL Params** | none |
191+--------------------+----------------------------------------------------+
192|**Data Params** | none |
193+--------------------+----------------------------------------------------+
194|**Success Response**| Response Code: :literal:`204` (No Content) |
195+--------------------+----------------------------------------------------+
196|**Error Response** | {"error":"*error_desc*"} |
197+--------------------+----------------------------------------------------+
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-18 12:52:18 +0000