Skip to content

Commit

Permalink
camera ready
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaimejim
jaimejim committed Oct 19, 2023
1 parent 51ea6ca commit daf1d45
Showing 1 changed file with 33 additions and 26 deletions.
59 changes: 33 additions & 26 deletions draft-ietf-core-coap-pubsub.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ contributor:
- name: Marco Tiloca
organization: RISE AB
email: marco.tiloca@ri.se
contribution: Marco provided thorough reviews and guidance on the last versions of this document.
contribution: Marco provided very thorough reviews and guidance on the last versions of this document.

normative:
RFC6570:
Expand All @@ -51,6 +51,7 @@ normative:
RFC7641:
informative:
RFC8288:
RFC8126:
I-D.hartke-t2trg-coral-pubsub:
I-D.ietf-ace-oscore-gm-admin:
I-D.ietf-ace-pubsub-profile:
Expand Down Expand Up @@ -221,7 +222,7 @@ The CBOR map includes the following configuration parameters, whose CBOR abbrevi

* '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".

* '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").
* '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").

* '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".

Expand Down Expand Up @@ -668,7 +669,7 @@ A client can publish data to a topic by submitting the data in a PUT request to

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 MUST return a 2.01 (Created) response and set the topic in the fully-created state (see {{topic-lifecycle}}).

If the request does not have an acceptable content format, the server returns a 4.15 (Unsupported Content Format) response.
If the request does not have an acceptable content-format, the server returns a 4.15 (Unsupported Content-Format) response.

If the client is sending publications too fast, the server returns a
4.29 (Too Many Requests) response {{!RFC8516}}.
Expand Down Expand Up @@ -877,18 +878,18 @@ This document defines parameters used in the messages exchanged between a client
Note that the media type application/core-pubsub+cbor MUST be used when these parameters are transported in the respective message fields.

~~~~
+-----------------+-----------+--------------+------------+
| 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] |
+-----------------+-----------+-----------+------------+
~~~~
{: #fig-CoAP-Pubsub-Parameters title="CoAP Pubsub Parameters" artwork-align="center"}

Expand Down Expand Up @@ -947,12 +948,10 @@ Published specification:
: {{media-type}} of RFC XXXX

Applications that use this media type:
: Clients and servers in the Internet of Things
: This type is used by clients that create, retrieve, and update topic configurations at servers acting as a pub-sub broker.

Fragment identifier considerations:
: 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".)
: N/A

Person & email address to contact for further information:
: CoRE WG mailing list (core@ietf.org),
Expand All @@ -970,27 +969,35 @@ Author/Change controller:
Provisional registration:
: no

## Content Format
## Content-Format

IANA has added the following Content-Formats to the
{{content-formats ("CoAP Content-Formats")<IANA.core-parameters}}
sub-registry, within the "Constrained RESTful Environments (CoRE)
Parameters" Registry {{!IANA.core-parameters}}, as follows:

| Content-Type | Content Coding | ID | Reference |
| Content Type | Content Coding | ID | Reference |
| application/pubsub+cbor | - | TBD9 | RFC XXXX |
{: align="left" title="New Content-Format"}

TBD9 is to be assigned from the space 256..999.

In the registry the column "Content-Type" is called "Media type" and the
column "Content Coding" is called "Encoding". [^remove]
## CoAP Pubsub Parameters {#iana-coap-pubsub-parameters}

IANA is asked to register the following entries in the subregistry of the "Constrained RESTful Environments (CoRE) Parameters" registry group.

[^remove]: This paragraph to be removed by RFC editor.
This specification establishes the "Pubsub Topic Configuration Parameters" IANA registry within the "Constrained RESTful Environments (CoRE)
Parameters" registry group.

## CoAP Pubsub Parameters ## {#iana-coap-pubsub-parameters}
The columns of this registry are:

IANA is asked to register the following entries in the subregistry of the "Constrained RESTful Environments (CoRE) Parameters" registry group.
* Name: This is a descriptive name that enables easier reference to the item. The name MUST be unique. It is not used in the encoding.

* CBOR Key: This is the value used as CBOR key of the item. These values MUST be unique. The value can be a positive integer, a negative integer, or a text string. Different ranges of values use different registration policies {{RFC8126}}. 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".

* 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.

* Reference: This contains a pointer to the public specification for the item.

The registry is initially populated with the entries in {{fig-CoAP-Pubsub-Parameters}} of {{pubsub-parameters}}.

Expand Down

0 comments on commit daf1d45

Please sign in to comment.