Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
Loading
from
Open

docs: Add x-kubernetes list/map/unions docs #132085

wants to merge 1 commit into from
+142 −0

Conversation

Gourang12332
Copy link

@Gourang12332 Gourang12332 commented Jun 4, 2025 •
edited
Loading

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

 ```release-note NONE ```

@Gourang12332
Update README.md
e92f57d 
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.
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jun 4, 2025
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jun 4, 2025 •
edited
Loading

CLA Signed


The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 4, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @Gourang12332!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 4, 2025
@k8s-ci-robot k8s-ci-robot requested review from saad-ali and sttts June 4, 2025 04:05
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Gourang12332
Once this PR has been reviewed and has the lgtm label, please assign msau42 for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 4, 2025
@Gourang12332
Copy link
Author

Hi @saad-ali Sir,
I have signed the CLA and added the required release note block. The PR is ready for review again. Please let me know if you can add /ok-to-test it. Thanks!

@Gourang12332
Copy link
Author

Hi maintainers,

Could someone please help tag this PR to the appropriate SIG for review and approval?

Thank you!

@Gourang12332
Copy link
Author

/retest

@k8s-ci-robot
Copy link
Contributor

@Gourang12332: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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.

@Gourang12332
Copy link
Author

Hello @sttts Sir,

This is my first PR to Kubernetes. Could you or any other reviewer, please take a look and, if appropriate, add /ok-to-test to trigger CI?
Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saad-ali saad-ali Awaiting requested review from saad-ali

@sttts sttts Awaiting requested review from sttts

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add missing docs for x-kubernetes openapi fields
2 participants
@Gourang12332 @k8s-ci-robot
Morty Proxy This is a proxified and sanitized view of the page, visit original site.