-
Notifications
You must be signed in to change notification settings - Fork 40.7k
docs: Add x-kubernetes list/map/unions docs #132085
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
docs: Add documentation for x-kubernetes-list-type, x-kubernetes-list-map-keys, and x-kubernetes-unions - Documented purpose and usage of these Kubernetes OpenAPI extensions - Included YAML examples for each extension - Added a sample CRD demonstrating all three extensions together - Provided usage instructions and notes for contributors This improves clarity for users defining CRDs and helps contributors understand these extensions better.
The committers listed above are authorized under a signed CLA. |
Welcome @Gourang12332! |
This issue is currently awaiting triage. If a SIG or subproject determines this is a relevant issue, they will accept it by applying the The Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Hi @Gourang12332. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Gourang12332 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Hi @saad-ali Sir, |
Hi maintainers, Could someone please help tag this PR to the appropriate SIG for review and approval? Thank you! |
/retest |
@Gourang12332: Cannot trigger testing until a trusted user reviews the PR and leaves an In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Hello @sttts Sir, This is my first PR to Kubernetes. Could you or any other reviewer, please take a look and, if appropriate, add |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds detailed documentation for the Kubernetes OpenAPI extensions:
x-kubernetes-list-type
x-kubernetes-list-map-keys
x-kubernetes-unions
This improves clarity for CRD authors on how to use these extensions, including YAML examples, usage instructions, and a sample CRD demonstrating all three extensions together.
Which issue(s) this PR fixes:
Fixes #131724
Special notes for your reviewer:
N/A
Does this PR introduce a user-facing change?
NONE
Additional documentation e.g., KEPs, usage docs, etc.:
N/A