Schemat katalogu Aggrega (MappingLibrary)
Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.
Identyfikator schematu: https://aggrega.ai/schemas/mappinglibrary-v1beta1.schema.json
Kolekcja fragmentów szablonów Go wielokrotnego użytku, z których encje Recipes i FeatureRecipes korzystają w czasie renderowania za pomocą valuesMapping: { $import: ... }. Poziom 3 — opcjonalny, dla katalogów, które potrzebują ponownego użycia mapowań między encjami Recipe. Jeden tryb tworzenia: wyłącznie szablony Go.
Opisowe wskazówki dotyczące tworzenia encji MappingLibrary zawiera dokumentacja tworzenia encji MappingLibrary; ta strona dokumentuje schemat strukturalny, który ta dokumentacja opisuje.
Typ najwyższego poziomu: object
Właściwości
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | tak | Stała: "aggrega.ai/v1beta1" |
kind | const “MappingLibrary” | tak | Stała: "MappingLibrary" |
metadata | object | tak | |
spec | object | tak | Zawartość encji MappingLibrary. spec.mappings jest wymagane i musi deklarować co najmniej jeden wpis. spec ma additionalProperties: false — na poziomie koperty nie są akceptowane równoległe tryby tworzenia. Jeden tryb tworzenia zapewnia jednolite renderowanie encji Recipe (wszędzie szablony Go) i sprawia, że autorzy nie muszą zmieniać modelu ewaluacji w trakcie renderowania, korzystając z importowanych fragmentów. |
Dodatkowe właściwości są niedozwolone.
mappinglibrary.metadata
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Identyfikator biblioteki w notacji PascalCase. Jest to nazwa ^[A-Z][A-Za-z0-9]*$. |
version | string | tak | Wersja biblioteki zgodna ze ścisłym Semantic Versioning (np. 1.0.0). Konsument może zadeklarować ją jako opcjonalny próg minimalnej wersji :<version> w referencji przez samą nazwę (^(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-]+)*))?$. |
description | string | nie | Zwięzłe podsumowanie zakresu biblioteki. |
labels | mapa string | nie | Etykiety deklarowane przez autora. Kompilator jest neutralny wobec treści i nie interpretuje wartości etykiet: są to nieprzezroczyste metadane, przenoszone po to, by cokolwiek odczytuje bibliotekę, mogło według nich dopasowywać. |
annotations | mapa string | nie | Adnotacje deklarowane przez autora. Takie samo podejście nieprzezroczystych metadanych jak w przypadku etykiet. |
Dodatkowe właściwości są niedozwolone.
mappinglibrary.spec
Zawartość encji MappingLibrary. spec.mappings jest wymagane i musi deklarować co najmniej jeden wpis. spec ma additionalProperties: false — na poziomie koperty nie są akceptowane równoległe tryby tworzenia. Jeden tryb tworzenia zapewnia jednolite renderowanie encji Recipe (wszędzie szablony Go) i sprawia, że autorzy nie muszą zmieniać modelu ewaluacji w trakcie renderowania, korzystając z importowanych fragmentów.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
mappings | mapa string | tak | Nazwana mapa fragmentów szablonów Go wielokrotnego użytku. Treść każdego wpisu jest nieprzezroczysta dla walidacji koperty — semantyką zawartości zajmuje się parser szablonów Go w czasie użycia. Klucze: identyfikator w notacji PascalCase. Klucze wpisów występują w kanonicznych adresach URL referencji (#/mappings/<name>); ograniczenie na poziomie koperty zapobiega rozprzestrzenianiu się kluczy niezgodnych z PascalCase w ekosystemie katalogów. Wzorzec: ^[A-Z][A-Za-z0-9]*$. Co najmniej 1 wpis. |
Dodatkowe właściwości są niedozwolone.