Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[Enh]: The `info.description` field in the OpenAPI output is never populated.

オープン
#3,702 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@souvikghosh04 がすでに取り組んでいます。

2026年7月7日 から。

評価

この issue はまだ評価されていません。

説明

cri open-api

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/data-api-builder のほかの issue

Azure/data-api-builder の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。