Validierungsspezifikation

Dieses Dokument beschreibt die Struktur und den Inhalt der Validierungsspezifikation, die vom Projekt api-specs-enriched veröffentlicht wird.

Übersicht

Die Validierungsspezifikation fasst API-Validierungseinschränkungen, Standardwerte und Konfigurationsmetadaten in einer einzigen JSON-Datei zusammen. Diese Spezifikation wird aus den erweiterten OpenAPI-Spezifikationen generiert und zusammen mit diesen veröffentlicht.

Veröffentlichungsort: docs/specifications/api/validation.json

Spezifikationsstruktur

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "version": "2.1.0",
  "generated_at": "2026-01-17T12:00:00Z",
  "source": "api-specs-enriched",

  "required_fields": { ... },
  "enum_values": { ... },
  "constraints": { ... },
  "patterns": [ ... ],
  "conditional_requirements": { ... },
  "minimum_configurations": { ... },
  "defaults": { ... },
  "extensions": { ... }
}

Abschnitte

required_fields

Gibt die für jeden Operationstyp pro Ressource erforderlichen Felder an.

{
  "required_fields": {
    "common": {
      "all_operations": ["metadata.name", "metadata.namespace"]
    },
    "resources": {
      "origin_pool": {
        "create": ["metadata.name", "metadata.namespace", "spec.origin_servers", "spec.port"],
        "update": ["metadata.name", "metadata.namespace"],
        "minimum_config": ["metadata.name", "metadata.namespace", "spec.origin_servers", "spec.port"]
      }
    }
  }
}

enum_values

Definiert zulässige Werte für eingeschränkte Felder.

{
  "enum_values": {
    "loadbalancer_algorithm": {
      "description": "Load balancing algorithm for distributing traffic across origin servers",
      "values": [
        {"value": "ROUND_ROBIN", "description": "Each healthy endpoint selected in round robin order"},
        {"value": "LEAST_REQUEST", "description": "Endpoint with fewest active requests selected"},
        {"value": "RING_HASH", "description": "Consistent hashing using ring hash of endpoint names"},
        {"value": "RANDOM", "description": "Random healthy endpoint selection"},
        {"value": "LB_OVERRIDE", "description": "Hash policy inherited from parent load balancer"}
      ],
      "default": "ROUND_ROBIN"
    }
  }
}

constraints

Typbezogene Validierungsstandards und musterbasierte Regeln.

{
  "constraints": {
    "type_defaults": {
      "string": {"minLength": 0, "maxLength": 1024},
      "integer": {"minimum": 0, "maximum": 2147483647}
    }
  }
}

patterns

Musterbasierte Validierungsregeln für Feldnamen mit Konfidenzwerten.

{
  "patterns": [
    {
      "pattern": "\\bport$",
      "constraints": {"minimum": 1, "maximum": 65535},
      "confidence": 0.99,
      "description": "Valid TCP/UDP port range"
    },
    {
      "pattern": "\\bname$",
      "constraints": {
        "minLength": 1,
        "maxLength": 63,
        "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
      },
      "confidence": 0.90,
      "description": "Kubernetes-style naming convention"
    }
  ]
}

defaults

Alle Standardwerte, geordnet nach Ressourcentyp in einer einheitlichen Struktur.

{
  "defaults": {
    "description": "All default values organized by resource type",
    "resources": {
      "healthcheck": {
        "server_applied": {
          "jitter": 0,
          "jitter_percent": 0
        },
        "recommended": {
          "timeout": 3,
          "interval": 15,
          "unhealthy_threshold": 1,
          "healthy_threshold": 3,
          "jitter_percent": 30
        },
        "oneof_recommended": {
          "health_check": "http_health_check"
        },
        "nested_recommended": {
          "http_health_check": {
            "path": "/",
            "use_http2": false,
            "expected_status_codes": ["200"],
            "use_origin_server_name": {}
          }
        }
      },
      "origin_pool": {
        "server_applied": {
          "no_tls": {},
          "healthcheck": [],
          "loadbalancer_algorithm": "ROUND_ROBIN",
          "endpoint_selection": "DISTRIBUTED"
        },
        "recommended": {
          "port": 443,
          "connection_timeout": 2000,
          "http_idle_timeout": 300000
        },
        "advanced_options": {
          "connection_timeout": 2000,
          "http_idle_timeout": 300000,
          "same_as_endpoint_port": {},
          "default_circuit_breaker": {},
          "disable_outlier_detection": {}
        },
        "oneof_choices": {
          "port_choice": "port",
          "tls_choice": "no_tls",
          "circuit_breaker_choice": "default_circuit_breaker"
        },
        "ui_vs_server": {
          "loadbalancer_algorithm": {
            "ui_default": "LB_OVERRIDE",
            "server_default": "ROUND_ROBIN",
            "note": "UI preselects LB_OVERRIDE but server applies ROUND_ROBIN if omitted"
          }
        }
      },
      "app_firewall": {
        "server_applied": {
          "allow_all_response_codes": {},
          "default_anonymization": {},
          "monitoring": {}
        }
      }
    }
  }
}

