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 catálogo do Aggrega (MappingLibrary)

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

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

Uma coleção reutilizável de fragmentos de templates Go que Recipes e FeatureRecipes consomem no momento da renderização via valuesMapping: { $import: ... }. Camada 3 — opcional, para catálogos que precisam reutilizar mapeamentos entre uma Recipe e outra. Um único modo de autoria: apenas templates Go.

Consulte a referência de autoria da MappingLibrary para orientações em prosa sobre como escrever entidades MappingLibrary; esta página documenta o esquema estrutural que essa referência descreve.

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
apiVersionconst “aggrega.ai/v1beta1”simConstante: "aggrega.ai/v1beta1"
kindconst “MappingLibrary”simConstante: "MappingLibrary"
metadataobjectsim
specobjectsimO conteúdo da MappingLibrary. spec.mappings é obrigatório e deve declarar pelo menos uma entrada. spec carrega additionalProperties: false — nenhum modo de autoria paralelo é aceito no nível do envelope. A postura de modo de autoria único mantém a renderização da Recipe uniforme (template Go em tudo) e evita obrigar os autores a trocar de modelo de avaliação no meio da renderização ao consumir fragmentos importados.

Não são permitidas propriedades adicionais.

mappinglibrary.metadata

PropriedadeTipoObrigatóriaDescrição
namestringsimIdentificador PascalCase da biblioteca. É o nome na referência de identidade por nome simples #/mappings/; a versão é fornecida pelo arquivo de bloqueio de cada Release e nenhum host de registro entra na referência nem em qualquer identificador derivado. Padrão: ^[A-Z][A-Za-z0-9]*$.
versionstringsimVersionamento semântico estrito da biblioteca (por exemplo, 1.0.0). Um consumidor pode exigi-la como versão mínima :<version> opcional em uma referência por nome simples (:#/mappings/); o arquivo de bloqueio de cada Release detém a versão resolvida. Padrão: ^(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-]+)*))?$.
descriptionstringnãoUm resumo conciso do que a biblioteca abrange.
labelsmapa de stringnãoRótulos declarados pelo autor. O compilador é neutro quanto ao conteúdo e não interpreta os valores dos rótulos: são metadados opacos, carregados para que aquilo que ler a biblioteca possa usá-los na correspondência.
annotationsmapa de stringnãoAnotações declaradas pelo autor. A mesma postura de metadados opacos dos rótulos.

Não são permitidas propriedades adicionais.

mappinglibrary.spec

O conteúdo da MappingLibrary. spec.mappings é obrigatório e deve declarar pelo menos uma entrada. spec carrega additionalProperties: false — nenhum modo de autoria paralelo é aceito no nível do envelope. A postura de modo de autoria único mantém a renderização da Recipe uniforme (template Go em tudo) e evita obrigar os autores a trocar de modelo de avaliação no meio da renderização ao consumir fragmentos importados.

PropriedadeTipoObrigatóriaDescrição
mappingsmapa de stringsimMapa nomeado de fragmentos de templates Go reutilizáveis. O corpo de cada entrada é opaco para a validação do envelope — a semântica do conteúdo é tratada pelo parser de templates Go no momento do consumo. Chaves: identificador PascalCase. As chaves das entradas aparecem nas URLs de referência canônicas (#/mappings/<name>); a restrição no nível do envelope impede que chaves que não sejam PascalCase se propaguem pelo ecossistema do catálogo. Padrão: ^[A-Z][A-Za-z0-9]*$. Pelo menos 1 entrada.

Não são permitidas propriedades adicionais.