Skip to content

Commit

Permalink
Clarified MUST requirement for JSON format (#644)
Browse files Browse the repository at this point in the history
* Clarified that JSON format is a MUST, if structured content mode is supported.

Signed-off-by: Klaus Deissner <[email protected]>

* Added AMQP,Kafka and MQTT

Signed-off-by: Klaus Deissner <[email protected]>
  • Loading branch information
deissnerk authored Jun 21, 2020
1 parent 5ea5b40 commit bf71de5
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 13 deletions.
3 changes: 2 additions & 1 deletion amqp-protocol-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ AMQP [application-properties][app-properties] section.

Event formats, used with the _stuctured_ content mode, define how an event is
expressed in a particular data format. All implementations of this specification
MUST support the [JSON event format][json-format].
that support the _structured_ content mode MUST support the [JSON event
format][json-format].

### 1.5. Security

Expand Down
5 changes: 3 additions & 2 deletions http-protocol-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ supports batching.

Event formats, used with the _structured_ content mode, define how an event is
expressed in a particular data format. All implementations of this specification
MUST support the non-batching [JSON event format][json-format], but MAY support
any additional, including proprietary, formats.
that support the _structured_ content mode MUST support the non-batching [JSON
event format][json-format], but MAY support any additional, including
proprietary, formats.

Event formats MAY additionally define how a batch of events is expressed. Those
can be used with the _batched_ content mode
Expand Down
13 changes: 7 additions & 6 deletions kafka-protocol-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,17 @@ the Kafka message's value section as-is, with the `content-type` header value
declaring its media type; all other event attributes MUST be mapped to the
Kafka message's [header section][kafka-message-header].

Implementations that use Kafka 0.11.0.0 and above MAY use either _binary_
or _structured_ modes. Implementations that use Kafka 0.10.x.x and below
MUST use only use _structured_ mode and encode the event in JSON. This is
because older versions of Kafka lacked support for message level headers.
Implementations that use Kafka 0.11.0.0 and above MAY use either _binary_ or
_structured_ modes. Implementations that use Kafka 0.10.x.x and below MUST only
use _structured_ mode and encode the event in JSON. This is because older
versions of Kafka lacked support for message level headers.

### 1.4. Event Formats

Event formats, used with the _structured_ content mode, define how an event is
expressed in a particular data format. All implementations of this
specification MUST support the [JSON event format][json-format].
expressed in a particular data format. All implementations of this specification
that support the _structured_ content mode MUST support the [JSON event
format][json-format].

### 1.5. Security

Expand Down
6 changes: 2 additions & 4 deletions mqtt-protocol-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,8 @@ event attributes are mapped to User Property fields.

Event formats, used with the _structured_ content mode, define how an event is
expressed in a particular data format. All implementations of this specification
MUST support the [JSON event format][json-format].

MQTT 5.0 implementations MAY support any additional, including proprietary,
formats.
that support the _structured_ content mode MUST support the [JSON event
format][json-format].

### 1.5. Security

Expand Down

0 comments on commit bf71de5

Please sign in to comment.