Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Aggrega-Schema für den Katalog (SchemaLibrary)

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/schemalibrary-v1beta1.schema.json

Eine wiederverwendbare Sammlung von Definitionen in JSON Schema 2020-12, auf die Kataloginhalte (Components, Features usw.) über die Identitätsreferenz per bloßem Namen #/schemas/ per $ref verweisen können (die Version liefert das Lockfile pro Release; kein Registry-Host erscheint in der Referenz). Stufe 3 — optional für Kataloge, die Schemas Component-übergreifend wiederverwenden müssen.

Siehe die Authoring-Referenz zur SchemaLibrary für Anleitungen in Prosaform zum Verfassen von SchemaLibrary-Entitäten; diese Seite dokumentiert das strukturelle Schema, das diese Referenz beschreibt.

Typ der obersten Ebene: object

Eigenschaften

EigenschaftTypErforderlichBeschreibung
apiVersionconst “aggrega.ai/v1beta1”jaKonstante: "aggrega.ai/v1beta1"
kindconst “SchemaLibrary”jaKonstante: "SchemaLibrary"
metadataobjectja
specobjectjaDer Inhalt der SchemaLibrary. spec.schemas ist erforderlich und muss mindestens einen Eintrag deklarieren; spec.templates ist optional und nur vorhanden, wenn die Bibliothek parametrisierte Helper verwendet.

Zusätzliche Eigenschaften sind nicht zulässig.

schemalibrary.metadata

EigenschaftTypErforderlichBeschreibung
namestringjaPascalCase-Bezeichner der Bibliothek. Er ist der Name in der Identitätsreferenz per bloßem Namen #/schemas/; die Version liefert das Lockfile pro Release, und kein Registry-Host geht in die Referenz oder einen abgeleiteten Bezeichner ein. Muster: ^[A-Z][A-Za-z0-9]*$.
versionstringjaStrikte semantische Versionierung der Bibliothek (z. B. 1.0.0). Das Lockfile pro Release legt eine Version pro Bibliothek fest. Muster: ^(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-]+)*))?$.
descriptionstringneinEine knappe Zusammenfassung dessen, was die Bibliothek abdeckt.
labelsMap von stringneinVom Autor deklarierte Labels. Der Compiler ist inhaltsneutral und interpretiert Label-Werte nicht: Sie sind opake Metadaten, mitgeführt für alles, was die Bibliothek liest und darauf abgleichen will.
annotationsMap von stringneinVom Autor deklarierte Annotationen. Dieselbe Haltung opaker Metadaten wie bei Labels.

Zusätzliche Eigenschaften sind nicht zulässig.

schemalibrary.spec

Der Inhalt der SchemaLibrary. spec.schemas ist erforderlich und muss mindestens einen Eintrag deklarieren; spec.templates ist optional und nur vorhanden, wenn die Bibliothek parametrisierte Helper verwendet.

EigenschaftTypErforderlichBeschreibung
schemasMap von objectjaBenannte Map wiederverwendbarer Schemadefinitionen. Der Inhalt jedes Eintrags wird beim Parsen vom Compiler der Kompaktform validiert; die Validierung auf Ebene der Hülle prüft nur die strukturelle Umhüllung. Schlüssel: PascalCase-Bezeichner — ^[A-Z][A-Za-z0-9]*$. Eintragsschlüssel erscheinen in Identitätsreferenzen per bloßem Namen (<Library>#/schemas/<name>); die Einschränkung auf Ebene der Hülle verhindert, dass Schlüssel, die nicht PascalCase sind, sich durch das Katalog-Ökosystem verbreiten. Mindestens 1 Eintrag.
templatesMap von objectneinOptionale benannte Map parametrisierter Helper. Schemaeinträge referenzieren Templates über den Namen per $instantiate:; nur literale Ersetzung von Skalaren — keine eingebetteten Go-Templates, keine Bedingungen, keine Schleifen. Die Ersetzungsschicht der Bibliothek ist bewusst enger als eine vollständige Template-Auswertung, damit das Authoring in der Schemasprache bleibt, statt eine separate Templating-Oberfläche einzuführen. Schlüssel: PascalCase-Bezeichner — ^[A-Z][A-Za-z0-9]*$. Dieselbe Disziplin auf Ebene der Hülle wie bei den Schlüsseln der Schemaeinträge; Template-Namen werden zum Zeitpunkt der Instanziierung über $instantiate: referenziert.

Zusätzliche Eigenschaften sind nicht zulässig.