Skip to content

Commit

Permalink
Remove trailing whitespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
@lu-zero
lu-zero committed Feb 13, 2023
1 parent f72b27f commit b756329
Showing 1 changed file with 59 additions and 59 deletions.
118 changes: 59 additions & 59 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,15 +150,15 @@
<li>In addition, it defines a <strong><a href="#http-basic-profile">HTTP Basic
Profile</a></strong> of the Thing Description, which
contains protocol binding rules for HTTP.
<p>The <em>normative</em> HTTP Basic Profile is complemented by two
<em>informative profiles for events</em>: The <a href=#sec-http-sse-profile>HTTP SSE Profile</a>
<p>The <em>normative</em> HTTP Basic Profile is complemented by two
<em>informative profiles for events</em>: The <a href=#sec-http-sse-profile>HTTP SSE Profile</a>
and the <a href="#sec-http-webhook-profile">HTTP Webhook Profile</a>.

<p>
In the current version of this document these event bindings are provided in <em>informative</em>
sections, to illustrate how these event mechanisms could be supported in other profiles.
</p>
<p>It is planned that future versions of this document <em>normatively</em> define
<p>It is planned that future versions of this document <em>normatively</em> define
these event mechanisms.
</p>

Expand All @@ -183,7 +183,7 @@
hold only for the HTTP Basic Profile subset.
</p>
<p>Future versions of this document may contain other profiles,
e.g. a profile for digital twins and a profile for resource constrained devices.</p>
e.g. a profile for digital twins and a profile for resource constrained devices.</p>

<section>
<h3>Motivation for a Profile</h3>
Expand Down Expand Up @@ -478,8 +478,8 @@ <h4 id="additional-definitions-">Additional Definitions</h4>
<dfn class="export">Profile</dfn>
</dt>
<dd>A technical specification which provides a set of assertions such that
any <a href="#dfn-consumer">Consumer</a> which conforms with the those
assertions is <a href="#out-of-the-box-interoperability">out-of-the-box
any <a href="#dfn-consumer">Consumer</a> which conforms with the those
assertions is <a href="#out-of-the-box-interoperability">out-of-the-box
interoperable</a> with any <a href="#dfn-thing">Thing</a> which also
conforms with those assertions.
</dd>
Expand Down Expand Up @@ -562,35 +562,35 @@ <h2 id="accessibility">Accessibility</h2>
users with disabilities.
</p>
<p><span class="rfc2119-assertion" id="common-constraints-a11y-1">
It is REQUIRED to provide a <code>title</code> that can be automatically rendered in a non-visual way
It is REQUIRED to provide a <code>title</code> that can be automatically rendered in a non-visual way
(e.g. using a screen reader)
for things that may be used in deployments with users with disabilities.</span>
</p>
<p><span class="rfc2119-assertion" id="common-constraints-a11y-2">
It is highly RECOMMENDED to provide a <code>description</code> that can be automatically rendered in a non-visual way
It is highly RECOMMENDED to provide a <code>description</code> that can be automatically rendered in a non-visual way
(e.g. using a screen reader)
for things that may be used in deployments with users with disabilities.</span>
</p>
<section class="ednote">
This is just a baseline set of requirements, which needs additional input from the APA group.
It needs to be clarified which TD elements are used by people with disabilities and to which these constraints are applied.
</section>

</section>
<!-- Units -->

<section id="sdec-common-constraints-units">
<h2 id="units">Units</h2>
<p>Authors of <a>Thing Descriptions</a> should be aware that units
that are common in their geographic region are not globally applicable
that are common in their geographic region are not globally applicable
and may lead to misinterpretation with drastic consequences.
</p>
<p><span class="rfc2119-assertion" id="common-constraints-units">
It is highly RECOMMENDED to provide a <code>unit</code>,
It is highly RECOMMENDED to provide a <code>unit</code>,
if a value has a physical quantity.</span>
</p>
<p><span class="rfc2119-assertion" id="common-constraints-units-metric">
It is highly RECOMMENDED to use the metric system (SI units)
It is highly RECOMMENDED to use the metric system (SI units)
for devices that are used in global deployments.</span>
</p>
</section>
Expand All @@ -600,7 +600,7 @@ <h2 id="units">Units</h2>
<h2 id="date-format">Date Format</h2>
<p>
<span class="rfc2119-assertion" id="common-constraints-date-format-1">
All date and time values MUST use the <code>date-time</code> format
All date and time values MUST use the <code>date-time</code> format
defined in [[RFC3339]].</span>
</p>
<pre class="example">
Expand Down Expand Up @@ -645,22 +645,22 @@ <h2>Security</h2>
<p><span class="rfc2119-assertion" id="common-constraints-security-2">
Conformant Consumers MUST support all of these security schemes.</span>
</p>

