Fix: Replace slash from generated operationId (#264)

Fix: Replace '/' with _ in operationId Fixes #263 Signed-off-by: Harish Karumuthil <[email protected]> Signed-off-by: Harish Karumuthil <[email protected]> (cherry picked from commit b96a490)
0b01001001 · Oct 15, 2022 · 86fd888 · 86fd888
1 parent 8280050
commit 86fd888
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/spectree/spec.py b/spectree/spec.py
@@ -274,7 +274,7 @@ def _generate_spec(self) -> Dict[str, Any]:
 
                 routes[path][method.lower()] = {
                     "summary": summary or f"{name} <{method}>",
-                    "operationId": f"{method.lower()}_{path}",
+                    "operationId": f"{method.lower()}_{path.replace('/', '_')}",
                     "description": desc or "",
                     "tags": [str(x) for x in getattr(func, "tags", ())],
                     "parameters": parse_params(func, parameters[:], self.models),

diff --git a/tests/test_plugin.py b/tests/test_plugin.py
@@ -68,7 +68,7 @@ def test_plugin_spec(api):
     assert ping["parameters"][0]["in"] == "header"
     assert ping["summary"] == "summary"
     assert ping["description"] == "description"
-    assert ping["operationId"] == "get_/ping"
+    assert ping["operationId"] == "get__ping"
 
     user = api.spec["paths"]["/api/user/{name}"]["post"]
     assert user["tags"] == ["API", "test"]