Skip to content

Add server-auxiliary-resources-management server-link-auxiliary-type #372

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

Merged
csarven merged 4 commits into from
Jan 24, 2022
Merged

Add server-auxiliary-resources-management server-link-auxiliary-type #372

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2d13ea4
Add server-auxiliary-resources-management server-link-auxiliary-type
csarven Jan 6, 2022
610b60f
Apply suggestions from code review
csarven Jan 18, 2022
557abc4
Clarify server-auxiliary-resources-management
csarven Jan 24, 2022
accfea7
Make server-auxiliary-resources-management specifically about 'support'
csarven Jan 24, 2022
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
8 changes: 5 additions & 3 deletions ED/protocol.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
<main>
<article about="" typeof="schema:Article doap:Specification">
<h1 property="schema:name">Solid Protocol</h1>
<h2>Editor’s Draft, 2021-12-27</h2>
<h2>Editor’s Draft, 2022-01-06</h2>

<details open="">
<summary>More details about this document</summary>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h2>Editor’s Draft, 2021-12-27</h2>

<dl id="document-modified">
<dt>Modified</dt>
<dd><time content="2021-12-27T00:00:00Z" datatype="xsd:dateTime" datetime="2021-12-27T00:00:00Z" property="schema:dateModified">2021-12-27</time></dd>
<dd><time content="2022-01-06T00:00:00Z" datatype="xsd:dateTime" datetime="2022-01-06T00:00:00Z" property="schema:dateModified">2022-01-06</time></dd>
</dl>

<dl id="document-repository">
Expand Down Expand Up @@ -683,7 +683,7 @@ <h3 property="schema:name">Auxiliary Resources</h3>
<div datatype="rdf:HTML" property="schema:description">
<p>Solid has the notion of <em>auxiliary resources</em> to provide supplementary information such as descriptive metadata, authorization conditions, data shape constraints, digital rights or provenance record about a given resource (hereafter referred as the <em>subject resource</em>), and affects how resources and others associated with it are processed, served or interpreted.</p>

<p id="auxiliary-resources-management">Server manages the association between a subject resource and auxiliary resources defined by this specification. The lifecycle of auxiliary resources defined by this specification depend on the lifecycle of the subject resource that they are associated with.</p>
<p><span about="" id="server-auxiliary-resources-management" rel="spec:requirement" resource="#server-auxiliary-resources-management"><span property="spec:statement"><span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> support auxiliary resources defined by this specification and manage the association between a subject resource and auxiliary resources. The lifecycle of auxiliary resources defined by this specification depends on the lifecycle of the subject resource that they are associated with.</span></span></p>
Copy link
Copy Markdown
Contributor

@edwardsph edwardsph Jan 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussing this with @kjetil, I would just comment that the statement below does seem redundant:

The lifecycle of auxiliary resources defined by this specification depends on the lifecycle of the subject resource that they are associated with.

When it says lifecycle I believe the only relevant part of the lifecycle is actually DELETE and that requirement is already covered (for all auxiliary resources, not just those defined in the spec) by #server-delete-remove-auxilary-resource. If this is a non-normative comment to help understanding then it doesn't need to be part of the requirement statement where it could be perceived as adding to or amending the requirement. Perhaps it could be moved, and simplified to say something like:

When a subject resource is deleted its auxiliary resources are also deleted by the server [#server-delete-remove-auxilary-resource]

Copy link
Copy Markdown
Member Author

@csarven csarven Jan 24, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edwardsph , thanks. I agree (as discussed elsewhere) and updated the text as per your suggestion.

@kjetilk @RubenVerborgh Are we okay to merge this and close 371? This shouldn't drag out longer.

371 and 372 should stick to clarifying the current text / what was in our minds as opposed to introducing anything new or major changes (on auxiliary resources) - those can be in a different PR.


<p id="auxiliary-resources-rdf-document">Auxiliary resources are represented as <em>RDF document</em>s [<cite><a class="bibref" href="#bib-rdf11-concepts">RDF11-CONCEPTS</a></cite>]. HTTP interactions on auxiliary resources are subject to the requirements as per <cite><a href="#reading-writing-resources">Reading and Writing Resources</a></cite>.</p>

Expand All @@ -701,6 +701,8 @@ <h4 property="schema:name"><span>Note</span>: Self-describing Resources</h4>
<li><a href="#auxiliary-resources-description-resource">Resource Description</a></li>
</ul>

<p><span about="" id="server-link-auxiliary-type" rel="spec:requirement" resource="#server-link-auxiliary-type"><span property="spec:statement"><span rel="spec:requirementSubject" resource="spec:Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> advertise auxiliary resources associated with a subject resource by responding to <code>HEAD</code> and <code>GET</code> requests by including the HTTP <code>Link</code> header with the <code>rel</code> parameter [<cite><a class="bibref" href="#bib-rfc8288">RFC8288</a></cite>].</span></span></p>

<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>

<table>
Expand Down