Skip to content

Commit

Permalink
Add requirements based on proposed TR/2022/notifications-protocol-202…
Browse files Browse the repository at this point in the history 
…21231

See also #491
  • Loading branch information
@csarven
csarven committed Dec 31, 2022
1 parent 3db07b7 commit 6742eab
Showing 1 changed file with 14 additions and 25 deletions.
39 changes: 14 additions & 25 deletions ED/protocol.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@
<main>
<article about="" typeof="schema:Article doap:Specification">
<h1 property="schema:name">Solid Protocol</h1>
<h2>Version <span property="doap:revision">0.9.1</span> Editor’s Draft, 2022-12-26</h2>
<h2>Version <span property="doap:revision">0.9.1</span> Editor’s Draft, 2022-12-31</h2>

<details open="">
<summary>More details about this document</summary>
Expand Down Expand Up @@ -240,7 +240,7 @@ <h2>Version <span property="doap:revision">0.9.1</span> Editor’s Draft, 2022-1

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

<dl id="document-repository">
Expand Down Expand Up @@ -1070,32 +1070,21 @@ <h2 property="schema:name">Live Update</h2>
<section id="notifications-protocol" inlist="" rel="schema:hasPart" resource="#notifications-protocol">
<h3 property="schema:name">Solid Notifications Protocol</h3>
<div datatype="rdf:HTML" property="schema:description">
<p>
Entities in a Solid ecosystem use the
<cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite>
to communicate about changes affecting a resource.
</p>
<p>Entities in a Solid ecosystem use the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite> to communicate about changes affecting a resource.</p>

<p>
<span about="" id="server-notification-api" rel="spec:requirement" resource="#server-notification-api"><span property="spec:statement"><span rel="spec:requirementSubject" resource="#Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> implement the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite> [<cite><a class="bibref" href="#bib-solid-notifications-protocol">SOLID-NOTIFICATIONS-PROTOCOL</a></cite>].</span></span>
</p>
<p about="" id="server-notifications-protocol-resource-server" rel="spec:requirement" resource="#server-notifications-protocol-resource-server"><span property="spec:statement"><span rel="spec:requirementSubject" resource="#Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> conform to the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite> [<cite><a class="bibref" href="#bib-solid-notifications-protocol">SOLID-NOTIFICATIONS-PROTOCOL</a></cite>] by implementing the <cite><a href="https://solidproject.org/TR/2022/notifications-protocol-20221231#ResourceServer" rel="rdfs:seeAlso">Resource Server</a></cite> to enable clients to discover subscription resources and notification channels available to a given resource or storage.</span></p>

<p>
<span about="" id="client-notification-api" rel="spec:requirement" resource="#client-notification-api"><span property="spec:statement"><span rel="spec:requirementSubject" resource="#Client">Clients</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> implement the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite>[<cite><a class="bibref" href="#bib-solid-notifications-protocol">SOLID-NOTIFICATIONS-PROTOCOL</a></cite>].</span></span>
</p>
<p about="" id="server-notifications-protocol-subscription-server" rel="spec:requirement" resource="#server-notifications-protocol-subscription-server"><span property="spec:statement"><span rel="spec:requirementSubject" resource="#Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> conform to the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite> [<cite><a class="bibref" href="#bib-solid-notifications-protocol">SOLID-NOTIFICATIONS-PROTOCOL</a></cite>] by implementing the <cite><a href="https://solidproject.org/TR/2022/notifications-protocol-20221231#SubscriptionServer" rel="rdfs:seeAlso">Subscription Server</a></cite> to process and produce instructions for subscription requests.</span></p>

