KEP-2887: Enum Types for OpenAPI #2888

jiahuif · 2021-08-20T22:42:35Z

One-line PR description: This PR creates design for KEP-2887

Issue link: OpenAPI Enum Types #2887

Other comments:

/label tide/merge-method-squash

jiahuif · 2021-09-02T21:54:30Z

/assign @jpbetz @apelisse

Could you take a look?

jiahuif · 2021-09-02T21:58:20Z

/assign @deads2k

For PRR.

jpbetz

One minor comment. Looks good to me otherwise.
(disclaimer: I've seen a preview of this, so already got a chance to provide some feedback).

keps/sig-api-machinery/2887-openapi-enum-types/README.md

jpbetz · 2021-09-08T20:18:07Z

/lgtm
(disclaimer: I've reviewed this in it's pre-KEP format a couple times so already had the opportunity to give feedback)

Co-authored-by: Daniel Smith <dbsmith@google.com>

deads2k · 2021-09-09T20:08:56Z

The approach suggested here that allows for improving openapi v2 suggests to me that this could be delivered separately of the main openapi v3. The PRR and pruning approach look reasonable.

/approve

I think @lavalamp has the last remaining comments.
/assign @lavalamp

apelisse · 2021-09-09T20:01:39Z

keps/prod-readiness/sig-api-machinery/2887.yaml

@@ -0,0 +1,3 @@
+kep-number: 2887
+alpha:
+  approver: "@deads2k"


How come you're missing so many fields here?

That's the PRR, scroll down a bit for the main KEP YAML.

apelisse · 2021-09-09T20:05:29Z

keps/sig-api-machinery/2887-openapi-enum-types/README.md

+- Add a marker that indicates a field as an enum.
+- Make the Kubernetes OpenAPI generator recognize the marker.
+- Deduce values of an enum type from its Go type definition.
+- Detect and annotate enum types in all built-in types. 


is this a one time thing? We'll use a one time script to annotation to all types once, review the PR and then forget about the script?

There is the "linter" thing that is also under discussion. The plan is to run the linter for the first time expecting tons of warnings, then check each to see if it is right or false positive. Afterwards, it checks for enums in new types.

keps/sig-api-machinery/2887-openapi-enum-types/README.md

apelisse · 2021-09-09T20:07:09Z

keps/sig-api-machinery/2887-openapi-enum-types/README.md

+When generating OpenAPI schema, the de facto enum types should be reflected as enums in the resulting schema.
+
+We define enum types with following properties:
+- All enum types are closed, i.e., the type includes a finite number of possible values.


They are closed from a server-side perspective (server won't allow any unknown value). Clients, for backwards compatibility reasons, should consider it open (new values are possible).

keps/sig-api-machinery/2887-openapi-enum-types/README.md

lavalamp · 2021-09-09T20:17:47Z

/lgtm
/approve
/hold

Hold for minor language tweaks, lgtm because I'll be afk for a few hours and don't want to hold anything up.

k8s-ci-robot · 2021-09-09T20:18:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deads2k, jiahuif, 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:

~~keps/prod-readiness/OWNERS~~ [deads2k]
~~keps/sig-api-machinery/OWNERS~~ [deads2k,lavalamp]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Co-authored-by: Daniel Smith <dbsmith@google.com>

may add it back later.

jpbetz · 2021-09-09T21:52:37Z

/lgtm

jiahuif · 2021-09-09T22:32:50Z

/hold cancel

For having got approval from all requested reviewers.

* [PRR] KEP-2887 Enum Type for OpenAPI * KEP-2887: OpenAPI Enum Types * annotation -> marker * reword value auto-detection. * kube-builder syntax compatibility. * re-target to OpenAPI v2. * field pruning for disabling this feature. * goal: unify with kubebuilder. * Update keps/sig-api-machinery/2887-openapi-enum-types/README.md Co-authored-by: Daniel Smith <dbsmith@google.com> * rewrite non-goals. * Update keps/sig-api-machinery/2887-openapi-enum-types/README.md Co-authored-by: Daniel Smith <dbsmith@google.com> * reword enum field pruning. * preprocessor for these don't want enums. * update TOC. * Update keps/sig-api-machinery/2887-openapi-enum-types/README.md Co-authored-by: Daniel Smith <dbsmith@google.com> * polish assumptions on impl. * Update keps/sig-api-machinery/2887-openapi-enum-types/README.md Co-authored-by: Daniel Smith <dbsmith@google.com> * reword non-goal * allow client open enum. * omit the enum linter. may add it back later. * update TOC. Co-authored-by: Daniel Smith <dbsmith@google.com>

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory labels Aug 20, 2021

k8s-ci-robot requested review from deads2k and lavalamp August 20, 2021 22:42

k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 20, 2021

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch 2 times, most recently from cc9d300 to 377b574 Compare September 2, 2021 21:49

jiahuif changed the title ~~[WIP] KEP-2887 Enum Types for OpenAPI~~ KEP-2887 Enum Types for OpenAPI Sep 2, 2021

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 2, 2021

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch from 377b574 to 260d1ec Compare September 2, 2021 21:51

jiahuif changed the title ~~KEP-2887 Enum Types for OpenAPI~~ KEP-2887: Enum Types for OpenAPI Sep 2, 2021

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch from 260d1ec to 3d73130 Compare September 2, 2021 21:53

k8s-ci-robot assigned apelisse and jpbetz Sep 2, 2021

k8s-ci-robot assigned deads2k Sep 2, 2021

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch from 3d73130 to 2eeafee Compare September 2, 2021 22:23

jpbetz reviewed Sep 3, 2021

View reviewed changes

keps/sig-api-machinery/2887-openapi-enum-types/README.md Outdated Show resolved Hide resolved

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch from 2eeafee to c7dc0ff Compare September 8, 2021 18:39

[PRR] KEP-2887 Enum Type for OpenAPI

43003e9

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch from c7dc0ff to 9e09352 Compare September 8, 2021 18:47

deads2k reviewed Sep 8, 2021

View reviewed changes

keps/sig-api-machinery/2887-openapi-enum-types/README.md Outdated Show resolved Hide resolved

deads2k reviewed Sep 8, 2021

View reviewed changes

keps/sig-api-machinery/2887-openapi-enum-types/README.md Show resolved Hide resolved

jiahuif force-pushed the kep/2887-enum-types-for-openapi branch 3 times, most recently from 61fe574 to 747dee2 Compare September 8, 2021 20:02

jiahuif and others added 3 commits September 9, 2021 12:46

Update keps/sig-api-machinery/2887-openapi-enum-types/README.md

17e8a14

Co-authored-by: Daniel Smith <dbsmith@google.com>

reword enum field pruning.

2098a63

preprocessor for these don't want enums.

e719529

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 9, 2021

update TOC.

e623d9a

apelisse reviewed Sep 9, 2021

View reviewed changes

lavalamp reviewed Sep 9, 2021

View reviewed changes

keps/sig-api-machinery/2887-openapi-enum-types/README.md Outdated Show resolved Hide resolved

lavalamp reviewed Sep 9, 2021

View reviewed changes

keps/sig-api-machinery/2887-openapi-enum-types/README.md Outdated Show resolved Hide resolved

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Sep 9, 2021

Update keps/sig-api-machinery/2887-openapi-enum-types/README.md

4147afd

Co-authored-by: Daniel Smith <dbsmith@google.com>

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 9, 2021

jiahuif and others added 6 commits September 9, 2021 13:19

polish assumptions on impl.

13d333c

Update keps/sig-api-machinery/2887-openapi-enum-types/README.md

8766cb0

Co-authored-by: Daniel Smith <dbsmith@google.com>

reword non-goal

87e595a

allow client open enum.

4a92239

omit the enum linter.

de12299

may add it back later.

update TOC.

348c8e8

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 9, 2021

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 9, 2021

k8s-ci-robot merged commit bc9d6c9 into kubernetes:master Sep 9, 2021

k8s-ci-robot added this to the v1.23 milestone Sep 9, 2021

palnabarun mentioned this pull request Jun 12, 2022

canonical kep number json field palnabarun/enhancements#1

Closed

palnabarun mentioned this pull request Jul 26, 2022

KEP Manifest Generator palnabarun/enhancements#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

KEP-2887: Enum Types for OpenAPI #2888

KEP-2887: Enum Types for OpenAPI #2888

jiahuif commented Aug 20, 2021 •

edited

Loading

jiahuif commented Sep 2, 2021

jiahuif commented Sep 2, 2021

jpbetz left a comment

jpbetz commented Sep 8, 2021

deads2k commented Sep 9, 2021

apelisse Sep 9, 2021

jiahuif Sep 9, 2021

apelisse Sep 9, 2021

jiahuif Sep 9, 2021

apelisse Sep 9, 2021

lavalamp commented Sep 9, 2021

k8s-ci-robot commented Sep 9, 2021

jpbetz commented Sep 9, 2021

jiahuif commented Sep 9, 2021

KEP-2887: Enum Types for OpenAPI #2888

KEP-2887: Enum Types for OpenAPI #2888

Conversation

jiahuif commented Aug 20, 2021 • edited Loading

jiahuif commented Sep 2, 2021

jiahuif commented Sep 2, 2021

jpbetz left a comment

Choose a reason for hiding this comment

jpbetz commented Sep 8, 2021

deads2k commented Sep 9, 2021

apelisse Sep 9, 2021

Choose a reason for hiding this comment

jiahuif Sep 9, 2021

Choose a reason for hiding this comment

apelisse Sep 9, 2021

Choose a reason for hiding this comment

jiahuif Sep 9, 2021

Choose a reason for hiding this comment

apelisse Sep 9, 2021

Choose a reason for hiding this comment

lavalamp commented Sep 9, 2021

k8s-ci-robot commented Sep 9, 2021

jpbetz commented Sep 9, 2021

jiahuif commented Sep 9, 2021

jiahuif commented Aug 20, 2021 •

edited

Loading