Add auto name generation for paths missing operationId. Closes #92

Author: dbanty

CHANGELOG.md

@@ -15,8 +15,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Properly remove spaces from generated Enum keys (#198). Thanks @bowenwr!
 
-### Added
+### Additions
 
+- Endpoints without operationIds will have a name generated from their method and path (#92). Thanks @Kerybas & @dtkav!
 - Note to README about supported OpenAPI versions (#176). Thanks @filippog!
 
 ## 0.6.0 - 2020-09-21

openapi_python_client/parser/openapi.py

@@ -63,6 +63,16 @@ def from_data(*, data: Dict[str, oai.PathItem]) -> Dict[str, "EndpointCollection
         return endpoints_by_tag
 
 
+def generate_operation_id(*, path: str, method: str) -> str:
+    """ Generate an operationId from a path """
+    clean_path = path.replace("{", "").replace("}", "").replace("/", "_")
+    if clean_path.startswith("_"):
+        clean_path = clean_path[1:]
+    if clean_path.endswith("_"):
+        clean_path = clean_path[:-1]
+    return f"{method}_{clean_path}"
+
+
 @dataclass
 class Endpoint:
     """
@@ -188,13 +198,15 @@ def from_data(*, data: oai.Operation, path: str, method: str, tag: str) -> Union
         """ Construct an endpoint from the OpenAPI data """
 
         if data.operationId is None:
-            return ParseError(data=data, detail="Path operations with operationId are not yet supported")
+            name = generate_operation_id(path=path, method=method)
+        else:
+            name = data.operationId
 
         endpoint = Endpoint(
             path=path,
             method=method,
             description=utils.remove_string_escapes(data.description) if data.description else "",
-            name=data.operationId,
+            name=name,
             requires_security=bool(data.security),
             tag=tag,
         )

tests/test_openapi_parser/test_openapi.py

@@ -578,7 +578,7 @@ def test_from_data_bad_responses(self, mocker):
 
         assert result == parse_error
 
-    def test_from_data(self, mocker):
+    def test_from_data_standard(self, mocker):
         from openapi_python_client.parser.openapi import Endpoint
 
         path = mocker.MagicMock()
@@ -613,8 +613,56 @@ def test_from_data(self, mocker):
         _add_responses.assert_called_once_with(_add_parameters.return_value, data.responses)
         _add_body.assert_called_once_with(_add_responses.return_value, data)
 
-        data.security = None
-        _add_parameters.reset_mock()
+    def test_from_data_no_operation_id(self, mocker):
+        from openapi_python_client.parser.openapi import Endpoint
+
+        path = "/path/with/{param}/"
+        method = "get"
+        _add_parameters = mocker.patch.object(Endpoint, "_add_parameters")
+        _add_responses = mocker.patch.object(Endpoint, "_add_responses")
+        _add_body = mocker.patch.object(Endpoint, "_add_body")
+        data = oai.Operation.construct(
+            description=mocker.MagicMock(),
+            operationId=None,
+            security={"blah": "bloo"},
+            responses=mocker.MagicMock(),
+        )
+
+        mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=data.description)
+
+        endpoint = Endpoint.from_data(data=data, path=path, method=method, tag="default")
+
+        assert endpoint == _add_body.return_value
+
+        _add_parameters.assert_called_once_with(
+            Endpoint(
+                path=path,
+                method=method,
+                description=data.description,
+                name="get_path_with_param",
+                requires_security=True,
+                tag="default",
+            ),
+            data,
+        )
+        _add_responses.assert_called_once_with(_add_parameters.return_value, data.responses)
+        _add_body.assert_called_once_with(_add_responses.return_value, data)
+
+    def test_from_data_no_security(self, mocker):
+        from openapi_python_client.parser.openapi import Endpoint
+
+        data = oai.Operation.construct(
+            description=mocker.MagicMock(),
+            operationId=mocker.MagicMock(),
+            security=None,
+            responses=mocker.MagicMock(),
+        )
+        _add_parameters = mocker.patch.object(Endpoint, "_add_parameters")
+        _add_responses = mocker.patch.object(Endpoint, "_add_responses")
+        _add_body = mocker.patch.object(Endpoint, "_add_body")
+        path = mocker.MagicMock()
+        method = mocker.MagicMock()
+        mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=data.description)
 
         Endpoint.from_data(data=data, path=path, method=method, tag="a")
 
@@ -629,11 +677,8 @@ def test_from_data(self, mocker):
             ),
             data,
         )
-
-        data.operationId = None
-        assert Endpoint.from_data(data=data, path=path, method=method, tag="a") == ParseError(
-            data=data, detail="Path operations with operationId are not yet supported"
-        )
+        _add_responses.assert_called_once_with(_add_parameters.return_value, data.responses)
+        _add_body.assert_called_once_with(_add_responses.return_value, data)
 
 
 class TestImportStringFromReference: