Aggrega Catalog (Component) şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/component-v1beta1.schema.json
Atomik bir yapı taşının soyut tanımı.
Component varlıklarının yazılmasına ilişkin açıklamalı rehberlik için Component yazma başvurusuna bakın; bu sayfa, o başvurunun açıkladığı yapısal şemayı belgeler.
Üst düzey tür: object
Özellikler
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | evet | Sabit: "aggrega.ai/v1beta1" |
kind | const “Component” | evet | Sabit: "Component" |
metadata | object | evet | |
spec | object | evet | Geliştiricinin opak values yükünü yöneten doğrulama ve şema tanımları. |
Ek özelliklere izin verilmez.
component.metadata
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | En az 1 karakter uzunluğunda. |
version | string | evet | Arayüzün katı Anlamsal Sürümlemesi (ör. 1.0.0). Desen: ^(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 | hayır | Bu varlığın ne olduğu ve ne işe yaradığı; onu kullanıp kullanmamaya karar veren biri için yazılır. Şeyi adlandıran bir cümleyle başlayın, ardından okurun onu seçmek ve doğru kullanmak için ihtiyaç duyduklarını ekleyin: onu dağıtan Release’ten ne beklediğini ve davranışında şaşırtıcı olan her şeyi. Olağan uzunluk kısa bir paragraftır. |
maintainers | object[] | hayır | Bu varlığın sahibi olan bakımcıların listesi. |
license | string | hayır | Bu varlığın tanımladığı yazılımın lisansı için MIT veya AGPL-3.0 gibi bir SPDX tanımlayıcısı. Bu dosyanın koşullarını değil, o yazılımın koşullarını kaydeder. |
repository | string | hayır | Kaynak dosyaların bulunduğu Git deposunun URL’si. |
home | string | hayır | Bu varlığın ana sayfasının, wiki’sinin veya belgelerinin URL’si. |
keywords | string[] | hayır | Kullanıcı arayüzünde keşfedilebilirlik için tanımlayıcı anahtar sözcüklerin listesi. |
labels | object | evet | Özellikleri bildirmek için duck-typing etiketleri. Ayrılmış ‘component.aggrega.ai/type’ anahtarını içermelidir. |
annotations | string eşlemi | hayır | Platform Mimarı tarafından Domain 2’de yazılan, değiştirilemez ve içsel bileşen özellikleri. .context.annotations.catalog kovasına doğru aşağı aktarılır. |
Ek özelliklere izin verilmez.
component.metadata.maintainers[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | |
email | string | hayır | |
url | string | hayır |
Ek özelliklere izin verilmez.
component.metadata.labels
Özellikleri bildirmek için duck-typing etiketleri. Ayrılmış ‘component.aggrega.ai/type’ anahtarını içermelidir.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
component.aggrega.ai/type | string (enum) | evet | Bu bileşenin ne tür bir şey olduğunu adlandıran ayrılmış eksen. Bu anahtarı ve kabul ettiği değerleri Aggrega tanımlar, dolayısıyla küme kapalıdır; bileşenleri kendi eksenlerinize göre sınıflandırmak için bunun yanına kendi etiket anahtarınızı ekleyin. İzin verilen değerler: "server", "worker", "task", "function", "stateful-server", "resource" |
component.spec
Geliştiricinin opak values yükünü yöneten doğrulama ve şema tanımları.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
extends | string | hayır | Bu Component’in genişlettiği temel Component’in URI’si. Genişletme yapıyı birleştirir: temelin metadata etiketleri ve ek açıklamaları, ek yuvaları (featuresSchema), kendi kendine enjeksiyon izin listesi (inject) ve topoloji soketleri (usesSchema) devralınır; bu Component bunlara ekleme yapabilir veya devralınan bir girdiyi anahtar anahtar değiştirebilir. Temelin veri sütunları birleştirilMEZ: temelin schema bloğu tam olarak temelin yazdığı gibi devralınır, bu nedenle genişleten bir Component schema: inherited yazar ve kendine ait hiçbir sütun içeriği yazmaz. |
featuresSchema | object eşlemi | hayır | Bildirimsel ek yuvası tanımları: bu varlığın bir Feature eklenmesini beklediği adlandırılmış bağlama noktaları. Bir yuva, onu hangi dolgunun bağlayabileceğini (selector) ve dolgunun malzemesinin nasıl iletilebileceğini (inject) kısıtlar; values ve infra sözleşmesinin sahibi dolgunun kendi Feature’ıdır. Bir yuva bildirmek ek bloğunu asla kapatmaz: bir yazar, hiçbir yuvanın bildirmediği bir ad altında Feature ekleyebilir; böylece tek bir varlık hem yuvayla doldurulan bir eke hem de daha geniş bir kapsamda paylaşılan bir kimlik bilgisine hizmet eder. Yuva bir bağlama noktasıdır, bağımlılık soketi değildir: ayrı topoloji yüzeyini usesSchema bildirir. |
inject | string[] | hayır | İzin listesine alınmış kendi kendine enjeksiyon iletim mekanizmaları (ör. [‘env’, ‘file’, ‘arg’]). Mevcut olduğunda geliştiriciler, kendi values veya provides anahtarlarını doğrudan iletim borusuna enjekte etmek için Aggregate içinde bileşen düzeyinde inject: bloğunu kullanabilir. Belirtilmezse bileşen düzeyinde kendi kendine enjeksiyon yasaktır (Kara Kutu deseni: tüm iç bağlantıları Recipe üstlenir). usesSchema[].inject ile aynı anlambilime sahiptir, ancak bileşenler arası topoloji yerine bileşenin kendi values değerlerini yönetir. all dışında herhangi bir mekanizma adı listelenebilir; all adını hiçbir inject bloğu kullanamaz. |
usesSchema | object eşlemi | hayır | Bu varlığın bildirdiği, soket adıyla anahtarlanan bağımlılık soketleri; bir soket üzerinden kurulan her bağlantı o soketin bildirimine — seçicisine, izin verdiği inject mekanizmalarına ve bağlantı başına sözleşmelerine — göre denetlenir. Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi veya kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
schema | herhangi | hayır | Serbest biçimli sütunları kapsayan JSON Schema 2020-12 içeriği: values (Geliştiricinin alanı: Geliştiricinin Aggregate içinde her Component örneği için yapılandırdığı uygulama biçimli parametreler); infra (Operatörün alanı: Release tarafından sağlanan fiziksel boyutlandırma ayarları); ve provides (bu Component’in topoloji borusu aracılığıyla tüketicilere sunduğu aşağı akış bağlam anahtarları). İçerik biçimine göre dağıtım yoluyla dört yazım kipini kabul eder: (1) satır içi içerik (kompakt biçim, JSON Schema YAML’ı veya karışık içerik taşıyan bir YAML eşlemi); (2) {$import: |
assertions | string eşlemi | hayır | Derleme zamanında alanlar arası doğrulama. Her girdi adlandırılmış bir onaylamadır: anahtar, hata iletilerinde gösterilen kararlı bir kural tanımlayıcısıdır; değer, {{ fail "message" }} durdurma anlambilimine sahip bir Go şablon dizesidir. Varlık başına birden çok adlandırılmış onaylama, örnek başına yazarın bildirdiği sırayla değerlendirilir; başarısız olan ilk onaylama derlemeyi durdurur. Component onaylamaları çözümleme ve statik analizden sonra, işlemeden önce değerlendirilir ve hangi Recipe bağlanırsa bağlansın geçerli olan sözleşmenin mimari değişmezlerini ifade eder. Şablon bağlamı: .values / .infra / .uses / .features / .metadata. Değerlendirici missingkey=error kullanır: tanımsız anahtarlara yapılan başvurular bir no-such-key tanılamasıyla durur. Çıplak başvuru herhangi bir geri dönüş çalışamadan durduğu için bu yüzeyde düz bir default isteğe bağlı alan geri dönüşü sağlamaz; başvuruyu hasKey ile koşula bağlayın veya varlık denetimini doğrudan yapan optional yardımcısını kullanın. Anahtarı index ile okumak da bunu sağlamaz: index, eşlemin içermediği bir eşlem anahtarında anahtarı adlandırarak durur. Kalıtım eklemelidir: extends bildiren bir Component, kendi onaylamalarının yanı sıra devraldığı onaylamalara karşı da değerlendirilir, önce devralınan kurallar gelir; her derinlikteki bir zincir, zincir kökünden aşağı doğru birikir; bu nedenle birden fazla kural başarısız olacaksa, zincirde en yukarıda bildirilen kural bildirilir. Devralınan bir adı farklı bir kural bildirmek için yeniden kullanmak, extends zinciri katalogla çözümlendiğinde her iki Component’i ve paylaşılan adı belirterek reddedilir; yani bu durum yalnızca genişleten belgeden değil, temel Component mevcut olduğunda ortaya çıkar; genişleten bir Component kural ekler ve hiçbir kuralı değiştirmez. Devralınan bir kuralı kendi adı altında bayt bayt aynen yeniden belirtmek, olduğu gibi etkisiz bir işlem olarak kabul edilir. İki kuralın birlikte sağlanıp sağlanamayacağını hiçbir şey denetlemez: karşılıklı olarak sağlanamayan bir çift, bir örnek önce hangisi tetiklenirse ona takıldığında sıradan bir onaylama hatası olarak ortaya çıkan bir yazım hatasıdır; asla önceden bir uyarı olarak çıkmaz. |
Ek özelliklere izin verilmez.
Tanımlar
extending-component-must-declare-schema-inherited
spec.extends mevcut olduğunda uygulanır. Genişleten bir Component, tabanının values / infra / provides içeriğini tabanın yazdığı haliyle tam olarak alır; bu nedenle spec.schema: inherited bildirir ve kendi sütun içeriğini yazmaz. Diğer iki sonuç da hatadır ve bunlar farklı hatalardır: spec.schema’yı tamamen atlamak, okuyucunun devralınmış bir sütun bloğunu unutulmuş bir bloktan ayırt edememesine yol açar; spec.schema altında sütun içeriği yazmak ise sözleşmesi tabanının sözleşmesi olan bir Component üzerinde ikinci, farklılaşan bir sözleşme istemek anlamına gelir.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
schema | const “inherited” | evet | Kalıtım işaretçisi; extends bildiren bir Component üzerinde spec.schema’nın alabileceği tek değer. Sütunların nereden geldiğini belirtir; sütun içeriğinin kendisi taban Component’e aittir. Sabit: "inherited" |
non-extending-component-authors-its-own-schema
spec.extends bulunmadığında uygulanır. Hiçbir tabanı genişletmeyen bir Component, kendi values / infra / provides içeriğini spec.schema altında yazar; bu nedenle alan, inherited işaretçisi yerine yazılmış içerik taşır: işaretçi sütunların bir tabandan geldiğini belirtir ve bu Component’in tabanı yoktur.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
schema | object | hayır | Yazılmış sütun içeriği — spec.schema’nın belgelediği üç içerik yazma modundan herhangi biriyle yazılmış bir eşleme. |