forked from autowarefoundation/autoware.universe
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request autowarefoundation#61 from tier4/sync-upstream
chore: sync upstream
- Loading branch information
Showing
44 changed files
with
575 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,25 @@ | ||
# autoware_ad_api_msgs | ||
|
||
## InterfaceVersion | ||
## ResponseStatus | ||
|
||
This API provides the interface version of the set of AD APIs. | ||
It follows [Semantic Versioning][semver] in order to provide an intuitive understanding of the changes between versions. | ||
This message is a response status commonly used in the service type API. For details, see [the response status][docs-response-status]. | ||
Each API can define its own status codes. | ||
The status codes are primarily used to indicate the error cause, such as invalid parameter and timeout. | ||
If the API succeeds, set success to true, code to zero, and message to the empty string. | ||
Alternatively, codes and messages can be used for warnings or additional information. | ||
If the API fails, set success to false, code to the related status code, and message to the information. | ||
The status code zero is reserved for success. The status code 50000 or over are also reserved for typical cases. | ||
|
||
### Use cases | ||
| Name | Code | Description | | ||
| ---------- | ----: | ------------------------------------ | | ||
| SUCCESS | 0 | This API has completed successfully. | | ||
| DEPRECATED | 50000 | This API is deprecated. | | ||
|
||
Considering the product life cycle, there will be multiple vehicles that use different versions of the AD API due to changes in requirements or some improvements. | ||
For example, a vehicle uses `v1` for stability and another vehicle uses `v2` for more functionality. | ||
## InterfaceVersion | ||
|
||
In that situation, the AD API users such as developers of a Web service have to switch the application behavior based on the version that each vehicle uses. | ||
This message is for the interface version of the set of AD APIs. For details, see [the interface feature][docs-interface]. | ||
|
||
<!-- link --> | ||
|
||
[semver]: https://semver.org/ | ||
[docs-response-status]: https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/#response-status | ||
[docs-interface]: https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/ad-api/features/interface/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# constants for code | ||
uint16 DEPRECATED = 50000 | ||
|
||
# variables | ||
bool success | ||
uint16 code | ||
string message |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.