Skip to content

Commit

Permalink
Added appendix section "Changes from Proposed Recommendation".
Browse files Browse the repository at this point in the history
  • Loading branch information
Takuki Kamiya committed Mar 13, 2020
1 parent 79526a0 commit c572fbd
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 160 deletions.
92 changes: 12 additions & 80 deletions index.html
View file
Expand Up @@ -5566,6 +5566,16 @@ <h1>JSON-LD Context Usage</h1>

<section id="changes" class="appendix">
<h1>Recent Specification Changes</h1>
<section>
<h2 id="changes-from-proposed-recommendation">Changes from Proposed Recommendation</h2>
<ul>
<li>CoAP Content-Format ID 432 was assigned by IANA. (See section <a href="#identification"></a> and
<a href="#content-format-section"></a>).</li>
<li>In section <a href="#behavior-security"></a>, clarified the interaction between the dynamic authentication information asked by some security protocols and the security configurations information declared in the Thing Description.</li>
<li>Several instances of a typo was fixed in appendix section <a href="#json-schema-for-validation"></a></li>
</ul>
</section>

<section>
<h2 id="changes-from-candidate-recommendation2">Changes from Second Candidate Recommendation</h2>
<ul>
Expand All @@ -5580,86 +5590,8 @@ <h2 id="changes-from-candidate-recommendation2">Changes from Second Candidate Re

<section>
<h2 id="changes-from-candidate-recommendation">Changes from First Candidate Recommendation</h2>
<ul>
<li>General</li>
<ul>
<li>Clarified definition of <a>TD Processor</a> and related text that implementations may be TD producer or TD consumer only as correctly assumed by all implementations (no impact on implementations).</li>
<li>Clarified uniqueness and possible values for Thing <code>id</code>, in particular privacy-preserving values such as URIs with local IP addresses or temporary and mutable URIs.</li>
<li>Updated references.</li>
<li>Improved text on semantic annotations.</li>
<li>Updated <a href="#thing-description-full-serialization"></a> to fix bugs.</li>
<ul>
<li><code>name</code> was renamed to <code>title</code> to reflect a previous change of the <a href="#thing"></a> Class definition.</li>
<li><code>@type</code> was removed from the forms.</li>
</ul>
<li>Updated <a href="#example-33-mylampthing-with-coap-protocol-binding"></a> to fix bug.</li>
<ul>
<li><code>op</code> was added to the form of the <code>status</code> Property to override the default value.</li>
<li>The default value of <code>["readproperty", "writeproperty"]</code> would have caused both forms to have the method GET, which was not the intention.</li>
</ul>
<li>Minor editorial text improvements and fixes.</li>
</ul>

<li>Terminology</li>
<ul>
<li>Section <a href="#terminology"></a> is non-normative.</li>
</ul>

<li>TD Information Model</li>
<ul>
<li>In section <a href="#thing"></a>, the <a>vocabulary term</a> id of a <a>Thing</a> was made optional. Also, mentions of uniqueness of id were removed because there is not such a requirement.</li>
<li>Adjusted location of a label in <a href="#td-core-model"></a>.</li>
<li>Fix uppercase MAY to lowercase that was not part of an assertion sentence/markup (TD Context Extension for data schema; no impact on implementations).</li>
<li>The title of <a href="#td-data-schema-model">Figure 2</a> "JSON schema vocabulary" was changed to "Data schema Vocabulary".</li>
<li>The <a>vocabulary term</a> <code>flow</code> of <a href="#oauth2securityscheme">OAuth2 authentication security configuration</a> now does not have a default value. Therefore, it was removed from section <a href="#sec-default-values"></a>.
</li>
</ul>

<li>TD Representation Format</li>
<ul>
<li>In section <a href="#form-serialization-json"></a>, the expectation for <a>Consumers</a> and <a>Things</a> in handling the operation type <code>writeallproperties</code> is clarified.</li>
</ul>

