Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

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śćTypWymaganaOpis
apiVersionconst “aggrega.ai/v1beta1”takStała: "aggrega.ai/v1beta1"
kindconst “MappingLibrary”takStała: "MappingLibrary"
metadataobjecttak
specobjecttakZawartość 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śćTypWymaganaOpis
namestringtakIdentyfikator biblioteki w notacji PascalCase. Jest to nazwa w referencji tożsamości przez samą nazwę #/mappings/; wersję dostarcza plik blokady danej encji Release, a żaden host rejestru nie wchodzi do referencji ani do żadnego pochodnego identyfikatora. Wzorzec: ^[A-Z][A-Za-z0-9]*$.
versionstringtakWersja 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ę (:#/mappings/); rozstrzygniętą wersją zarządza plik blokady danej encji Release. Wzorzec: ^(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-]+)*))?$.
descriptionstringnieZwięzłe podsumowanie zakresu biblioteki.
labelsmapa stringnieEtykiety 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ć.
annotationsmapa stringnieAdnotacje 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śćTypWymaganaOpis
mappingsmapa stringtakNazwana 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.