Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auxiliary resource for container metadata as alternative #362

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Auxiliary resource for container metadata as alternative #362

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82c0fd6
Propose an auxiliary resource for container metadata
kjetilk Dec 15, 2021
43d463d
Rename to container metadata resource as per @acoburn 's suggestion
kjetilk Dec 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion protocol.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,8 @@ <h4 property="schema:name"><span>Note</span>: Self-describing Resources</h4>
<ul>
<li><a href="#auxiliary-resources-web-access-control">Web Access Control</a></li>
<li><a href="#auxiliary-resources-description-resource">Resource Description</a></li>
</ul>
<li><a href="#auxiliary-resources-stat-resource">Server Metadata Description Resource</a></li>
</ul>

<p><span about="" id="client-link-auxiliary-type" rel="spec:requirement" resource="#client-link-auxiliary-type">Clients can discover auxiliary resources associated with a subject resource by making an HTTP <code>HEAD</code> or <code>GET</code> request on the target URL, and checking the HTTP <code>Link</code> header with the <code>rel</code> parameter [<cite><a class="bibref" href="#bib-rfc8288">RFC8288</a></cite>].</span></p>

Expand All @@ -608,6 +609,11 @@ <h4 property="schema:name"><span>Note</span>: Self-describing Resources</h4>
<td><code>describedby</code></td>
<td>[<cite><a class="bibref" href="#bib-ldp">LDP</a></cite>]</td>
</tr>
<tr>
<td><a href="#auxiliary-resources-stat-resource">Server Metadata Description Resource</a></td>
<td><code>http://www.w3.org/ns/solid/terms#statResource</code></td>
<td></td>
</tr>
</tbody>
<tfoot>
<tr>
Expand Down Expand Up @@ -648,6 +654,34 @@ <h4 property="schema:name">Description Resource</h4>
<p><span about="" id="client-link-describes" rel="spec:requirement" resource="#client-link-describes">Clients can discover resources that are described by description resources by making an HTTP <code>HEAD</code> or <code>GET</code> request on the target URL, and checking the HTTP <code>Link</code> header with a <code>rel</code> value of <code>describes</code> (inverse of the <code>describedby</code> relation) [<cite><a class="bibref" href="#bib-rfc6892">RFC6892</a></cite>].</span></p>
</div>
</section>

<section id="auxiliary-resources-stat-resource" inlist="" rel="schema:hasPart" resource="#auxiliary-resources-stat-resource">
<h4 property="schema:name">Server Metadata Description Resource</h4>
<div datatype="rdf:HTML" property="schema:description">
<p>
An auxiliary resource of type <em>Server Metadata Description Resource</em> provides server-maintained metadata about contained resources.
</p>
<p about="" id="server-stat-resource-discovery" rel="spec:requirement" resource="#server-stat-resource-discovery"><span property="spec:statement">When a read operation targets a container, <span rel="spec:requirementSubject" resource="spec:Server">servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> advertize the existence of this type of resource using a HTTP <code>Link</code> header with a <code>rel</code> value of <code>http://www.w3.org/ns/solid/terms#statResource</code>.
</span></p>
<p>
<span about="" id="server-stat-resource-data" rel="spec:requirement" resource="#server-stat-resource-discovery-data"><span property="spec:statement">When a read operation targets a <em>Server Metadata Description Resource</em>, <span rel="spec:requirementSubject" resource="spec:Server">servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> supply the following metadata about a representation of each contained resource of the corresponding container:</span>
<ul>
<li about="" id="server-stat-resource-data-type" rel="spec:requirement" resource="#server-stat-resource-discovery-data-type"><span property="spec:statement"><span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> use the predicate <code>rdf:type</code> and a class whose URI is the expansion of the <em>URI Template</em> [<cite><a class="bibref" href="#bib-rfc6570">RFC6570</a></cite>] <code>http://www.w3.org/ns/iana/media-types/{+iana-media-type}#Resource</code>, where <code>iana-media-type</code> corresponds to a value from the IANA Media Types [<cite><a class="bibref" href="#bib-iana-media-types">IANA-MEDIA-TYPES</a></cite>].</span></li>
<li about="" id="server-stat-resource-data-mtime" rel="spec:requirement" resource="#server-stat-resource-discovery-data-mtime"><div property="spec:statement">The date and time when the contained resource was last modified. <span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> express this using two properties:
<ul>
<li><code>dct:modified</code> using a <code>xsd:dateTime</code> data type; and </li>
<li><code>stat:mtime</code> given as a UNIX timestamp.</li>
</ul></div>
</li>
<li about="" id="server-stat-resource-data-mtime" rel="spec:requirement" resource="#server-stat-resource-discovery-data-size"><span property="spec:statement"> <span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> supply the size in bytes as a non-negative integer using the <code>stat:size</code> predicate.</span></li>
</ul>
</p>
<p about="" id="server-stat-resource-reject-non-read" rel="spec:requirement" resource="#server-stat-resource-reject-non-read"><span property="spec:statement"><span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST-NOT">MUST NOT</span> allow non-read operations and reject requests using methods other than <code>GET</code>, <code>HEAD</code> and <code>OPTIONS</code> using a <code>405</code> status code.</span></p>
<p about="" id="server-stat-resource-own-access-control" rel="spec:requirement" resource="#server-stat-resource-own-access-control"><span property="spec:statement">By default, the server uses the authorization rule for the corresponding container for the server metadata description resource. However, <span rel="spec:requirementSubject" resource="spec:Server">servers</span> <span rel="spec:requirementLevel" resource="spec:MAY">MAY</span> associate an explicit authorization rule with the server metadata description resource that further restricts access to the resource.</span>
</p>
</div>
</section>

