İçeriğe geç
AggregaAggrega
Dil seçin: Türkçe
Bu sayfa makine çevirisiyle çevrilmiştir. İngilizce orijinalini okuyun.

Aggrega Wasm FeatureRecipe-Pipeline Step Socket şeması

Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.

Şema kimliği: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

Bir feature-recipe-pipeline adım plugin soketinin tükettiği (FRPStepInput) ve ürettiği (FRPStepOutput) aktarım biçimleri. Bir FRP adımı, bir Recipe ya da FeatureRecipe içinde bildirilen her satır içi pipeline girdisi için çalışır: ana makine, anahtarlı belge kümesini adıma bütün olarak verir, adım hedeflediği belgeleri içeriklerine göre seçer ve yan etkiler ile tanılamaların yanı sıra anahtarla adreslenen RFC 6902 yamaları döndürür. Bu, tüm topoloji grafiği üzerinde bir kez çalışan ve opak etiket yamaları döndüren label-transform rolünden ayrı bir konuk sözleşmesidir. Go, Rust ve TypeScript yük türleri bu şemadan plugin-ABI paketlerine üretilir; böylece üç dil tek bir aktarım biçimini okur ve yazar; bir konuk bunları bu paketlerden ya da kit bunları yeniden dışa aktarıyorsa eklenti kiti üzerinden içe aktarır.

Aşağıdaki biçimlerden biri

  • FRPStepInput
  • FRPStepOutput

Tanımlar

FRPStepInput

Bir feature-recipe-pipeline konuğunun bir işlem hattı adımı için aldığı yük: ana makinenin bütün olarak verdiği anahtarlı belge kümesi, Recipe’in bu adım için bildirdiği adıma özgü girdi, işleme zamanı bağlamı, adımın işlem hattındaki konumu ve daha önce çalışmış adımların kaydı.

ÖzellikTürZorunluAçıklama
documentsDocumentSetevetBir işlem hattı konuğunun girdi yüzeyi olarak aldığı, anahtarlı ve kapsam köklü adreslenebilir birimler kümesi. Ana makine kümenin tamamını verir ve içeriğini yorumlamaz; konuk hedeflediği belgeleri içeriğe göre seçer ve yamalarını anahtara göre adresler.
step_inputobjecthayırAdımın işlenmiş with bloğu; konuğun adıma özgü girdisi olarak okuduğu, yazar sıralı bir anahtar kümesi. Yazar sırasını korur; böylece aynı girdiyle yapılan çalıştırmalarda yük bayt düzeyinde aynı olur.
contextobjectevetAna makinenin adıma verdiği, JSON belgesinin baytları olarak taşınan render zamanı bağlamı; bu şema nesneyi bildirmeden bırakır ve ana makine ondan hiçbir şeyi geri okumaz. Bir Recipe’in ya da bileşen kapsamlı bir FeatureRecipe’in adımı şunları alır: parameters, yani ada göre sıralanmış Release parametre değerleri, hiç yoksa bulunmaz; annotations, yani düğümün ek açıklamaları, her birinin yazıldığı yere göre aggregate, release ve catalog olarak ayrılmış, boş olduğunda her biri bulunmaz; ve boundary, yani düğümün içinde bulunduğu sınır: name, path (kesimleri), sync_wave (0 olduğunda bulunmaz), directory, sub_directory (yoksa bulunmaz) ve annotations (Release’in sınırlarının düğüme kademeli olarak aktardığı küme; kendi Release girdisininki en son katmanlanır; boşsa bulunmaz). Ana makine bileşeni olmayan sınır kapsamlı bir FeatureRecipe’in adımı şunları alır: parameters; yalnızca release kovasını, yani sınırın kendi ek açıklama kümesini taşıyan annotations; ve name, path ile aynı kümeyi annotations olarak taşıyan bir boundary. Aynı FeatureRecipe’in provider render’ı aynı bağlamı alır. Girinti genişliği yaml_indent bir adım için ayarlanmaz.
step_indexintegerevetBu adımın işlem hattındaki sıfır tabanlı konumu.
preceding_stepsPrecedingStep[]hayırBu adımdan önce çalışan işlem hattı adımları; böylece bir konuk kendisinden önce gelenleri inceleyebilir.

Ek özelliklere izin verilmez.

FRPStepOutput

Bir feature-recipe-pipeline konuğunun bir işlem hattı adımı için döndürdüğü yük: ana makinenin anahtarlı belge kümesine uyguladığı RFC 6902 yamaları, bu adımın ürettiği yan etkiler ve konuğun oluşturduğu tanılamalar.

