feat(ad-api): add routing api description (#555)

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
autowarefoundation · Jun 26, 2024 · b0d4d3f · b0d4d3f
1 parent 0bcd252
commit b0d4d3f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route.md
@@ -19,4 +19,5 @@ type:
 {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
 {% block description %}
 Set the route with the waypoint segments in lanelet format. If start pose is not specified, the current pose will be used.
+This API only accepts the route when the route state is UNSET. In any other state, clear the route first.
 {% endblock %}
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route_points.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route_points.md
@@ -19,4 +19,5 @@ type:
 {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
 {% block description %}
 Set the route with the waypoint poses. If start pose is not specified, the current pose will be used.
+This API only accepts the route when the route state is UNSET. In any other state, clear the route first.
 {% endblock %}