summaryrefslogtreecommitdiff
path: root/source/namestore.rst
diff options
context:
space:
mode:
Diffstat (limited to 'source/namestore.rst')
-rw-r--r--source/namestore.rst120
1 files changed, 118 insertions, 2 deletions
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-05-01 16:39:13 +0000