ÖzellikTürZorunluAçıklama
patchesJSONPatchOp[]hayırAdımın anahtarlı kümedeki belgelere karşı ürettiği yapılandırılmış RFC 6902 işlemleri. Her biri hedef belgesini kapsam ve anahtarla adlandırır, ardından op, path ve value değerlerini açıkça belirtir. label-transform rolünün opak yama listesinden farklıdır: bir FRP adımının yamaları ana makine tarafından uygulanır ve başarısız bir adımda anlık görüntüden geri yüklenir; bu nedenle işlemler burada opak değil, açıktır.
side_effectsSideEffect[]hayırBu adımın mevcut bir belgeye yama yapmanın ötesinde ürettiği etkiler (örneğin bir CRD yayımlamak veya bir dosya yazmak).
diagnosticsDiagnostic[]hayırKonuğun oluşturduğu tanılamalar. Her öğe, ortak Wasm eklentisi tanılama biçimindedir.
outputsobjecthayırKonuğun bu adım için döndürdüğü adreslenebilir çıktılar; sonraki bir adımın veya bir şablonun okuması için adımın çıktılarını dolduran, yazar sıralı bir anahtar kümesi. Yazar sırasını korur; böylece aynı girdiyle yapılan çalıştırmalarda yük bayt düzeyinde aynı olur. Adım çıktı döndürmediğinde bulunmaz.
errorstringhayırKonuk çalıştığı hâlde işlemi tamamlayamadığında ayarlanan bir hata mesajı; başarı durumunda bulunmaz. Çıktının taşıdığı tanılamalardan farklıdır: tanılamalar yine de bir sonuç üreten bir çalıştırma sırasında bulunan sorunları bildirirken error, işlemin kendisinin tamamlanmadığını bildirir. Ana makine, mevcut bir error’u başarısız bir eklenti çağrısı olarak yansıtır.

Ek özelliklere izin verilmez.

DocumentSet

Bir işlem hattı konuğunun girdi yüzeyi olarak aldığı, anahtarlı ve kapsam köklü adreslenebilir birimler kümesi. Ana makine kümenin tamamını verir ve içeriğini yorumlamaz; konuk hedeflediği belgeleri içeriğe göre seçer ve yamalarını anahtara göre adresler.

ÖzellikTürZorunluAçıklama
ownUnit eşlemievetDüğümün kendi işlenmiş çıktısı; birim belirtecine göre anahtarlanır. Anahtar sırasını korur; böylece küme iletime kararlı bir sırayla ulaşır ve aynı girdiyle yapılan çalıştırmalarda yük bayt düzeyinde aynı olur.
hostUnit eşlemihayırBileşen kapsamlı bir FeatureRecipe’in bağlı olduğu bileşenin işlenmiş çıktısı — varlıklar arası yüzey. Ana bileşeni olmayan Recipe adımlarında ve sınır kapsamlı FeatureRecipe adımlarında bulunmaz. Anahtar sırasını korur; böylece küme iletime kararlı bir sırayla ulaşır ve aynı girdiyle yapılan çalıştırmalarda yük bayt düzeyinde aynı olur.

Ek özelliklere izin verilmez.

Unit

Bir sağlayıcının yaydığı çıktının bölündüğü adreslenebilir tek bir parça — bir çıktı parçasının hibrit görünümü. Yapılandırılmış bir birim bir ağaç (RFC 6902 ile adreslenebilir bir görünüm) taşır ve bir PATCH hedefidir; opak bir birim yalnızca medya türünü ve baytlarını taşır (ağaç yoktur) ve bir SELECT ve EMIT hedefidir, ancak PATCH hedefi değildir.

ÖzellikTürZorunluAçıklama
tokenstringevetCodec’in atadığı opak konumsal adres — tek belgeli bir dosya için yayılan dosya adı ya da bir dosya birden çok belge taşıdığında <filename>#<ordinal> (dosya sırası). Konuk bunu opak olarak ele alır: bir birimi içeriğe göre seçer ve belirteci ayrıştırmadan aynen geri yansıtır.
bytesstringhayırBirimin özgün baytları, yeniden birleştirme kaynağı. Yeniden birleştirme yapısı gereği bayta sadıktır: dokunulmamış baytlar buradan birebir yeniden birleştirilir. Her kit bunları kendi alan türünde taşır — bu tür bir bayt türü olduğunda ham olarak, adımın onları geri elde etmek için çözdüğü bir string olduğunda base64 kodlu olarak — ve üretilen kodlayıcı, alan ile iletimin baytları taşıdığı biçim arasında dönüşüm yapar.
media_typestringhayırBirimin içerik türü (örneğin hazır YAML codec’i için application/yaml); böylece konuk neye baktığını bilir.
treeherhangihayırCodec bir tane ürettiğinde birimin RFC 6902 ile adreslenebilir normalleştirilmiş görünümü; üretmediğinde bulunmaz. Ağacı olan bir birim yapılandırılmıştır (bir PATCH hedefi); ağacı olmayan bir birim opaktır. Belge ana makine için opaktır; ana makine baytları yorumlamadan aktarır, bu nedenle ağaç bu şema katmanında herhangi bir JSON değerini taşır.