<p about="" id="server-notifications-protocol-notification-sender" rel="spec:requirement" resource="#server-notifications-protocol-notification-sender"><span property="spec:statement"><span rel="spec:requirementSubject" resource="#Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> conform to the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite> [<cite><a class="bibref" href="#bib-solid-notifications-protocol">SOLID-NOTIFICATIONS-PROTOCOL</a></cite>] by implementing the <cite><a href="https://solidproject.org/TR/2022/notifications-protocol-20221231#NotificationSender" rel="rdfs:seeAlso">Notification Sender</a></cite> to produce and send messages to a <cite><a href="https://solidproject.org/TR/2022/notifications-protocol-20221231#NotificationSender" rel="rdfs:seeAlso">Notification Receiver</a></cite>.</span></p>

<p about="" id="server-notifications-protocol-notification-receiver" rel="spec:requirement" resource="#server-notifications-protocol-notification-receiver"><span property="spec:statement"><span rel="spec:requirementSubject" resource="#Server">Servers</span> <span rel="spec:requirementLevel" resource="spec:MUST">MUST</span> conform to the <cite><a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a></cite> [<cite><a class="bibref" href="#bib-solid-notifications-protocol">SOLID-NOTIFICATIONS-PROTOCOL</a></cite>] by implementing the <cite><a href="https://solidproject.org/TR/2022/notifications-protocol-20221231#NotificationReceiver" rel="rdfs:seeAlso">Notification Receiver</a></cite> to receive and process messages that conform to a notification channel type.</span></p>

<p><em>The following is non-normative.</em></p>

<p>
The <cite>Solid WebSockets API</cite> (Unofficial Draft)
[<cite><a class="bibref" href="#bib-solid-websockets-api">SOLID-WEBSOCKETS-API</a></cite>]
has been the common notification protocol for many years. That draft does not include an authentication mechanism,
and therefore this Protocol has transitioned to require the <a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a>.
</p>
<p>The <cite>Solid WebSockets API</cite> (Unofficial Draft) [<cite><a class="bibref" href="#bib-solid-websockets-api">SOLID-WEBSOCKETS-API</a></cite>] has been the common notification protocol for many years. That draft does not include an authentication mechanism, and therefore this Protocol has transitioned to require the <a href="https://solidproject.org/TR/notifications-protocol">Solid Notifications Protocol</a>.</p>

<p>
Existing client and server implementations should begin providing support for the new notification protocol while supporting backwards compatibility, as appropriate.
</p>
<p>Existing client and server implementations should begin providing support for the new notification protocol while supporting backwards compatibility, as appropriate.</p>
</div>
</section>
</div>
Expand Down Expand Up @@ -1327,7 +1316,7 @@ <h3 property="schema:name">Security and Privacy Review</h3>
<dd about="#security-privacy-review-underlying-platform-data" datatype="rdf:HTML" property="schema:description">No.</dd>

<dt about="#security-privacy-review-send-to-platform" id="security-privacy-review-send-to-platform"><a href="https://www.w3.org/TR/security-privacy-questionnaire/#send-to-platform" rel="cito:repliesTo">Does this specification allow an origin to send data to the underlying platform?</a></dt>
<dd about="#security-privacy-review-send-to-platform" datatype="rdf:HTML" property="schema:description">No. <cite>Resources are described within the framework of HTTP, where some kinds of resources are required to be RDF documents. Servers might be able to redirect to other resources, e.g., the <code>https:</code> URLs to <code>file:</code>, <code>data:</code>, or <code>blob:</code> URLs, but no behaviour is defined by this specification.</dd>
<dd about="#security-privacy-review-send-to-platform" datatype="rdf:HTML" property="schema:description">No. Resources are described within the framework of HTTP, where some kinds of resources are required to be RDF documents. Servers might be able to redirect to other resources, e.g., the <code>https:</code> URLs to <code>file:</code>, <code>data:</code>, or <code>blob:</code> URLs, but no behaviour is defined by this specification.</dd>

