Skip to content

Fix up JSON type mappings #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
duglin merged 6 commits into from
Sep 12, 2019
Merged

Fix up JSON type mappings #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
50957a5
Fix up JSON type mappings
evankanderson Aug 30, 2019
8048037
Merge remote-tracking branch 'upstream/master' into a-hobgoblin-with-…
evankanderson Aug 30, 2019
0693ded
Fix type mapping for AMQP
evankanderson Aug 30, 2019
93ca988
Add `data` to AMQP.
evankanderson Aug 30, 2019
dda6857
Add payload data to amqp-format.md
evankanderson Aug 30, 2019
50b5745
Update AMQP data encoding per discussion in #492
evankanderson Sep 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 29 additions & 17 deletions amqp-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Abstract

The AMQP Format for CloudEvents defines how event attributes are expressed in
the [AMQP 1.0 Type System][type-system].
The AMQP Format for CloudEvents defines how event attributes and payload data
are expressed in the [AMQP 1.0 Type System][type-system].

## Status of this document

Expand All @@ -13,7 +13,8 @@ This document is a working draft.

1. [Introduction](#1-introduction)
2. [Attributes](#2-attributes)
3. [References](#3-references)
3. [Data](#3-data)
4. [References](#4-references)

## 1. Introduction

Expand Down Expand Up @@ -55,13 +56,13 @@ exceptions noted below.

| CloudEvents | AMQP |
| ------------- | --------------------------- |
| String | [string][amqp-string] |
| Boolean | [boolean][amqp-boolean] |
| Integer | [long][amqp-long] |
| String | [string][amqp-string] |
| Binary | [binary][amqp-binary] |
| URI | [string][amqp-string] |
| URI-reference | [string][amqp-string] |
| Timestamp | [timestamp][amqp-timestamp] |
| Any | See 2.3. |

A CloudEvents AMQP format implementation MUST allow for attribute values to be
convertible from/to their canonical CloudEvents string representation. For
Expand All @@ -88,14 +89,21 @@ any revision of such a specification, MUST also define explicit mapping rules
for all other event formats that are part of the CloudEvents core at the time of
the submission or revision.

### 2.3. Mapping Any-typed Attributes
## 3. Data

Before encoding, the AMQP serializer MUST first determine the runtime data type
of the data content. This may be determined by examining the data for characters
outside the UTF-8 range or by consulting the `datacontenttype` attribute.

If the implementation determines that the type of the data is binary, the value
MUST be stored in the payload as a single [AMQP data][amqp-data] section.

`Any`-typed CloudEvents values can either hold a `String`, or a `Binary` value,
or a `Map`. `Map` entry values are also `Any` typed. AMQP's type system natively
represents dynamic typing in its [type system encoding][type-system-encoding],
and therefore immediately allows for the required variant type representation.
For other types (non-binary data without a `datacontenttype` attribute), the
implementation MUST translate the data value into an [AMQP type
system][type-system] value and the value MUST be stored in an [AMQP
value][amqp-value] section.

## 3. References
## 4. References

- [RFC2046][rfc2046] Multipurpose Internet Mail Extensions (MIME) Part Two:
Media Types
Expand All @@ -109,21 +117,25 @@ and therefore immediately allows for the required variant type representation.
https://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html
[type-system-encoding]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#section-encodings
[amqp-string]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-string
[amqp-boolean]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-boolean
[amqp-long]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-long
[amqp-string]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-string
[amqp-binary]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-binary
[amqp-timestamp]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-timestamp
[amqp-map]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#type-map
[amqp-describedtype]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html#doc-idp38080
[amqp-data]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-data

@duglin duglin Sep 3, 2019

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems right, but @clemensv do you agree with this reference?

[amqp-value]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-value
[rfc2046]: https://tools.ietf.org/html/rfc2046
[rfc2119]: https://tools.ietf.org/html/rfc2119
[rfc4627]: https://tools.ietf.org/html/rfc4627
[rfc4648]: https://tools.ietf.org/html/rfc4648
[rfc6839]: https://tools.ietf.org/html/rfc6839#section-3.1
[rfc8259]: https://tools.ietf.org/html/rfc8259
[oasis-amqp-1.0]:
http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0-os.html
5 changes: 3 additions & 2 deletions json-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ with exceptions noted below.

| CloudEvents | JSON |
| ------------- | -------------------------------------------------------------- |
| String | [string][json-string] |
| Boolean | [boolean][json-bool]
| Integer | [number][json-number], only the `int` component is permitted |
| String | [string][json-string] |
| Binary | [string][json-string], [Base64-encoded][base64] binary |
| URI | [string][json-string] following [RFC 3986][rfc3986] |
| URI-reference | [string][json-string] following [RFC 3986][rfc3986] |
| Timestamp | [string][json-string] following [RFC 3339][rfc3339] (ISO 8601) |
| Any | [JSON value][json-value] |

Extension specifications MAY define diverging mapping rules for the values of
attributes they define.
Expand Down Expand Up @@ -314,6 +314,7 @@ also valid in a request):
https://www.iana.org/assignments/media-types/application/geo+json-seq
[json-object]: https://tools.ietf.org/html/rfc7159#section-4
[json-seq]: https://www.iana.org/assignments/media-types/application/json-seq
[json-bool]: https://tools.ietf.org/html/rfc7159#section-3
[json-number]: https://tools.ietf.org/html/rfc7159#section-6
[json-string]: https://tools.ietf.org/html/rfc7159#section-7
[json-value]: https://tools.ietf.org/html/rfc7159#section-3
Expand Down