Skip to content

Commit 2a3236d

Browse files
authored
Python: feat: support path item parameters and non-method keys in OpenAPI parser (microsoft#14588)
Fixes microsoft#14581. OpenApiParser.create_rest_api_operations treated every key of a path item as an HTTP method, so summary, description, servers or parameters on a path item made plugin loading fail with 'operationId missing'. Only HTTP method keys are now treated as operations, and path-level parameters are merged into each operation (an operation-level parameter with the same name and location overrides the shared one). Added tests for both.
1 parent c79a160 commit 2a3236d

2 files changed

Lines changed: 55 additions & 1 deletion

File tree

‎python/semantic_kernel/connectors/openapi_plugin/openapi_parser.py‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525

2626
logger: logging.Logger = logging.getLogger(__name__)
2727

28+
# Keys of an OpenAPI path item that describe an operation; the others (summary, description, servers,
29+
# parameters, $ref, x-*) apply to the path as a whole.
30+
HTTP_METHODS: Final = frozenset({"get", "put", "post", "delete", "options", "head", "patch", "trace"})
31+
2832

2933
class OpenApiParser:
3034
"""NOTE: SK Python only supports the OpenAPI Spec >=3.0.
@@ -250,8 +254,11 @@ def create_rest_api_operations(
250254
server_urls = [{"url": "/", "variables": {}, "description": ""}]
251255

252256
for path, methods in paths.items():
257+
path_parameters = methods.get("parameters", [])
253258
for method, details in methods.items():
254259
request_method = method.lower()
260+
if request_method not in HTTP_METHODS:
261+
continue
255262
# Validate that operationId exists
256263
if "operationId" not in details:
257264
raise PluginInitializationError(f"operationId missing, path: '{path}', method: '{method}'")
@@ -290,7 +297,12 @@ def create_rest_api_operations(
290297
logger.info(f"Skipping operation {operationId} as it is excluded.")
291298
continue
292299

293-
parameters = details.get("parameters", [])
300+
# Operation level parameters override path level ones with the same name and location.
301+
operation_parameters = details.get("parameters", [])
302+
overridden = {(p.get("name"), p.get("in")) for p in operation_parameters}
303+
parameters = [
304+
p for p in path_parameters if (p.get("name"), p.get("in")) not in overridden
305+
] + operation_parameters
294306
parsed_params = self._parse_parameters(parameters)
295307
request_body = self._create_rest_api_operation_payload(operationId, details.get("requestBody", None))
296308
responses = dict(self._create_response(details.get("responses", {})))

‎python/tests/unit/connectors/openapi_plugin/test_openapi_parser.py‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,3 +383,45 @@ def test_create_functions_propagates_enable_file_ref_resolution():
383383
enable_file_ref_resolution=True,
384384
enable_http_ref_resolution=False,
385385
)
386+
387+
388+
def _path_item_spec(path_item: dict) -> dict:
389+
return {
390+
"openapi": "3.0.1",
391+
"info": {"title": "t", "version": "1"},
392+
"servers": [{"url": "https://api.example.com"}],
393+
"paths": {"/items/{id}": path_item},
394+
}
395+
396+
397+
def test_create_rest_api_operations_path_item_keys_and_shared_parameters():
398+
id_param = {"name": "id", "in": "path", "required": True, "schema": {"type": "string"}}
399+
spec = _path_item_spec({
400+
"summary": "Item",
401+
"description": "An item",
402+
"parameters": [id_param],
403+
"get": {"operationId": "getItem", "responses": {"200": {"description": "ok"}}},
404+
"delete": {"operationId": "deleteItem", "responses": {"200": {"description": "ok"}}},
405+
})
406+
407+
operations = OpenApiParser().create_rest_api_operations(spec)
408+
409+
assert set(operations) == {"getItem", "deleteItem"}
410+
for operation in operations.values():
411+
assert [p.name for p in operation.parameters] == ["id"]
412+
413+
414+
def test_create_rest_api_operations_operation_parameter_overrides_path_parameter():
415+
spec = _path_item_spec({
416+
"parameters": [{"name": "id", "in": "path", "required": True, "schema": {"type": "string"}}],
417+
"get": {
418+
"operationId": "getItem",
419+
"parameters": [
420+
{"name": "id", "in": "path", "required": True, "description": "own", "schema": {"type": "integer"}}
421+
],
422+
"responses": {"200": {"description": "ok"}},
423+
},
424+
})
425+
426+
operation = OpenApiParser().create_rest_api_operations(spec)["getItem"]
427+
assert [(p.name, p.type, p.description) for p in operation.parameters] == [("id", "integer", "own")]

0 commit comments

Comments
 (0)