Skip to content

Commit

Permalink
Script updating gh-pages from daf1d45. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
ID Bot committed Oct 19, 2023
1 parent a2fd401 commit 62ca66c
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 55 deletions.
67 changes: 42 additions & 25 deletions ps-rev/draft-ietf-core-coap-pubsub.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1257,7 +1257,7 @@ <h2 id="name-copyright-notice">
<p id="section-toc.1-1.6.2.1.1"><a href="#section-6.1" class="auto internal xref">6.1</a>.  <a href="#name-media-type" class="internal xref">Media Type</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6.2.2">
<p id="section-toc.1-1.6.2.2.1"><a href="#section-6.2" class="auto internal xref">6.2</a>.  <a href="#name-content-format" class="internal xref">Content Format</a></p>
<p id="section-toc.1-1.6.2.2.1"><a href="#section-6.2" class="auto internal xref">6.2</a>.  <a href="#name-content-format" class="internal xref">Content-Format</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6.2.3">
<p id="section-toc.1-1.6.2.3.1"><a href="#section-6.3" class="auto internal xref">6.3</a>.  <a href="#name-coap-pubsub-parameters-3" class="internal xref">CoAP Pubsub Parameters</a></p>
Expand Down Expand Up @@ -1688,7 +1688,7 @@ <h4 id="name-topic-properties">
<p id="section-2.2.1-2.3.1">'resource-type': A required field used to indicate the resource type of the topic-data resource for the topic. It encodes the resource type as a CBOR text string. The value should be "core.ps.conf".<a href="#section-2.2.1-2.3.1" class="pilcrow"></a></p>
</li>
<li class="normal" id="section-2.2.1-2.4">
<p id="section-2.2.1-2.4.1">'media-type': An optional field used to indicate the media type of the topic-data resource for the topic. It encodes the media type as a this information as the integer identifier of the CoAP content format (e.g., value is "50" for "application/json").<a href="#section-2.2.1-2.4.1" class="pilcrow"></a></p>
<p id="section-2.2.1-2.4.1">'media-type': An optional field used to indicate the media type of the topic-data resource for the topic. It encodes the media type as a this information as the integer identifier of the CoAP content-format (e.g., value is "50" for "application/json").<a href="#section-2.2.1-2.4.1" class="pilcrow"></a></p>
</li>
<li class="normal" id="section-2.2.1-2.5">
<p id="section-2.2.1-2.5.1">'topic-type': An optional field used to indicate the attribute or property of the topic-data resource for the topic. It encodes the attribute as a CBOR text string. Example attributes include "temperature".<a href="#section-2.2.1-2.5.1" class="pilcrow"></a></p>
Expand Down Expand Up @@ -2149,7 +2149,7 @@ <h4 id="name-publish">
<p id="section-3.2.1-1">A topic-configuration with a topic-data resource must have been created in order to publish data to it (See <a href="#topic-create" class="auto internal xref">Section 2.4.3</a>) and be in the half-created or fully-created state in order to the publish operation to work (see <a href="#topic-lifecycle" class="auto internal xref">Section 3.1</a>).<a href="#section-3.2.1-1" class="pilcrow"></a></p>
<p id="section-3.2.1-2">A client can publish data to a topic by submitting the data in a PUT request to the topic-data URI as indicated in its topic resource property. Please note that the topic-data URI is not the same as the topic-configuration URI used for configuring the topic (see <a href="#topic-resource-representation" class="auto internal xref">Section 2.2</a>).<a href="#section-3.2.1-2" class="pilcrow"></a></p>
<p id="section-3.2.1-3">On success, the server returns a 2.04 (Updated) response. However, when data is published to the topic for the first time, the server instead <span class="bcp14">MUST</span> return a 2.01 (Created) response and set the topic in the fully-created state (see <a href="#topic-lifecycle" class="auto internal xref">Section 3.1</a>).<a href="#section-3.2.1-3" class="pilcrow"></a></p>
<p id="section-3.2.1-4">If the request does not have an acceptable content format, the server returns a 4.15 (Unsupported Content Format) response.<a href="#section-3.2.1-4" class="pilcrow"></a></p>
<p id="section-3.2.1-4">If the request does not have an acceptable content-format, the server returns a 4.15 (Unsupported Content-Format) response.<a href="#section-3.2.1-4" class="pilcrow"></a></p>
<p id="section-3.2.1-5">If the client is sending publications too fast, the server returns a
4.29 (Too Many Requests) response <span>[<a href="#RFC8516" class="cite xref">RFC8516</a>]</span>.<a href="#section-3.2.1-5" class="pilcrow"></a></p>
<p id="section-3.2.1-6">Example of first publication:<a href="#section-3.2.1-6" class="pilcrow"></a></p>
Expand Down Expand Up @@ -2338,18 +2338,18 @@ <h2 id="name-coap-pubsub-parameters">
<figure id="figure-5">
<div class="alignCenter art-text artwork" id="section-4-3.1">
<pre>
+-----------------+-----------+--------------+------------+
| Name | CBOR Key | CBOR Type | Reference |
|-----------------|-----------|--------------|------------|
| topic-name | TBD1 | tstr | [RFC-XXXX] |
| topic-data | TBD2 | tstr | [RFC-XXXX] |
| resource-type | TBD3 | tstr | [RFC-XXXX] |
| media-type | TBD4 | uint (opt) | [RFC-XXXX] |
| topic-type | TBD5 | tstr (opt) | [RFC-XXXX] |
| expiration-date | TBD6 | tstr (opt) | [RFC-XXXX] |
| max-subscribers | TBD7 | uint (opt) | [RFC-XXXX] |
| observer-check | TBD8 | uint (opt) | [RFC-XXXX] |
+-----------------+-----------+--------------+------------+
+-----------------+-----------+-----------+------------+
| Name | CBOR Key | CBOR Type | Reference |
|-----------------|-----------|-----------|------------|
| topic-name | TBD1 | tstr | [RFC-XXXX] |
| topic-data | TBD2 | tstr | [RFC-XXXX] |
| resource-type | TBD3 | tstr | [RFC-XXXX] |
| media-type | TBD4 | uint | [RFC-XXXX] |
| topic-type | TBD5 | tstr | [RFC-XXXX] |
| expiration-date | TBD6 | tstr | [RFC-XXXX] |
| max-subscribers | TBD7 | uint | [RFC-XXXX] |
| observer-check | TBD8 | uint | [RFC-XXXX] |
+-----------------+-----------+-----------+------------+
</pre>
</div>
<figcaption><a href="#figure-5" class="selfRef">Figure 5</a>:
Expand Down Expand Up @@ -2451,14 +2451,12 @@ <h3 id="name-media-type">
<dd class="break"></dd>
<dt id="section-6.1-3.17">Applications that use this media type:</dt>
<dd style="margin-left: 1.5em" id="section-6.1-3.18">
<p id="section-6.1-3.18.1">Clients and servers in the Internet of Things<a href="#section-6.1-3.18.1" class="pilcrow"></a></p>
<p id="section-6.1-3.18.1">This type is used by clients that create, retrieve, and update topic configurations at servers acting as a pub-sub broker.<a href="#section-6.1-3.18.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
<dt id="section-6.1-3.19">Fragment identifier considerations:</dt>
<dd style="margin-left: 1.5em" id="section-6.1-3.20">
<p id="section-6.1-3.20.1">The syntax and semantics of fragment identifiers is as specified for
"application/cbor". (At publication of RFC XXXX, there is no
fragment identification syntax defined for "application/cbor".)<a href="#section-6.1-3.20.1" class="pilcrow"></a></p>
<p id="section-6.1-3.20.1">N/A<a href="#section-6.1-3.20.1" class="pilcrow"></a></p>
</dd>
<dd class="break"></dd>
<dt id="section-6.1-3.21">Person &amp; email address to contact for further information:</dt>
Expand Down Expand Up @@ -2493,7 +2491,7 @@ <h3 id="name-media-type">
<div id="content-format">
<section id="section-6.2">
<h3 id="name-content-format">
<a href="#section-6.2" class="section-number selfRef">6.2. </a><a href="#name-content-format" class="section-name selfRef">Content Format</a>
<a href="#section-6.2" class="section-number selfRef">6.2. </a><a href="#name-content-format" class="section-name selfRef">Content-Format</a>
</h3>
<p id="section-6.2-1">IANA has added the following Content-Formats to the
<a href="http://www.iana.org/assignments/core-parameters#content-formats" class="relref">"CoAP Content-Formats"</a>
Expand All @@ -2506,7 +2504,7 @@ <h3 id="name-content-format">
</caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">Content-Type</th>
<th class="text-left" rowspan="1" colspan="1">Content Type</th>
<th class="text-left" rowspan="1" colspan="1">Content Coding</th>
<th class="text-left" rowspan="1" colspan="1">ID</th>
<th class="text-left" rowspan="1" colspan="1">Reference</th>
Expand All @@ -2522,8 +2520,6 @@ <h3 id="name-content-format">
</tbody>
</table>
<p id="section-6.2-3">TBD9 is to be assigned from the space 256..999.<a href="#section-6.2-3" class="pilcrow"></a></p>
<p id="section-6.2-4">In the registry the column "Content-Type" is called "Media type" and the
column "Content Coding" is called "Encoding". <span class="cref" id="remove">This paragraph to be removed by RFC editor.</span><a href="#section-6.2-4" class="pilcrow"></a></p>
</section>
</div>
<div id="iana-coap-pubsub-parameters">
Expand All @@ -2532,7 +2528,24 @@ <h3 id="name-coap-pubsub-parameters-3">
<a href="#section-6.3" class="section-number selfRef">6.3. </a><a href="#name-coap-pubsub-parameters-3" class="section-name selfRef">CoAP Pubsub Parameters</a>
</h3>
<p id="section-6.3-1">IANA is asked to register the following entries in the subregistry of the "Constrained RESTful Environments (CoRE) Parameters" registry group.<a href="#section-6.3-1" class="pilcrow"></a></p>
<p id="section-6.3-2">The registry is initially populated with the entries in <a href="#fig-CoAP-Pubsub-Parameters" class="auto internal xref">Figure 5</a> of <a href="#pubsub-parameters" class="auto internal xref">Section 4</a>.<a href="#section-6.3-2" class="pilcrow"></a></p>
<p id="section-6.3-2">This specification establishes the "Pubsub Topic Configuration Parameters" IANA registry within the "Constrained RESTful Environments (CoRE)
Parameters" registry group.<a href="#section-6.3-2" class="pilcrow"></a></p>
<p id="section-6.3-3">The columns of this registry are:<a href="#section-6.3-3" class="pilcrow"></a></p>
<ul class="normal">
<li class="normal" id="section-6.3-4.1">
<p id="section-6.3-4.1.1">Name: This is a descriptive name that enables easier reference to the item. The name <span class="bcp14">MUST</span> be unique. It is not used in the encoding.<a href="#section-6.3-4.1.1" class="pilcrow"></a></p>
</li>
<li class="normal" id="section-6.3-4.2">
<p id="section-6.3-4.2.1">CBOR Key: This is the value used as CBOR key of the item. These values <span class="bcp14">MUST</span> be unique. The value can be a positive integer, a negative integer, or a text string. Different ranges of values use different registration policies <span>[<a href="#RFC8126" class="cite xref">RFC8126</a>]</span>. Integer values from -256 to 255 as well as text strings of length 1 are designated as "Standards Action With Expert Review". Integer values from -65536 to -257 and from 256 to 65535, as well as text strings of length 2 are designated as "Specification Required". Integer values greater than 65535 as well as text strings of length greater than 2 are designated as "Expert Review". Integer values less than -65536 are marked as "Private Use".<a href="#section-6.3-4.2.1" class="pilcrow"></a></p>
</li>
<li class="normal" id="section-6.3-4.3">
<p id="section-6.3-4.3.1">CBOR Type: This contains the CBOR type of the item, or a pointer to the registry that defines its type, when that depends on another item.<a href="#section-6.3-4.3.1" class="pilcrow"></a></p>
</li>
<li class="normal" id="section-6.3-4.4">
<p id="section-6.3-4.4.1">Reference: This contains a pointer to the public specification for the item.<a href="#section-6.3-4.4.1" class="pilcrow"></a></p>
</li>
</ul>
<p id="section-6.3-5">The registry is initially populated with the entries in <a href="#fig-CoAP-Pubsub-Parameters" class="auto internal xref">Figure 5</a> of <a href="#pubsub-parameters" class="auto internal xref">Section 4</a>.<a href="#section-6.3-5" class="pilcrow"></a></p>
</section>
</div>
<div id="iana-rt">
Expand Down Expand Up @@ -2652,6 +2665,10 @@ <h3 id="name-informative-references">
<dd>
<span class="refAuthor">Palombini, F.</span>, <span class="refAuthor">Sengul, C.</span>, and <span class="refAuthor">M. Tiloca</span>, <span class="refTitle">"Publish-Subscribe Profile for Authentication and Authorization for Constrained Environments (ACE)"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-ace-pubsub-profile-07</span>, <time datetime="2023-09-13" class="refDate">13 September 2023</time>, <span>&lt;<a href="https://datatracker.ietf.org/doc/html/draft-ietf-ace-pubsub-profile-07">https://datatracker.ietf.org/doc/html/draft-ietf-ace-pubsub-profile-07</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC8126">[RFC8126]</dt>
<dd>
<span class="refAuthor">Cotton, M.</span>, <span class="refAuthor">Leiba, B.</span>, and <span class="refAuthor">T. Narten</span>, <span class="refTitle">"Guidelines for Writing an IANA Considerations Section in RFCs"</span>, <span class="seriesInfo">BCP 26</span>, <span class="seriesInfo">RFC 8126</span>, <span class="seriesInfo">DOI 10.17487/RFC8126</span>, <time datetime="2017-06" class="refDate">June 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc8126">https://www.rfc-editor.org/rfc/rfc8126</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC8288">[RFC8288]</dt>
<dd>
<span class="refAuthor">Nottingham, M.</span>, <span class="refTitle">"Web Linking"</span>, <span class="seriesInfo">RFC 8288</span>, <span class="seriesInfo">DOI 10.17487/RFC8288</span>, <time datetime="2017-10" class="refDate">October 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc8288">https://www.rfc-editor.org/rfc/rfc8288</a>&gt;</span>. </dd>
Expand All @@ -2673,7 +2690,7 @@ <h2 id="name-contributors">
<a href="mailto:marco.tiloca@ri.se" class="email">marco.tiloca@ri.se</a>
</div>
</address>
<p id="appendix-A-1">Marco provided thorough reviews and guidance on the last versions of this document.<a href="#appendix-A-1" class="pilcrow"></a></p>
<p id="appendix-A-1">Marco provided very thorough reviews and guidance on the last versions of this document.<a href="#appendix-A-1" class="pilcrow"></a></p>
</section>
</div>
<div id="authors-addresses">
Expand Down
Loading

0 comments on commit 62ca66c

Please sign in to comment.