Faults

Requirement: GET /{entity}/faults/{code} REQ_INTEROP_013

The endpoint shall return detailed information for the addressed diagnostic fault code, including environment data captured at fault confirmation.

Response includes:

  • item: Fault details with SOVD-compliant status object (aggregatedStatus, testFailed, confirmedDTC, pendingDTC)

  • environment_data: Extended data records (timestamps) and snapshots array

  • environment_data.snapshots[]: Array of freeze_frame (topic data) and rosbag (bulk-data reference) entries

  • x-medkit: Extension fields (occurrence_count, reporting_sources, severity_label)

Requirement: DELETE /{entity}/faults REQ_INTEROP_014

The endpoint shall clear all diagnostic fault entries stored for the addressed entity, if permitted.

Requirement: DELETE /{entity}/faults/{code} REQ_INTEROP_015
status: verified
tags: Faults

The endpoint shall clear the addressed diagnostic fault code for the entity, if permitted.

Requirement: Fault Snapshot and Rosbag Capture REQ_INTEROP_088
status: verified
tags: Faults, BulkData
is verified by: TEST_FaultManagerTest_GetRosbagNotFound, TEST_FaultManagerTest_GetRosbagServiceNotAvailable, TEST_FaultManagerTest_GetRosbagSuccess, TEST_FaultManagerTest_GetRosbagUsesConfiguredFaultManagerNamespace, TEST_FaultManagerTest_GetSnapshotsEmptyResponse, TEST_FaultManagerTest_GetSnapshotsErrorResponse, TEST_FaultManagerTest_GetSnapshotsInvalidJsonFallback, TEST_FaultManagerTest_GetSnapshotsServiceNotAvailable, TEST_FaultManagerTest_GetSnapshotsSuccessWithTopicFilter, TEST_FaultManagerTest_GetSnapshotsSuccessWithValidJson, TEST_FaultManagerTest_GetSnapshotsUsesConfiguredFaultManagerNamespace, TEST_RosbagCaptureTest_ConstructorAcceptsMcapFormat, TEST_RosbagCaptureTest_ConstructorRequiresValidNode, TEST_RosbagCaptureTest_ConstructorRequiresValidStorage, TEST_RosbagCaptureTest_ConstructorSucceedsWithValidParams, TEST_RosbagCaptureTest_ConstructorThrowsOnInvalidFormat, TEST_RosbagCaptureTest_ConstructorWithDisabledRosbag, TEST_RosbagCaptureTest_IsEnabledReturnsConfigState, TEST_SnapshotCaptureTest_BackgroundCaptureInitializesSubscriptions, TEST_SnapshotCaptureTest_ConfigAccessorReturnsCorrectValues, TEST_SnapshotCaptureTest_ConstructorRequiresValidNode, TEST_SnapshotCaptureTest_ConstructorRequiresValidStorage, TEST_SnapshotCaptureTest_ConstructorSucceedsWithValidParams, TEST_SnapshotCaptureTest_DisabledCaptureSkipsProcessing, TEST_SnapshotCaptureTest_EmptyConfigurationHandledGracefully, TEST_SnapshotCaptureTest_InvalidRegexPatternIsSkipped, TEST_SnapshotCaptureTest_IsEnabledReturnsConfigState, TEST_SnapshotCaptureTest_MultipleValidPatternsCompiled, TEST_SnapshotCaptureTest_OnDemandCaptureHandlesNonExistentTopic, TEST_SqliteFaultStorageTest_ClearFaultDeletesAssociatedSnapshots, TEST_SqliteFaultStorageTest_FilterSnapshotsByTopic, TEST_SqliteFaultStorageTest_MultipleSnapshotsForSameFault, TEST_SqliteFaultStorageTest_NoSnapshotsForUnknownFault, TEST_SqliteFaultStorageTest_StoreAndRetrieveSnapshot, TEST_TestFaultManagerIntegration_test_16_snapshot_capture_on_fault_confirmation, TEST_TestFaultManagerIntegration_test_17_get_snapshots_nonexistent_fault, TEST_TestFaultManagerIntegration_test_18_get_snapshots_empty_fault_code, TEST_TestFaultManagerIntegration_test_19_snapshot_with_topic_filter, TEST_TestFaultManagerIntegration_test_20_snapshot_config_loads_patterns, TEST_TestSnapshotsApi_test_root_endpoint_excludes_legacy_snapshots, TEST_TopicResolutionTest_DefaultTopicsUsedAsFallback, TEST_TopicResolutionTest_FaultSpecificHasHighestPriority, TEST_TopicResolutionTest_PatternMatchUsedWhenNoFaultSpecific

When a fault is confirmed, the system shall automatically capture diagnostic snapshots (freeze-frame topic data) and rosbag recordings as configured. Captured data shall be stored as environment data associated with the fault and accessible via the bulk-data endpoints on the fault’s reporting entity.