Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
#3,702 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@souvikghosh04 ci sta già lavorando.

Dal 7/7/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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.

Lingua principale
C#
Stelle
1.5k
Fork
372
Merge medio
9g 1h
PR unite (30g)
13

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Azure/data-api-builder

Tutte le issue di Azure/data-api-builder

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.