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.

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

feat(ad-api): add restrictions and options #602

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

isamu-takagi
Copy link
Contributor

@isamu-takagi isamu-takagi commented Aug 29, 2024

Description

Add restrictions and options for safety. Related to autowarefoundation/autoware_adapi_msgs#61.
See the release notes for v1.6.0 for details.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
@isamu-takagi isamu-takagi self-assigned this Aug 29, 2024

### allow_while_using_route

**[v1.6.0]** This option only affects the route change APIs. Autoware accepts new route even while the vehicle is using the current route. The APIs fail if it cannot safely transition to new route. When set false, the APIs always fail when the vehicle is using the route.
Copy link
Member

@youtalk youtalk Sep 5, 2024

Choose a reason for hiding this comment

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

The current autoware_adapi_msgs version is v1.3.0. https://github.com/autowarefoundation/autoware_adapi_msgs/tags
So v1.4.0 seems to be better to bump up, doesn't it?

Suggested change
**[v1.6.0]** This option only affects the route change APIs. Autoware accepts new route even while the vehicle is using the current route. The APIs fail if it cannot safely transition to new route. When set false, the APIs always fail when the vehicle is using the route.
**[v1.4.0]** This option only affects the route change APIs. Autoware accepts new route even while the vehicle is using the current route. The APIs fail if it cannot safely transition to new route. When set false, the APIs always fail when the vehicle is using the route.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@youtalk
Your comment made me realize that there are two versions of the AD API: specification and messages. Since we are talking about the specification version here, v1.6.0 is correct. Because the specification version v1.5.0 has already been released.

I think it's necessary to create a correspondence table between specification and message versions, or to update the message version to match the specifications version even if there are no message changes. Which do you think is better?

Copy link
Member

@youtalk youtalk Sep 6, 2024

Choose a reason for hiding this comment

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

update the message version to match the specifications version even if there are no message changes.

I think it is more clear. Please update package.xml to bump version to 1.6.0 even there is no actual updates by next PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants