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

Aggrega-Schema für den Katalog (Feature)

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

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

Ein modulares operatives Feature, das sich dynamisch an Komponenten bindet.

Siehe die Authoring-Referenz zum Feature für Anleitungen in Prosaform zum Verfassen von Feature-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 “Feature”jaKonstante: "Feature"
metadataobjectja
specobjectjaDer Vertrag für Validierung, Zielauswahl und Interoperabilität eines Feature aus dem Katalog: die frei geformten Säulen (values, infra, provides), verfasst über schema, die Säulen mit fester Form (Abhängigkeits-Sockets in usesSchema, Anbindungs-Slots in featuresSchema), die Zielauswahl von Komponenten (appliesTo und appliesToAnyOf) und Steuerungen für die Interoperabilität.

Zusätzliche Eigenschaften sind nicht zulässig.

feature.metadata

EigenschaftTypErforderlichBeschreibung
namestringjaMindestens 1 Zeichen lang.
versionstringjaStrikte semantische Versionierung des Feature (z. B. 1.0.0). 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-]+)*))?$.
descriptionstringneinWas diese Entität ist und wofür sie gedacht ist, geschrieben für jemanden, der entscheidet, ob er sie verwendet. Beginnen Sie mit einem Satz, der die Sache benennt, und ergänzen Sie dann, was ein Leser braucht, um sie auszuwählen und richtig zu verwenden — was sie von dem Release erwartet, das sie bereitstellt, und alles Überraschende an ihrem Verhalten. Ein kurzer Absatz ist die übliche Länge.
maintainersobject[]neinListe der Maintainer, die für diese Entität verantwortlich sind.
licensestringneinSPDX-Bezeichner für die Lizenz der Software, die diese Entität beschreibt, etwa MIT oder AGPL-3.0. Er hält die Bedingungen dieser Software fest, nicht die Bedingungen dieser Datei.
repositorystringneinDie URL des Git-Repositorys, in dem die Quelldateien liegen.
homestringneinDie URL der Homepage, des Wikis oder der Dokumentation dieser Entität.
keywordsstring[]neinEine Liste beschreibender Schlüsselwörter für die Auffindbarkeit in der Benutzeroberfläche.
labelsobjectneinDuck-Typing-Labels für das Feature. Das reservierte Label ‘feature.aggrega.ai/kind’ mit dem Wert ‘secret’ kennzeichnet dieses als Zugangsdaten-Feature für den Autor und für die Werkzeuge, die es anzeigen. Ein Zugangsdaten-Feature und ein gewöhnliches Feature werden auf dieselbe Weise angebunden, unter derselben Anbindungsoberfläche; was eine Anbindung erzeugt, entscheidet das FeatureRecipe, auf das das Manifest ihren Typ abbildet, nicht das Label.
annotationsMap von stringneinUnveränderliche, intrinsische Merkmale des Feature, verfasst vom Plattformarchitekten in Domäne 2. Kaskadiert hinunter in den Bucket .context.annotations.catalog.

Zusätzliche Eigenschaften sind nicht zulässig.

feature.metadata.maintainers[]
EigenschaftTypErforderlichBeschreibung
namestringja
emailstringnein
urlstringnein

Zusätzliche Eigenschaften sind nicht zulässig.

feature.metadata.labels

Duck-Typing-Labels für das Feature. Das reservierte Label ‘feature.aggrega.ai/kind’ mit dem Wert ‘secret’ kennzeichnet dieses als Zugangsdaten-Feature für den Autor und für die Werkzeuge, die es anzeigen. Ein Zugangsdaten-Feature und ein gewöhnliches Feature werden auf dieselbe Weise angebunden, unter derselben Anbindungsoberfläche; was eine Anbindung erzeugt, entscheidet das FeatureRecipe, auf das das Manifest ihren Typ abbildet, nicht das Label.

EigenschaftTypErforderlichBeschreibung
feature.aggrega.ai/kindstring (enum)neinLabel für die Art des Feature. Der Wert ‘secret’ kennzeichnet dieses als Zugangsdaten-Feature. Zulässige Werte: "secret"

feature.spec

