Standard Compliance
This section tracks ros2_medkit’s compliance with diagnostic industry standards.
Note
These are not project requirements in the traditional V-Model sense.
The items listed here represent standard API endpoints that ros2_medkit implements for interoperability with diagnostic tools and systems. The project may also include extensions beyond the standard (e.g., exposing ROS 2 Topics as diagnostic entities) which are documented separately.
Traceability & Reports
Specifications
All Requirements
The following table shows all requirements across all categories:
ID |
Title |
Status |
Tags |
|---|---|---|---|
GET /version-info |
open |
Discovery |
|
GET /{any}/docs |
open |
Discovery |
|
GET /{entity-collection} |
open |
Discovery |
|
GET /areas/{id}/subareas |
open |
Discovery |
|
GET /components/{id}/subcomponents |
open |
Discovery |
|
GET /areas/{id}/contains |
open |
Discovery |
|
GET /components/{id}/hosts |
open |
Discovery |
|
GET /components/{id}/depends-on |
open |
Discovery |
|
GET /apps/{id}/depends-on |
open |
Discovery |
|
GET / |
open |
Discovery |
|
tags=... (query) |
open |
Discovery |
|
GET /{entity}/faults |
open |
Faults |
|
GET /{entity}/faults/{code} |
open |
Faults |
|
DELETE /{entity}/faults |
open |
Faults |
|
DELETE /{entity}/faults/{code} |
open |
Faults |
|
GET /{entity}/data-categories |
open |
Data |
|
GET /{entity}/data-groups |
open |
Data |
|
GET /{entity}/data |
open |
Data |
|
GET /{entity}/data/{data-id} |
open |
Data |
|
PUT /{entity}/data/{data-id} |
open |
Data |
|
GET /{entity}/data-lists |
open |
DataSets |
|
POST /{entity}/data-lists |
open |
DataSets |
|
GET /{entity}/data-lists/{id} |
open |
DataSets |
|
DELETE /{entity}/data-lists/{id} |
open |
DataSets |
|
GET /{entity}/cyclic-subscriptions |
open |
Subscriptions |
|
GET /{entity}/cyclic-subscriptions/{id} |
open |
Subscriptions |
|
PUT /{entity}/cyclic-subscriptions/{id} |
open |
Subscriptions |
|
DELETE /{entity}/cyclic-subscriptions/{id} |
open |
Subscriptions |
|
POST /{entity}/triggers |
open |
Subscriptions |
|
GET /{entity}/triggers |
open |
Subscriptions |
|
PUT /{entity}/triggers/{id} |
open |
Subscriptions |
|
DELETE /{entity}/triggers/{id} |
open |
Subscriptions |
|
GET /{entity}/operations |
open |
Operations |
|
GET /{entity}/operations/{op-id} |
open |
Operations |
|
POST /{entity}/operations/{op-id}/executions |
open |
Operations |
|
GET /{entity}/operations/{op-id}/executions |
open |
Operations |
|
GET /{entity}/operations/{op-id}/executions/{exec-id} |
open |
Operations |
|
PUT /{entity}/operations/{op-id}/executions/{exec-id} |
open |
Operations |
|
DELETE /{entity}/operations/{op-id}/executions/{exec-id} |
open |
Operations |
|
POST /{entity}/scripts |
open |
Scripts |
|
GET /{entity}/scripts |
open |
Scripts |
|
GET /{entity}/scripts/{id} |
open |
Scripts |
|
DELETE /{entity}/scripts/{id} |
open |
Scripts |
|
POST /{entity}/scripts/{id}/executions |
open |
Scripts |
|
GET /{entity}/scripts/{id}/executions |
open |
Scripts |
|
GET /{entity}/scripts/{id}/executions/{exec-id} |
open |
Scripts |
|
PUT /{entity}/scripts/{id}/executions/{exec-id} |
open |
Scripts |
|
GET /{entity}/configurations |
open |
Configuration |
|
GET /{entity}/configurations/{id} |
open |
Configuration |
|
PUT /{entity}/configurations/{id} |
open |
Configuration |
|
DELETE /{entity}/configurations |
open |
Configuration |
|
DELETE /{entity}/configurations/{id} |
open |
Configuration |
|
GET /{entity}/modes |
open |
Modes |
|
GET /{entity}/modes/{mode-id} |
open |
Modes |
|
PUT /{entity}/modes/{mode-id} |
open |
Modes |
|
GET /{entity}/clear-data |
open |
ClearData |
|
PUT /{entity}/clear-data/cached-data |
open |
ClearData |
|
PUT /{entity}/clear-data/learned-data |
open |
ClearData |
|
PUT /{entity}/clear-data/client-defined-resources |
open |
ClearData |
|
GET /{entity}/clear-data/status |
open |
ClearData |
|
GET /{entity}/logs |
open |
Logs |
|
GET /{entity}/logs/entries |
open |
Logs |
|
GET /{entity}/logs/config |
open |
Logs |
|
PUT /{entity}/logs/config |
open |
Logs |
|
DELETE /{entity}/logs/config |
open |
Logs |
|
GET /{entity}/communication-logs |
open |
CommLogs |
|
POST /{entity}/communication-logs |
open |
CommLogs |
|
GET /{entity}/communication-logs/{id} |
open |
CommLogs |
|
PUT /{entity}/communication-logs/{id} |
open |
CommLogs |
|
DELETE /{entity}/communication-logs/{id} |
open |
CommLogs |
|
GET /{entity}/bulk-data |
open |
BulkData |
|
GET /{entity}/bulk-data/{category} |
open |
BulkData |
|
GET /{entity}/bulk-data/{category}/{bulk-data-id} |
open |
BulkData |
|
POST /{entity}/bulk-data/{category} |
open |
BulkData |
|
DELETE /{entity}/bulk-data/{category}/{bulk-data-id} |
open |
BulkData |
|
GET /{entity}/status |
open |
Lifecycle |
|
PUT /{entity}/status/start |
open |
Lifecycle |
|
PUT /{entity}/status/restart |
open |
Lifecycle |
|
PUT /{entity}/status/force-restart |
open |
Lifecycle |
|
PUT /{entity}/status/shutdown |
open |
Lifecycle |
|
PUT /{entity}/status/force-shutdown |
open |
Lifecycle |
|
GET /updates |
open |
Updates |
|
POST /updates |
open |
Updates |
|
DELETE /updates/{id} |
open |
Updates |
|
GET /updates/{id} |
open |
Updates |
|
POST /authorize |
open |
Auth |
|
POST /token |
open |
Auth |
|
test_01_root_endpoint |
verified |
||
test_01b_version_info_endpoint |
verified |
||
test_02_list_areas |
verified |
||
test_03_list_components |
verified |
||
test_04_automotive_areas_discovery |
verified |
||
test_05_area_components_success |
verified |
||
test_06_area_components_nonexistent_error |
verified |
||
test_07_component_data_powertrain_engine |
verified |
||
test_08_component_data_chassis_brakes |
verified |
||
test_09_component_data_body_door |
verified |
||
test_10_component_data_structure |
verified |
||
test_11_component_nonexistent_error |
verified |
||
test_12_component_no_topics |
verified |
||
test_13_invalid_component_id_special_chars |
verified |
||
test_14_invalid_area_id_special_chars |
verified |
||
test_15_valid_ids_with_underscores |
verified |
||
test_16_invalid_ids_with_hyphens |
verified |
||
test_17_component_topic_temperature |
verified |
||
test_18_component_topic_rpm |
verified |
||
test_19_component_topic_pressure |
verified |
||
test_20_component_topic_data_structure |
verified |
||
test_21_component_nonexistent_topic_error |
verified |
||
test_22_component_topic_nonexistent_component_error |
verified |
||
test_23_component_topic_with_slashes |
verified |
||
test_24_component_topic_valid_names |
verified |
||
test_25_publish_brake_command |
verified |
||
test_26_publish_validation_missing_type |
verified |
||
test_27_publish_validation_missing_data |
verified |
||
test_28_publish_validation_invalid_type_format |
verified |
||
test_29_publish_nonexistent_component |
verified |
||
test_30_publish_invalid_json_body |
verified |
||
test_31_operation_call_calibrate_service |
verified |
||
test_32_operation_call_nonexistent_operation |
verified |
||
test_33_operation_call_nonexistent_component |
verified |
||
test_34_operation_call_invalid_component_id |
verified |
||
test_35_operation_call_invalid_operation_name |
verified |
||
test_36_operation_call_with_invalid_json |
verified |
||
test_37_operations_listed_in_component_discovery |
verified |
||
test_38_root_endpoint_includes_operations |
verified |
||
test_39_action_send_goal_and_get_id |
verified |
||
test_40_action_status_endpoint |
verified |
||
test_41_action_status_after_completion |
verified |
||
test_42_action_cancel_endpoint |
verified |
||
test_43_action_listed_in_component_discovery |
verified |
||
test_44_action_status_without_goal_id_returns_latest |
verified |
||
test_45_list_configurations |
verified |
||
test_46_get_configuration |
verified |
||
test_47_set_configuration |
verified |
||
test_48_delete_configuration_resets_to_default |
verified |
||
test_49_configurations_nonexistent_component |
verified |
||
test_50_configuration_nonexistent_parameter |
verified |
||
test_51_set_configuration_missing_value |
verified |
||
test_52_root_endpoint_includes_configurations |
verified |
||
test_53_service_operation_has_type_info_schema |
verified |
||
test_54_action_operation_has_type_info_schema |
verified |
||
test_55_root_endpoint_includes_faults |
verified |
||
test_56_list_faults_response_structure |
verified |
||
test_57_faults_nonexistent_component |
verified |
||
test_58_get_nonexistent_fault |
verified |
||
test_list_areas_endpoint |
verified |
||
test_list_components_endpoint |
verified |
||
test_root_endpoint |
verified |
||
test_version_info_endpoint |
verified |