Standardwertkategorien

Kategorie	Beschreibung	Quelle
server_applied	Werte, die die API anwendet, wenn Felder weggelassen werden	Live-API-Tests
recommended	Vorausgefüllte Werte der F5 XC Web-Konsole	UI-Analyse
advanced_options	Verschachtelte Standardwerte innerhalb von advanced_options-Objekten	API-Erkennung
oneof_choices	Standard-OneOf-Variantenauswahl	API-Verhalten
oneof_recommended	Empfohlene OneOf-Varianten	Konsolenstandardwerte
nested_recommended	Empfohlene Werte für verschachtelte Schemas	UI-Analyse
ui_vs_server	Fälle, in denen UI-Standardwerte von API-Standardwerten abweichen	Vergleichsanalyse

conditional_requirements

Sich gegenseitig ausschließende Felder und bedingte Abhängigkeiten.

{
  "conditional_requirements": {
    "resources": {
      "healthcheck": {
        "mutually_exclusive": [
          {
            "fields": ["spec.http_health_check", "spec.tcp_health_check", "spec.udp_icmp_health_check"],
            "reason": "Choose exactly one health check type"
          }
        ],
        "conditional": []
      }
    }
  }
}

minimum_configurations

Minimal funktionsfähige Konfigurationen mit funktionierenden Beispielen.

{
  "minimum_configurations": {
    "resources": {
      "origin_pool": {
        "description": "Backend origin servers for load balancing",
        "example": {
          "metadata": {"name": "backend-pool", "namespace": "default"},
          "spec": {
            "origin_servers": [{"public_name": {"dns_name": "backend1.example.com"}}],
            "port": 8080
          }
        }
      }
    }
  }
}

OpenAPI-Erweiterungszuordnung

Die erweiterten OpenAPI-Spezifikationen betten Validierungsmetadaten mithilfe dieser Erweiterungen ein:

Erweiterung	Zweck	Ort
x-f5xc-required-for	Kontextspezifische Pflichtfelder	Schema-Eigenschaften
x-f5xc-server-default	Kennzeichnet serverseitig angewendete Standardwerte	Schema-Eigenschaften
x-f5xc-recommended-value	Empfohlener Standardwert	Schema-Eigenschaften
x-f5xc-recommended-oneof-variant	Empfohlene OneOf-Variante	Schema-Definitionen
x-f5xc-conditions	Bedingte Anforderungen	Schema-Eigenschaften
x-f5xc-minimum-configuration	Mindestkonfigurationsbeispiele	Schema-Definitionen
x-f5xc-validation	Durch Erkennung abgeleitete Einschränkungen	Schema-Eigenschaften

Datenzugriff

Veröffentlichungs-URLs

Quelle	URL
GitHub Pages	https://f5-sales-demo.github.io/api-specs-enriched/specifications/api/validation.json
Raw GitHub	https://raw.githubusercontent.com/f5-sales-demo/api-specs-enriched/main/docs/specifications/api/validation.json

Lokaler Pfad

Nach Ausführung der Pipeline: docs/specifications/api/validation.json

Versionierung

Die Validierungsspezifikation folgt der semantischen Versionierung im Feld version:

Änderungstyp	Versionserhöhung	Beispiel
Grundlegende Strukturänderungen	Major	Feldumbenennungen, entfernte Abschnitte
Neue Validierungsregeln oder Ressourcen	Minor	Neue Ressourcenstandardwerte
Fehlerbehebungen oder Beschreibungsaktualisierungen	Patch	Tippfehlerkorrektur

Abstimmungspriorität

Wenn mehrere Quellen Einschränkungen bereitstellen, gilt folgende Abstimmungspriorität:

1. Bestehend – Einschränkungen in der ursprünglichen OpenAPI-Spezifikation (höchste Priorität)
2. Erkennung – Einschränkungen aus der Live-API-Erkennung
3. Abgeleitet – Einschränkungen aus dem Musterabgleich (niedrigste Priorität)

Verwandte Dokumentation

• Healthcheck-Erweiterungen – Schema-Anreicherungen für Healthchecks
• Ursprungsserver-Pool-Erweiterungen – Schema-Anreicherungen für Ursprungsserver-Pools
• CLAUDE.md – KI-Assistentenanweisungen
• DEVELOPMENT.md – Entwicklerleitfaden

Änderungsprotokoll

Version	Datum	Änderungen
2.1.2	2026-01-18	Neu geschrieben als reine API-Referenz; Kategorien oneof_recommended und nested_recommended hinzugefügt
2.1.0	2026-01-18	Einheitliche Standardwertstruktur ersetzt fragmentierte Abschnitte
2.0.0	2026-01-15	Erste Validierungsspezifikation