Add support for parameterless ops (vblagoje#11)

Author: vblagoje

openapi_llm/core/schema_conversion.py

@@ -156,41 +156,46 @@ def _convert_operation_to_openai_schema(
             "Invalid OpenAPI spec format provided. Could not extract function."
         )
         return {}
+
     function_name = resolved_spec.get("operationId")
     description = resolved_spec.get("description") or resolved_spec.get("summary", "")
-    schema: Dict[str, Any] = {"type": "object", "properties": {}}
-    # requestBody section
-    req_body_schema = (
-        resolved_spec.get("requestBody", {})
-        .get("content", {})
-        .get("application/json", {})
-        .get("schema", {})
-    )
-    if "properties" in req_body_schema:
-        for prop_name, prop_schema in req_body_schema["properties"].items():
-            schema["properties"][prop_name] = _parse_property_attributes(prop_schema)
-        if "required" in req_body_schema:
-            schema.setdefault("required", []).extend(req_body_schema["required"])
-
-    # parameters section
-    for param in resolved_spec.get("parameters", []):
-        if "schema" in param:
-            schema_dict = _parse_property_attributes(param["schema"])
-            # these attributes are not in param[schema] level but on param level
-            useful_attributes = ["description", "pattern", "enum"]
-            schema_dict.update(
-                {key: param[key] for key in useful_attributes if param.get(key)}
-            )
-            schema["properties"][param["name"]] = schema_dict
-            if param.get("required", False):
-                schema.setdefault("required", []).append(param["name"])
 
-    if function_name and description and schema["properties"]:
+    # Return valid schema even if no parameters are present
+    if function_name and description:
+        schema: Dict[str, Any] = {"type": "object", "properties": {}}
+
+        # requestBody section
+        req_body_schema = (
+            resolved_spec.get("requestBody", {})
+            .get("content", {})
+            .get("application/json", {})
+            .get("schema", {})
+        )
+        if "properties" in req_body_schema:
+            for prop_name, prop_schema in req_body_schema["properties"].items():
+                schema["properties"][prop_name] = _parse_property_attributes(prop_schema)
+            if "required" in req_body_schema:
+                schema.setdefault("required", []).extend(req_body_schema["required"])
+
+        # parameters section
+        for param in resolved_spec.get("parameters", []):
+            if "schema" in param:
+                schema_dict = _parse_property_attributes(param["schema"])
+                # these attributes are not in param[schema] level but on param level
+                useful_attributes = ["description", "pattern", "enum"]
+                schema_dict.update(
+                    {key: param[key] for key in useful_attributes if param.get(key)}
+                )
+                schema["properties"][param["name"]] = schema_dict
+                if param.get("required", False):
+                    schema.setdefault("required", []).append(param["name"])
+
         return {
             "name": function_name,
             "description": description,
             parameters_name: schema,
         }
+
     logger.warning(
         "Invalid OpenAPI spec format provided. Could not extract function from %s",
         resolved_spec,

test/test_files/yaml/parameterless.yml

@@ -0,0 +1,23 @@
+openapi: 3.0.0
+info:
+  title: Parameterless API
+  version: 1.0.0
+  description: API with parameterless endpoints
+servers:
+  - url: https://api.example.com
+paths:
+  /status:
+    get:
+      operationId: getBatchStatus
+      description: Get the status of all batch jobs
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    enum: [idle, processing, completed]

test/test_openapi_client_live_openai.py

@@ -104,7 +104,7 @@ def test_firecrawl(self):
         """
         from openapi_llm.utils import HttpClientError
 
-        openapi_spec_url = "https://raw.githubusercontent.com/mendableai/firecrawl/main/apps/api/openapi.json"
+        openapi_spec_url = "https://raw.githubusercontent.com/mendableai/firecrawl/main/apps/api/v1-openapi.json"
         config = ClientConfig(openapi_spec=create_openapi_spec(openapi_spec_url), credentials=os.getenv("FIRECRAWL_API_KEY"))
         client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
         response = client.chat.completions.create(

test/test_openapi_cohere_conversion.py

@@ -163,3 +163,13 @@ def test_complex_types(self, test_files_path):
                 "required": True,
             },
         }
+
+    def test_parameterless(self, test_files_path):
+        spec = OpenAPISpecification.from_file(test_files_path / "yaml" / "parameterless.yml")
+        functions = cohere_converter(schema=spec)
+        assert functions
+        assert len(functions) == 1
+        function = functions[0]
+        assert function["name"] == "getBatchStatus"
+        assert function["description"] == "Get the status of all batch jobs"
+        assert function["parameter_definitions"] == {}

test/test_openapi_openai_conversion.py

@@ -104,3 +104,19 @@ def test_complex_types(self, test_files_path, provider: str):
                 "required": ["transaction_amount", "description", "payment_method_id", "payer"],
             }
         )
+
+    @pytest.mark.parametrize("provider", ["openai", "anthropic"])
+    def test_parameterless(self, test_files_path, provider: str):
+        spec = OpenAPISpecification.from_file(test_files_path / "yaml" / "parameterless.yml")
+        functions = openai_converter(schema=spec) if provider == "openai" else anthropic_converter(schema=spec)
+        assert functions
+        assert len(functions) == 1
+        function = functions[0]["function"] if provider == "openai" else functions[0]
+        assert function["name"] == "getBatchStatus"
+        assert function["description"] == "Get the status of all batch jobs"
+        assert (
+            function["parameters"]
+            if provider == "openai"
+            else function["input_schema"]
+            == {"type": "object", "properties": {}}
+        )