Ir al contenido

Catálogo de extensiones de enriquecimiento

Fuente de verdad para cada extensión x-* que aparece en docs/specifications/api/*.json. La paridad con scripts/utils/extension_constants.py es aplicada por tests/test_extension_catalog.py.

Aquí se documentan tres clases de extensiones:

  • Inyectadas aquí — extensiones que nuestros enriquecedores añaden (x-f5xc-* y x-ves-cli-* / x-ves-field-* / x-ves-operation-* / variantes de descubrimiento). Estas son las que las herramientas descendentes deben consumir.
  • Transferencia desde upstream — extensiones que F5 emite en las especificaciones fuente y que preservamos sin cambios (x-ves-proto-*, x-displayname, etc.). Documentadas por transparencia, pero no controladas por este repositorio.
  • Inyección futura — aún no emitidas; documentadas aquí en el momento en que un enriquecedor comience a producirlas (no aplica en la población inicial).

Cada entrada a continuación tiene exactamente esta forma. La prueba de paridad en tests/test_extension_catalog.py tolera que el cuerpo de la sección sea mínimo, siempre que exista el encabezado ### x-nombre y el indicador Pass-through from upstream: esté presente con el valor yes o no.

### x-<name>
- **Applied at:** <schema | parameter | operation | path-item | info | response>
- **Purpose:** <one sentence>
- **Consumers:** <CLI | VSCode | Terraform | Web UI | multiple | N/A>
- **Value type:** <string | number | boolean | object | array>
- **Value schema:** <JSON Schema snippet, or N/A>
- **Injected by:** <scripts/utils/<enricher>.py, or "upstream">
- **Driven by config:** <config/<file>.yaml, or "hardcoded", or "upstream">
- **Example:** <short snippet>
- **Pass-through from upstream:** <yes/no>

Inyectadas — nivel de especificación (sección info)

Sección titulada «Inyectadas — nivel de especificación (sección info)»
  • Applied at: info
  • Purpose: Identifica el slug del dominio CLI (p. ej., http_loadbalancer) para una especificación enriquecida.
  • Consumers: CLI
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: hardcoded
  • Example: "x-f5xc-cli-domain": "http_loadbalancer"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Bloque de metadatos de CLI (nombre de la herramienta, sugerencias de versión, agrupación de dominio).
  • Consumers: CLI
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/cli_metadata.yaml
  • Example: "x-f5xc-cli-metadata": {"tool": "xcsh", "domain": "http_loadbalancer"}
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Marca de tiempo de la especificación fuente upstream a partir de la cual se construyó el archivo enriquecido.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string", "format": "date-time"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: hardcoded
  • Example: "x-f5xc-upstream-timestamp": "2026-04-21T12:00:00Z"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: ETag del activo de la versión de la especificación fuente upstream.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: hardcoded
  • Example: "x-f5xc-upstream-etag": "\"abc123\""
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Versión semántica estampada en la especificación enriquecida por el pipeline.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: hardcoded
  • Example: "x-f5xc-enriched-version": "3.2.1"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Bloque de glosario de marca/terminología aplicado a cada especificación de dominio.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/branding.py
  • Driven by config: config/branding.yaml
  • Example: "x-f5xc-glossary": {"XC": "F5 Distributed Cloud"}
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Marca de tiempo de cuando se ejecutó el paso de descubrimiento de la API en vivo.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string", "format": "date-time"}
  • Injected by: scripts/utils/discovery_enricher.py
  • Driven by config: config/discovery.yaml
  • Example: "x-f5xc-discovered-at": "2026-04-21T09:15:00Z"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: URL base de la API en vivo que fue sondeada durante el descubrimiento.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string", "format": "uri"}
  • Injected by: scripts/utils/discovery_enricher.py
  • Driven by config: config/discovery.yaml
  • Example: "x-f5xc-api-url": "https://f5-amer-ent.console.ves.volterra.io"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: URL a la página de documentación de referencia de API alojada para este dominio.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string", "format": "uri"}
  • Injected by: scripts/utils/external_docs_enricher.py
  • Driven by config: none (derived from domain name)
  • Example: "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Tiempo de respuesta observado (ms) para la API sondeada durante el descubrimiento.
  • Consumers: multiple
  • Value type: number
  • Value schema: {"type": "number"}
  • Injected by: scripts/utils/discovery_enricher.py
  • Driven by config: config/discovery.yaml
  • Example: "x-f5xc-response-time-ms": 42
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Guía de mejores prácticas seleccionadas para un dominio.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "object"}}
  • Injected by: scripts/utils/best_practices_enricher.py
  • Driven by config: config/best_practices.yaml
  • Example: "x-f5xc-best-practices": [{"id": "bp-1", "text": "Prefer HTTPS"}]
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Flujos de trabajo paso a paso con nombre para realizar tareas comunes en un dominio.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "object"}}
  • Injected by: scripts/utils/guided_workflow_enricher.py
  • Driven by config: config/guided_workflows.yaml
  • Example: "x-f5xc-guided-workflows": [{"name": "create-lb", "steps": [...]}]
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Tabla de expansión de acrónimos por dominio.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object", "additionalProperties": {"type": "string"}}
  • Injected by: scripts/utils/acronym_enricher.py
  • Driven by config: config/acronyms.yaml
  • Example: "x-f5xc-acronyms": {"LB": "Load Balancer"}
  • Pass-through from upstream: no
  • Applied at: spec info
  • Purpose: Árbol de navegación global de la consola — jerarquía de espacios de trabajo y menús.
  • Consumers: console-catalog, xcsh, browser-automation
  • Value type: object
  • Value schema: {"type": "object", "properties": {"workspaces": "object"}}
  • Injected by: scripts/utils/console_ui_enricher.py
  • Driven by config: config/console_ui.yaml
  • Example: "x-f5xc-console-navigation": {"workspaces": {"web-app-and-api-protection": {"label": "Web App & API Protection", "route_prefix": "/web/workspaces/web-app-and-api-protection"}}}
  • Pass-through from upstream: no

Inyectadas — nivel de esquema (esquemas de componentes)

Sección titulada «Inyectadas — nivel de esquema (esquemas de componentes)»
  • Applied at: schema
  • Purpose: Conjunto mínimo de campos requerido para realizar con éxito un POST/PUT de este recurso.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/minimum_configuration_enricher.py
  • Driven by config: config/minimum_configs.yaml
  • Example: "x-f5xc-minimum-configuration": {"required_fields": ["name"]}
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Proporciona metadatos de restricción, recomendación y clasificación de espacio de nombres para un recurso.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object", "properties": {"constraint": {"type": "object"}, "recommendation": {"type": "object"}, "classification": {"type": "object"}}}
  • Injected by: scripts/utils/namespace_profile_enricher.py
  • Driven by config: config/namespace_profile.yaml
  • Example: "x-f5xc-namespace-profile": {"constraint": {"allowed": ["system", "shared", "user"]}, "recommendation": {"default": "shared"}, "classification": {"multi_tenant_pattern": "shared-ref"}}
  • Pass-through from upstream: no
  • Applied at: schema
  • Purpose: Orden sugerido de propiedades para la presentación en UI/CLI.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-displayorder": ["name", "description", "spec"]
  • Pass-through from upstream: no
  • Applied at: schema
  • Purpose: Nombre del tipo de recurso de Terraform que se corresponde con este esquema.
  • Consumers: Terraform
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-terraform-resource": "volterra_http_loadbalancer"
  • Pass-through from upstream: no
  • Applied at: schema
  • Purpose: Nombre para mostrar legible por humanos para un esquema de recurso (anula la generación automática).
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-display-name": "HTTP Load Balancer"
  • Pass-through from upstream: no
  • Applied at: schema
  • Purpose: Navegación, enrutamiento y estructura de formulario de la UI de la consola para este recurso.
  • Consumers: console-catalog, xcsh, vscode-xcsh, browser-automation
  • Value type: object
  • Value schema: {"type": "object", "properties": {"workspace": "string", "menu_path": "array", "route_pattern": "string", "breadcrumbs": "array", "add_action": "object", "form_sections": "array", "metadata": "object"}}
  • Injected by: scripts/utils/console_ui_enricher.py
  • Driven by config: config/console_ui.yaml
  • Example: "x-f5xc-console": {"workspace": "web-app-and-api-protection", "menu_path": ["Manage", "Load Balancers", "HTTP Load Balancers"]}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Descripción de propiedad enriquecida que complementa la description upstream.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_descriptions.yaml
  • Example: "x-f5xc-description": "Fully-qualified domain name used for TLS SNI."
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Reglas de validación declarativas derivadas de ves.io.schema.rules de protobuf upstream.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/validation_enricher.py
  • Driven by config: config/validation_rules.yaml
  • Example: "x-f5xc-validation": {"min_len": 1, "max_len": 64}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Múltiples valores de ejemplo ilustrativos para una propiedad.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array"}
  • Injected by: scripts/utils/resource_examples_enricher.py
  • Driven by config: config/resource_examples.yaml
  • Example: "x-f5xc-examples": ["example.com", "api.example.com"]
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Un único valor de ejemplo canónico.
  • Consumers: multiple
  • Value type: string
  • Value schema: {}
  • Injected by: scripts/utils/field_description_enricher.py
  • Driven by config: config/field_descriptions.yaml
  • Example: "x-f5xc-example": "example.com"
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Sugerencias de autocompletado de shell (enumeración estática o comando dinámico).
  • Consumers: CLI
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-completion": {"source": "command", "cmd": "xcsh namespace list"}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Valor(es) predeterminado(s) para mostrar en la documentación generada y en las interfaces de usuario.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-defaults": {"value": "default"}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Lista las operaciones HTTP (POST/PUT/…) que requieren esta propiedad.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-required-for-operations": ["POST", "PUT"]
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Lista las combinaciones de características con nombre que requieren esta propiedad.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/utils/minimum_configuration_enricher.py
  • Driven by config: config/minimum_configs.yaml
  • Example: "x-f5xc-required-for": ["tls-origin", "mtls"]
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Requisitos condicionales (p. ej., requerido cuando un campo hermano es igual a X).
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "object"}}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-conditions": [{"when": "tls.enabled == true", "require": "cert"}]
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Aviso de obsolescencia con orientación sobre el reemplazo.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/field_metadata_enricher.py
  • Driven by config: config/field_metadata.yaml
  • Example: "x-f5xc-deprecated": {"since": "3.0.0", "use": "new_field"}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Valor predeterminado que el servidor asigna cuando el cliente omite la propiedad.
  • Consumers: multiple
  • Value type: string
  • Value schema: {}
  • Injected by: scripts/utils/default_value_enricher.py
  • Driven by config: config/discovered_defaults.yaml
  • Example: "x-f5xc-server-default": "ROUND_ROBIN"
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Valor de producción recomendado para un campo donde el valor predeterminado del servidor es subóptimo.
  • Consumers: multiple
  • Value type: string
  • Value schema: {}
  • Injected by: scripts/utils/default_value_enricher.py
  • Driven by config: config/discovered_defaults.yaml
  • Example: "x-f5xc-recommended-value": "LEAST_REQUEST"
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Para bloques oneOf, indica cuál variante es la recomendada.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/default_value_enricher.py
  • Driven by config: config/discovered_defaults.yaml
  • Example: "x-f5xc-recommended-oneof-variant": "tls_parameters"
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Lista las propiedades hermanas que no pueden establecerse junto con esta.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/utils/conflicts_with_enricher.py
  • Driven by config: hardcoded
  • Example: "x-f5xc-conflicts-with": ["plaintext", "auto_cert"]
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Documenta las dependencias entre campos donde un campo requiere que otro esté configurado.
  • Consumers: compile_catalog.py, xcsh CLI
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "object", "properties": {"field": {"type": "string"}, "required": {"type": "boolean"}, "reason": {"type": "string"}}}}
  • Injected by: scripts/utils/dependency_enricher.py
  • Driven by config: config/minimum_configs.yaml (dependencies section)
  • Example: "x-f5xc-requires": [{"field": "tls_config", "required": true, "reason": "use_tls requires tls_config sub-field"}]
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Restricciones numéricas/de cadena derivadas del sondeo de la API en vivo o de patrones estáticos.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/constraint_enricher.py
  • Driven by config: config/constraint_patterns.yaml
  • Example: "x-f5xc-constraints": {"min": 1, "max": 65535, "source": "live-api"}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Declara si un campo debe ser único dentro de su ámbito.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/uniqueness_enricher.py
  • Driven by config: hardcoded
  • Example: "x-f5xc-uniqueness": {"scope": "namespace"}
  • Pass-through from upstream: no
  • Applied at: schema property
  • Purpose: Metadatos del widget de formulario de la consola para esta propiedad de API.
  • Consumers: console-catalog, xcsh, browser-automation
  • Value type: object
  • Value schema: {"type": "object", "properties": {"widget_type": "string", "label": "string", "default": "any", "selector": "string", "form_section": "string", "show_when": "object", "advanced": "boolean"}}
  • Injected by: scripts/utils/console_ui_enricher.py
  • Driven by config: config/console_field_metadata.yaml
  • Example: "x-f5xc-console-field": {"widget_type": "listbox", "default": "HTTPS with Automatic Certificate", "form_section": "domains-and-lb-type"}
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Nombra los campos del cuerpo de la operación que deben proporcionarse para que sea exitosa.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/utils/operation_metadata_enricher.py
  • Driven by config: config/operation_metadata.yaml
  • Example: "x-f5xc-required-fields": ["metadata.name", "spec.domains"]
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Clasifica el radio de impacto de una operación (bajo/medio/alto/crítico).
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string", "enum": ["low", "medium", "high", "critical"]}
  • Injected by: scripts/utils/operation_metadata_enricher.py
  • Driven by config: config/operation_metadata.yaml
  • Example: "x-f5xc-danger-level": "high"
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Indica si el CLI/UI debe solicitar confirmación al usuario antes de ejecutar.
  • Consumers: multiple
  • Value type: boolean
  • Value schema: {"type": "boolean"}
  • Injected by: scripts/utils/operation_metadata_enricher.py
  • Driven by config: config/operation_metadata.yaml
  • Example: "x-f5xc-confirmation-required": true
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Lista los efectos secundarios observables de la operación (reinicio, reconfiguración, etc.).
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/utils/operation_metadata_enricher.py
  • Driven by config: config/operation_metadata.yaml
  • Example: "x-f5xc-side-effects": ["invalidates-cache"]
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Tiempo de respuesta medido empíricamente para esta operación durante el descubrimiento.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/discovery_enricher.py
  • Driven by config: config/discovery_enrichment.yaml
  • Example: "x-f5xc-discovered-response-time": {"p50_ms": 40, "p95_ms": 120}
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Encabezados/comportamiento de límite de tasa observados desde la API en vivo.
  • Consumers: multiple
  • Value type: object
  • Value schema: {"type": "object"}
  • Injected by: scripts/utils/discovery_enricher.py
  • Driven by config: config/discovery_enrichment.yaml
  • Example: "x-f5xc-discovered-rate-limits": {"limit": 100, "window_s": 60}
  • Pass-through from upstream: no
  • Applied at: operation
  • Purpose: Catálogo de respuestas de error observadas durante el descubrimiento en vivo, con cargas de muestra.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "object"}}
  • Injected by: scripts/utils/discovery_enricher.py
  • Driven by config: config/discovery_enrichment.yaml
  • Example: "x-f5xc-discovered-error-catalog": [{"status": 400, "reason": "bad_request"}]
  • Pass-through from upstream: no

Inyectadas — nivel de índice (metadatos de dominio)

Sección titulada «Inyectadas — nivel de índice (metadatos de dominio)»
  • Applied at: info
  • Purpose: Categoría de agrupación de nivel superior para CLI / UI / documentación / Terraform de un dominio.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-category": "networking"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Lista de tipos de recursos primarios que definen el dominio.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-primary-resources": ["http_loadbalancer"]
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Recursos que requieren cuidado especial (críticos para producción).
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/critical_resources.yaml
  • Example: "x-f5xc-critical-resources": ["tls_certificate"]
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Descripción corta del dominio (~60 caracteres). También aplica a nivel de propiedad para descripciones largas.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/property_description_short_enricher.py
  • Driven by config: config/property_description_short.yaml
  • Example: "x-f5xc-description-short": "Layer-7 HTTPS load balancing."
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Descripción media del dominio (~150 caracteres). También aplica a nivel de propiedad.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/property_description_short_enricher.py
  • Driven by config: config/property_description_short.yaml
  • Example: "x-f5xc-description-medium": "HTTP/HTTPS load balancer with advanced routing, WAF, and TLS."
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Descripción larga del dominio (~500 caracteres).
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/utils/description_enricher.py
  • Driven by config: config/domain_descriptions.yaml
  • Example: "x-f5xc-description-long": "Full paragraph describing the domain..."
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Nivel de complejidad relativa para la creación de configuraciones en este dominio.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string", "enum": ["low", "medium", "high"]}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-complexity": "medium"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Nivel mínimo de suscripción de F5 XC requerido.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-requires-tier": "enterprise"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Marca un dominio como característica de vista previa / beta.
  • Consumers: multiple
  • Value type: boolean
  • Value schema: {"type": "boolean"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-is-preview": false
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Casos de uso con nombre que admite este dominio.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-use-cases": ["tls-termination", "waf"]
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Identificador de icono para usar al renderizar este dominio en una interfaz de usuario.
  • Consumers: Web UI
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-icon": "f5xc:load-balancer"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: SVG en línea (o ruta) para un logotipo de marca que representa el dominio.
  • Consumers: Web UI
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-logo-svg": "<svg>...</svg>"
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Vínculos cruzados hacia otros dominios comúnmente utilizados junto con este.
  • Consumers: multiple
  • Value type: array
  • Value schema: {"type": "array", "items": {"type": "string"}}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-related-domains": ["origin_pool", "tls_certificate"]
  • Pass-through from upstream: no
  • Applied at: info
  • Purpose: Sección de documentación / slug de agrupación de navegación para la documentación renderizada.
  • Consumers: multiple
  • Value type: string
  • Value schema: {"type": "string"}
  • Injected by: scripts/merge_specs.py
  • Driven by config: config/domain_patterns.yaml
  • Example: "x-f5xc-doc-section": "load-balancing"
  • Pass-through from upstream: no
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: "x-ves-proto-package": "ves.io.schema.virtual_host"
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: "x-ves-proto-file": "ves.io/schema/virtual_host/types.proto"
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: "x-ves-proto-message": "ves.io.schema.virtual_host.CreateSpecType"
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: "x-ves-proto-service": "ves.io.schema.virtual_host.API"
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: "x-ves-proto-rpc": "ves.io.schema.api_sec.api_crawler.API.Create"
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: "x-displayname": "Namespace"
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: Consulte la documentación upstream de F5.
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: Consulte la documentación upstream de F5.
  • Pass-through from upstream: yes
  • Applied at: upstream
  • Purpose: Preservado sin cambios desde la especificación upstream de F5.
  • Consumers: N/A
  • Value type: varies
  • Value schema: N/A
  • Injected by: upstream
  • Driven by config: upstream
  • Example: Consulte la documentación upstream de F5.
  • Pass-through from upstream: yes