docs/templates/pages/proto/package.html
2022-02-01 17:59:16 +00:00

62 lines
1.7 KiB
HTML

{% extends "base.html" %}
{% block title %}package{% endblock %}
{% block body %}
<h1><code>package</code></h1>
<h2 id="list"><code>package.list</code></h2>
<h3>Request:</h3>
<pre>{% highlight "cxml" %}<call ...>
<package method="list" pkgtype="??pkgtype" model*="" />
</call>{% endhighlight %}</pre>
<p><code>all</code> is the only currently observed value for <code>pkgtype</code></p>
<h3>Response:</h3>
<pre>{% highlight "cxml" %}<response>
<package status="??status">
<item[] url="" name="" desc="" size="" pkgtype="" sumtype="" sum="" from="" till="" />
</package>
</response>{% endhighlight %}</pre>
<p>A list of all packages available for download.</p>
<table>
<tr>
<td><code>url</code></td>
<td> </td>
</tr>
<tr>
<td><code>desc</code></td>
<td> </td>
</tr>
<tr>
<td><code>size</code></td>
<td>Size of the resource at <code>url</code> in bytes</td>
</tr>
<tr>
<td><code>pkgtype</code></td>
<td> </td>
</tr>
<tr>
<td><code>sumtype</code></td>
<td>Only allowable value is <code>md5</code>.</td>
</tr>
<tr>
<td><code>sum</code></td>
<td>The <code>sumtype</code> digest of the file at <code>url</code>.</td>
</tr>
<tr>
<td><code>from</code></td>
<td> </td>
</tr>
<tr>
<td><code>till</code></td>
<td> </td>
</tr>
</table>
<h2 id="intend"><code>package.intend</code></h2>
<h3>Request:</h3>
<pre>{% highlight "cxml" %}<call ...>
<package method="intend" url="" model*="" />
</call>{% endhighlight %}</pre>
<h3>Response:</h3>
<pre>{% highlight "cxml" %}<response>
<package status="??status" />
</response>{% endhighlight %}</pre>
{% endblock %}