[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-rest-api] branch master updated: more cleanup
|
From: |
gnunet |
|
Subject: |
[gnunet-rest-api] branch master updated: more cleanup |
|
Date: |
Fri, 14 Feb 2020 11:03:21 +0100 |
This is an automated email from the git hooks/post-receive script.
martin-schanzenbach pushed a commit to branch master
in repository gnunet-rest-api.
The following commit(s) were added to refs/heads/master by this push:
new 3df7e33 more cleanup
3df7e33 is described below
commit 3df7e33125a177952f98cf96b518e562afe8c77d
Author: Schanzenbach, Martin <address@hidden>
AuthorDate: Fri Feb 14 10:59:29 2020 +0100
more cleanup
---
source/namestore.rst | 139 ++++++++++++++++++++++++++++-----------------------
1 file changed, 76 insertions(+), 63 deletions(-)
diff --git a/source/namestore.rst b/source/namestore.rst
index 2b532e1..8ead7c6 100644
--- a/source/namestore.rst
+++ b/source/namestore.rst
@@ -18,7 +18,21 @@ of record ``data''. The data consists of a ``value``, an
``expiration_time``,
a ``flag`` and a ``record_name``.
Adding a GNS records with the same record_name incrementally adds record to it.
-A GNS record is sent in the JSON format: ``{ "record_name:" "name", "data":
[{"value": "value", "record_type": "type", "expiration_time": "time", "flag":
flag},...}]}``
+A GNS ``Record`` is sent in the JSON format ::
+
+ {
+ "record_name": string,
+ "data": RecordData[]
+ }
+
+A ``RecordData`` has the following format ::
+
+ {
+ "value": string,
+ "record_type": string,
+ "expiration_time": string,
+ "flag": string
+ }
``name`` is the name of the record.
@@ -30,6 +44,7 @@ A GNS record is sent in the JSON format: ``{ "record_name:"
"name", "data": [{"v
``time`` is the expiration time of the record either "never" or fancy time
(see GNUNET_STRINGS_fancy_time_to_absolute)
``flag`` is the option of the record. Either 0 for none, 2 for private, 8 for
relative expiration or 16 if all other records have expired. ``flag`` must be a
number.
+
Error Response
--------------
@@ -60,80 +75,78 @@ Requests
GET Request
------------
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Title** |Returns all namestore entries for one zone specified by
its name |
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL** |:literal:`/namestore/'zone'`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Method** |**GET**
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Data Params** |none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Success Response**|[{"record_name": "*name*", "data:" [{"value": "*value*",
"record_type": "*type*", "expiration_time": "*time*", |
-| |"flag": *flag*},...]}]
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
++--------------------+---------------------------------------------------------+
+|**Title** |Returns all namestore entries for one zone.
|
++--------------------+---------------------------------------------------------+
+|**URL** |:literal:`/namestore/'zone'`
|
++--------------------+---------------------------------------------------------+
+|**Method** |**GET**
|
++--------------------+---------------------------------------------------------+
+|**URL Params** |none
|
++--------------------+---------------------------------------------------------+
+|**Data Params** |none
|
++--------------------+---------------------------------------------------------+
+|**Success Response**|``Record[]``
|
++--------------------+---------------------------------------------------------+
+|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4`
|
++--------------------+---------------------------------------------------------+
POST Request
------------
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Title** |Creates a namestore entry in a zone
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL** |:literal:`/namestore/'zone'`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Method** |**POST**
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Data Params** |{"record_name": "*name*", "data": [{"value": "*value*",
"record_type": "*type*", "expiration_time": "*time*", |
-| |"flag": *flag*},...]}
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Success Response**|Response Code: :literal:`204` (No Content)
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`3; 4; 5; 6; 7`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
++--------------------+---------------------------------------------------------+
+|**Title** |Creates a namestore entry in a zone
|
++--------------------+---------------------------------------------------------+
+|**URL** |:literal:`/namestore/'zone'`
|
++--------------------+---------------------------------------------------------+
+|**Method** |**POST**
|
++--------------------+---------------------------------------------------------+
+|**URL Params** |none
|
++--------------------+---------------------------------------------------------+
+|**Data Params** |``Record``
|
++--------------------+---------------------------------------------------------+
+|**Success Response**|Response Code: :literal:`204` (No Content)
|
++--------------------+---------------------------------------------------------+
+|**Error Response** | {"error":"*error_desc*"} :sup:`3; 4; 5; 6; 7`
|
++--------------------+---------------------------------------------------------+
|
DELETE Request
--------------
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-| **Title** | Deletes specific namestore entry in specific zone
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL** |:literal:`/namestore/'zone'?record_name='name'`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Method** | **DELETE**
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL Params** | none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Data Params** | none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Success Response**| Response Code: :literal:`204` (No Content)
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4; 6; 8; 9`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
++--------------------+---------------------------------------------------+
+| **Title** | Deletes specific namestore entry in specific zone |
++--------------------+---------------------------------------------------+
+|**URL** |:literal:`/namestore/'zone'?record_name='name'` |
++--------------------+---------------------------------------------------+
+|**Method** | **DELETE** |
++--------------------+---------------------------------------------------+
+|**URL Params** | none |
++--------------------+---------------------------------------------------+
+|**Data Params** | none |
++--------------------+---------------------------------------------------+
+|**Success Response**| Response Code: :literal:`204` (No Content) |
++--------------------+---------------------------------------------------+
+|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4; 6; 8; 9` |
++--------------------+---------------------------------------------------+
OPTIONS Request
---------------
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Title** |Gets request options
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL** |:literal:`/namestore`
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Method** |**OPTIONS**
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Data Params** |none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Success Response**|
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
-|**Error Response** |none
|
-+--------------------+---------------------------------------------------------------------------------------------------------------------------+
++--------------------+---------------------------------------------------+
+|**Title** |Gets request options |
++--------------------+---------------------------------------------------+
+|**URL** |:literal:`/namestore` |
++--------------------+---------------------------------------------------+
+|**Method** |**OPTIONS** |
++--------------------+---------------------------------------------------+
+|**URL Params** |none |
++--------------------+---------------------------------------------------+
+|**Data Params** |none |
++--------------------+---------------------------------------------------+
+|**Success Response**| |
++--------------------+---------------------------------------------------+
+|**Error Response** |none |
++--------------------+---------------------------------------------------+
--
To stop receiving notification emails like this one, please contact
address@hidden.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [gnunet-rest-api] branch master updated: more cleanup,
gnunet <=