<p><span class="rfc2119-assertion" id="common-constraints-security-3">
A Thing MAY implement multiple security schemes.</span>
</p>

<p><span class="rfc2119-assertion" id="common-constraints-security-6">
Conformant Consumers MUST support security bootstrapping for all
Conformant Consumers MUST support security bootstrapping for all
implemented security schemes, as defined in
<a href="https://w3c.github.io/wot-discovery/#exploration-secboot">Security Bootstrapping</a>
in the WoT Discovery [[wot-discovery]] specification.
</span></p>

<p><span class="rfc2119-assertion" id="common-constraints-security-7">
Conformant Things which require authentication in order to retrieve
Conformant Things which require authentication in order to retrieve
their Thing Description MUST implement security bootstrapping, as
defined in
defined in
<a href="https://w3c.github.io/wot-discovery/#exploration-secboot">Security Bootstrapping</a>
in the WoT Discovery [[wot-discovery]] specification.
</span></p>
Expand All @@ -670,7 +670,7 @@ <h2>Security</h2>
<section id="common-constraints-discovery">
<h2>Discovery</h2>
<p class="rfc2119-assertion" id="common-constraints-discovery-1">
A Web Thing's Thing Description [[wot-thing-description]] MUST be
A Web Thing's Thing Description [[wot-thing-description]] MUST be
retrievable from a
<a href="https://w3c.github.io/wot-architecture/#dfn-wot-thing-description-server">
Thing Description Server</a> [[wot-architecture11]] using an HTTP
Expand All @@ -687,7 +687,7 @@ <h2>Links</h2>

<p>Hypermedia links in the HTTP Profiles are significantly constrained to ensure a common interpretation
and interoperability between things and consumers.</p>

<p>
<span class="rfc2119-assertion" id="common-constraints-links-1">The following keywords are defined for links in the
HTTP profiles and MAY be present in profile-compliant TDs with the constraints defined by this section.</span>
Expand All @@ -698,7 +698,7 @@ <h2>Links</h2>
<span class="rfc2119-assertion" id="common-constraints-links-3">These other link types MAY
be ignored by all profile-compliant consumers.</span>
</p>

<section class=note>
<p>
These links enable consumers to interpret linked content that is provided by the link target in an unambiguous way.
Expand Down Expand Up @@ -800,7 +800,7 @@ <h3>Media Types for Link Targets</h3>
<span class="rfc2119-assertion" id="common-constraints-links-media-types-1">The following media types from <a
href="https://www.iana.org/assignments/media-types/media-types.xhtml">IANA</a>
MAY be used as the link targets of profile compliant TDs with the constraints in this section.</span>
<span class="rfc2119-assertion" id="common-constraints-links-media-types-2">Other media types MAY
<span class="rfc2119-assertion" id="common-constraints-links-media-types-2">Other media types MAY
be present in a TD, however their heir interpretation is undefined
in the context of the HTTP profiles and they MAY be ignored by all profile-compliant consumers.</span>
<table class="def">
Expand Down Expand Up @@ -868,7 +868,7 @@ <h3>Media Types for Link Targets</h3>
</section>
</p>
<p>

<span class="rfc2119-assertion" id="common-constraints-links-media-types-6">
If a Consumer encounters a link with "rel": "service-doc" and "type": "text/plain", "type": "text/html" or "type":
"text/pdf", and is capable of rendering documents in the provided format, then it SHOULD interpret the link as a
Expand All @@ -877,7 +877,7 @@ <h3>Media Types for Link Targets</h3>
</section>
</p>
<p>

