Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
#3,702 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

@souvikghosh04 đang làm issue này rồi.

Từ ngày 7/7/2026.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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.

Ngôn ngữ chính
C#
Star
1.5k
Fork
372
Merge trung bình
9 ngày 1 giờ
Pull request đã merge (30 ngày)
13

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/data-api-builder

Tất cả issue của Azure/data-api-builder

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.