feat: Document of AD API prototyping (#2)

* Add prototyping AD API

* ci(pre-commit): autofix

* Add document generator

* Update api specs

* Fix type pages

* Add door status

* Modify generation tool

* Fix menu

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

docs/design/ad-api/.pages

@@ -1,2 +1,3 @@
 nav:
   - index.md
+  - prototyping

docs/design/ad-api/prototyping/.pages

@@ -0,0 +1,3 @@
+nav:
+  - api
+  - type

docs/design/ad-api/prototyping/api/.pages

@@ -0,0 +1,3 @@
+collapse: true
+nav:
+  - list.md

docs/design/ad-api/prototyping/api/external/get/command/selected/control.md

@@ -0,0 +1,14 @@
+# /api/external/get/command/selected/control
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/ControlCommandStamped
+
+## Description
+
+車両にて受け付けた最新の制御コマンドを取得する。
+
+## Requirement
+
+車両が受け付けた local/remote いずれかの制御コマンドを提供すること。

docs/design/ad-api/prototyping/api/external/get/command/selected/vehicle.md

@@ -0,0 +1,14 @@
+# /api/external/get/command/selected/vehicle
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/ControlCommandStamped
+
+## Description
+
+車両に送信している最新の制御コマンドを取得する。
+
+## Requirement
+
+車両に送信している各種処理を行った最終的な制御コマンドを提供すること。

docs/design/ad-api/prototyping/api/external/get/diagnostics.md

@@ -0,0 +1,14 @@
+# /api/external/get/diagnostics
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/ClassifiedDiagnostics
+
+## Description
+
+車両の各種診断情報を取得する。
+
+## Requirement
+
+現在の車両の状態に応じて分類した各種診断情報を提供すること。

docs/design/ad-api/prototyping/api/external/get/door.md

@@ -0,0 +1,14 @@
+# /api/external/get/door
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/DoorStatus
+
+## Description
+
+車両のドア状態を取得する。
+
+## Requirement
+
+車両のドア状態を提供すること。

docs/design/ad-api/prototyping/api/external/get/emergency.md

@@ -0,0 +1,14 @@
+# /api/external/get/emergency
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Emergency
+
+## Description
+
+車両を外部指示緊急停止状態を取得する。
+
+## Requirement
+
+車両の停止が完了しているかに関わらず、外部指示緊急停止状態が取得できること。

docs/design/ad-api/prototyping/api/external/get/engage.md

@@ -0,0 +1,14 @@
+# /api/external/get/engage
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/EngageStatus
+
+## Description
+
+エンゲージ状態を取得する。
+
+## Requirement
+
+現在のエンゲージ状態が取得できること。

docs/design/ad-api/prototyping/api/external/get/map/info/hash.md

@@ -0,0 +1,14 @@
+# /api/external/get/map/info/hash
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/MapHash
+
+## Description
+
+現在設定されている地図のハッシュを取得する。
+
+## Requirement
+
+地図データを保持するファイルのハッシュ値(SHA-256)を取得できること。

docs/design/ad-api/prototyping/api/external/get/map/lanelet/xml.md

@@ -0,0 +1,14 @@
+# /api/external/get/map/lanelet/xml
+
+## Classification
+
+- Behavior: Service
+- DataType: tier4_external_api_msgs/srv/GetTextFile
+
+## Description
+
+地図情報を Lanelet の XML(OSM) 形式で取得する。
+
+## Requirement
+
+必要に応じて地図フォーマットの変換を行い、地図情報が Lanelet の XML(OSM) 形式で取得できること。

docs/design/ad-api/prototyping/api/external/get/metadata/packages.md

@@ -0,0 +1,14 @@
+# /api/external/get/metadata/packages
+
+## Classification
+
+- Behavior: Service
+- DataType: tier4_external_api_msgs/srv/GetMetadataPackages
+
+## Description
+
+Autoware の実装バージョンを特定するための各種情報を取得する。
+
+## Requirement
+
+Autoware を構成する各パッケージが本 API 向けの情報を提供している場合、パッケージ名をキーとする辞書形式で情報が取得できること。

docs/design/ad-api/prototyping/api/external/get/observer.md

@@ -0,0 +1,14 @@
+# /api/external/get/observer
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Observer
+
+## Description
+
+車両の監視を行う対象を取得する。
+
+## Requirement
+
+現在車両の監視を行っている対象を取得できること。

docs/design/ad-api/prototyping/api/external/get/operator.md

@@ -0,0 +1,14 @@
+# /api/external/get/operator
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Operator
+
+## Description
+
+車両の操作を行う対象を取得する。
+
+## Requirement
+
+現在車両の操作を行っている対象を取得できること。

docs/design/ad-api/prototyping/api/external/get/route.md

@@ -0,0 +1,14 @@
+# /api/external/get/route
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Route
+
+## Description
+
+車両の運行ルートを取得する。
+
+## Requirement
+
+[[/api/external/set/route]]により設定された運行ルートを取得できること。

docs/design/ad-api/prototyping/api/external/get/service.md

@@ -0,0 +1,14 @@
+# /api/external/get/service
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Service
+
+## Description
+
+車両のサービス提供状態を取得する。
+
+## Requirement
+
+[[/api/external/set/engage]]により設定されたサービス状態を取得できること。

docs/design/ad-api/prototyping/api/external/get/vehicle/status.md

@@ -0,0 +1,14 @@
+# /api/external/get/vehicle/status
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/VehicleStatusStamped
+
+## Description
+
+車両制御に関する情報を取得する。
+
+## Requirement
+
+車両の速度、ステア、ウィンカー、ギアに関する情報を取得できること。

docs/design/ad-api/prototyping/api/external/get/version.md

@@ -0,0 +1,18 @@
+# /api/external/get/version
+
+## Classification
+
+- Behavior: Service
+- DataType: autoware_external_api_msgs/srv/GetVersion
+
+## Description
+
+Autoware External API のバージョン情報を取得する。
+
+## Requirement
+
+以下の規則に従ったバージョン文字列`major.minor.patch`が取得できること。
+
+- major: 全体に関わる大規模な変更があったとき。
+- minor: 互換性の失われる変更があったとき。
+- patch: 互換性の維持される変更があったとき。

docs/design/ad-api/prototyping/api/external/set/clear_route.md

@@ -0,0 +1,14 @@
+# /api/external/set/clear_route
+
+## Classification
+
+- Behavior: Service
+- DataType: tier4_external_api_msgs/srv/ClearRoute
+
+## Description
+
+車両の運行ルートを取り消す。
+
+## Requirement
+
+[[/api/external/set/route]]により設定された運行ルートを取り消すこと。

docs/design/ad-api/prototyping/api/external/set/command/local/control.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/local/control
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/ControlCommandStamped
+
+## Description
+
+車両のアクセル・ブレーキ・ステアリングを制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/local/gear_shift.md

@@ -0,0 +1,15 @@
+# /api/external/set/command/local/gear_shift
+
+## Classification
+
+- Category: Optional
+- Behavior: Topic
+- DataType: autoware_external_api_msgs/msg/GearShiftStamped
+
+## Description
+
+車両の変速機を制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/local/heartbeat.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/local/heartbeat
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Heartbeat
+
+## Description
+
+車両との通信状態を確認するための信号を送信する。
+
+## Requirement
+
+この信号が途切れた場合、車両は監視されていない状態になったとして適切な制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/local/shift.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/local/shift
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/GearShiftStamped
+
+## Description
+
+車両の変速機を制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/local/turn_signal.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/local/turn_signal
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/TurnSignalStamped
+
+## Description
+
+車両の方向指示器を制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/remote/control.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/remote/control
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/ControlCommandStamped
+
+## Description
+
+車両のアクセル・ブレーキ・ステアリングを制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/remote/gear_shift.md

@@ -0,0 +1,15 @@
+# /api/external/set/command/remote/gear_shift
+
+## Classification
+
+- Category: Optional
+- Behavior: Topic
+- DataType: autoware_external_api_msgs/msg/GearShiftStamped
+
+## Description
+
+車両の変速機を制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/remote/heartbeat.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/remote/heartbeat
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/Heartbeat
+
+## Description
+
+車両との通信状態を確認するための信号を送信する。
+
+## Requirement
+
+この信号が途切れた場合、車両は監視されていない状態になったとして適切な制御を行うこと。

docs/design/ad-api/prototyping/api/external/set/command/remote/shift.md

@@ -0,0 +1,14 @@
+# /api/external/set/command/remote/shift
+
+## Classification
+
+- Behavior: Topic
+- DataType: tier4_external_api_msgs/msg/GearShiftStamped
+
+## Description
+
+車両の変速機を制御するコマンドを送信する。
+
+## Requirement
+
+現在の車両状態を考慮し、指定されたコマンドを可能な限り反映した制御を行うこと。