Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Esquema do socket Wasm de etapa de pipeline de FeatureRecipe do Aggrega

Referência gerada. Não edite à mão — gere novamente a partir do JSON Schema publicado.

ID do esquema: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

As formas de transmissão que um socket de plugin de etapa de pipeline feature-recipe consome (FRPStepInput) e emite (FRPStepOutput). Uma etapa FRP é executada para cada entrada de pipeline inline declarada em uma Recipe ou FeatureRecipe: o host entrega à etapa o conjunto de documentos indexado por chave inteiro, a etapa seleciona pelo conteúdo os documentos que visa e retorna patches RFC 6902 endereçados por chave, além de efeitos colaterais e diagnósticos. Este é um contrato de guest distinto do papel label-transform, que é executado uma única vez sobre todo o grafo de topologia e retorna patches de rótulos opacos. Os tipos de payload de Go, Rust e TypeScript são gerados a partir deste esquema nos pacotes da ABI de plugins, de modo que as três linguagens leem e escrevem o mesmo formato de transmissão; um guest os importa desses pacotes, ou por meio do seu kit de plugins quando o kit os reexporta.

Uma das seguintes formas

  • FRPStepInput
  • FRPStepOutput

Definições

FRPStepInput

O payload que um guest de pipeline feature-recipe recebe para uma etapa de pipeline: o conjunto de documentos indexado por chave que o host entrega inteiro, a entrada local à etapa que a Recipe declarou para esta etapa, o contexto do momento da renderização, a posição da etapa no pipeline e um registro das etapas que já foram executadas.

PropriedadeTipoObrigatóriaDescrição
documentsDocumentSetsimO conjunto indexado por chave, enraizado em um escopo, de unidades endereçáveis que um guest de pipeline recebe como a sua superfície de entrada. O host entrega o conjunto inteiro e não interpreta o seu conteúdo; o guest seleciona pelo conteúdo os documentos que visa e endereça os seus patches por chave.
step_inputobjectnãoO bloco with renderizado da etapa, um conjunto de chaves na ordem do autor que o guest lê como a sua entrada local à etapa. Preserva a ordem do autor para que o payload seja idêntico byte a byte entre execuções com entrada idêntica.
contextobjectsimO contexto do momento da renderização que o host entrega à etapa, transportado como os bytes do seu documento JSON; este esquema deixa o objeto não declarado, e o host não lê nada de volta dele. Uma etapa de uma Recipe ou de uma FeatureRecipe com escopo de componente recebe parameters, os valores de parâmetros da Release ordenados por nome e ausentes quando não há nenhum; annotations, as anotações do nó divididas conforme onde cada uma foi escrita, em aggregate, release e catalog, cada um ausente quando vazio; e boundary, a fronteira em que o nó se encontra: name, path (os seus segmentos), sync_wave (ausente quando 0), directory, sub_directory (ausente quando não há nenhum) e annotations (o conjunto que as fronteiras da Release propagam em cascata até o nó, com a sua própria entrada da Release aplicada por último; ausente quando vazio). Uma etapa de uma FeatureRecipe com escopo de fronteira, que não tem componente host, recebe parameters; annotations carregando apenas o compartimento release, que é o conjunto de anotações próprio da fronteira; e um boundary carregando o seu name, o seu path e esse mesmo conjunto como as suas annotations. A renderização do provedor da mesma FeatureRecipe recebe o mesmo contexto. A largura de indentação, yaml_indent, não é definida para uma etapa.
step_indexintegersimA posição desta etapa no pipeline, a partir de zero.
preceding_stepsPrecedingStep[]nãoAs etapas do pipeline que foram executadas antes desta etapa, para que um guest possa inspecionar o que veio antes dela.

Não são permitidas propriedades adicionais.

FRPStepOutput

O payload que um guest de pipeline feature-recipe retorna para uma etapa de pipeline: os patches RFC 6902 que o host aplica ao conjunto de documentos indexado por chave, os efeitos colaterais que esta etapa produziu e quaisquer diagnósticos que o guest levantou.

