Skip to content

Fix pluralized lifecycle status operationIds (closes #475) #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfaferek93 merged 2 commits into from
Jul 5, 2026
Merged

Fix pluralized lifecycle status operationIds (closes #475) #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4c671d
Fix pluralized lifecycle status operationIds (closes #475)
YueBit Jul 4, 2026
4d795ba
test: add regression guard for lifecycle status operationId naming
YueBit Jul 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/ros2_medkit_gateway/src/http/rest_server.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1620,8 +1620,8 @@ void RESTServer::setup_routes() {
for (const auto & et_lc :
std::vector<std::pair<const char *, const char *>>{{"apps", "app"}, {"components", "component"}}) {
const std::string base_lc = std::string("/") + et_lc.first + "/{" + et_lc.second + "_id}";
// e.g. "Apps" / "Components" for operation ID construction
const std::string entity_cap = capitalize(std::string(et_lc.first));
// e.g. "App" / "Component" for operation ID construction
const std::string entity_cap = capitalize(std::string(et_lc.second));
Comment thread
mfaferek93 marked this conversation as resolved.

for (const auto & action : {"start", "restart", "force-restart", "shutdown", "force-shutdown"}) {
std::string action_str = action;
Expand Down
12 changes: 12 additions & 0 deletions src/ros2_medkit_integration_tests/test/features/test_docs_endpoint.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,18 @@ def test_root_docs_returns_openapi_spec(self):
f'Root spec should include /apps path. Paths: {list(paths.keys())}'
)

# Lifecycle status operationIds use the singular entity name
# (getAppStatus), not the plural collection name (getAppsStatus).
self.assertEqual(
paths['/apps/{app_id}/status']['get']['operationId'],
'getAppStatus')
self.assertEqual(
paths['/components/{component_id}/status']['get']['operationId'],
'getComponentStatus')
self.assertEqual(
paths['/apps/{app_id}/status/restart']['put']['operationId'],
'putAppStatusRestart')

def test_apps_docs_returns_entity_collection_spec(self):
"""GET /apps/docs returns spec for apps collection.

Expand Down
Loading