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

Esquema do socket Wasm de mutador do Aggrega

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

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

As formas de transmissão que um plugin de governação anexado ao papel label-transform consome (MutatorInput) e emite (MutatorOutput). O papel é executado na construção da topologia, depois de o grafo ser construído e antes de ser avaliado: o plugin devolve documentos JSON Patch, e o host aplica-os às etiquetas dos nós e a nada mais, parando o build perante um patch que alcance qualquer outra parte do grafo. Os tipos de payload de Go, Rust e TypeScript são gerados a partir deste esquema nos pacotes da ABI de plugins, pelo que as três linguagens leem e escrevem o mesmo formato de transmissão; um guest importa-os desses pacotes, ou através do seu kit de plugins quando o kit os reexporta.

Uma das seguintes formas

  • MutatorInput
  • MutatorOutput

Definições

MutatorInput

O payload que o host entrega ao plugin mutador em cada invocação: o contexto de compilação ao nível da release mais uma projeção do grafo de topologia que transporta as etiquetas de cada nó e os valores que a sua instância declara.

PropriedadeTipoObrigatóriaDescrição
compilation_contextCompilationContextsimMetadados ao nível da Release que o mutador lê ao decidir que regras de conformidade, FinOps ou governação se aplicam ao build.
graphMutatorGraphsimA projeção do grafo de topologia exposta ao plugin mutador: o Component de cada nó, a sua versão resolvida, as suas etiquetas e os valores que a sua instância declara. Intencionalmente mais restrita do que o resultado completo da topologia: as arestas e os payloads de features não são expostos porque a tarefa do mutador é a etiquetagem, não a remodelação da topologia. Os valores estão lá para serem lidos, pelo que uma configuração que o programador declarou pode decidir uma etiqueta; um patch alcança as etiquetas e nada mais, pelo que o plugin não pode alterar os valores.
sourcesMutatorSource[]nãoFicheiros de definição que o host lê e entrega literalmente ao plugin, como uma lista ordenada por caminho. O host lê os bytes como conteúdo opaco e não os analisa. Ausente quando o anexo não declara origens.
settingsobjetonãoUm objeto de definições de forma livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando o anexo não declara definições.

Não são permitidas propriedades adicionais.

MutatorOutput

A forma de resposta que o plugin mutador emite: uma lista de documentos JSON Patch opacos que o host aplica ao grafo de topologia. Os patches permanecem opacos na camada do esquema para que o host não tenha de duplicar o analisador de JSON Patch que o guest já implementa.

PropriedadeTipoObrigatóriaDescrição
patchesany[]simDocumentos JSON Patch opacos a aplicar ao grafo de topologia, por ordem.
errorstringnãoUma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. O host apresenta um erro presente como uma invocação de plugin falhada.

Não são permitidas propriedades adicionais.

CompilationContext

Metadados ao nível da Release que o mutador lê ao decidir que regras de conformidade, FinOps ou governação se aplicam ao build.

PropriedadeTipoObrigatóriaDescrição
release_namestringsimO metadata.name da Release.
environmentstringsimA etiqueta de ambiente sob a qual a Release é executada (por exemplo, dev, staging, prod).

Não são permitidas propriedades adicionais.

MutatorGraph

A projeção do grafo de topologia exposta ao plugin mutador: o Component de cada nó, a sua versão resolvida, as suas etiquetas e os valores que a sua instância declara. Intencionalmente mais restrita do que o resultado completo da topologia: as arestas e os payloads de features não são expostos porque a tarefa do mutador é a etiquetagem, não a remodelação da topologia. Os valores estão lá para serem lidos, pelo que uma configuração que o programador declarou pode decidir uma etiqueta; um patch alcança as etiquetas e nada mais, pelo que o plugin não pode alterar os valores.

PropriedadeTipoObrigatóriaDescrição
nodesmapa de MutatorNodesimNós indexados por ID absoluto do nó.

Não são permitidas propriedades adicionais.

MutatorNode

A projeção por nó com base na qual o plugin mutador avalia as suas regras: que Component o nó implementa, que versão desse Component foi resolvida, que etiquetas o nó transporta e que valores a sua instância declara.

PropriedadeTipoObrigatóriaDescrição
componentstringsimO nome do Component subjacente que o nó instancia.
resolved_versionstringsimA versão semântica exata do Component que o resolvedor fixou para este nó.
labelsmapa de stringsimAs etiquetas de duck-typing e de ontologia do nó.
valuesobjetonãoOs valores que a instância de componente do nó declara no Aggregate, indexados tal como o autor os escreveu e pela ordem do autor. Cada template no Aggregate já foi avaliado com base nos seus parâmetros, pelo que um valor elevado a um parâmetro chega como o valor que a Release forneceu, ou como o valor predefinido do parâmetro. Aqui estão apenas os valores próprios da instância: um valor predefinido que o esquema do Component declara, e tudo o que uma Recipe ou uma Feature contribui, não estão. Um valor que o Component declara sensível chega retido, exatamente como o veredicto de governação sobre todo o grafo o recebe: no seu lugar está o mesmo objeto marcador de valor retido de chave única que esse veredicto transporta, que indica o motivo declarado, e um valor irmão que nenhuma declaração alcança chega tal como está escrito. Um plugin lê-os para decidir que etiquetas acrescentar; um patch não os pode alcançar. Ausente quando a instância não declara nenhum valor.

Não são permitidas propriedades adicionais.

MutatorSource

Um ficheiro de definição entregue ao plugin: o seu caminho de nome base e o conteúdo do ficheiro. Ambos são transportados literalmente; o host não analisa o conteúdo.

PropriedadeTipoObrigatóriaDescrição
pathstringsimO nome base do ficheiro de origem. O host fornece apenas o nome base, nunca um caminho absoluto do host, pelo que o formato de transmissão é portável e determinístico.
contentstringsimO conteúdo do ficheiro de origem, transportado literalmente como uma cadeia opaca.

Não são permitidas propriedades adicionais.