[Enh]: The `info.description` field in the OpenAPI output is never populated.
维护者通常 1 天内回复
@souvikghosh04 已经在做这个了。
开始于 2026年7月7日。
评估
这个 Issue 还没有评估数据。
描述
Summary
The info.description field in the generated OpenAPI document is never populated.
DAB already supports a server-level description through runtime.mcp.description. Use this value to populate OpenApiInfo.Description when building the OpenAPI document.
Desired behavior
When runtime.mcp.description is configured, pass its value to OpenApiInfo.Description in BuildOpenApiDocument.
Single configuration
{
"runtime": {
"mcp": {
"description": "This server provides access to the company database."
}
}
}
Expected OpenAPI output
{
"info": {
"title": "Data API builder - REST Endpoint",
"version": "1.0.0",
"description": "This server provides access to the company database."
}
}
Multiple configurations
When DAB uses multiple configuration files, use runtime.mcp.description from the top-level configuration.
The combined runtime produces one OpenAPI document, so it should also have one description. Runtime settings from child configuration files should not contribute separate descriptions.
Top-level configuration
{
"data-source-files": [
"sales.json",
"inventory.json"
],
"runtime": {
"mcp": {
"description": "This server provides access to company sales and inventory data."
}
}
}
Expected OpenAPI output
{
"info": {
"title": "Data API builder - REST Endpoint",
"version": "1.0.0",
"description": "This server provides access to company sales and inventory data."
}
}
Current behavior
runtime.mcp.description is available in the DAB configuration and is used as the MCP server description, but OpenApiInfo.Description is never set.
As a result, the description is available to MCP clients but omitted from the generated OpenAPI document.
Recommendation
Set OpenApiInfo.Description to the resolved top-level runtime.mcp.description value in BuildOpenApiDocument.
Do not introduce a separate runtime.rest.openapi-description property. Using the existing MCP description avoids duplicate configuration and provides one consistent description for the server across MCP and OpenAPI.
- 主要语言
- C#
- 星标
- 1.5k
- 派生
- 372
- 平均合并
- 9 天 2 小时
- 30 天内合并 PR
- 10
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Azure/data-api-builder 的其他 Issue
-
pgsql
难度 2/5 1-3 小时 新手友好度 68/100
Azure/data-api-builder#3598 ·
维护者通常 1 天内回复
-
2.x cli mcp-server
难度 2/5 1-3 小时 新手友好度 68/100
Azure/data-api-builder#3576 ·
维护者通常 1 天内回复
-
2.x health-endpoint
难度 2/5 1-3 小时 新手友好度 68/100
Azure/data-api-builder#3570 ·
维护者通常 1 天内回复
-
2.x telemetry
难度 2/5 1-3 小时 新手友好度 68/100
Azure/data-api-builder#3564 ·
维护者通常 1 天内回复
-
2.x telemetry
难度 2/5 1-3 小时 新手友好度 70/100
Azure/data-api-builder#3562 ·
维护者通常 1 天内回复
查看 Azure/data-api-builder 的全部 Issue
相似的 Issue
-
area-System.Numerics.Tensors untriaged
难度 2/5 1-3 小时 新手友好度 78/100
dotnet/runtime#134691 · 2 条评论 ·
维护者通常 1 天内回复
-
ci-failure-cause test-failure
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 78/100
AvaloniaUI/Avalonia#22312 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 68/100