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

Fix raw extension openapi definition #80773

Merged
merged 2 commits into from Aug 23, 2019

Conversation

jennybuckley
Copy link

@jennybuckley jennybuckley commented Jul 30, 2019

What type of PR is this?
/kind bug
/sig api-machinery
/priority important-longterm

What this PR does / why we need it:
Changes the definition of RawExtension to this (adding json:"-")

type RawExtension struct {
    ...
    Raw []byte `json:"-" protobuf:"bytes,1,opt,name=raw"`
    ...
}

I noticed that this removes Raw from the openapi defintion of it, making it just type: object, without changing how it is marshalled or unmarshalled (since we have custom functions for that). This fixes a known issue with the client side validation of RawExtension

Which issue(s) this PR fixes:
Fixes #55890

Does this PR introduce a user-facing change?:

Fixed a bug with the openAPI definition for io.k8s.apimachinery.pkg.runtime.RawExtension, which previously required a field "raw" to be specified

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 30, 2019
@jennybuckley
Copy link
Author

/retest

@jennybuckley
Copy link
Author

/assign @roycaihw

@jennybuckley
Copy link
Author

/retest

2 similar comments
@jennybuckley
Copy link
Author

/retest

@jennybuckley
Copy link
Author

/retest

@roycaihw
Copy link
Member

roycaihw commented Aug 1, 2019

/lgtm

This doesn't introduce any user-facing change in apiserver handling a request (besides the openapi spec itself is visible to user), but it will cause a few client-side change that are user-facing (kubectl and the openapi-generated clients won't require raw in a field of RawExtension type and/or error on unknown fields). Could you add a release note mentioning that the spec is fixed?

also please squash the first and the third commits

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Aug 1, 2019
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 1, 2019
@jennybuckley
Copy link
Author

/retest
@roycaihw I think this is ready now

@lavalamp
Copy link
Member

nice find

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jennybuckley, lavalamp

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 22, 2019
@roycaihw
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 22, 2019
@k8s-ci-robot k8s-ci-robot merged commit 3dbedef into kubernetes:master Aug 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/code-generation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Openapi generator and the RawExtension type
4 participants