Skip to content

Commit 78dac92

Browse files
committed
address @TallTed reviews
> Co-authored-by: @TallTed [email protected]
1 parent 75380bd commit 78dac92

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

index.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1912,7 +1912,7 @@ <h3><code>EventAffordance</code></h3>
19121912
<p>
19131913
EventAffordances are similar to observable PropertyAffordances in the sense that the Thing itself informs
19141914
interested Consumers about state changes. However, a main difference of EventAffordances is that not every
1915-
change of the associated resource needs to trigger an event message to be emitted, e.g. a critical
1915+
change of the associated resource needs to trigger an event message to be emitted, e.g., a critical
19161916
threshold for a numeric value. Furthermore, EventAffordances allow for more complex subscribing and
19171917
unsubscribing mechanisms via the definition of <code>subscription</code>, <code>dataResponse</code>, and
19181918
<code>cancellation</code> DataSchema definitions. Not all protocols might support these more advanced
@@ -2520,8 +2520,8 @@ <h3><code>ObjectSchema</code></h3>
25202520
<td><code>required</code></td>
25212521
<td>
25222522
Defines which members of the object type are mandatory, i.e. which members are mandatory in the
2523-
payload that is to be sent (e.g. input of <code>invokeaction</code>, <code>writeproperty</code>) and
2524-
what members will be definitely delivered in the payload that is being received (e.g. output of
2523+
payload that is to be sent (e.g., input of <code>invokeaction</code>, <code>writeproperty</code>)
2524+
and what members will be definitely delivered in the payload that is being received (e.g., output of
25252525
<code>invokeaction</code>, <code>readproperty</code>)
25262526
</td>
25272527
<td>optional</td>
@@ -2760,7 +2760,7 @@ <h3><code>SecurityScheme</code></h3>
27602760
<code>SecurityScheme</code>, then the <code>name</code> field SHOULD NOT be set.</span
27612761
>
27622762
In this case, the application of the <code>SecurityScheme</code> is subject to the respective
2763-
specification for the given protocol (e.g. [[!RFC8288]] when using the
2763+
specification for the given protocol (e.g., [[!RFC8288]] when using the
27642764
<code>BasicSecurityScheme</code> with HTTP).
27652765
</dd>
27662766
</dl>
@@ -2892,7 +2892,7 @@ <h3><code>AutoSecurityScheme</code></h3>
28922892
An automatic authentication security configuration identified by the term <code>auto</code> (i.e.,
28932893
<code>"scheme": "auto"</code>). This scheme indicates that the security parameters are going to be
28942894
negotiated by the underlying protocols at runtime, subject to the respective specifications for the
2895-
protocol (e.g. [[!RFC8288]] for Basic Authentication when using HTTP).
2895+
protocol (e.g., [[!RFC8288]] for Basic Authentication when using HTTP).
28962896
</p>
28972897
</section>
28982898
<section>
@@ -3678,7 +3678,7 @@ <h3><code>Form</code></h3>
36783678
<tr class="rfc2119-table-assertion" id="td-vocab-href--Form">
36793679
<td><code>href</code></td>
36803680
<td>
3681-
Target URI[[RFC3986]] of a submission target of a <a>Form</a>. If relative, it is combined with the
3681+
Target URI [[RFC3986]] of a submission target of a <a>Form</a>. If relative, it is combined with the
36823682
value in the <code>base</code> in Thing-level to create an absolute URI.
36833683
</td>
36843684
<td>mandatory</td>
@@ -3761,7 +3761,7 @@ <h3><code>Form</code></h3>
37613761
<tr class="rfc2119-table-assertion" id="td-vocab-additionalResponses--Form">
37623762
<td><code>additionalResponses</code></td>
37633763
<td>
3764-
This optional term can be used if additional expected responses are possible, e.g. for error
3764+
This optional term can be used if additional expected responses are possible, e.g., for error
37653765
reporting. Each additional response needs to be distinguished from others in some way (for example,
37663766
by specifying a protocol-specific error code), and may also have its own data schema.
37673767
</td>
@@ -3816,12 +3816,12 @@ <h3><code>Form</code></h3>
38163816
</table>
38173817

38183818
<p class="note">
3819-
Please note that the value of <code>href</code> is of of type URI[[RFC3986]] and what is sent as a
3819+
Please note that the value of <code>href</code> is of of type URI [[RFC3986]] and what is sent as a
38203820
protocol message is protocol-specific and can be decoded from <code>href</code>.
38213821
<span class="rfc2119-assertion" id="td-form-href-unicode-usage">
3822-
In cases of protocols where Universal Character Set (Unicode) [[ISO10646]] characters are to be sent in
3823-
the protocol message, the resource MAY be represented internally as an IRI[[!RFC3987]] and can be
3824-
converted to a URI following Section 3.1 of [[RFC3987]] before placing it in the <code>href</code>.
3822+
When Universal Character Set (Unicode) [[ISO10646]] characters are to be sent in the protocol message,
3823+
the resource MAY be represented internally as an IRI [[!RFC3987]] and can be converted to a URI
3824+
following Section 3.1 of [[RFC3987]] before placing it in the <code>href</code>.
38253825
</span>
38263826
</p>
38273827

ontology/hctl.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ <h2>Terminology</h2>
148148
<section id="ExpectedResponse"><h4>ExpectedResponse</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#ExpectedResponse</code></p><span>Communication metadata describing the expected response message for the primary response.</span><table class="def numbered"><tbody><tr><td>In the range of</td><td><code><a href="#returns">hctl:returns</a></code></td></tr></tbody></table></section>
149149
<section id="Form"><h4>Form</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#Form</code></p><span>A form can be viewed as a statement of "To perform an <b><em>operation type</em></b> operation on <b><em>form context</b></em>, make a <b><em>request method</b></em> request to <b><em>submission target</b></em>" where the optional <b><em>form fields</b></em> may further describe the required request. In Thing Descriptions, the <b><em>form context</b></em> is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions.</span><table class="def numbered"><tbody><tr><td>In the domain of</td><td><code><a href="#additionalReturns">hctl:additionalReturns</a></code><br><code><a href="#forContentCoding">hctl:forContentCoding</a></code><br><code><a href="#forContentType">hctl:forContentType</a></code><br><code><a href="#forSubProtocol">hctl:forSubProtocol</a></code><br><code><a href="#hasOperationType">hctl:hasOperationType</a></code><br><code><a href="#hasTarget">hctl:hasTarget</a></code><br><code><a href="#returns">hctl:returns</a></code><br><code><a href="https://www.w3.org/2019/wot/td#hasSecurityConfiguration">td:hasSecurityConfiguration</a></code></td></tr><tr><td>In the range of</td><td><code><a href="https://www.w3.org/2019/wot/td#hasForm">td:hasForm</a></code></td></tr></tbody></table></section>
150150
<section id="Link"><h4>Link</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#Link</code></p><span>A link can be viewed as a statement of the form "<b><em>link context</em></b> has a <b><em>relation type</em></b> resource at <b><em>link target</em></b>", where the optional <b><em>target attributes</em></b> may further describe the resource.</span><table class="def numbered"><tbody><tr><td>In the domain of</td><td><code><a href="#hasAnchor">hctl:hasAnchor</a></code><br><code><a href="#hasHreflang">hctl:hasHreflang</a></code><br><code><a href="#hasRelationType">hctl:hasRelationType</a></code><br><code><a href="#hasSizes">hctl:hasSizes</a></code><br><code><a href="#hasTarget">hctl:hasTarget</a></code><br><code><a href="#hintsAtMediaType">hctl:hintsAtMediaType</a></code></td></tr><tr><td>In the range of</td><td><code><a href="https://www.w3.org/2019/wot/td#hasLink">td:hasLink</a></code></td></tr></tbody></table></section></section><section><h3>Object Properties</h3><section id="additionalReturns"><h4>additionalReturns</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#additionalReturns</code></p><span>This optional term can be used if additional expected responses
151-
are possible, e.g. for error reporting. Each additional response needs to be
151+
are possible, e.g., for error reporting. Each additional response needs to be
152152
distinguished from others in some way (for example, by specifying
153153
a protocol-specific response code), and may also have its own data schema.</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Form">hctl:Form</a></code></td></tr><tr><td>Range includes</td><td><code><a href="#AdditionalExpectedResponse">hctl:AdditionalExpectedResponse</a></code></td></tr></tbody></table></section>
154154
<section id="hasAdditionalOutputSchema"><h4>hasAdditionalOutputSchema</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hasAdditionalOutputSchema</code></p><span>This optional term can be used to define a data schema for
@@ -168,7 +168,7 @@ <h2>Terminology</h2>
168168
<section id="hasHreflang"><h4>hasHreflang</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hasHreflang</code></p><span>The hreflang attribute specifies the language of a linked document. The value of this must be a valid language tag [[BCP47]].</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Link">hctl:Link</a></code></td></tr></tbody></table></section>
169169
<section id="hasRelationType"><h4>hasRelationType</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hasRelationType</code></p><span>A link relation type identifies the semantics of a link.</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Link">hctl:Link</a></code></td></tr></tbody></table></section>
170170
<section id="hasSizes"><h4>hasSizes</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hasSizes</code></p><span>Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., "16x16", "16x16 32x32")</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Link">hctl:Link</a></code></td></tr></tbody></table></section>
171-
<section id="hasTarget"><h4>hasTarget</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hasTarget</code></p><span>Target URI[[RFC3986]] of a submission target of a <a>Form</a>. If relative, it is combined with the value in the <code>base</code> in Thing-level to create an absolute URI.</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Form">hctl:Form</a></code><br><code><a href="#Link">hctl:Link</a></code></td></tr></tbody></table></section>
171+
<section id="hasTarget"><h4>hasTarget</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hasTarget</code></p><span>Target URI [[RFC3986]] of a submission target of a <a>Form</a>. If relative, it is combined with the value in the <code>base</code> in Thing-level to create an absolute URI.</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Form">hctl:Form</a></code><br><code><a href="#Link">hctl:Link</a></code></td></tr></tbody></table></section>
172172
<section id="hintsAtMediaType"><h4>hintsAtMediaType</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#hintsAtMediaType</code></p><span>Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#Link">hctl:Link</a></code></td></tr><tr><td>Range includes</td><td><code><a href="http://schema.org/Text">schema:Text</a></code></td></tr></tbody></table></section>
173173
<section id="isSuccess"><h4>isSuccess</h4><p>IRI: <code>https://www.w3.org/2019/wot/hypermedia#isSuccess</code></p><span>Signals if the additional response should not be considered an error.</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="#AdditionalExpectedResponse">hctl:AdditionalExpectedResponse</a></code></td></tr><tr><td>Range includes</td><td><code><a href="http://schema.org/Boolean">schema:Boolean</a></code></td></tr></tbody></table></section></section><section><h3>Annotation Properties</h3><p>No AnnotationProperty found in the ontology.</p></section></section>
174174

ontology/hctl.ttl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For example, for HTTP and Events, it indicates which of several available mechan
5151
:additionalReturns rdf:type owl:ObjectProperty ;
5252
rdfs:label "additionalReturns" ;
5353
rdfs:comment """This optional term can be used if additional expected responses
54-
are possible, e.g. for error reporting. Each additional response needs to be
54+
are possible, e.g., for error reporting. Each additional response needs to be
5555
distinguished from others in some way (for example, by specifying
5656
a protocol-specific response code), and may also have its own data schema."""@en ;
5757
schema:domainIncludes :Form ;
@@ -81,7 +81,7 @@ For example, for HTTP and Events, it indicates which of several available mechan
8181
schema:domainIncludes :Link .
8282

8383
:hasTarget rdf:type owl:DatatypeProperty ;
84-
rdfs:comment "Target URI[[RFC3986]] of a submission target of a <a>Form</a>. If relative, it is combined with the value in the <code>base</code> in Thing-level to create an absolute URI." ;
84+
rdfs:comment "Target URI [[RFC3986]] of a submission target of a <a>Form</a>. If relative, it is combined with the value in the <code>base</code> in Thing-level to create an absolute URI." ;
8585
rdfs:label "hasTarget" ;
8686
schema:domainIncludes :Link, :Form .
8787

0 commit comments

Comments
 (0)