<dt about="#security-privacy-review-sensor-data" id="security-privacy-review-sensor-data"><a href="https://www.w3.org/TR/security-privacy-questionnaire/#sensor-data" rel="cito:repliesTo">Do features in this specification allow an origin access to sensors on a user’s device</a></dt>
<dd about="#security-privacy-review-sensor-data" datatype="rdf:HTML" property="schema:description">No.</dd>
Expand Down Expand Up @@ -1507,7 +1496,7 @@ <h3 property="schema:name">Normative References</h3>
<dt id="bib-rfc8288">[RFC8288]</dt>
<dd><a href="https://httpwg.org/specs/rfc8288.html" rel="cito:citesAsAuthority"><cite>Web Linking</cite></a>. M. Nottingham. IETF. October 2017. Proposed Standard. URL: <a href="https://httpwg.org/specs/rfc8288.html">https://httpwg.org/specs/rfc8288.html</a></dd>
<dt id="bib-solid-notifications-protocol">[SOLID-NOTIFICATIONS-PROTOCOL]</dt>
<dd><a href="https://solidproject.org/TR/notifications-protocol" rel="cito:citesAsAuthority"><cite>Solid Notifications Protocol</cite></a>. Aaron Coburn; Sarven Capadisli. W3C Solid Community Group. 09 May 2022. Version 0.1.0. URL: <a href="https://solidproject.org/TR/notifications-protocol">https://solidproject.org/TR/notifications-protocol</a></dd>
<dd><a href="https://solidproject.org/TR/notifications-protocol" rel="cito:citesAsAuthority"><cite>Solid Notifications Protocol</cite></a>. Sarven Capadisli. W3C Solid Community Group. 31 December 2022. Version 0.2.0. URL: <a href="https://solidproject.org/TR/notifications-protocol">https://solidproject.org/TR/notifications-protocol</a></dd>
<dt id="bib-solid-oidc">[SOLID-OIDC]</dt>
<dd><a href="https://solidproject.org/TR/oidc" rel="cito:citesAsAuthority"><cite>SOLID-OIDC</cite></a>. Aaron Coburn; elf Pavlik; Dmitri Zagidulin. W3C Solid Community Group. 28 March 2022. Version 0.1.0. URL: <a href="https://solidproject.org/TR/oidc">https://solidproject.org/TR/oidc</a></dd>
<dt id="bib-sparql11-query">[SPARQL11-QUERY]</dt>
Expand All @@ -1517,7 +1506,7 @@ <h3 property="schema:name">Normative References</h3>
<dt id="bib-w3c-html">[W3C-HTML]</dt>
<dd><a href="https://www.w3.org/TR/html/" rel="cito:citesAsAuthority"><cite>HTML</cite></a>. W3C. 28 January 2021. W3C Recommendation. URL: <a href="https://www.w3.org/TR/html/">https://www.w3.org/TR/html/</a></dd>
<dt id="bib-wac">[WAC]</dt>
<dd><a href="https://solidproject.org/TR/wac" rel="cito:citesAsAuthority"><cite>Web Access Control</cite></a>. Sarven Capadisli. W3C Solid Community Group. 11 July 2021. Draft. URL: <a href="https://solidproject.org/TR/wac">https://solidproject.org/TR/wac</a></dd>
<dd><a href="https://solidproject.org/TR/wac" rel="cito:citesAsAuthority"><cite>Web Access Control</cite></a>. Sarven Capadisli. W3C Solid Community Group. 5 July 2022. Version 1.0.0-cr-1. URL: <a href="https://solidproject.org/TR/wac">https://solidproject.org/TR/wac</a></dd>
<dt id="bib-webarch">[WEBARCH]</dt>
<dd><a href="https://www.w3.org/TR/webarch/" rel="cito:citesAsAuthority"><cite>Architecture of the World Wide Web, Volume One</cite></a>. Ian Jacobs; Norman Walsh. W3C. 15 December 2004. W3C Recommendation. URL: <a href="https://www.w3.org/TR/webarch/">https://www.w3.org/TR/webarch/</a></dd>
<dt id="bib-webid">[WEBID]</dt>
Expand Down

0 comments on commit 6742eab

Please sign in to comment.