Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Schéma du catalogue d’Aggrega (SchemaLibrary)

Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.

Identifiant du schéma : https://aggrega.ai/schemas/schemalibrary-v1beta1.schema.json

Une collection réutilisable de définitions JSON Schema 2020-12 vers lesquelles le contenu du catalogue (Components, Features, etc.) peut faire un $ref via la référence d’identité par nom nu #/schemas/ (la version est fournie par le fichier de verrouillage propre à chaque Release ; aucun hôte de registre n’apparaît dans la référence). Niveau 3 — facultatif, pour les catalogues qui ont besoin de réutiliser des schémas d’un Component à l’autre.

Consultez la référence de rédaction de la SchemaLibrary pour des conseils rédigés sur l’écriture des entités SchemaLibrary ; cette page documente le schéma structurel que décrit cette référence.

Type de premier niveau : object

Propriétés

PropriétéTypeObligatoireDescription
apiVersionconst “aggrega.ai/v1beta1”ouiConstante : "aggrega.ai/v1beta1"
kindconst “SchemaLibrary”ouiConstante : "SchemaLibrary"
metadataobjectoui
specobjectouiLe contenu de la SchemaLibrary. spec.schemas est obligatoire et doit déclarer au moins une entrée ; spec.templates est facultatif et n’est présent que lorsque la bibliothèque utilise des helpers paramétrés.

Les propriétés supplémentaires ne sont pas autorisées.

schemalibrary.metadata

PropriétéTypeObligatoireDescription
namestringouiIdentifiant PascalCase de la bibliothèque. C’est le nom dans la référence d’identité par nom nu #/schemas/ ; la version est fournie par le fichier de verrouillage propre à chaque Release et aucun hôte de registre n’entre dans la référence ni dans aucun identifiant dérivé. Motif : ^[A-Z][A-Za-z0-9]*$.
versionstringouiVersionnage sémantique strict de la bibliothèque (par ex. 1.0.0). Le fichier de verrouillage propre à chaque Release épingle une version par bibliothèque. Motif : ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
descriptionstringnonUn résumé concis de ce que couvre la bibliothèque.
labelsmap de stringnonLabels déclarés par l’auteur. Le compilateur est neutre vis-à-vis du contenu et n’interprète pas les valeurs des labels : ce sont des métadonnées opaques, transmises pour que tout ce qui lit la bibliothèque puisse s’en servir pour la correspondance.
annotationsmap de stringnonAnnotations déclarées par l’auteur. Même posture de métadonnées opaques que les labels.

Les propriétés supplémentaires ne sont pas autorisées.

schemalibrary.spec

Le contenu de la SchemaLibrary. spec.schemas est obligatoire et doit déclarer au moins une entrée ; spec.templates est facultatif et n’est présent que lorsque la bibliothèque utilise des helpers paramétrés.

PropriétéTypeObligatoireDescription
schemasmap de objectouiMap nommée de définitions de schéma réutilisables. Le contenu de chaque entrée est validé par le compilateur de la forme compacte au moment de l’analyse ; la validation au niveau de l’enveloppe ne vérifie que l’encapsulation structurelle. Clés : identifiant PascalCase — ^[A-Z][A-Za-z0-9]*$. Les clés des entrées apparaissent dans les références d’identité par nom nu (<Library>#/schemas/<name>) ; la contrainte au niveau de l’enveloppe empêche les clés non PascalCase de se propager dans l’écosystème du catalogue. Au moins 1 entrée.
templatesmap de objectnonMap nommée facultative de helpers paramétrés. Les entrées de schéma référencent des templates par leur nom via $instantiate: ; substitution littérale de scalaires uniquement — pas de templates Go intégrés, pas de conditions, pas de boucles. La couche de substitution de la bibliothèque est volontairement plus étroite qu’une évaluation complète de templates, afin que la rédaction reste dans le langage de schéma au lieu d’introduire une surface de templating distincte. Clés : identifiant PascalCase — ^[A-Z][A-Za-z0-9]*$. Même discipline au niveau de l’enveloppe que pour les clés des entrées de schéma ; les noms de templates sont référencés via $instantiate: au moment de l’instanciation.

Les propriétés supplémentaires ne sont pas autorisées.