Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del catálogo de Aggrega (Feature)

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

ID del esquema: https://aggrega.ai/schemas/feature-v1beta1.schema.json

Una funcionalidad operativa modular que se enlaza dinámicamente a los componentes.

Consulta la referencia de autoría de la Feature para obtener orientación en prosa sobre cómo escribir entidades Feature; esta página documenta el esquema estructural que describe esa referencia.

Tipo de nivel superior: object

Propiedades

PropiedadTipoObligatoriaDescripción
apiVersionconst “aggrega.ai/v1beta1”síConstante: "aggrega.ai/v1beta1"
kindconst “Feature”síConstante: "Feature"
metadataobjectsí
specobjectsíEl contrato de validación, selección de destino e interoperabilidad de una Feature del catálogo: los pilares de forma libre (values, infra, provides) escritos mediante schema, los pilares de forma fija (sockets de dependencia usesSchema, ranuras de vinculación featuresSchema), la selección de componentes de destino (appliesTo y appliesToAnyOf) y los controles de interoperabilidad.

No se permiten propiedades adicionales.

feature.metadata

PropiedadTipoObligatoriaDescripción
namestringsíAl menos 1 carácter de longitud.
versionstringsíVersionado semántico estricto de la funcionalidad (p. ej., 1.0.0). Patrón: ^(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-]+)*))?$.
descriptionstringnoQué es esta entidad y para qué sirve, escrito para quien está decidiendo si usarla. Empieza con una frase que nombre la cosa y luego añade lo que un lector necesita para elegirla y usarla correctamente — qué espera de la Release que la despliega, y cualquier cosa sorprendente sobre su comportamiento. Un párrafo corto es la extensión habitual.
maintainersobject[]noLista de mantenedores responsables de esta entidad.
licensestringnoIdentificador SPDX de la licencia del software que describe esta entidad, como MIT o AGPL-3.0. Registra las condiciones de ese software, no las de este archivo.
repositorystringnoLa URL del repositorio Git donde se encuentran los archivos fuente.
homestringnoLa URL de la página de inicio, la wiki o la documentación de esta entidad.
keywordsstring[]noUna lista de palabras clave descriptivas para facilitar el descubrimiento en la interfaz de usuario.
labelsobjectnoEtiquetas de duck typing para la Feature. La etiqueta reservada ‘feature.aggrega.ai/kind’ con el valor ‘secret’ marca esta como una Feature de credenciales para el autor y para las herramientas que la muestran. Una Feature de credenciales y una Feature ordinaria se vinculan de la misma manera, bajo la misma superficie de vinculación; lo que produce una vinculación lo decide la FeatureRecipe a la que el Manifest asigna su tipo, no la etiqueta.
annotationsmapa de stringnoCaracterísticas intrínsecas e inmutables de la funcionalidad, escritas por el arquitecto de plataforma en el Dominio 2. Se propagan en cascada hasta el contenedor .context.annotations.catalog.

No se permiten propiedades adicionales.

feature.metadata.maintainers[]
PropiedadTipoObligatoriaDescripción
namestringsí
emailstringno
urlstringno

No se permiten propiedades adicionales.

feature.metadata.labels

Etiquetas de duck typing para la Feature. La etiqueta reservada ‘feature.aggrega.ai/kind’ con el valor ‘secret’ marca esta como una Feature de credenciales para el autor y para las herramientas que la muestran. Una Feature de credenciales y una Feature ordinaria se vinculan de la misma manera, bajo la misma superficie de vinculación; lo que produce una vinculación lo decide la FeatureRecipe a la que el Manifest asigna su tipo, no la etiqueta.

PropiedadTipoObligatoriaDescripción
feature.aggrega.ai/kindstring (enum)noEtiqueta del tipo de Feature. El valor ‘secret’ marca esta como una Feature de credenciales. Valores permitidos: "secret"

feature.spec

El contrato de validación, selección de destino e interoperabilidad de una Feature del catálogo: los pilares de forma libre (values, infra, provides) escritos mediante schema, los pilares de forma fija (sockets de dependencia usesSchema, ranuras de vinculación featuresSchema), la selección de componentes de destino (appliesTo y appliesToAnyOf) y los controles de interoperabilidad.