<span class="rfc2119-assertion" id="common-constraints-links-media-types-7">
If a Consumer encounters a link with "rel": "item" and "type": "application/td+json" and is capable of rendering a
hierarchical tree of Things, then it should interpret the link as an indication that the target is a sub-Thing of
Expand All @@ -886,7 +886,7 @@ <h3>Media Types for Link Targets</h3>
</span>
</p>
<p>

<span class="rfc2119-assertion" id="common-constraints-links-media-types-8">
If a Consumer encounters a link with "rel": "collection" and "type": "application/td+json" and is capable of
rendering a
Expand Down Expand Up @@ -976,7 +976,7 @@ <h2>HTTP Basic Profile</h2>
<span class="rfc2119-assertion" id="http-basic-profile-1">
In order to conform with the HTTP Basic Profile, Web Things and
Consumers MUST also conform with all of the assertions in the
<a href="#common-constraints">Common Constraints</a>
<a href="#common-constraints">Common Constraints</a>
section.
</span>
</p>
Expand Down Expand Up @@ -1132,7 +1132,7 @@ <h5><code>readproperty</code></h5>
<li>URL set to the URL of the <code>Property</code> resource</li>
<li><code>Accept</code> header set to <code>application/json
</code></li>
</ul>
</ul>
</div>
<pre class="example">
GET /things/lamp/properties/on HTTP/1.1
Expand Down Expand Up @@ -1452,32 +1452,32 @@ <h5><code>invokeaction</code></h5>
</ol>
</div>
<p>
<span class="rfc2119-assertion"
<span class="rfc2119-assertion"
id="http-basic-profile-protocol-binding-invokeaction-7">
If the <code>synchronous</code> member of the
If the <code>synchronous</code> member of the
<a href="https://w3c.github.io/wot-thing-description/#actionaffordance"><code>ActionAffordance</code></a>
[[wot-thing-description11]] is set to <code>true</code> then the Web
[[wot-thing-description11]] is set to <code>true</code> then the Web
Thing MUST respond with a
<a href="#sync-action-response">Synchronous Action Response</a>.
</span>
</p>
<p>
<span class="rfc2119-assertion"
<span class="rfc2119-assertion"
id="http-basic-profile-protocol-binding-invokeaction-8">
If the <code>synchronous</code> member of the
If the <code>synchronous</code> member of the
<a href="https://w3c.github.io/wot-thing-description/#actionaffordance"><code>ActionAffordance</code></a>
[[wot-thing-description11]] is set to <code>false</code> then the Web
[[wot-thing-description11]] is set to <code>false</code> then the Web
Thing MUST respond with an
<a href="#async-action-response">Asynchronous Action Response</a>.
</span>
</p>
<p>
<span class="rfc2119-assertion"
<span class="rfc2119-assertion"
id="http-basic-profile-protocol-binding-invokeaction-9">
If the <code>synchronous</code> member of the
If the <code>synchronous</code> member of the
<a href="https://w3c.github.io/wot-thing-description/#actionaffordance"><code>ActionAffordance</code></a>
[[wot-thing-description11]] is <code>undefined</code> then the Web
Thing MAY respond with either a
[[wot-thing-description11]] is <code>undefined</code> then the Web
Thing MAY respond with either a
<a href="#sync-action-response">Synchronous Action Response</a> or
<a href="#async-action-response">Asynchronous Action Response</a>.
</span>
Expand Down Expand Up @@ -1565,7 +1565,7 @@ <h6 id="ActionStatus"><code>ActionStatus</code> object</h6>
<td><code>href</code></td>
<td>
The [[URL]] of an <code>ActionStatus</code> resource which
can be used by <code>queryaction</code> and
can be used by <code>queryaction</code> and
<code>cancelaction</code> operations, the
<a href="https://tools.ietf.org/html/rfc3986#section-3.1">URI
scheme</a> [[RFC3986]] of which MUST resolve to
Expand All @@ -1580,8 +1580,8 @@ <h6 id="ActionStatus"><code>ActionStatus</code> object</h6>
<td><code>timeRequested</code></td>
<td>
A timestamp indicating the time at which the Thing received
the request to execute the action. (See
<a href="#date-format">Date Format</a> for date format
the request to execute the action. (See
<a href="#date-format">Date Format</a> for date format
constraints).
</td>
<td>optional</td>
Expand All @@ -1592,8 +1592,8 @@ <h6 id="ActionStatus"><code>ActionStatus</code> object</h6>
<td>
A timestamp indicating the time at which the Thing
successfully completed executing the action, or failed to
execute the action. (See
<a href="#date-format">Date Format</a> for date format
execute the action. (See
<a href="#date-format">Date Format</a> for date format
constraints).
</td>
<td>optional</td>
Expand Down Expand Up @@ -2223,8 +2223,8 @@ <h5><code>observeproperty</code></h5>
<span class="rfc2119-assertion" id="http-sse-profile-protocol-binding-observeproperty-5d">
It is RECOMMENDED that the
identifier is a timestamp representing the time at which the
property changed</span> (see
<a href="#date-format">Date Format</a> for date format
property changed</span> (see
<a href="#date-format">Date Format</a> for date format
constraints).
</p>
<pre class="example">
Expand Down Expand Up @@ -2382,8 +2382,8 @@ <h5><code>observeallproperties</code></h5>
below).</span>
<span class="rfc2119-assertion" id="http-sse-profile-protocol-binding-observeallproperties-5e">
It is RECOMMENDED that the identifier is a timestamp
representing the time at which the property changed</span> (see
<a href="#date-format">Date Format</a> for date format
representing the time at which the property changed</span> (see
<a href="#date-format">Date Format</a> for date format
constraints).
</p>
<pre class="example">
Expand Down Expand Up @@ -2557,8 +2557,8 @@ <h5><code>subscribeevent</code></h5>
below).</span>
<span class="rfc2119-assertion" id="http-sse-profile-protocol-binding-subscribeevent-6e">
It is RECOMMENDED that the identifier is a timestamp
representing the time at which the event ocurred</span> (see
<a href="#date-format">Date Format</a> for date format
representing the time at which the event ocurred</span> (see
<a href="#date-format">Date Format</a> for date format
constraints).
</p>
<pre class="example">
Expand Down Expand Up @@ -2805,17 +2805,17 @@ <h3>Introduction</h3>
A Webhook is similar to a callback mechanism in programming languages. Consumers can
subscribe to events they are interested in by registering a listener with the event endpoint.
When the event condition occurs, the WebThing
is notifying all listeners with a corresponding event message, which is transmitted over HTTP(s).
The event message contains details about the event, such as timestamp, event type,
is notifying all listeners with a corresponding event message, which is transmitted over HTTP(s).
The event message contains details about the event, such as timestamp, event type,
event source etc. in the data payload.
</p><p>
Depending on the deployment scenarios and integration requirements for existing consumers, it may be
Depending on the deployment scenarios and integration requirements for existing consumers, it may be
required to use specific data payload formats (e.g. Cloud Events).
When a listener receives an event message in a data payload, in many cases it just acknowledges the
When a listener receives an event message in a data payload, in many cases it just acknowledges the
successful reception of the event.
Additionally, it may provide a dataResponse payload, which provides a back-channel that can be used
to communicate further details from the consumer to the WebThing.
</p>
Additionally, it may provide a dataResponse payload, which provides a back-channel that can be used
to communicate further details from the consumer to the WebThing.
</p>
<p><span class="rfc2119-assertion" id="http-webhook-profile-protocol-binding-events-1">
Depending on the use case, a single listener for multiple things and multiple
event types MAY be used.</span>
Expand Down Expand Up @@ -2928,7 +2928,7 @@ <h3>Message Format</h3>
TODO: Describe data and dataResponse schemas.
</p>
</section>

<section id="http-webhook-profile-protocol-binding">
<h2>Protocol Binding</h2>
<p>
Expand Down Expand Up @@ -2999,7 +2999,7 @@ <h4><code>subscribeevent</code></h4>
</li>
<p>
The subscription payload contains the URI for the event message listener
in the field with the <code>callbackURI</code> key.
in the field with the <code>callbackURI</code> key.
</p>

</ul>
Expand Down

0 comments on commit b756329

Please sign in to comment.