Der Vertrag für Validierung, Zielauswahl und Interoperabilität eines Feature aus dem Katalog: die frei geformten Säulen (values, infra, provides), verfasst über schema, die Säulen mit fester Form (Abhängigkeits-Sockets in usesSchema, Anbindungs-Slots in featuresSchema), die Zielauswahl von Komponenten (appliesTo und appliesToAnyOf) und Steuerungen für die Interoperabilität.

EigenschaftTypErforderlichBeschreibung
extendsstringneinReferenz auf ein Basis-Feature, von dem dieses Feature erbt. Sie benennt die Basis über deren metadata.name statt über die Registry-Koordinate, unter der das Feature veröffentlicht wird, und akzeptiert dieselben drei Versionsformen wie jede Katalogreferenz: bloß (core/queue) für die höchste verfügbare Version, exakt (core/queue:1.0.0) oder ein Caret-Bereich (core/queue:^1.0.0). Vererbt wird mehr als Metadaten: metadata.labels und metadata.annotations der Basis, ihre Selektoren appliesTo und appliesToAnyOf, ihr Block interoperability, ihr usesSchema und ihr featuresSchema werden alle nach unten zusammengeführt, und ihre Deklarationen in JSON Schema 2020-12 auf schema werden automatisch zusammengeführt. Der eigene Wert des Kindes gewinnt bei einem gemeinsamen Schlüssel, und Identitätsfelder werden nie vererbt.
featuresSchemaMap von objectneinDeklarative Definitionen von Anbindungs-Slots: die benannten Bindungspunkte, an denen dieses Feature erwartet, dass ein weiteres Feature angebunden wird. Ein Slot schränkt ein, welche Füllung ihn binden darf (selector) und wie das Material der Füllung zugestellt werden darf (inject); das eigene Feature der Füllung besitzt seinen Vertrag für values und infra. Das Deklarieren eines Slots schließt den Anbindungsblock nie — ein Autor kann ein Feature unter einem Namen anbinden, den kein Slot deklariert. Ein Slot ist ein Bindungspunkt, kein Abhängigkeits-Socket: usesSchema deklariert die separate Topologie-Oberfläche.
appliesTostringneinLabel-Selektor-String im Kubernetes-Stil, der Components auswählt. Durch Kommas getrennte Anforderungen müssen alle gelten (AND). Unterstützte Formen: key=value, key!=value, key in (v1, v2), key notin (v1, v2), bloßer Schlüssel (Label vorhanden), !key (Label nicht vorhanden). Beispiel: “tier in (critical, production), !legacy”. Ein leerer oder fehlender Selektor deklariert keine Einschränkung. Der Selektor wird jedes Mal gegen diese Formen gelesen, wenn eine Anbindung dieses Feature ausgewertet wird, und eine Anforderung außerhalb davon bricht den Build ab und nennt sie: eine leere Anforderung (ein führendes, abschließendes oder doppeltes Komma) oder ein Schlüssel, der Leerraum oder eines der Zeichen = ! ( ) und das Komma enthält — daher wird “!tier=frontend” abgelehnt, und tier!=frontend ist die Art, einen Wert auszuschließen. Ein Wert ist der Text nach seinem Operator, welche Zeichen er auch enthält. Das Muster dieses Felds lehnt nur einige wenige fehlerhafte Formen ab, bevor irgendeine Anbindung ausgewertet wird. Muster: ^(?:[^()]*[()][\s\S]*|[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?(?:,[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?)*)$.
appliesToAnyOfstring oder Map von string[]neinEine Liste von Selektoren; das Feature gilt, wenn IRGENDEIN Element passt (OR-Logik). Jedes Element ist entweder ein Label-Selektor-String (gleiche Grammatik wie appliesTo; Anforderungen innerhalb des Strings werden per AND verknüpft) oder eine flache Schlüssel-Wert-Map, in der jedes Paar passen muss (nur Gleichheit).
interoperabilityobjectneinErweiterte Steuerungen für Betriebssicherheit und Interoperabilität.
usesSchemaMap von objectneinDie Abhängigkeits-Sockets, die diese Entität deklariert, nach Socket-Namen geschlüsselt; jede durch einen Socket gezogene Verbindung wird gegen die Deklaration dieses Sockets geprüft — seinen Selektor und die Injektionsmechanismen, die er zulässt. Schlüssel: ein oder mehrere Buchstaben, Ziffern, Unterstriche oder Bindestriche. Ein Punkt ist nicht zulässig. Muster: ^[a-zA-Z0-9_-]+$.
schemaobjectneinInhalt im Format JSON Schema 2020-12, der die frei geformten Säulen abdeckt: values (die Domäne des Entwicklers — anwendungsbezogene Parameter, die der Entwickler pro Feature-Anbindung im Aggregate konfiguriert); infra (die Domäne des Betreibers — physische Dimensionierungsregler, die das Release liefert); und provides (nachgelagerte Kontextschlüssel, die dieses Feature Konsumenten über die Topologie-Pipe zur Verfügung stellt). Akzeptiert drei Authoring-Modi per Dispatch nach Inhaltsform: (1) Inline-Inhalt (eine YAML-Map mit Kompaktform, JSON Schema YAML oder gemischt); (2) Dateiersetzung über {$import: }, geschrieben an spec.schema, um den gesamten Vertrag aus einer Datei zu liefern, oder an einer einzelnen Säule, um nur diese Säule zu liefern, wobei ein relativer Pfad relativ zum Verzeichnis gelesen wird, das die Entität enthält, die ihn deklariert hat; (3) dokumentübergreifende Referenz über {$ref: #/schemas/} auf einen SchemaLibrary-Eintrag über die Identität per bloßem Namen (die Version liefert das Lockfile pro Release; kein Registry-Host erscheint in der Referenz). Die Begleitfelder usesSchema und featuresSchema decken die Säulen mit fester Form ab (Abhängigkeits-Sockets, Anbindungs-Slots); der Compiler setzt die drei zu dem einen Schema zusammen, gegen das eine Instanz validiert wird.
assertionsMap von stringneinFeldübergreifende Validierung zur Build-Zeit. Jeder Eintrag ist eine benannte Assertion: Der Schlüssel ist ein stabiler Regelbezeichner, der in Fehlermeldungen erscheint; der Wert ist ein Go-Template-String mit der Abbruchsemantik {{ fail "message" }}. Mehrere benannte Assertions pro Entität werden pro Instanz in der vom Autor deklarierten Reihenfolge ausgewertet; die erste fehlschlagende Assertion bricht den Build ab. Feature-Assertions werden nach der Auflösung und der statischen Analyse, vor dem Rendern ausgewertet und drücken architektonische Invarianten des Vertrags aus. Template-Kontext: .values / .infra / .uses / .features / .metadata. Der Auswerter verwendet missingkey=error: Referenzen auf nicht definierte Schlüssel brechen mit einer no-such-key-Diagnose ab. Da die bloße Referenz abbricht, bevor ein Fallback ausgeführt werden kann, liefert ein einfaches default auf dieser Oberfläche keinen Fallback für ein optionales Feld — sichern Sie die Referenz mit hasKey ab, oder verwenden Sie den Helfer optional, der die Anwesenheitsprüfung direkt durchführt. Auch das Lesen des Schlüssels über index liefert keinen: index bricht bei einem Map-Schlüssel ab, den die Map nicht enthält, und nennt den Schlüssel.

Zusätzliche Eigenschaften sind nicht zulässig.

feature.spec.interoperability

Erweiterte Steuerungen für Betriebssicherheit und Interoperabilität.

EigenschaftTypErforderlichBeschreibung
conflictsWithstring[]neinNamen der Features, zusammen mit denen dieses Feature eine Komponente nicht erreichen kann, jeweils so geschrieben, wie der Typ einer Anbindung ein Feature benennt. Der Build bricht vor dem Rendern ab, wenn eine Komponente am Ende dieses Feature und ein hier genanntes Feature trägt — ob jedes an der Komponente angebunden wurde, an einem Subsystem oder einer Boundary, die sie enthält, an einem Komponenteneintrag des Release oder durch annotationsgesteuerte Expansion. Eine Deklaration genügt: Für den Abbruch muss das andere Feature dieses nicht aufführen. Namen werden ohne jede Version verglichen, sodass ein Eintrag jede Version des Feature erfasst, das er benennt. Zwei Features, die an Geschwister-Boundaries angebunden sind, die keine Komponente gemeinsam haben, treffen nie aufeinander und führen nicht zum Abbruch.

Zusätzliche Eigenschaften sind nicht zulässig.