#97 feat(gateway): add GET /api/v1/faults endpoint for system-wide fa… #98
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ult retrieval Add convenience API endpoint that returns all faults across the system without requiring iteration over individual components. Supports status filtering via query parameter (?status=pending|confirmed|cleared|all).
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new convenience endpoint GET /api/v1/faults that retrieves all faults across the entire system without requiring iteration over individual components. The endpoint supports optional status filtering via query parameter (?status=pending|confirmed|cleared|all).
Key changes:
- Added system-wide fault retrieval endpoint for dashboard/monitoring use cases
- Implemented status filtering with default behavior (pending + confirmed, excluding cleared)
- Added integration tests validating the endpoint's basic functionality and status filtering
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
src/ros2_medkit_gateway/include/ros2_medkit_gateway/rest_server.hpp |
Declared new handle_list_all_faults handler method |
src/ros2_medkit_gateway/src/rest_server.cpp |
Implemented GET /api/v1/faults endpoint with status filtering, added route registration, and updated root endpoint documentation |
src/ros2_medkit_gateway/test/test_integration.test.py |
Added integration tests for global fault listing and status filtering, updated root endpoint test to verify new endpoint is advertised |
mfaferek93
force-pushed
the
97/getAllFaultsAPI
branch
from
2966fdb to
10a0844
Compare
mfaferek93
changed the base branch from
94/topicBasedComponentDiscovery
to
main
Address code review feedback: - Extract FaultStatusFilter struct and parse_fault_status_param() helper to eliminate code duplication between fault listing functions - Return 400 Bad Request for invalid status parameter values - Add tests for invalid status handling (test_61, test_62) - Extend test_60 to cover all valid status values - Document Faults Endpoints section in README.md - Add system-wide faults requests to Postman collection
mfaferek93
force-pushed
the
97/getAllFaultsAPI
branch
from
10a0844 to
dd454fb
Compare
mfaferek93
changed the base branch from
main
to
94/topicBasedComponentDiscovery
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Summary
add GET /api/v1/faults endpoint for system-wide fault retrieval
Add convenience API endpoint that returns all faults across the system
without requiring iteration over individual components. Supports status
filtering via query parameter (?status=pending|confirmed|cleared|all).
Issue
Link the related issue (required):
Type
Testing
How was this tested / how should reviewers verify it?
Checklist