Schemat gniazda kroku potoku FeatureRecipe Aggrega Wasm
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/wasm-frp-step-v1beta1.schema.json
Kształty komunikacji, które gniazdo pluginu kroku potoku feature-recipe przyjmuje (FRPStepInput) i emituje (FRPStepOutput). Krok FRP jest uruchamiany dla każdego wpisu potoku inline zadeklarowanego w encji Recipe lub FeatureRecipe: host przekazuje krokowi cały zbiór dokumentów z kluczami, krok wybiera dokumenty, których dotyczy, na podstawie ich treści, i zwraca adresowane kluczami poprawki RFC 6902 wraz z efektami ubocznymi i komunikatami diagnostycznymi. Jest to kontrakt gościa odrębny od roli label-transform, która jest uruchamiana raz na całym grafie topologii i zwraca nieprzejrzyste poprawki etykiet. Typy ładunków dla Go, Rust i TypeScript są generowane z tego schematu do pakietów plugin-ABI, więc trzy języki odczytują i zapisują jeden format komunikacji; gość importuje je z tych pakietów albo przez swój zestaw narzędzi dla pluginów, jeśli zestaw je reeksportuje.
Jeden z następujących kształtów
FRPStepInputFRPStepOutput
Definicje
FRPStepInput
Ładunek, który gość potoku feature-recipe-pipeline otrzymuje dla jednego kroku potoku: kluczowany zbiór dokumentów przekazywany przez hosta w całości, lokalne dane wejściowe kroku zadeklarowane przez encję Recipe dla tego kroku, kontekst czasu renderowania, pozycja kroku w potoku oraz zapis kroków, które zostały już wykonane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
documents | DocumentSet | tak | Kluczowany, zakorzeniony w zakresie zbiór adresowalnych jednostek, który gość potoku otrzymuje jako swoją powierzchnię wejściową. Host przekazuje cały zbiór i nie interpretuje jego treści; gość wybiera docelowe dokumenty według treści i adresuje swoje poprawki według klucza. |
step_input | object | nie | Wyrenderowany blok with kroku, zbiór kluczy w kolejności nadanej przez autora, który gość odczytuje jako lokalne dane wejściowe kroku. Zachowuje kolejność autora, dzięki czemu ładunek jest identyczny bajt w bajt między przebiegami dla identycznych danych wejściowych. |
context | object | tak | Kontekst czasu renderowania, który host przekazuje krokowi, przenoszony jako bajty jego dokumentu JSON; ten schemat nie deklaruje tego obiektu, a host niczego z niego z powrotem nie odczytuje. Krok encji Recipe lub FeatureRecipe o zakresie komponentu otrzymuje parameters — wartości parametrów encji Release posortowane według nazwy, nieobecne, gdy ich nie ma; annotations — adnotacje węzła podzielone według miejsca zapisu na aggregate, release i catalog, każda nieobecna, gdy jest pusta; oraz boundary — granicę, w której znajduje się węzeł: name, path (jej segmenty), sync_wave (nieobecne przy 0), directory, sub_directory (nieobecne, gdy go nie ma) i annotations (zbiór, który granice encji Release kaskadowo przekazują do węzła, z adnotacjami własnego wpisu Release nałożonymi na końcu; nieobecny, gdy jest pusty). Krok encji FeatureRecipe o zakresie granicy, która nie ma komponentu hosta, otrzymuje parameters; annotations zawierające wyłącznie kubeł release, czyli własny zbiór adnotacji granicy; oraz boundary zawierającą jej name, path i ten sam zbiór jako annotations. Renderowanie przez dostawcę tej samej encji FeatureRecipe otrzymuje ten sam kontekst. Szerokość wcięcia, yaml_indent, nie jest ustawiana dla kroku. |
step_index | integer | tak | Liczona od zera pozycja tego kroku w potoku. |
preceding_steps | PrecedingStep[] | nie | Kroki potoku wykonane przed tym krokiem, dzięki czemu gość może sprawdzić, co działo się przed nim. |
Dodatkowe właściwości są niedozwolone.
FRPStepOutput
Ładunek, który gość potoku feature-recipe-pipeline zwraca dla jednego kroku potoku: poprawki RFC 6902, które host stosuje do kluczowanego zbioru dokumentów, efekty uboczne wytworzone przez ten krok oraz wszelką diagnostykę zgłoszoną przez gościa.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
patches | JSONPatchOp[] | nie | Ustrukturyzowane operacje RFC 6902, które krok emituje względem dokumentów w kluczowanym zbiorze. Każda wskazuje dokument docelowy przez zakres i klucz, a następnie jawnie podaje operację, ścieżkę i wartość. Różni się od nieprzezroczystej listy poprawek roli label-transform: poprawki kroku FRP są stosowane przez hosta i przywracane z migawki w razie nieudanego kroku, dlatego operacje są tu jawne, a nie nieprzezroczyste. |
side_effects | SideEffect[] | nie | Efekty wytworzone przez ten krok poza poprawianiem istniejącego dokumentu (na przykład emisja CRD lub zapis pliku). |
diagnostics | Diagnostic[] | nie | Diagnostyka zgłoszona przez gościa. Każdy element ma wspólny kształt diagnostyki pluginów Wasm. |
outputs | object | nie | Adresowalne wyniki zwracane przez gościa dla tego kroku, zbiór kluczy w kolejności nadanej przez autora, który wypełnia wyniki kroku do odczytu przez późniejszy krok lub szablon. Zachowuje kolejność autora, dzięki czemu ładunek jest identyczny bajt w bajt między przebiegami dla identycznych danych wejściowych. Nieobecne, gdy krok nie zwraca wyników. |
error | string | nie | Komunikat o niepowodzeniu ustawiany, gdy gość został uruchomiony, ale nie mógł ukończyć operacji; nieobecny w razie powodzenia. Różni się od diagnostyki przenoszonej przez wynik: diagnostyka zgłasza problemy wykryte podczas przebiegu, który mimo to dał wynik, natomiast błąd zgłasza, że sama operacja nie została ukończona. Host traktuje obecny błąd jako nieudane wywołanie pluginu. |
Dodatkowe właściwości są niedozwolone.
DocumentSet
Kluczowany, zakorzeniony w zakresie zbiór adresowalnych jednostek, który gość potoku otrzymuje jako swoją powierzchnię wejściową. Host przekazuje cały zbiór i nie interpretuje jego treści; gość wybiera docelowe dokumenty według treści i adresuje swoje poprawki według klucza.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
own | mapa Unit | tak | Własny wyrenderowany wynik węzła, kluczowany tokenem jednostki. Zachowuje kolejność kluczy, dzięki czemu zbiór trafia do przesyłu w stabilnej kolejności, a ładunek jest identyczny bajt w bajt między przebiegami dla identycznych danych wejściowych. |
host | mapa Unit | nie | Wyrenderowany wynik komponentu, do którego dołączona jest encja FeatureRecipe o zakresie komponentu — powierzchnia międzyencyjna. Nieobecny dla kroków encji Recipe i kroków encji FeatureRecipe o zakresie granicy, które nie mają komponentu hosta. Zachowuje kolejność kluczy, dzięki czemu zbiór trafia do przesyłu w stabilnej kolejności, a ładunek jest identyczny bajt w bajt między przebiegami dla identycznych danych wejściowych. |
Dodatkowe właściwości są niedozwolone.
Unit
Jeden adresowalny fragment, na który dzieli się wyemitowany wynik dostawcy — hybrydowy widok jednego fragmentu wyniku. Jednostka ustrukturyzowana przenosi drzewo (widok adresowalny według RFC 6902) i jest celem PATCH; jednostka nieprzezroczysta przenosi tylko swój typ nośnika i bajty (bez drzewa) i jest celem SELECT i EMIT, ale nie celem PATCH.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
token | string | tak | Nieprzezroczysty adres pozycyjny nadawany przez kodek — wyemitowana nazwa pliku dla pliku z jednym dokumentem lub <filename>#<ordinal> (kolejność w pliku), gdy jeden plik zawiera kilka dokumentów. Gość traktuje go jako nieprzezroczysty: wybiera jednostkę według treści i odsyła token, nigdy go nie parsując. |
bytes | string | nie | Oryginalne bajty jednostki, źródło ponownego składania. Ponowne składanie jest z założenia wierne bajt w bajt: nietknięte bajty są ponownie łączone dosłownie z tego źródła. Każdy zestaw przenosi je we własnym typie pola — surowo, gdy ten typ jest typem bajtowym, lub zakodowane w base64, gdy jest to ciąg znaków, który krok dekoduje, aby je odzyskać — a wygenerowany koder konwertuje między polem a postacią, w jakiej bajty są przesyłane. |
media_type | string | nie | Typ zawartości jednostki (na przykład application/yaml dla standardowego kodeka YAML), dzięki czemu gość wie, z czym ma do czynienia. |
tree | any | nie | Znormalizowany widok jednostki adresowalny według RFC 6902, jeśli kodek go wytworzył, lub nieobecny, jeśli nie. Jednostka z drzewem jest ustrukturyzowana (cel PATCH); jednostka bez drzewa jest nieprzezroczysta. Dokument jest nieprzezroczysty dla hosta, który przekazuje bajty bez ich interpretowania, więc drzewo przenosi dowolną wartość JSON na tej warstwie schematu. |
Dodatkowe właściwości są niedozwolone.
JSONPatchOp
Jedna operacja JSON-Patch RFC 6902, którą krok FRP emituje względem jednego dokumentu w kluczowanym zbiorze. Zakres i klucz wskazują dokument docelowy; op, path, value i from opisują operację względem miejsca w tym dokumencie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
scope | string (enum) | tak | Korzeń dokumentów, którego dotyczy operacja: own (własne wyrenderowane dokumenty węzła) lub host (dokumenty komponentu, do którego dołączona jest encja FeatureRecipe o zakresie komponentu). Dozwolone wartości: "own", "host" |
key | string | tak | Klucz będący wyemitowaną nazwą pliku w obrębie wskazanego korzenia — klucz, który gość poznał w czasie wykonania z dokumentu wybranego według treści. |
op | string | tak | Operacja RFC 6902: jedna z add, remove, replace, move, copy, test. |
path | string | tak | Wskaźnik JSON Pointer RFC 6901 na miejsce docelowe we wskazanym dokumencie. |
value | any | nie | Operand dla add, replace i test, w pozostałych przypadkach pomijany. Dowolny fragment dokumentu JSON utworzony przez gościa, który host przekazuje nieprzezroczyście; przenosi dowolną wartość JSON na tej warstwie schematu. |
from | string | nie | Wskaźnik źródłowy dla move i copy, w pozostałych przypadkach pomijany. |
Dodatkowe właściwości są niedozwolone.
SideEffect
Jeden efekt, który krok potoku feature-recipe-pipeline wytwarza poza poprawianiem istniejącego dokumentu. Kind to emit_crd lub emit_file; schemat pozostawia go otwartym ciągiem znaków, aby można było dodać nowy rodzaj bez naruszenia ABI, a przy każdym innym rodzaju kompilacja zostaje zatrzymana. Gdy kind to emit_crd, crd przenosi dokument CRD, a file jest pomijane; gdy kind to emit_file, file przenosi plik do zapisania, a crd jest pomijane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Rodzaj efektu: emit_crd lub emit_file. Schemat pozostawia to pole otwartym ciągiem znaków, aby można było dodać nowy rodzaj bez naruszenia ABI; przy każdym innym rodzaju kompilacja zostaje zatrzymana ze wskazaniem węzła, efektu ubocznego i rodzaju. |
scope | string (enum) | nie | Korzeń dokumentów, do którego trafia emisja: own (własny zbiór węzła) lub host (zbiór dołączonego komponentu hosta). Brak scope oznacza own w chwili zastosowania. Dozwolone wartości: "own", "host" |
crd | any | nie | Dokument CRD emitowany przez krok, gdy kind to emit_crd. Nieprzezroczysty dla hosta, który przekazuje go bez interpretowania; przenosi dowolną wartość JSON na tej warstwie schematu. |
file | SideEffectFile | nie | Plik zapisywany przez efekt uboczny emit_file: ścieżka docelowa i zawartość pliku. |
Dodatkowe właściwości są niedozwolone.
SideEffectFile
Plik zapisywany przez efekt uboczny emit_file: ścieżka docelowa i zawartość pliku.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
path | string | tak | Ścieżka docelowa, pod którą zapisywany jest plik. |
content | string | tak | Zawartość pliku do zapisania. |
Dodatkowe właściwości są niedozwolone.
PrecedingStep
Jeden krok potoku, który został wykonany przed bieżącym krokiem, dzięki czemu gość może sprawdzić, co go poprzedzało: indeks kroku w potoku, plugin, który ten krok wskazał, oraz efekty uboczne wyemitowane przez ten krok.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
index | integer | tak | Pozycja poprzedniego kroku w potoku, liczona od zera. |
plugin_uri | string | tak | Plugin, który poprzedni wpis potoku wskazuje w swoim polu plugin, w zapisanej postaci. |
side_effects | SideEffect[] | nie | Efekty uboczne wyemitowane przez poprzedni krok. |
Dodatkowe właściwości są niedozwolone.