[Enh]: The `info.description` field in the OpenAPI output is never populated.
@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日 1時間
- マージ済み PR(30日)
- 13
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Azure/data-api-builder のほかの issue
-
pgsql
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Azure/data-api-builder#3598 ·
-
2.x cli mcp-server
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Azure/data-api-builder#3576 ·
-
2.x health-endpoint
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Azure/data-api-builder#3570 ·
-
2.x telemetry
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Azure/data-api-builder#3564 ·
-
2.x telemetry
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Azure/data-api-builder#3562 ·
Azure/data-api-builder の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
bug needs response
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Adyen/adyen-dotnet-api-library#1869 ·
-
Status: Needs Triage Type: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
bug effort:S P3
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
nightscout/nocturne#1602 ·