Azure / Azure/data-api-builder

[Enh]: For auto-config entities support `@file()`

Ouverte
#3,277 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
2.x auto-config
Langage dominant
C#
Étoiles
1.5k
Forks
372
Merge moyen
3 j 22 h
PR mergées (30 j)
9

Description

## What

Allow `autoentities.template` to reference external metadata files using the new `@file()` syntax.

This enhancement allows auto-generated entities to inherit descriptions or other metadata from configuration-managed metadata files.

This enhancement depends on the following:

* #2794
* #2863

## New properties

This uses the new `@file()` syntax but behaves differently from normal configuration replacements. Because internal macros such as `{schema}`, `{object}`, `{column}`, and `{parameter}` are resolved dynamically within the auto-entity generation loop, these replacements cannot occur during configuration load. Instead, they must be evaluated **after** auto-generated entities have been expanded.

```json
{
"template": {
"description": "@file('{schema}.{object}.MS_Description')", // table-level
"source": {
"parameters": {
"description": "@file('{schema}.{object}.@{parameter}.MS_Description')" // parameter-level
}
},
"fields": {
"description": "@file('{schema}.{object}.{column}.MS_Description')" // column-level
}
}
}
```

In this case the metadata keys correspond to entries in the metadata files configured through `metadata-files`.

Example metadata file:

```json
{
"dbo.Author.MS_Description": "Author records in the system",
"dbo.Author.Id.MS_Description": "Primary key of the author",
"dbo.GetCustomer.@CustomerId.MS_Description": "Identifier of the requested customer"
}
```

During auto-entity generation, the template macros are expanded first and the resulting keys are resolved using `@file()` against the merged metadata dictionary.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par suivre la manière dont autoentities.template est développé et dont les metadata-files sont fusionnés. Vérifiez que les macros de modèle sont développées lors de la génération des auto-entities avant que les clés résultantes soient résolues via @file() ; c’est terminé lorsque les valeurs de métadonnées au niveau de la table, du paramètre et de la colonne sont héritées du dictionnaire de métadonnées fusionné.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp
Domaine
api, backend
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

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