</div>
</section>
</div>
Expand Down Expand Up @@ -1056,6 +1090,8 @@ <h3 property="schema:name">Normative References</h3>
<dl class="bibliography" resource="">
<dt id="bib-fetch">[FETCH]</dt>
<dd><a href="https://fetch.spec.whatwg.org/" rel="cito:citesAsAuthority"><cite>Fetch Standard</cite></a>. Anne van Kesteren. WHATWG. Living Standard. URL: <a href="https://fetch.spec.whatwg.org/">https://fetch.spec.whatwg.org/</a></dd>
<dt id="bib-iana-media-types">[IANA-MEDIA-TYPES]</dt>
<dd><a href="https://www.iana.org/assignments/media-types/" rel="cito:citesAsAuthority"><cite>Media Types</cite></a>. IANA. URL: <a href="https://www.iana.org/assignments/media-types/">https://www.iana.org/assignments/media-types/</a></dd>
<dt id="bib-json-ld11">[JSON-LD11]</dt>
<dd><a href="https://www.w3.org/TR/json-ld11/" rel="cito:citesAsAuthority"><cite>JSON-LD 1.1</cite></a>. Gregg Kellogg; Pierre-Antoine Champin; Dave Longley. W3C. 16 July 2020. W3C Recommendation. URL: <a href="https://www.w3.org/TR/json-ld11/">https://www.w3.org/TR/json-ld11/</a></dd>
<dt id="bib-ldn">[LDN]</dt>
Expand All @@ -1080,6 +1116,7 @@ <h3 property="schema:name">Normative References</h3>
<dd><a href="https://datatracker.ietf.org/doc/html/rfc6454" rel="cito:citesAsAuthority"><cite>The Web Origin Concept</cite></a>. A. Barth. IETF. December 2011. Proposed Standard. URL: <a href="https://datatracker.ietf.org/doc/html/rfc6454">https://datatracker.ietf.org/doc/html/rfc6454</a></dd>
<dt id="bib-rfc6455">[RFC6455]</dt>
<dd><a href="https://datatracker.ietf.org/doc/html/rfc6455" rel="cito:citesAsAuthority"><cite>The WebSocket Protocol</cite></a>. I. Fette; A. Melnikov. IETF. December 2011. Proposed Standard. URL: <a href="https://datatracker.ietf.org/doc/html/rfc6455">https://datatracker.ietf.org/doc/html/rfc6455</a></dd>
<dt id="bib-rfc6570">[RFC6570]</dt><dd><a href="https://www.rfc-editor.org/rfc/rfc6570" rel="cito:citesAsAuthority"><cite>URI Template</cite></a>. J. Gregorio; R. Fielding; M. Hadley; M. Nottingham; D. Orchard. IETF. March 2012. Proposed Standard. URL: <a href="https://www.rfc-editor.org/rfc/rfc6570">https://www.rfc-editor.org/rfc/rfc6570</a></dd>
<dt id="bib-rfc6892">[RFC6892]</dt>
<dd><a href="https://datatracker.ietf.org/doc/html/rfc6892" rel="cito:citesAsAuthority"><cite>The 'describes' Link Relation Type</cite></a>. E. Wilde. IETF. March 2013. Informational. URL: <a href="https://datatracker.ietf.org/doc/html/rfc6892">https://datatracker.ietf.org/doc/html/rfc6892</a></dd>
<dt id="bib-rfc7230">[RFC7230]</dt>
Expand Down