PropriedadeTipoObrigatóriaDescrição
patchesJSONPatchOp[]nãoOperações RFC 6902 estruturadas que a etapa emite contra documentos do conjunto indexado por chave. Cada uma nomeia o seu documento de destino por scope e key e depois nomeia explicitamente op, path e value. Distintas da lista de patches opaca do papel label-transform: os patches de uma etapa FRP são aplicados pelo host e restaurados por snapshot em uma etapa com falha, por isso aqui as operações são explícitas em vez de opacas.
side_effectsSideEffect[]nãoOs efeitos que esta etapa produziu além de aplicar um patch a um documento existente (por exemplo, emitir um CRD ou escrever um arquivo).
diagnosticsDiagnostic[]nãoDiagnósticos que o guest levantou. Cada elemento é a forma de diagnóstico compartilhada dos plugins Wasm.
outputsobjectnãoAs saídas endereçáveis que o guest retorna para esta etapa, um conjunto de chaves na ordem do autor que preenche as saídas da etapa para que uma etapa posterior ou um template as leia. Preserva a ordem do autor para que o payload seja idêntico byte a byte entre execuções com entrada idêntica. Ausente quando a etapa não retorna nenhuma saída.
errorstringnãoUma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. Ela é distinta de quaisquer diagnósticos que a saída carregue: os diagnósticos informam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error informa que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin com falha.

Não são permitidas propriedades adicionais.

DocumentSet

O conjunto indexado por chave, enraizado em um escopo, de unidades endereçáveis que um guest de pipeline recebe como a sua superfície de entrada. O host entrega o conjunto inteiro e não interpreta o seu conteúdo; o guest seleciona pelo conteúdo os documentos que visa e endereça os seus patches por chave.

PropriedadeTipoObrigatóriaDescrição
ownmapa de UnitsimA saída renderizada própria do nó, indexada por token de unidade. Preserva a ordem das chaves para que o conjunto chegue ao formato de transmissão em uma ordem estável e o payload seja idêntico byte a byte entre execuções com entrada idêntica.
hostmapa de UnitnãoA saída renderizada do componente ao qual está vinculada uma FeatureRecipe com escopo de componente — a superfície entre entidades. Ausente para etapas de Recipe e etapas de FeatureRecipe com escopo de fronteira, que não têm componente host. Preserva a ordem das chaves para que o conjunto chegue ao formato de transmissão em uma ordem estável e o payload seja idêntico byte a byte entre execuções com entrada idêntica.

Não são permitidas propriedades adicionais.

Unit

Uma peça endereçável em que a saída emitida de um provedor se divide — a visão híbrida de uma peça de saída. Uma unidade estruturada carrega uma árvore (uma visão endereçável segundo a RFC 6902) e é um destino PATCH; uma unidade opaca carrega apenas o seu tipo de mídia e os seus bytes (nenhuma árvore) e é um destino SELECT e EMIT, mas não um destino PATCH.

PropriedadeTipoObrigatóriaDescrição
tokenstringsimO endereço posicional opaco que o codec atribui — o nome de arquivo emitido para um arquivo de um único documento, ou <filename>#<ordinal> (ordem no arquivo) quando um arquivo carrega vários documentos. O guest o trata como opaco: seleciona uma unidade pelo conteúdo e devolve o token como está, sem nunca analisá-lo.
bytesstringnãoOs bytes originais da unidade, a origem da remontagem. A remontagem é fiel ao byte por construção: os bytes não tocados são reunidos literalmente a partir destes. Cada kit os carrega no seu próprio tipo de campo — brutos onde esse tipo é um tipo de bytes, codificados em base64 onde é uma string que a etapa decodifica para recuperá-los — e o codificador gerado converte entre o campo e a forma em que o formato de transmissão carrega bytes.
media_typestringnãoO tipo de conteúdo da unidade (por exemplo, application/yaml para o codec YAML padrão), para que o guest saiba o que está olhando.
treeanynãoA visão normalizada da unidade endereçável segundo a RFC 6902 quando o codec produziu uma, ou ausente quando não produziu. Uma unidade com árvore é estruturada (um destino PATCH); uma unidade sem árvore é opaca. O documento é opaco para o host, que repassa os bytes sem interpretá-los, de modo que a árvore carrega qualquer valor JSON nesta camada do esquema.

