Azure / Azure/data-api-builder

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

Ouverte
#3,702 0 commentaires 0 réactions 1 personne assignée Réclamée par @souvikghosh04 Voir sur GitHub
cri open-api
Langage dominant
C#
Étoiles
1.5k
Forks
370
Merge moyen
3 j 22 h
PR mergées (30 j)
9

Description

## 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

```json
{
"runtime": {
"mcp": {
"description": "This server provides access to the company database."
}
}
}
```

### Expected OpenAPI output

```json
{
"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

```json
{
"data-source-files": [
"sales.json",
"inventory.json"
],
"runtime": {
"mcp": {
"description": "This server provides access to company sales and inventory data."
}
}
}
```

### Expected OpenAPI output

```json
{
"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.
****

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.