[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[lsd0004] branch master updated: update API
From: |
gnunet |
Subject: |
[lsd0004] branch master updated: update API |
Date: |
Wed, 29 Dec 2021 13:03:24 +0100 |
This is an automated email from the git hooks/post-receive script.
martin-schanzenbach pushed a commit to branch master
in repository lsd0004.
The following commit(s) were added to refs/heads/master by this push:
new 57ad933 update API
57ad933 is described below
commit 57ad933bd91e95e6cfabf71c1d0c681f5e4ddf40
Author: Martin Schanzenbach <schanzen@gnunet.org>
AuthorDate: Wed Dec 29 13:03:21 2021 +0100
update API
---
draft-schanzen-r5n.xml | 38 +++++++++++++++++++++++++++++---------
1 file changed, 29 insertions(+), 9 deletions(-)
diff --git a/draft-schanzen-r5n.xml b/draft-schanzen-r5n.xml
index e1a5cb8..c43caee 100644
--- a/draft-schanzen-r5n.xml
+++ b/draft-schanzen-r5n.xml
@@ -227,16 +227,36 @@ Connectivity | |Underlay| |Underlay|
The GET procedure is defined as follows:
</t>
<artwork name="" type="" align="left" alt=""><![CDATA[
-GET(Key[, RouteOptions][, XQuery]) -> RESULTS as List
- ]]></artwork>
+GET(Key[, QueryParams]) -> Results as List
+ ]]></artwork>
<t>
- The procedure takes two arguments. The first argument is the query
- key and is mandatory. The GET procedure may also allow the caller
- to specifiy <tt>RouteOptions</tt> in order to indicate certain
- processing requirements for messages.
- Any combination of options may be specificied.
+ The procedure takes a single additional <tt>QueryParams</tt>
+ argument in order to specify detailed query parameters.
+ The <tt>QueryParams</tt> consist of the following parameters:
</t>
<dl>
+ <dt>BlockType</dt>
+ <dd>
+ </dd>
+ <dt>ReplicationLevel</dt>
+ <dd></dd>
+ <dt>RouteOptions</dt>
+ <dd>
+ are used in order to indicate certain
+ processing requirements for messages.
+ Any combination of options as defined in <xref
target="route_options"/>
+ may be specificied.
+ </dd>
+ <dt>XQuery</dt>
+ <dd>
+ is extended query medatadata which may be
+ required depending on the respective <tt>BlockType</tt>.
+ A <tt>BlockType</tt> must define if the <tt>XQuery</tt> can or must
+ be used and what the specific format of its contents should be.
+ See also <xref target="block_types"/>.
+ </dd>
+ </dl>
+ <dl anchor="route_options">
<dt>DemultiplexEverywhere</dt>
<dd>
indicates that each peer along the way should process the request.
@@ -266,7 +286,7 @@ GET(Key[, RouteOptions][, XQuery]) -> RESULTS as List
The PUT procedure is defined as follows:
</t>
<artwork name="" type="" align="left" alt=""><![CDATA[
-PUT(Key, Block[, RouteOptions])
+PUT(Key, Type, Block[, RouteOptions])
]]></artwork>
<t>
The procedure takes two mandatory arguments.
@@ -1043,7 +1063,7 @@ END
</dd>
</dl>
</section>
- <section>
+ <section anchor="block_types">
<name>Block Types</name>
<t>
Applications can and should define their own block types.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.