<li>TD Context Extensions</li>
<ul>
<li>Improved <a href="#example-28"></a> and <a href="#saref-state-annotation-example"></a></li>
<ul>
<li>Use <code>saref:TemperatureSensor</code> to semantically annotate the Thing with an extension class.</li>
<li>Use SAREF to also annotate Property to be consistent across the examples.</li>
<li>Use newer version of ontology-of-units-of-measure (om).</li>
</ul>
<li>Updated <a href="#saref-state-annotation-example"></a> to clarify the design difference from that of <a href="#thing-description-full-serialization"></a>.</li>
</ul>

<li> Behavioral Assertions</li>
<ul>
<li>Section <a href="#behavior-data"></a> describes the precise conditions as to when Things may return additional data and Consumers have to accept additional data even when such data is not described in the data schemas.</li>
<li>Section <a href="#http-binding-assertions"></a> was so renamed from "HTTP Protocol Binding".</li>
</ul>

<li>Security and Privacy Considerations</li>
<ul>
<li>Updated section <a href="#sec-security-consideration"></a> to match the <a>vocabulary term</a> id of a <a>Thing</a> being non-unique and optional.</li>
<ul>
<li>Added mitigations such as "filtering out IDs when not needed for a use case".</li>
<li>Added risks such as fingerprinting the type of a device.</li>
<li>Added risks for globally unique IDs, and points out that this is not required and that distributed cryptographic mechanisms or locally-scoped ids can be used.</li>
</ul>
</ul>

<li>Appendix</li>
<ul>
<li>Appendix section <a href="#thing-templates"></a> was so renamed from "Thing Templates".</li>
<li>Appendix section <a href="#json-ld-ctx-usage"></a> now explains the two steps to retrieve the TD information model in RDF.</li>
<li>A reference to the WoT Architecture specification [[?WOT-ARCHITECTURE]] is informative.</li>
</ul>
</ul>
</section>

<section>
<h2 id="changes-from-third-public-working-draft">Changes from Third Public Working Draft</h2>
<p>Changes from Third Public Working Draft are described in the
<a href="https://www.w3.org/TR/2019/CR-wot-thing-description-20190516/#changes">Candidate Recommendation</a>
<p>Changes from First Candidate Recommendation are described in the second
<a href="https://www.w3.org/TR/2019/CR-wot-thing-description-20191106/#changes">Candidate Recommendation</a>
</p>
</section>

Expand Down
92 changes: 12 additions & 80 deletions index.template.html
View file
Expand Up @@ -4480,6 +4480,16 @@ <h1>JSON-LD Context Usage</h1>

<section id="changes" class="appendix">
<h1>Recent Specification Changes</h1>
<section>
<h2 id="changes-from-proposed-recommendation">Changes from Proposed Recommendation</h2>
<ul>
<li>CoAP Content-Format ID 432 was assigned by IANA. (See section <a href="#identification"></a> and
<a href="#content-format-section"></a>).</li>
<li>In section <a href="#behavior-security"></a>, clarified the interaction between the dynamic authentication information asked by some security protocols and the security configurations information declared in the Thing Description.</li>
<li>Several instances of a typo was fixed in appendix section <a href="#json-schema-for-validation"></a></li>
</ul>
</section>

<section>
<h2 id="changes-from-candidate-recommendation2">Changes from Second Candidate Recommendation</h2>
<ul>
Expand All @@ -4494,86 +4504,8 @@ <h2 id="changes-from-candidate-recommendation2">Changes from Second Candidate Re

<section>
<h2 id="changes-from-candidate-recommendation">Changes from First Candidate Recommendation</h2>
<ul>
<li>General</li>
<ul>
<li>Clarified definition of <a>TD Processor</a> and related text that implementations may be TD producer or TD consumer only as correctly assumed by all implementations (no impact on implementations).</li>
<li>Clarified uniqueness and possible values for Thing <code>id</code>, in particular privacy-preserving values such as URIs with local IP addresses or temporary and mutable URIs.</li>
<li>Updated references.</li>
<li>Improved text on semantic annotations.</li>
<li>Updated <a href="#thing-description-full-serialization"></a> to fix bugs.</li>
<ul>
<li><code>name</code> was renamed to <code>title</code> to reflect a previous change of the <a href="#thing"></a> Class definition.</li>
<li><code>@type</code> was removed from the forms.</li>
</ul>
<li>Updated <a href="#example-33-mylampthing-with-coap-protocol-binding"></a> to fix bug.</li>
<ul>
<li><code>op</code> was added to the form of the <code>status</code> Property to override the default value.</li>
<li>The default value of <code>["readproperty", "writeproperty"]</code> would have caused both forms to have the method GET, which was not the intention.</li>
</ul>
<li>Minor editorial text improvements and fixes.</li>
</ul>

