summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Schanzenbach <schanzen@gnunet.org>2021-12-29 13:03:21 +0100
committerMartin Schanzenbach <schanzen@gnunet.org>2021-12-29 13:03:21 +0100
commit57ad933bd91e95e6cfabf71c1d0c681f5e4ddf40 (patch)
tree8b91b1dd466f90f986ed73c1af55e07881d8fed2
parentdac2075e4879a495fe2ec4bb6d5167a28dabfa62 (diff)
downloadlsd0004-57ad933bd91e95e6cfabf71c1d0c681f5e4ddf40.tar.gz
lsd0004-57ad933bd91e95e6cfabf71c1d0c681f5e4ddf40.zip
update API
-rw-r--r--draft-schanzen-r5n.xml38
1 files 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|
227 The GET procedure is defined as follows: 227 The GET procedure is defined as follows:
228 </t> 228 </t>
229 <artwork name="" type="" align="left" alt=""><![CDATA[ 229 <artwork name="" type="" align="left" alt=""><![CDATA[
230GET(Key[, RouteOptions][, XQuery]) -> RESULTS as List 230GET(Key[, QueryParams]) -> Results as List
231 ]]></artwork> 231 ]]></artwork>
232 <t> 232 <t>
233 The procedure takes two arguments. The first argument is the query 233 The procedure takes a single additional <tt>QueryParams</tt>
234 key and is mandatory. The GET procedure may also allow the caller 234 argument in order to specify detailed query parameters.
235 to specifiy <tt>RouteOptions</tt> in order to indicate certain 235 The <tt>QueryParams</tt> consist of the following parameters:
236 processing requirements for messages.
237 Any combination of options may be specificied.
238 </t> 236 </t>
239 <dl> 237 <dl>
238 <dt>BlockType</dt>
239 <dd>
240 </dd>
241 <dt>ReplicationLevel</dt>
242 <dd></dd>
243 <dt>RouteOptions</dt>
244 <dd>
245 are used in order to indicate certain
246 processing requirements for messages.
247 Any combination of options as defined in <xref target="route_options"/>
248 may be specificied.
249 </dd>
250 <dt>XQuery</dt>
251 <dd>
252 is extended query medatadata which may be
253 required depending on the respective <tt>BlockType</tt>.
254 A <tt>BlockType</tt> must define if the <tt>XQuery</tt> can or must
255 be used and what the specific format of its contents should be.
256 See also <xref target="block_types"/>.
257 </dd>
258 </dl>
259 <dl anchor="route_options">
240 <dt>DemultiplexEverywhere</dt> 260 <dt>DemultiplexEverywhere</dt>
241 <dd> 261 <dd>
242 indicates that each peer along the way should process the request. 262 indicates that each peer along the way should process the request.
@@ -266,7 +286,7 @@ GET(Key[, RouteOptions][, XQuery]) -> RESULTS as List
266 The PUT procedure is defined as follows: 286 The PUT procedure is defined as follows:
267 </t> 287 </t>
268 <artwork name="" type="" align="left" alt=""><![CDATA[ 288 <artwork name="" type="" align="left" alt=""><![CDATA[
269PUT(Key, Block[, RouteOptions]) 289PUT(Key, Type, Block[, RouteOptions])
270 ]]></artwork> 290 ]]></artwork>
271 <t> 291 <t>
272 The procedure takes two mandatory arguments. 292 The procedure takes two mandatory arguments.
@@ -1043,7 +1063,7 @@ END
1043 </dd> 1063 </dd>
1044 </dl> 1064 </dl>
1045 </section> 1065 </section>
1046 <section> 1066 <section anchor="block_types">
1047 <name>Block Types</name> 1067 <name>Block Types</name>
1048 <t> 1068 <t>
1049 Applications can and should define their own block types. 1069 Applications can and should define their own block types.