You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: wg-api-expression/charter.md
+5-16Lines changed: 5 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,13 +39,15 @@ The working group will deliver:
39
39
-**Kube API Linter (KAL)**: Automated API convention checker integrated into the review process
40
40
-**Integration strategy**: Cohesive approach for integrating validation-gen, kubebuilder, KAL, and other tools
41
41
-**KEPs**: Series of enhancement proposals introducing and evolving the framework
42
-
-**CRD equivalence strategy**: Plan to bridge the gap between native types and CRDs
43
-
-**Documentation generation strategy**: Automated documentation from declarative API expressions
42
+
-**Native Type and CRD Validation Parity**: Bridge the gap between how validation is implemented for native Kubernetes types and CRDs to unify the developer experience and improve APIs. This strategy includes:
43
+
- Establishing a declarative source of truth (e.g., Go struct tags) for validation rules that can generate the validation methods needed for native types and the OpenAPI/CEL rules used by CRDs.
44
+
- Enable easier inheritance of validation logic when a CRD embeds a native type. For example, a CRD that includes a `corev1.PodSpec` should allow reuse of `PodSpec`'s validation.
45
+
-**Automated API Reference Documentation**: A strategy and tooling to automatically generate documentation for validation rules directly from the declarative tags in the Go API types. The goal is to enhance Kubernetes API reference docs by ensuring they are synchronized with the validation logic enforced by the API server.
44
46
-**Migration guides**: Documentation for SIGs to adopt the framework and migrate existing APIs
45
47
46
48
## Stakeholders
47
49
48
-
-**SIG API Machinery**: Owner of API server, gengo, kube-openapi, and validation-gen tool
50
+
-**SIG API Machinery**: Owner of API server, gengo, kube-openapi, kube-api-linter, and validation-gen tool
49
51
-**SIG Architecture**: Owner of Kubernetes API conventions and architectural decisions
50
52
-**SIG CLI**: Consumer of more expressive APIs, providing feedback on kubectl interaction and user experience
51
53
@@ -54,19 +56,6 @@ The working group will deliver:
54
56
This sig adheres to the Roles and Organization Management outlined in [sig-governance]
55
57
and opts-in to updates and modifications to [sig-governance].
0 commit comments