Schemat Aggrega Catalog (SchemaLibrary)
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/schemalibrary-v1beta1.schema.json
Kolekcja wielokrotnego użytku definicji JSON Schema 2020-12, do których treść katalogu (Components, Features itp.) może odwoływać się przez $ref za pomocą referencji tożsamości opartej na samej nazwie
Wskazówki dotyczące tworzenia encji SchemaLibrary zawiera dokumentacja tworzenia SchemaLibrary; ta strona dokumentuje schemat strukturalny, który opisuje tamta dokumentacja.
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 “SchemaLibrary” | tak | Stała: "SchemaLibrary" |
metadata | object | tak | |
spec | object | tak | Treść encji SchemaLibrary. Pole spec.schemas jest wymagane i musi deklarować co najmniej jeden wpis; pole spec.templates jest opcjonalne i występuje tylko wtedy, gdy biblioteka używa sparametryzowanych helperów. |
Dodatkowe właściwości są niedozwolone.
schemalibrary.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 w ścisłym formacie Semantic Versioning (np. 1.0.0). Plik blokady danej encji Release przypina jedną wersję każdej biblioteki. 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-]+)*))?$. |
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.
schemalibrary.spec
Treść encji SchemaLibrary. Pole spec.schemas jest wymagane i musi deklarować co najmniej jeden wpis; pole spec.templates jest opcjonalne i występuje tylko wtedy, gdy biblioteka używa sparametryzowanych helperów.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
schemas | mapa object | tak | Nazwana mapa definicji schematów wielokrotnego użytku. Treść każdego wpisu jest walidowana przez kompilator formy kompaktowej w czasie parsowania; walidacja na poziomie koperty sprawdza jedynie strukturę opakowania. Klucze: identyfikator w notacji PascalCase — ^[A-Z][A-Za-z0-9]*$. Klucze wpisów pojawiają się w referencjach tożsamości opartych na samej nazwie (<Library>#/schemas/<name>); ograniczenie na poziomie koperty zapobiega rozprzestrzenianiu się w ekosystemie katalogów kluczy niezgodnych z PascalCase. Co najmniej 1 wpis. |
templates | mapa object | nie | Opcjonalna nazwana mapa sparametryzowanych helperów. Wpisy schematów odwołują się do szablonów po nazwie przez $instantiate:; wyłącznie dosłowne podstawianie wartości skalarnych — bez osadzonych szablonów Go, bez instrukcji warunkowych, bez pętli. Warstwa podstawiania w bibliotece jest celowo węższa niż pełna ewaluacja szablonów, aby tworzenie treści pozostawało w języku schematów zamiast wprowadzać osobną warstwę szablonów. Klucze: identyfikator w notacji PascalCase — ^[A-Z][A-Za-z0-9]*$. Ta sama dyscyplina na poziomie koperty co w przypadku kluczy wpisów schematów; do nazw szablonów odwołuje się przez $instantiate: w czasie instancjacji. |
Dodatkowe właściwości są niedozwolone.