<li>Terminology</li>
<ul>
<li>Section <a href="#terminology"></a> is non-normative.</li>
</ul>

<li>TD Information Model</li>
<ul>
<li>In section <a href="#thing"></a>, the <a>vocabulary term</a> id of a <a>Thing</a> was made optional. Also, mentions of uniqueness of id were removed because there is not such a requirement.</li>
<li>Adjusted location of a label in <a href="#td-core-model"></a>.</li>
<li>Fix uppercase MAY to lowercase that was not part of an assertion sentence/markup (TD Context Extension for data schema; no impact on implementations).</li>
<li>The title of <a href="#td-data-schema-model">Figure 2</a> "JSON schema vocabulary" was changed to "Data schema Vocabulary".</li>
<li>The <a>vocabulary term</a> <code>flow</code> of <a href="#oauth2securityscheme">OAuth2 authentication security configuration</a> now does not have a default value. Therefore, it was removed from section <a href="#sec-default-values"></a>.
</li>
</ul>

<li>TD Representation Format</li>
<ul>
<li>In section <a href="#form-serialization-json"></a>, the expectation for <a>Consumers</a> and <a>Things</a> in handling the operation type <code>writeallproperties</code> is clarified.</li>
</ul>

<li>TD Context Extensions</li>
<ul>
<li>Improved <a href="#example-28"></a> and <a href="#saref-state-annotation-example"></a></li>
<ul>
<li>Use <code>saref:TemperatureSensor</code> to semantically annotate the Thing with an extension class.</li>
<li>Use SAREF to also annotate Property to be consistent across the examples.</li>
<li>Use newer version of ontology-of-units-of-measure (om).</li>
</ul>
<li>Updated <a href="#saref-state-annotation-example"></a> to clarify the design difference from that of <a href="#thing-description-full-serialization"></a>.</li>
</ul>

<li> Behavioral Assertions</li>
<ul>
<li>Section <a href="#behavior-data"></a> describes the precise conditions as to when Things may return additional data and Consumers have to accept additional data even when such data is not described in the data schemas.</li>
<li>Section <a href="#http-binding-assertions"></a> was so renamed from "HTTP Protocol Binding".</li>
</ul>

<li>Security and Privacy Considerations</li>
<ul>
<li>Updated section <a href="#sec-security-consideration"></a> to match the <a>vocabulary term</a> id of a <a>Thing</a> being non-unique and optional.</li>
<ul>
<li>Added mitigations such as "filtering out IDs when not needed for a use case".</li>
<li>Added risks such as fingerprinting the type of a device.</li>
<li>Added risks for globally unique IDs, and points out that this is not required and that distributed cryptographic mechanisms or locally-scoped ids can be used.</li>
</ul>
</ul>

<li>Appendix</li>
<ul>
<li>Appendix section <a href="#thing-templates"></a> was so renamed from "Thing Templates".</li>
<li>Appendix section <a href="#json-ld-ctx-usage"></a> now explains the two steps to retrieve the TD information model in RDF.</li>
<li>A reference to the WoT Architecture specification [[?WOT-ARCHITECTURE]] is informative.</li>
</ul>
</ul>
</section>

<section>
<h2 id="changes-from-third-public-working-draft">Changes from Third Public Working Draft</h2>
<p>Changes from Third Public Working Draft are described in the
<a href="https://www.w3.org/TR/2019/CR-wot-thing-description-20190516/#changes">Candidate Recommendation</a>
<p>Changes from First Candidate Recommendation are described in the second
<a href="https://www.w3.org/TR/2019/CR-wot-thing-description-20191106/#changes">Candidate Recommendation</a>
</p>
</section>

Expand Down

0 comments on commit c572fbd

Please sign in to comment.