Autogenerated HTML docs for v2.31.1-621-g97eea

2 files changed, 74 insertions, 1 deletions

diff --git a/technical/protocol-v2.html b/technical/protocol-v2.html
index 70a0a2122..8f64ac868 100644
--- a/technical/protocol-v2.html
+++ b/technical/protocol-v2.html
@@ -1405,6 +1405,48 @@ current implementation uses trace2 session IDs (see
 <a href="api-trace2.html">api-trace2</a> for details), but this may change and users of

 the session ID should not rely on this fact.</p></div>

 </div>

+<div class="sect2">

+<h3 id="_object_info">object-info</h3>

+<div class="paragraph"><p><code>object-info</code> is the command to retrieve information about one or more objects.

+Its main purpose is to allow a client to make decisions based on this

+information without having to fully fetch objects. Object size is the only

+information that is currently supported.</p></div>

+<div class="paragraph"><p>An <code>object-info</code> request takes the following arguments:</p></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>size

+Requests size information to be returned for each listed object id.</code></pre>

+</div></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>oid &lt;oid&gt;

+Indicates to the server an object which the client wants to obtain

+information for.</code></pre>

+</div></div>

+<div class="paragraph"><p>The response of <code>object-info</code> is a list of the the requested object ids

+and associated requested information, each separated by a single space.</p></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>output = info flush-pkt</code></pre>

+</div></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>info = PKT-LINE(attrs) LF)

+        *PKT-LINE(obj-info LF)</code></pre>

+</div></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>attrs = attr | attrs SP attrs</code></pre>

+</div></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>attr = "size"</code></pre>

+</div></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>obj-info = obj-id SP obj-size</code></pre>

+</div></div>

+</div>

 </div>

 </div>

 </div>

@@ -1412,7 +1454,7 @@ the session ID should not rely on this fact.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2021-02-26 10:29:29 JST

+ 2021-05-14 08:55:43 JST

 </div>

 </div>

 </body>

diff --git a/technical/protocol-v2.txt b/technical/protocol-v2.txt
index a7c806a73..f4ed14177 100644
--- a/technical/protocol-v2.txt
+++ b/technical/protocol-v2.txt
@@ -514,3 +514,34 @@ packet-line, and must not contain non-printable or whitespace characters. The
 current implementation uses trace2 session IDs (see
 link:api-trace2.html[api-trace2] for details), but this may change and users of
 the session ID should not rely on this fact.
+
+object-info
+~~~~~~~~~~~
+
+`object-info` is the command to retrieve information about one or more objects.
+Its main purpose is to allow a client to make decisions based on this
+information without having to fully fetch objects. Object size is the only
+information that is currently supported.
+
+An `object-info` request takes the following arguments:
+
+	size
+	Requests size information to be returned for each listed object id.
+
+	oid <oid>
+	Indicates to the server an object which the client wants to obtain
+	information for.
+
+The response of `object-info` is a list of the the requested object ids
+and associated requested information, each separated by a single space.
+
+	output = info flush-pkt
+
+	info = PKT-LINE(attrs) LF)
+		*PKT-LINE(obj-info LF)
+
+	attrs = attr | attrs SP attrs
+
+	attr = "size"
+
+	obj-info = obj-id SP obj-size