lsd0004

commit 57ad933bd91e95e6cfabf71c1d0c681f5e4ddf40
parent dac2075e4879a495fe2ec4bb6d5167a28dabfa62
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date:   Wed, 29 Dec 2021 13:03:21 +0100

update API

Diffstat:
M
draft-schanzen-r5n.xml
 | 
38
+++++++++++++++++++++++++++++---------

1 file changed, 29 insertions(+), 9 deletions(-)
diff --git 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.