Skip to content

Commit 4cc78b7

Browse files
committed
refactor: rename parameters in get_service_ports method for clarity and update corresponding tests
1 parent 8b25a9e commit 4cc78b7

File tree

3 files changed

+28
-16
lines changed

3 files changed

+28
-16
lines changed

packages/models-library/src/models_library/api_schemas_catalog/services_ports.py

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,29 @@ class ServicePortGet(BaseModel):
2929

3030
model_config = ConfigDict(
3131
json_schema_extra={
32-
"example": {
33-
"key": "input_1",
34-
"kind": "input",
35-
"content_schema": {
36-
"title": "Sleep interval",
37-
"type": "integer",
38-
"x_unit": "second",
39-
"minimum": 0,
40-
"maximum": 5,
32+
"examples": [
33+
{
34+
"key": "input_1",
35+
"kind": "input",
36+
"content_schema": {
37+
"title": "Sleep interval",
38+
"type": "integer",
39+
"x_unit": "second",
40+
"minimum": 0,
41+
"maximum": 5,
42+
},
4143
},
42-
}
44+
{
45+
"key": "output_1",
46+
"kind": "output",
47+
"content_media_type": "text/plain",
48+
"content_schema": {
49+
"type": "string",
50+
"title": "File containing one random integer",
51+
"description": "Integer is generated in range [1-9]",
52+
},
53+
},
54+
]
4355
}
4456
)
4557

services/api-server/src/simcore_service_api_server/services_rpc/catalog.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ async def get_service_ports(
127127
*,
128128
product_name: ProductName,
129129
user_id: UserID,
130-
service_key: ServiceKey,
131-
service_version: ServiceVersion,
130+
name: ServiceKey,
131+
version: ServiceVersion,
132132
) -> list[ServicePortGet]:
133133
"""Gets service ports (inputs and outputs) for a specific service version
134134
@@ -141,6 +141,6 @@ async def get_service_ports(
141141
self._client,
142142
product_name=product_name,
143143
user_id=user_id,
144-
service_key=service_key,
145-
service_version=service_version,
144+
service_key=name,
145+
service_version=version,
146146
)

services/api-server/tests/unit/test_services_catalog.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ async def test_catalog_service_read_solvers(
8080
ports = await catalog_service.get_service_ports(
8181
product_name=product_name,
8282
user_id=user_id,
83-
service_key=selected_solver.id,
84-
service_version=oldest_release.version,
83+
name=selected_solver.id,
84+
version=oldest_release.version,
8585
)
8686

8787
# Verify ports are returned and contain both inputs and outputs

0 commit comments

Comments
 (0)