Skip to content

Commit

Permalink
Merge up-spec and up-core-api
Browse files Browse the repository at this point in the history
the following change takes the 1.5.7 release of up-core-api and merges it with up-spec so we can have better traceability with the spec and protos.

#88
  • Loading branch information
czfdcn committed Mar 18, 2024
1 parent b12f0bb commit 47f8aa1
Show file tree
Hide file tree
Showing 26 changed files with 2,214 additions and 15 deletions.
2 changes: 1 addition & 1 deletion basics/error_model.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ SPDX-License-Identifier: Apache-2.0
----


uProtocol will follow Google's https://cloud.google.com/apis/design/errors[protocol-agnostic API error model] declared in up-core-api project in https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/ustatus.proto[`ustatus.proto`] please refer to the proto for details about UStatus and UCode.
uProtocol will follow Google's https://cloud.google.com/apis/design/errors[protocol-agnostic API error model] declared in up-core-api project in link:../../up-core-api/uprotocol/ustatus.proto[`ustatus.proto`] please refer to the proto for details about UStatus and UCode.
6 changes: 3 additions & 3 deletions basics/permissions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ While inspired by Android’s permission, CAPs under the current proposal are di

=== Service Declaration of uPLs

Services declare their uPLs as google.protobuf CustomOptions within their protos. The options are declared in https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/uprotocol_options.proto[uprotocol_options.proto] and their purpose is defined in <<cap-options>> below.
Services declare their uPLs as google.protobuf CustomOptions within their protos. The options are declared in link:../../up-core-api/uprotocol/uprotocol_options.proto[uprotocol_options.proto] and their purpose is defined in <<cap-options>> below.

* uPL value *MUST* be an integer, 0 to N, where N is the most permissive level. The default value is 0.

Expand All @@ -115,7 +115,7 @@ NOTE: *MUST* assumes the most permissive level, N, if the the declarations above
=== Client Declaration of uPLs
Claimed level of a uE is also handled by link:../up-l1/README.adoc[uTransport]. Implementations will determine the claimed level of the caller in a secure manner, and this will also be done differently depending on the link:../up-l1/README.adoc[uTransport] implementation.

When the calling uE permission level needs to be carried across different uTransport implementations, or across hops (i.e. across dispatchers such as the uBus), the callers permission level is placed in https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/uattributes.proto[uAttributes `permission_level`].
When the calling uE permission level needs to be carried across different uTransport implementations, or across hops (i.e. across dispatchers such as the uBus), the callers permission level is placed in link:../../up-core-api/uprotocol/uattributes.proto[uAttributes `permission_level`].

uEs that do not have proto defintions (i.e. applications), claimed uPLs using a implementation specific manor like Android's manifest file. See <<Example using Android>> for an example.

Expand Down Expand Up @@ -175,6 +175,6 @@ Scope is the list of artifacts that the caller (who has the token) are allowed t

=== Sending Tokens

Tokens are passed by the called to the transport (and then carried throughout the network) by populating the https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/uattributes.proto[`token`] uAttributes header field.
Tokens are passed by the called to the transport (and then carried throughout the network) by populating the link:../../up-core-api/uprotocol/uattributes.proto[`token`] uAttributes header field.


2 changes: 1 addition & 1 deletion basics/uattributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ SPDX-License-Identifier: Apache-2.0

uProtocol Header attributes that are common for all transports. The UAttributes message holds routing and UMessage attributes such as priority, permission, communication status and more

NOTE: Please refer to https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/uattributes.proto[uattributes.proto] for the latest version of the UAttributes data model
NOTE: Please refer to hlink:../../up-core-api/uprotocol/uattributes.proto[uattributes.proto] for the latest version of the UAttributes data model
2 changes: 1 addition & 1 deletion basics/umessage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ SPDX-License-Identifier: Apache-2.0

UMessage is the top-level message type for the uProtocol. It contains a link:uri.adoc[UUri] (source address), link:uattributes.adoc[UAttributes] (uProtocol header), and link:upayload.adoc[UPayload] (the message payload). UMessage is the common way to represent messages sent between uEs over any communication protocol/middleware.

