Skip to content

Commit

Permalink
[#71] Remove ambiguity around uAttributes requirements
Browse files Browse the repository at this point in the history
The requirements regarding the usage of particular UAttributes
properties for the message types supported by uProtocol had been
scattered around multiple documents, some textual descriptions as well
as proto files. It was hard to find the relevant information and to
keep it consistent across the specifications.

The following things have been done to mitigate the situation:
* The uattributes.adoc file is now the single source of truth regarding
  the usage of UAttributes for the supported message types. All
  corresponding definitions have been removed from the cloudevents.adoc
  and uattributes.proto files.
* The cloudevents.adoc file has been moved to the up-l1 folder because
  its content is relevant to uProtocol Client libraries only that use
  CloudEvents' JSON or Protobuf Format to map UMessages to a transport
  protocol's PDU. Application (uEntity) developers will not get in
  touch with CloudEvents at all.

Fixes #71
  • Loading branch information
sophokles73 authored Apr 11, 2024
1 parent 3cefb30 commit 8fcb37d
Show file tree
Hide file tree
Showing 10 changed files with 606 additions and 473 deletions.
4 changes: 1 addition & 3 deletions basics/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The key words "*MUST*", "*MUST NOT*", "*REQUIRED*", "*SHALL*", "*SHALL NOT*", "*SHOULD*", "*SHOULD NOT*", "*RECOMMENDED*", "*MAY*", and "*OPTIONAL*" in this document are to be interpreted as described in https://www.rfc-editor.org/info/bcp14[IETF BCP14 (RFC2119 & RFC8174)]

----
Copyright (c) 2023 General Motors GTO LLC
SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand All @@ -25,7 +25,6 @@ specific language governing permissions and limitations
under the License.
SPDX-FileType: DOCUMENTATION
SPDX-FileCopyrightText: 2023 General Motors GTO LLC
SPDX-License-Identifier: Apache-2.0
----

Expand All @@ -41,6 +40,5 @@ The following are the foundational requirements for uProtocol specifications:
* *link:umessage.adoc[uProtocol Message (UMessage)]*
* *link:upayload.adoc[uProtocol Payload (UPayload)]*
* *link:delivery.adoc[Event Delivery]*
* *link:cloudevents.adoc[CloudEvents]*
* *link:permissions.adoc[Permissions]*
Loading

0 comments on commit 8fcb37d

Please sign in to comment.