Skip to content

feat(ad-api): add interface list #663

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/design/autoware-interfaces/ad-api/features/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
## Related API

- {{ link_ad_api('/api/interface/version') }}
- {{ link_ad_api('/api/interface/list') }}

## Description

This API provides the interface version of the set of AD APIs.
This feature provides information about AD API.
The interface version API indicates which release of the specification the implementation is based on.
It follows [Semantic Versioning][semver] in order to provide an intuitive understanding of the changes between versions.
The Interface list API provides the support status of each API.

<!-- link -->

Expand Down
19 changes: 19 additions & 0 deletions docs/design/autoware-interfaces/ad-api/list/api/interface/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: /api/interface/list
status: not released
method: function call
type:
name: autoware_adapi_v1_msgs/srv/GetInterfaceList
res:
- name: status
text: response status
- name: apis.name
text: The name of the API.
- name: apis.available
text: The support status of the API.
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Get the interface list. All interfaces for that version are listed, including unsupported ones.
{% endblock %}
1 change: 1 addition & 0 deletions docs/design/autoware-interfaces/ad-api/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
| [/api/fail_safe/mrm_request/send](./api/fail_safe/mrm_request/send.md) | not released | function call |
| [/api/fail_safe/mrm_state](./api/fail_safe/mrm_state.md) | v1.1.0 | notification |
| [/api/fail_safe/rti_state](./api/fail_safe/rti_state.md) | not released | notification |
| [/api/interface/list](./api/interface/list.md) | not released | function call |
| [/api/interface/version](./api/interface/version.md) | v1.0.0 | function call |
| [/api/localization/initialization_state](./api/localization/initialization_state.md) | v1.0.0 | notification |
| [/api/localization/initialize](./api/localization/initialize.md) | v1.0.0 | function call |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
# This file is generated by tools/autoware-interfaces/generate.py
title: autoware_adapi_v1_msgs/msg/InterfaceInfo
used:
- autoware_adapi_v1_msgs/srv/GetInterfaceList
---

{% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %}
{% block definition %}

```txt
string name
bool available
```

{% endblock %}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ used:
- autoware_adapi_v1_msgs/srv/ClearRoute
- autoware_adapi_v1_msgs/srv/GetCooperationPolicies
- autoware_adapi_v1_msgs/srv/GetDoorLayout
- autoware_adapi_v1_msgs/srv/GetInterfaceList
- autoware_adapi_v1_msgs/srv/GetVehicleDimensions
- autoware_adapi_v1_msgs/srv/GetVehicleSpecs
- autoware_adapi_v1_msgs/srv/InitializeLocalization
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# This file is generated by tools/autoware-interfaces/generate.py
title: autoware_adapi_v1_msgs/srv/GetInterfaceList
uses:
- autoware_adapi_v1_msgs/msg/InterfaceInfo
- autoware_adapi_v1_msgs/msg/ResponseStatus
---

{% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %}
{% block definition %}

```txt
---
autoware_adapi_v1_msgs/ResponseStatus status
autoware_adapi_v1_msgs/InterfaceInfo[] apis
```

{% endblock %}
2 changes: 2 additions & 0 deletions docs/design/autoware-interfaces/ad-api/types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
- [autoware_adapi_v1_msgs/msg/HazardLights](./autoware_adapi_v1_msgs/msg/HazardLights.md)
- [autoware_adapi_v1_msgs/msg/HazardLightsCommand](./autoware_adapi_v1_msgs/msg/HazardLightsCommand.md)
- [autoware_adapi_v1_msgs/msg/Heartbeat](./autoware_adapi_v1_msgs/msg/Heartbeat.md)
- [autoware_adapi_v1_msgs/msg/InterfaceInfo](./autoware_adapi_v1_msgs/msg/InterfaceInfo.md)
- [autoware_adapi_v1_msgs/msg/LocalizationInitializationState](./autoware_adapi_v1_msgs/msg/LocalizationInitializationState.md)
- [autoware_adapi_v1_msgs/msg/ManualControlMode](./autoware_adapi_v1_msgs/msg/ManualControlMode.md)
- [autoware_adapi_v1_msgs/msg/ManualControlModeStatus](./autoware_adapi_v1_msgs/msg/ManualControlModeStatus.md)
Expand Down Expand Up @@ -60,6 +61,7 @@
- [autoware_adapi_v1_msgs/srv/ClearRoute](./autoware_adapi_v1_msgs/srv/ClearRoute.md)
- [autoware_adapi_v1_msgs/srv/GetCooperationPolicies](./autoware_adapi_v1_msgs/srv/GetCooperationPolicies.md)
- [autoware_adapi_v1_msgs/srv/GetDoorLayout](./autoware_adapi_v1_msgs/srv/GetDoorLayout.md)
- [autoware_adapi_v1_msgs/srv/GetInterfaceList](./autoware_adapi_v1_msgs/srv/GetInterfaceList.md)
- [autoware_adapi_v1_msgs/srv/GetVehicleDimensions](./autoware_adapi_v1_msgs/srv/GetVehicleDimensions.md)
- [autoware_adapi_v1_msgs/srv/GetVehicleSpecs](./autoware_adapi_v1_msgs/srv/GetVehicleSpecs.md)
- [autoware_adapi_v1_msgs/srv/InitializeLocalization](./autoware_adapi_v1_msgs/srv/InitializeLocalization.md)
Expand Down
8 changes: 8 additions & 0 deletions yaml/autoware-interfaces.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ types:
msg:
seq: uint16
stamp: builtin_interfaces/msg/Time
autoware_adapi_v1_msgs/msg/InterfaceInfo:
msg:
available: bool
name: string
autoware_adapi_v1_msgs/msg/LocalizationInitializationState:
msg:
stamp: builtin_interfaces/msg/Time
Expand Down Expand Up @@ -274,6 +278,10 @@ types:
res:
doors: autoware_adapi_v1_msgs/msg/DoorLayout[]
status: autoware_adapi_v1_msgs/msg/ResponseStatus
autoware_adapi_v1_msgs/srv/GetInterfaceList:
res:
apis: autoware_adapi_v1_msgs/msg/InterfaceInfo[]
status: autoware_adapi_v1_msgs/msg/ResponseStatus
autoware_adapi_v1_msgs/srv/GetVehicleDimensions:
res:
dimensions: autoware_adapi_v1_msgs/msg/VehicleDimensions
Expand Down
Loading