Ek özelliklere izin verilmez.

JSONPatchOp

Bir FRP adımının anahtarlı kümedeki bir belgeye karşı ürettiği tek bir RFC 6902 JSON-Patch işlemi. Scope ve key hedef belgeyi adlandırır; op, path, value ve from, o belge içindeki bir konuma karşı işlemi taşır.

ÖzellikTürZorunluAçıklama
scopestring (enum)evetİşlemin hedeflediği belge kökü: own (düğümün kendi işlenmiş belgeleri) veya host (bileşen kapsamlı bir FeatureRecipe’in bağlı olduğu bileşenin belgeleri). İzin verilen değerler: "own", "host"
keystringevetAdlandırılan kök içindeki yayılan dosya adı anahtarı — konuğun çalışma zamanında içeriğe göre seçtiği belgeden öğrendiği anahtar.
opstringevetRFC 6902 işlemi: add, remove, replace, move, copy, test değerlerinden biri.
pathstringevetAdlandırılan belge içindeki hedef konuma işaret eden bir RFC 6901 JSON Pointer.
valueherhangihayıradd, replace ve test için işlenen; diğer durumlarda atlanır. Konuğun yazdığı, ana makinenin opak biçimde aktardığı rastgele bir JSON belge parçası; bu şema katmanında herhangi bir JSON değerini taşır.
fromstringhayırmove ve copy için kaynak işaretçisi; diğer durumlarda atlanır.

Ek özelliklere izin verilmez.

SideEffect

Bir feature-recipe-pipeline adımının mevcut bir belgeye yama yapmanın ötesinde ürettiği tek bir etki. Kind, emit_crd ya da emit_file’dır; şema bunu açık bir string olarak bırakır, böylece ABI kırılması olmadan yeni bir tür eklenebilir ve başka herhangi bir türde derleme durur. Kind emit_crd olduğunda crd CRD belgesini taşır ve file atlanır; kind emit_file olduğunda file yazılacak dosyayı taşır ve crd atlanır.

ÖzellikTürZorunluAçıklama
kindstringevetEtki türü: emit_crd ya da emit_file. Şema bu alanı açık bir string olarak bırakır, böylece ABI kırılması olmadan yeni bir tür eklenebilir; başka herhangi bir türde derleme, düğümü, yan etkiyi ve türü adlandırarak durur.
scopestring (enum)hayırYayımın katkıda bulunduğu belge kökü: own (düğümün kendi kümesi) veya host (bağlı ana bileşenin kümesi). Bulunmayan bir scope, uygulama zamanında own anlamına gelir. İzin verilen değerler: "own", "host"
crdherhangihayırKind emit_crd olduğunda adımın yaydığı CRD belgesi. Ana makine için opaktır; ana makine onu yorumlamadan aktarır; bu şema katmanında herhangi bir JSON değerini taşır.
fileSideEffectFilehayırBir emit_file yan etkisinin yazdığı dosya: hedef yol ve dosya içeriği.

Ek özelliklere izin verilmez.

SideEffectFile

Bir emit_file yan etkisinin yazdığı dosya: hedef yol ve dosya içeriği.

ÖzellikTürZorunluAçıklama
pathstringevetDosyanın yazıldığı hedef yol.
contentstringevetYazılacak dosya içeriği.

Ek özelliklere izin verilmez.

PrecedingStep

Geçerli adımdan önce çalışmış bir işlem hattı adımı; böylece konuk kendisinden önce neyin geldiğini inceleyebilir: adımın işlem hattındaki dizini, adlandırdığı eklenti ve o adımın ürettiği yan etkiler.

ÖzellikTürZorunluAçıklama
indexintegerevetÖnceki adımın işlem hattındaki sıfır tabanlı konumu.
plugin_uristringevetÖnceki işlem hattı girdisinin plugin alanında yazıldığı haliyle adlandırdığı eklenti.
side_effectsSideEffect[]hayırÖnceki adımın ürettiği yan etkiler.

Ek özelliklere izin verilmez.