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

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

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

Uma coleção reutilizável de definições JSON Schema 2020-12 que o conteúdo do catálogo (Components, Features, etc.) pode referenciar com $ref através da referência de identidade por nome simples #/schemas/ (a versão é fornecida pelo ficheiro de bloqueio de cada Release; nenhum host de registo aparece na referência). Camada 3 — opcional, para catálogos que precisem de reutilizar esquemas entre um Component e outro.

Consulte-se a referência de autoria da SchemaLibrary para orientações em prosa sobre como escrever entidades SchemaLibrary; 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 “SchemaLibrary”simConstante: "SchemaLibrary"
metadataobjetosim
specobjetosimO conteúdo da SchemaLibrary. spec.schemas é obrigatório e tem de declarar pelo menos uma entrada; spec.templates é opcional e só está presente quando a biblioteca usa helpers parametrizados.

Não são permitidas propriedades adicionais.

schemalibrary.metadata

PropriedadeTipoObrigatóriaDescrição
namestringsimIdentificador PascalCase da biblioteca. É o nome na referência de identidade por nome simples #/schemas/; a versão é fornecida pelo ficheiro de bloqueio de cada Release e nenhum host de registo 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). O ficheiro de bloqueio de cada Release fixa uma versão por biblioteca. 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ãoEtiquetas declaradas pelo autor. O compilador é neutro quanto ao conteúdo e não interpreta os valores das etiquetas: são metadados opacos, transportados para que aquilo que ler a biblioteca os possa usar na correspondência.
annotationsmapa de stringnãoAnotações declaradas pelo autor. A mesma postura de metadados opacos das etiquetas.

Não são permitidas propriedades adicionais.

schemalibrary.spec

O conteúdo da SchemaLibrary. spec.schemas é obrigatório e tem de declarar pelo menos uma entrada; spec.templates é opcional e só está presente quando a biblioteca usa helpers parametrizados.

PropriedadeTipoObrigatóriaDescrição
schemasmapa de objectsimMapa com nome de definições de esquema reutilizáveis. O conteúdo de cada entrada é validado pelo compilador da forma compacta no momento da análise; a validação ao nível do envelope verifica apenas o encapsulamento estrutural. Chaves: identificador PascalCase — ^[A-Z][A-Za-z0-9]*$. As chaves das entradas aparecem nas referências de identidade por nome simples (<Library>#/schemas/<name>); a restrição ao nível do envelope impede que chaves que não sejam PascalCase se propaguem pelo ecossistema do catálogo. Pelo menos 1 entrada.
templatesmapa de objectnãoMapa com nome opcional de helpers parametrizados. As entradas de esquema referenciam templates pelo nome através de $instantiate:; apenas substituição literal de escalares — sem templates Go incorporados, sem condicionais, sem ciclos. A camada de substituição da biblioteca é intencionalmente mais restrita do que uma avaliação completa de templates, para que a autoria permaneça na linguagem de esquemas em vez de introduzir uma superfície de templating separada. Chaves: identificador PascalCase — ^[A-Z][A-Za-z0-9]*$. A mesma disciplina ao nível do envelope que as chaves das entradas de esquema; os nomes de template são referenciados através de $instantiate: no momento da instanciação.

Não são permitidas propriedades adicionais.