Merge pull request #435 from kreneskyp/openapi_path_args

OpenAPIRequest now handles paths with variables
kreneskyp · Feb 5, 2024 · d414f98 · d414f98
2 parents a939391 + 005119e
commit d414f98
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/ix/runnable/openapi.py b/ix/runnable/openapi.py
@@ -13,7 +13,11 @@
 
 def build_httpx_kwargs(path: str, input: Input, **kwargs) -> dict[str, Any]:
     """Build kwargs for OpenAPI request with httpx"""
-    formatted_path = path.format(**input.get("path", {}))
+    path_args = input.get("path", {})
+    path_args = (
+        path_args.model_dump() if isinstance(path_args, BaseModel) else path_args
+    )
+    formatted_path = path.format(**path_args)
     headers = kwargs.get("headers", {})
     headers.update(input.get("headers", {}))
     params = {}

diff --git a/ix/runnable/tests/test_openapi.py b/ix/runnable/tests/test_openapi.py
@@ -107,12 +107,8 @@ def test_input_with_path_args(self, schema):
                     "type": "object",
                 }
             },
-            "properties": {
-                "args": {
-                    "anyOf": [{"$ref": "#/$defs/DynamicModel"}, {"type": "null"}],
-                    "default": None,
-                }
-            },
+            "properties": {"path": {"$ref": "#/$defs/DynamicModel"}},
+            "required": ["path"],
             "title": "DynamicModel",
             "type": "object",
         }

diff --git a/ix/utils/openapi.py b/ix/utils/openapi.py
@@ -10,7 +10,7 @@ def get_input_schema(
 ) -> Dict[str, Any]:
     """
     Extracts the JSON schema for the input of a specified HTTP method, converts it to a valid JSON schema,
-    and uses references for nested objects named 'query', 'args', and 'body' (using the schema title if available).
+    and uses references for nested objects named 'query', 'path', and 'body' (using the schema title if available).
     """
 
     def resolve_reference(schema, ref):
@@ -65,21 +65,21 @@ def extract_nested_objects(schema, definitions, definition_name):
     method_item = path_item.get(method.lower(), {})
 
     path_properties, path_required = convert_to_json_schema(
-        method_item.get("parameters", []), "path", result["definitions"], "Args"
+        method_item.get("parameters", []), "path", result["definitions"], "Path"
     )
     query_properties, query_required = convert_to_json_schema(
         method_item.get("parameters", []), "query", result["definitions"], "Query"
     )
 
     if path_properties:
-        result["properties"]["args"] = extract_nested_objects(
+        result["properties"]["path"] = extract_nested_objects(
             {
                 "type": "object",
                 "properties": path_properties,
                 "required": path_required,
             },
             result["definitions"],
-            "Args",
+            "Path",
         )
 
     if query_properties:

diff --git a/ix/utils/tests/mock_schema.py b/ix/utils/tests/mock_schema.py
@@ -431,15 +431,15 @@
 
 GET_DETAIL_SCHEMA = {
     "definitions": {
-        "Args": {
+        "Path": {
             "properties": {
                 "chain_id": {"format": "uuid", "title": "Chain Id", "type": "string"}
             },
             "required": ["chain_id"],
             "type": "object",
         }
     },
-    "properties": {"args": {"$ref": "#/definitions/Args"}},
+    "properties": {"path": {"$ref": "#/definitions/Path"}},
     "required": ["path"],
     "type": "object",
 }