PropiedadTipoObligatoriaDescripción
extendsstringnoReferencia a una Feature base de la que hereda esta Feature. Nombra la base por su metadata.name en lugar de por la coordenada de registro con la que se publica la Feature, y admite las mismas tres formas de versión que toda referencia de catálogo: simple (core/queue) para la versión más alta disponible, exacta (core/queue:1.0.0) o un rango con acento circunflejo (core/queue:^1.0.0). Lo que se hereda va más allá de los metadatos: metadata.labels y metadata.annotations de la base, sus selectores appliesTo y appliesToAnyOf, su bloque interoperability, su usesSchema y su featuresSchema se fusionan todos hacia abajo, y sus declaraciones JSON Schema 2020-12 en schema se fusionan automáticamente. El valor propio del hijo prevalece en una clave compartida, y los campos de identidad nunca se heredan.
featuresSchemamapa de objectnoDefiniciones declarativas de ranuras de vinculación: los puntos de enlace con nombre en los que esta Feature espera que se vincule otra Feature. Una ranura restringe qué relleno puede enlazarla (selector) y cómo puede entregarse el material del relleno (inject); la Feature propia del relleno es dueña de su contrato de values e infra. Declarar una ranura nunca cierra el bloque de vinculaciones — un autor puede vincular una Feature con un nombre que ninguna ranura declara. Una ranura es un punto de enlace, no un socket de dependencia: usesSchema declara la superficie de topología independiente.
appliesTostringnoCadena de selector de etiquetas al estilo de Kubernetes que selecciona Components. Todos los requisitos separados por comas deben cumplirse (AND). Formas admitidas: key=value, key!=value, key in (v1, v2), key notin (v1, v2), clave simple (etiqueta presente), !key (etiqueta ausente). Ejemplo: “tier in (critical, production), !legacy”. Un selector vacío o ausente no declara ninguna restricción. El selector se lee con respecto a estas formas cada vez que se evalúa una vinculación de esta Feature, y un requisito fuera de ellas detiene la compilación, nombrándolo: un requisito vacío (una coma inicial, final o duplicada), o una clave que contiene espacios en blanco o cualquiera de = ! ( ) y la coma — así, “!tier=frontend” se rechaza, y tier!=frontend es la forma de excluir un valor. Un valor es el texto que sigue a su operador, sean cuales sean los caracteres que contenga. El patrón de este campo rechaza solo unas pocas formas mal construidas, antes de que se evalúe ninguna vinculación. Patrón: ^(?:[^()]*[()][\s\S]*|[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?(?:,[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?)*)$.
appliesToAnyOfstring o mapa de string[]noUna lista de selectores; la Feature se aplica si CUALQUIER elemento coincide (lógica OR). Cada elemento es una cadena de selector de etiquetas (misma gramática que appliesTo; los requisitos dentro de la cadena se combinan con AND) o un mapa plano de clave-valor en el que cada par debe coincidir (solo igualdad).
interoperabilityobjectnoControles avanzados de seguridad operativa e interoperabilidad.
usesSchemamapa de objectnoLos sockets de dependencia que declara esta entidad, indexados por nombre de socket; cada conexión trazada a través de un socket se comprueba con la declaración de ese socket — su selector y los mecanismos de inyección que permite. Claves: una o más letras, dígitos, guiones bajos o guiones. No se permite un punto. Patrón: ^[a-zA-Z0-9_-]+$.
schemaobjectnoContenido JSON Schema 2020-12 que cubre los pilares de forma libre: values (el dominio del Desarrollador — parámetros con la forma de la aplicación que el Desarrollador configura por cada vinculación de Feature en el Aggregate); infra (el dominio del Operador — controles de dimensionamiento físico que suministra la Release); y provides (claves de contexto aguas abajo que esta Feature expone a los consumidores a través del pipe de topología). Acepta tres modos de autoría mediante despacho según la forma del contenido: (1) contenido inline (un mapa YAML con forma compacta, JSON Schema YAML o una combinación); (2) sustitución por archivo mediante {$import: }, escrita en spec.schema para suministrar el contrato completo desde un archivo o en un solo pilar para suministrar solo ese pilar, con una ruta relativa leída respecto al directorio que contiene la entidad que la declaró; (3) referencia entre documentos mediante {$ref: #/schemas/} a una entrada de una SchemaLibrary por identidad de nombre simple (la versión la suministra el archivo de bloqueo de cada Release; ningún host de registro aparece en la referencia). Los campos complementarios usesSchema y featuresSchema cubren los pilares de forma fija (sockets de dependencia, ranuras de vinculación); el compilador compone los tres en el único esquema con el que se valida una instancia.
assertionsmapa de stringnoValidación entre campos en tiempo de compilación. Cada entrada es una aserción con nombre: la clave es un identificador de regla estable que aparece en los mensajes de error; el valor es una cadena de plantilla Go con semántica de detención {{ fail "message" }}. Varias aserciones con nombre por entidad se evalúan por instancia en el orden declarado por el autor; la primera aserción que falla detiene la compilación. Las aserciones de Feature se evalúan después de la resolución y el análisis estático, antes del renderizado, y expresan invariantes arquitectónicos del contrato. Contexto de la plantilla: .values / .infra / .uses / .features / .metadata. El evaluador usa missingkey=error: las referencias a claves no definidas provocan una detención con un diagnóstico no-such-key. Como la referencia simple provoca la detención antes de que pueda ejecutarse cualquier valor alternativo, un default simple no proporciona un valor alternativo para un campo opcional en esta superficie — protege la referencia con hasKey, o usa la función auxiliar optional, que realiza directamente la comprobación de presencia. Leer la clave mediante index tampoco proporciona uno: index provoca una detención ante una clave de mapa que el mapa no contiene, nombrando la clave.

No se permiten propiedades adicionales.

feature.spec.interoperability

Controles avanzados de seguridad operativa e interoperabilidad.

PropiedadTipoObligatoriaDescripción
conflictsWithstring[]noNombres de las Features junto a las cuales esta Feature no puede llegar a un componente, cada uno escrito de la forma en que el tipo de una vinculación nombra una Feature. La compilación se detiene antes del renderizado cuando un componente acaba llevando esta Feature y una Feature nombrada aquí — ya sea que cada una se haya vinculado en el componente, en un subsistema o límite que lo contiene, en una entrada de componente de la Release o mediante expansión guiada por anotaciones. Basta una declaración: la detención no necesita que la otra Feature incluya a esta. Los nombres se comparan sin ninguna versión, de modo que una entrada coincide con todas las versiones de la Feature que nombra. Dos Features vinculadas a límites hermanos que no comparten ningún componente nunca se encuentran y no provocan una detención.

No se permiten propiedades adicionales.