Não são permitidas propriedades adicionais.

JSONPatchOp

Uma operação JSON-Patch RFC 6902 que uma etapa FRP emite contra um documento do conjunto indexado por chave. Scope e key nomeiam o documento de destino; op, path, value e from carregam a operação contra uma localização dentro desse documento.

PropriedadeTipoObrigatóriaDescrição
scopestring (enum)simA raiz de documentos que a operação visa: own (os documentos renderizados próprios do nó) ou host (os documentos do componente ao qual está vinculada uma FeatureRecipe com escopo de componente). Valores permitidos: "own", "host"
keystringsimA chave do nome de arquivo emitido dentro da raiz nomeada — a chave que o guest aprendeu em tempo de execução a partir do documento que selecionou pelo conteúdo.
opstringsimA operação RFC 6902: uma de add, remove, replace, move, copy, test.
pathstringsimUm JSON Pointer RFC 6901 para a localização de destino dentro do documento nomeado.
valueanynãoO operando para add, replace e test, omitido caso contrário. Um fragmento arbitrário de documento JSON escrito pelo guest, que o host repassa de forma opaca; ele carrega qualquer valor JSON nesta camada do esquema.
fromstringnãoO ponteiro de origem para move e copy, omitido caso contrário.

Não são permitidas propriedades adicionais.

SideEffect

Um efeito que uma etapa de pipeline feature-recipe produz além de aplicar um patch a um documento existente. Kind é emit_crd ou emit_file; o esquema o deixa como uma string aberta para que um novo tipo possa ser adicionado sem uma quebra da ABI, e um build é interrompido diante de qualquer outro tipo. Quando kind é emit_crd, crd traz o documento CRD e file é omitido; quando kind é emit_file, file traz o arquivo a ser escrito e crd é omitido.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO tipo de efeito: emit_crd ou emit_file. O esquema deixa o campo como uma string aberta para que um novo tipo possa ser adicionado sem uma quebra da ABI; um build é interrompido diante de qualquer outro tipo, nomeando o nó, o efeito colateral e o tipo.
scopestring (enum)nãoA raiz de documentos para a qual a emissão contribui: own (o conjunto próprio do nó) ou host (o conjunto do componente host vinculado). Um scope ausente significa own no momento da aplicação. Valores permitidos: "own", "host"
crdanynãoO documento CRD que a etapa emite quando kind é emit_crd. Opaco para o host, que o repassa sem interpretá-lo; ele traz qualquer valor JSON nesta camada do esquema.
fileSideEffectFilenãoO arquivo que um efeito colateral emit_file escreve: o caminho de destino e o conteúdo do arquivo.

Não são permitidas propriedades adicionais.

SideEffectFile

O arquivo que um efeito colateral emit_file escreve: o caminho de destino e o conteúdo do arquivo.

PropriedadeTipoObrigatóriaDescrição
pathstringsimO caminho de destino em que o arquivo é escrito.
contentstringsimO conteúdo do arquivo a ser escrito.

Não são permitidas propriedades adicionais.

PrecedingStep

Uma etapa de pipeline que foi executada antes da etapa atual, para que um guest possa inspecionar o que veio antes dela: o índice da etapa no pipeline, o plugin que ela nomeou e os efeitos colaterais que essa etapa emitiu.

PropriedadeTipoObrigatóriaDescrição
indexintegersimA posição, a partir de zero, da etapa anterior no pipeline.
plugin_uristringsimO plugin que a entrada anterior do pipeline nomeia no seu campo plugin, como está escrito.
side_effectsSideEffect[]nãoOs efeitos colaterais que a etapa anterior emitiu.

Não são permitidas propriedades adicionais.