Skip to content
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

api: fix ValidatingAdmissionPolicyList json tag #124568

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

Conversation

xyz-li
Copy link
Contributor

@xyz-li xyz-li commented Apr 26, 2024

What type of PR is this?

/kind bug

What this PR does / why we need it:

Change the output when validatingadmissionpolicies is empty.
kubectl get --raw /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies

{
  "kind": "ValidatingAdmissionPolicyList",
  "apiVersion": "admissionregistration.k8s.io/v1",
  "metadata": {
    "resourceVersion": "30603"
  }
}

kubectl get --raw /api/v1/nodes

{
  "kind": "NodeList",
  "apiVersion": "v1",
  "metadata": {
    "resourceVersion": "30721"
  },
  "items": []
}

Which issue(s) this PR fixes:

Fixes #1593

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Fixed a bug in the API server where empty collections of ValidatingAdmissionPolicies did not have an `items` field.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. 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. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. 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 Apr 26, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @xyz-li. 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/test-infra repository.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: xyz-li
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. For more information see the Kubernetes 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 the kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API label Apr 26, 2024
@xyz-li
Copy link
Contributor Author

xyz-li commented Apr 26, 2024

/sig api-machinery

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Apr 26, 2024
@xyz-li
Copy link
Contributor Author

xyz-li commented Apr 26, 2024

If there is no item fields, kubectl won't treat the response as a list. Then the output is wrong.

@xyz-li
Copy link
Contributor Author

xyz-li commented Apr 26, 2024

/cc @cici37

@sftim
Copy link
Contributor

sftim commented Apr 26, 2024

Changelog suggestion

-This change make api-server not omity the field `item` of ValidatingAdmissionPolicyList when ValidatingAdmissionPolicy is empty.
+Fixed a bug in the API server where empty collections of ValidatingAdmissionPolicies did not have an `items` field.

@sftim
Copy link
Contributor

sftim commented Apr 26, 2024

BTW, the response to a list is formally a collection.

@k8s-triage-robot
Copy link

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

This change make api-server not omity the field `item` of
ValidatingAdmissionPolicyList when ValidatingAdmissionPolicy is empty.
So kubetl will print ValidatingAdmissionPolicyList correctly when ValidatingAdmissionPolicy is empty.

Signed-off-by: xyz-li <hui0787411@163.com>
@cici37
Copy link
Contributor

cici37 commented Apr 30, 2024

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/bug Categorizes issue or PR as related to a bug. 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. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

kubectl returns kind: ValidatingAdmissionPolicyList for empty list of policies
5 participants