Skip to content
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

Remove ambiguity for UNSPECIFIED UPayloadFormat #247

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Remove ambiguity for UNSPECIFIED UPayloadFormat #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3170de
Remove ambiguity for UNSPECIFIED UPayloadFormat
stevenhartley Nov 8, 2024
7af377a
Apply suggestions from code review
stevenhartley Nov 8, 2024
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
5 changes: 5 additions & 0 deletions basics/upayloadformat.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ The following table provides an overview of the payload formats supported by uPr
|===
|UPayloadFormat |MIME Type |Payload encoding

| `UPAYLOAD_FORMAT_UNSPECIFIED`
| N/A
| The payload format is unknown. Clients will need to have gained knowledge about the concrete encoding and semantics of the payload by means of an out-of-band mechanism.


|`UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY`
|`application/x-protobuf`
|The message payload *MUST* be the network byte order serialization of a `google.protobuf.Any` structure that contains the payload itself along with the schema URI indicating the (protobuf) type of the payload.
Expand Down
3 changes: 1 addition & 2 deletions up-core-api/uprotocol/v1/uattributes.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,7 @@ enum UPriority {

// The format for the data stored in the UMessage.
enum UPayloadFormat {
// Payload format was not is not set,
// per specification, assumption is UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY
// Payload format is unknown.
UPAYLOAD_FORMAT_UNSPECIFIED = 0;

// Payload is an Any protobuf message that contains the packed payload
Expand Down
Loading