From 3468665e066e659a4eba5be97d56519be2625167 Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Wed, 17 Jun 2020 17:48:00 +0200 Subject: [PATCH 1/5] Remove slash from version number. See https://github.com/solid/specification/issues/163 --- api-websockets.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/api-websockets.md b/api-websockets.md index cab7ce9..cb631d4 100644 --- a/api-websockets.md +++ b/api-websockets.md @@ -6,7 +6,7 @@ versioned as a whole. ## Status This is a _draft_ protocol. -This specific version is identified by the string `solid/0.1.0-alpha`. +This specific version is identified by the string `solid-0.1-alpha`. ## Protocol description @@ -41,20 +41,20 @@ Updates-Via: wss://example.org ### Connection Then, the client needs to open a WebSocket connection to that URI. -The client _SHOULD_ include the protocol version `solid/0.1.0-alpha` +The client _SHOULD_ include the protocol version `solid-0.1-alpha` in the `Sec-WebSocket-Protocol` header. For example, in JavaScript, this could be done as follows: ``` -const socket = new WebSocket('wss://example.org', ['solid/0.1.0-alpha']); +const socket = new WebSocket('wss://example.org', ['solid-0.1-alpha']); ``` Upon connection, the server SHOULD indicate the protocol version as follows: ``` -protocol solid/0.1.0-alpha +protocol solid-0.1-alpha warning Unstandardized protocol version, proceed with care ``` @@ -62,17 +62,17 @@ If the client did not specify a `Sec-WebSocket-Protocol` header, the server SHOULD warn the client as follows: ``` -warning Missing Sec-WebSocket-Protocol header, expected value 'solid/0.1.0-alpha' +warning Missing Sec-WebSocket-Protocol header, expected value 'solid-0.1-alpha' ``` Otherwise, if the set of values obtained from parsing the `Sec-WebSocket-Protocol` header -does not contain `solid/0.1.0-alpha`, +does not contain `solid-0.1-alpha`, then the server SHOULD emit a warning and SHOULD close the connection: ``` -error Client does not support protocol solid/0.1.0-alpha +error Client does not support protocol solid-0.1-alpha ``` ### Subscription @@ -128,7 +128,7 @@ Here is a Javascript example on how to subscribe to live updates for a `test` resource at `https://example.org/data/test`: ```js -var socket = new WebSocket('wss://example.org/', ['solid/0.1.0-alpha']); +var socket = new WebSocket('wss://example.org/', ['solid-0.1-alpha']); socket.onopen = function() { this.send('sub https://example.org/data/test'); }; From 7b5cb3f49d782501a34d6781717e3e25f7578fd2 Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Wed, 17 Jun 2020 17:50:52 +0200 Subject: [PATCH 2/5] Drop alpha from version number. See https://github.com/solid/solid-spec/issues/221 --- api-websockets.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/api-websockets.md b/api-websockets.md index cb631d4..d8aa857 100644 --- a/api-websockets.md +++ b/api-websockets.md @@ -6,7 +6,7 @@ versioned as a whole. ## Status This is a _draft_ protocol. -This specific version is identified by the string `solid-0.1-alpha`. +This specific version is identified by the string `solid-0.1`. ## Protocol description @@ -41,20 +41,20 @@ Updates-Via: wss://example.org ### Connection Then, the client needs to open a WebSocket connection to that URI. -The client _SHOULD_ include the protocol version `solid-0.1-alpha` +The client _SHOULD_ include the protocol version `solid-0.1` in the `Sec-WebSocket-Protocol` header. For example, in JavaScript, this could be done as follows: ``` -const socket = new WebSocket('wss://example.org', ['solid-0.1-alpha']); +const socket = new WebSocket('wss://example.org', ['solid-0.1']); ``` Upon connection, the server SHOULD indicate the protocol version as follows: ``` -protocol solid-0.1-alpha +protocol solid-0.1 warning Unstandardized protocol version, proceed with care ``` @@ -62,17 +62,17 @@ If the client did not specify a `Sec-WebSocket-Protocol` header, the server SHOULD warn the client as follows: ``` -warning Missing Sec-WebSocket-Protocol header, expected value 'solid-0.1-alpha' +warning Missing Sec-WebSocket-Protocol header, expected value 'solid-0.1' ``` Otherwise, if the set of values obtained from parsing the `Sec-WebSocket-Protocol` header -does not contain `solid-0.1-alpha`, +does not contain `solid-0.1`, then the server SHOULD emit a warning and SHOULD close the connection: ``` -error Client does not support protocol solid-0.1-alpha +error Client does not support protocol solid-0.1 ``` ### Subscription @@ -128,7 +128,7 @@ Here is a Javascript example on how to subscribe to live updates for a `test` resource at `https://example.org/data/test`: ```js -var socket = new WebSocket('wss://example.org/', ['solid-0.1-alpha']); +var socket = new WebSocket('wss://example.org/', ['solid-0.1']); socket.onopen = function() { this.send('sub https://example.org/data/test'); }; From 077e39ccfebb68d8e9f3a333f88999e7498ec3e2 Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Wed, 17 Jun 2020 17:52:26 +0200 Subject: [PATCH 3/5] Replace warning by explanation. See https://github.com/solid/solid-spec/issues/221 --- api-websockets.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/api-websockets.md b/api-websockets.md index d8aa857..999ace1 100644 --- a/api-websockets.md +++ b/api-websockets.md @@ -8,6 +8,8 @@ versioned as a whole. This is a _draft_ protocol. This specific version is identified by the string `solid-0.1`. +**WARNING: Future versions of this protocol will NOT be backward compatible for security reasons.** + ## Protocol description Live updates are currently only supported through WebSockets. This describes a @@ -55,7 +57,6 @@ the server SHOULD indicate the protocol version as follows: ``` protocol solid-0.1 -warning Unstandardized protocol version, proceed with care ``` If the client did not specify a `Sec-WebSocket-Protocol` header, From a0818f74e4d18cd2e781781cbd754f24de862e6c Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Wed, 12 May 2021 21:36:08 +0200 Subject: [PATCH 4/5] Remove obsolete acronym expansion --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4cc6431..78dd793 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ For the time being, the present document contains the best approximation of expe ## Overview -[Solid](https://github.com/solid/solid) (derived from "**so**cial **li**nked -**d**ata") is a proposed set of conventions and tools for building -*decentralized social applications* based on [Linked +[Solid](https://github.com/solid/solid) +is a proposed set of conventions and tools for building +*decentralized applications* based on [Linked Data](http://www.w3.org/DesignIssues/LinkedData.html) principles. Solid is modular and extensible. It relies as much as possible on existing [W3C](http://www.w3.org/) standards and protocols. From 4477be0e3613e5a5a3e100dccf749ab2e166ef3b Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Wed, 12 May 2021 21:50:46 +0200 Subject: [PATCH 5/5] Correct LD URL. Co-authored-by: Sarven Capadisli --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 78dd793..c6b427f 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ For the time being, the present document contains the best approximation of expe [Solid](https://github.com/solid/solid) is a proposed set of conventions and tools for building *decentralized applications* based on [Linked -Data](http://www.w3.org/DesignIssues/LinkedData.html) principles. Solid is +Data](https://www.w3.org/DesignIssues/LinkedData) principles. Solid is modular and extensible. It relies as much as possible on existing [W3C](http://www.w3.org/) standards and protocols.