NOTE: Please refer to https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/umessage.proto[umessage.proto] for more details.
NOTE: Please refer to link:../../up-core-api/uprotocol/umessage.proto[umessage.proto] for more details.
2 changes: 1 addition & 1 deletion basics/upayload.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ SPDX-License-Identifier: Apache-2.0
== Overview
UPayload contains the actual message payload (either by value or reference) as well as metadata such as the format, size, etc...

NOTE: Please refer to https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/upayload.proto[upayload.proto] for more details
NOTE: Please refer tolink:../../up-core-api/uprotocol/upayload.proto[upayload.proto] for more details
4 changes: 2 additions & 2 deletions basics/uri.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ image:uuri.drawio.svg[UUri Data Model]

* *MUST* Follow the type names, member variables, and method names as defined in the diagram above

NOTE: please refer to https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/uri.proto for the data model definitions
NOTE: please refer to link:../../up-core-api/uprotocol/uri.proto for the data model definitions


In the next section we shall define the per-language requirements for the UUri data model. These classes are meant to facilitate the use of the UUri data model in the respective language (i.e. serialize, validate, etc...).
Expand Down Expand Up @@ -308,7 +308,7 @@ NOTE: Not all implementations and uEs support wildcards, please refer to the imp

The section will give a few example URIs and their use in uProtocol. Service and resource will be generalized in this section. Example devices used for reference are http://bo.up.gm.com[bo.up.gm.com] representing the back office device, and VIN representing a vehicle.

NOTE: To illustrate the different URI formats, we will use uSubscription service definitions and IDs found in https://github.com/eclipse-uprotocol/up-core-api/blob/main/uprotocol/core/usubscription/v3/usubscription.proto[usubscription.proto].
NOTE: To illustrate the different URI formats, we will use uSubscription service definitions and IDs found in link:../../up-core-api/uprotocol/core/usubscription/v3/usubscription.proto[usubscription.proto].


. Serialized Uri Examples
Expand Down
36 changes: 36 additions & 0 deletions up-core-api/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
= Contributing to Eclipse uProtocol

Thanks for your interest in this project. Contributions are welcome!

== Developer resources

Information regarding source code management, builds, coding standards, and
more.

https://projects.eclipse.org/proposals/eclipse-uprotocol

The project maintains the following source code repositories

* https://github.com/eclipse-uprotocol

== Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must
electronically sign the Eclipse Contributor Agreement (ECA).

* http://www.eclipse.org/legal/ECA.php

Commits that are provided by non-committers must have a Signed-off-by field in
the footer indicating that the author is aware of the terms by which the
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

== Contact

Contact the project developers via the project's "dev" list.

* https://accounts.eclipse.org/mailing-list/uprotocol-dev
201 changes: 201 additions & 0 deletions up-core-api/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
33 changes: 33 additions & 0 deletions up-core-api/NOTICE.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Notices for Eclipse uProtocol

This content is produced and maintained by the Eclipse uProtocol project.

* Project home: https://projects.eclipse.org/projects/automotive.uprotocol
== Trademarks

Eclipse uProtocol is trademark of the Eclipse Foundation.
Eclipse, and the Eclipse Logo are registered trademarks of the Eclipse Foundation.

== Copyright

All content is the property of the respective authors or their employers.
For more information regarding authorship of content, please consult the
listed source code repository logs.

== Declared Project Licenses

This program and the accompanying materials are made available under the
terms of the or the Apache License, Version 2.0
which is available at https://www.apache.org/licenses/LICENSE-2.0.

SPDX-License-Identifier: Apache-2.0

== Third-party Content

The following are libraries that uProtocol project uses:

* http://cloudevents.io
* http://protobuf.dev

NOTE: Please refer to link:pom.xml[] for more information of library dependencies
Loading

0 comments on commit 47f8aa1

Please sign in to comment.