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 missing docs for x-kubernetes openapi fields #131737

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 2 commits into
base: master
Choose a base branch
Loading
from
Open

docs: add missing docs for x-kubernetes openapi fields #131737

wants to merge 2 commits into from
+117 −0

Conversation

Whitea029
Copy link

What type of PR is this?

/kind documentation

Which issue(s) this PR fixes:

Fixes #131724

@k8s-ci-robot
Copy link
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

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 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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 13, 2025
@k8s-ci-robot k8s-ci-robot requested review from sttts and yujuhong May 13, 2025 08:17
@k8s-ci-robot k8s-ci-robot added the do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label May 13, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @Whitea029!

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 k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 13, 2025
@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 @Whitea029. 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-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. labels May 13, 2025
singh1203
singh1203 suggested changes May 13, 2025
View reviewed changes
Copy link

@singh1203 singh1203 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am new to this stuff, but as per my learning, here is a review:
Some JSON examples have formatting issues (e.g., \n, inconsistent indentation) — maybe a quick lookup

singh1203
singh1203 suggested changes May 13, 2025
View reviewed changes
api/openapi-spec/README.md Outdated Show resolved Hide resolved
api/openapi-spec/README.md Outdated Show resolved Hide resolved
api/openapi-spec/README.md Outdated Show resolved Hide resolved
api/openapi-spec/README.md Outdated Show resolved Hide resolved
@Whitea029 Whitea029 requested a review from singh1203 May 13, 2025 10:57
chansuke
chansuke reviewed May 13, 2025
View reviewed changes
api/openapi-spec/README.md
Annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:

- `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps.
- `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.
- `atomic`: the map is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.

should be map?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not very familiar with this repository, and the main reference here is https://github.com/kubernetes/kubernetes/blob/fbd474a28611522de1493a90bd2b8e5a74f28058/api/openapi-spec/v3/apis__apiextensions.k8s.io__v1_openapi.json#L703C1-L706C13

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is correct based on the pointed reference.
@chansuke

@Whitea029 Whitea029 requested a review from chansuke May 14, 2025 00:49
singh1203
singh1203 approved these changes May 14, 2025
View reviewed changes
Copy link

@singh1203 singh1203 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as of now!
Thank you.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: singh1203, Whitea029
Once this PR has been reviewed and has the lgtm label, please assign thockin 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

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

@singh1203 singh1203 singh1203 approved these changes

@sttts sttts Awaiting requested review from sttts

@yujuhong yujuhong Awaiting requested review from yujuhong

@chansuke chansuke Awaiting requested review from chansuke

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. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. 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. 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
4 participants
@Whitea029 @k8s-ci-robot @chansuke @singh1203
Morty Proxy This is a proxified and sanitized view of the page, visit original site.