fix: generate deterministic operationId for root endpoints without one (#19888)

This commit is contained in:
Hao Cheng
2025-07-15 14:19:55 +08:00
committed by GitHub
parent 7e666dc3b1
commit 32c541a9ed
3 changed files with 57 additions and 2 deletions

View File

@@ -1,5 +1,4 @@
import re
import uuid
from json import dumps as json_dumps
from json import loads as json_loads
from json.decoder import JSONDecodeError
@@ -154,7 +153,7 @@ class ApiBasedToolSchemaParser:
# remove special characters like / to ensure the operation id is valid ^[a-zA-Z0-9_-]{1,64}$
path = re.sub(r"[^a-zA-Z0-9_-]", "", path)
if not path:
path = str(uuid.uuid4())
path = "<root>"
interface["operation"]["operationId"] = f"{path}_{interface['method']}"

View File

@@ -0,0 +1,56 @@
import pytest
from flask import Flask
from core.tools.utils.parser import ApiBasedToolSchemaParser
@pytest.fixture
def app():
app = Flask(__name__)
return app
def test_parse_openapi_to_tool_bundle_operation_id(app):
openapi = {
"openapi": "3.0.0",
"info": {"title": "Simple API", "version": "1.0.0"},
"servers": [{"url": "http://localhost:3000"}],
"paths": {
"/": {
"get": {
"summary": "Root endpoint",
"responses": {
"200": {
"description": "Successful response",
}
},
}
},
"/api/resources": {
"get": {
"summary": "Non-root endpoint without an operationId",
"responses": {
"200": {
"description": "Successful response",
}
},
},
"post": {
"summary": "Non-root endpoint with an operationId",
"operationId": "createResource",
"responses": {
"201": {
"description": "Resource created",
}
},
},
},
},
}
with app.test_request_context():
tool_bundles = ApiBasedToolSchemaParser.parse_openapi_to_tool_bundle(openapi)
assert len(tool_bundles) == 3
assert tool_bundles[0].operation_id == "<root>_get"
assert tool_bundles[1].operation_id == "apiresources_get"
assert tool_bundles[2].operation_id == "createResource"