[#15] feat: implement GET /components endpoint #18
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
Add endpoint to list all discovered components across all areas. Changes: - Add GET /components REST endpoint in rest_server.cpp - Implement handle_list_components() to return component metadata - Add test_03_list_components integration test - Update README with API reference and endpoint documentation - Update Postman collection with new endpoint
mfaferek93
force-pushed
the
15/feat/GET/components
branch
from
f8f2b65 to
fd71fa9
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new GET /components endpoint to the REST API that returns all discovered ROS 2 components (nodes) across all areas. It complements the existing /areas endpoint by providing detailed component metadata including fully qualified names and parent area associations.
Key changes:
- New REST endpoint implementation following existing patterns for error handling and JSON serialization
- Comprehensive integration test with structure validation and expected component checks
- Complete API documentation with examples and response field descriptions
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/ros2_medkit_gateway/src/rest_server.cpp |
Implements handle_list_components() handler that queries the entity cache and returns component metadata as JSON |
src/ros2_medkit_gateway/include/ros2_medkit_gateway/rest_server.hpp |
Adds method declaration for the new components handler |
src/ros2_medkit_gateway/test/test_integration.test.py |
Adds test_03_list_components() integration test and renumbers subsequent test to maintain sequential ordering |
src/ros2_medkit_gateway/README.md |
Adds comprehensive API reference section with endpoint documentation, curl examples, and response field descriptions |
postman/collections/ros2-medkit-gateway.postman_collection.json |
Adds "GET List Components" request to the Postman collection |
postman/README.md |
Updates quick start guide to include the new components endpoint |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
@mfaferek93 could you asssing an issue to this PR? |
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.
Add endpoint to list all discovered components across all areas.
Changes:
Pull Request
Description
What changed and why.
Type of change
Related issues
Fixes # (if applicable)
Related to # (if applicable)
How has this been tested?
Describe the tests you ran to verify your changes.
Checklist
colcon buildand the build succeeds without warningscolcon testand all tests pass locallyAdditional notes for reviewers