OpenAPI Enum Types

[jiahuif]

Enhancement Description

• One-line enhancement description (can be used as a release note): Detect enum types in resource types, and generate enum definition in OpenAPI spec. This feature optionally depends on OpenAPI v3 #2896 , and should remain compatible with it.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/2887-openapi-enum-types/README.md
• Discussion Link:
• Primary contact (assignee): @jiahuif
• Responsible SIGs: api-machinery
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.23
  • Beta release target (x.y): 1.24
  • Stable release target (x.y):
• Alpha
  • KEP (k/enhancements) update PR(s): KEP-2887: Enum Types for OpenAPI #2888
  • Code (k/k) update PR(s):
    • Enum type generator kube-openapi#242
    • Add Support for OpenAPIEnum in OpenAPI v2 kubernetes#105057
    • add feature gate for OpenAPIEnums. kubernetes#105054
  • Docs (k/website) update PR(s): None needed. The documentation of this feature will be auto-generated from OpenAPI Spec.

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[mysunshine92]

/sig api-machinery

[Priyankasaggu11929]

/milestone v1.23

[k8s-ci-robot]

@Priyankasaggu11929: The provided milestone is not valid for this repository. Milestones in this repository: [keps-beta, keps-ga, v1.17, v1.18, v1.19, v1.20, v1.21, v1.22, v1.23, v1.24, v1.25, v1.26]

Use /milestone clear to clear the milestone.

In response to this:

/milestone 1.23

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.

[Priyankasaggu11929]

/milestone v1.23

[Priyankasaggu11929]

Hello @jiahuif! 1.23 Enhancements team here. Just checking in as we approach enhancements freeze on Today 09/09/2021 23:59 PT. Here's where this enhancement currently stands:

• KEP file using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable
• KEP has a test plan section filled out.
• KEP has up to date graduation criteria.
• KEP has a production readiness review that has been completed and merged into k/enhancements.

Looks like for this one, we would just require getting this PR #2888 merged.

Thanks!

[jiahuif]

@Priyankasaggu11929 #2888 merged, should be good to go.

[Priyankasaggu11929]

Thank you so much @jiahuif. With the KEP PR merged, this enhancement is ready for the 1.23 enhancements freeze.

[mehabhalodiya]

Hi @jiahuif 👋 1.23 Docs shadow here.

This enhancement is marked as 'Needs Docs' for the 1.23 release.

Please follow the steps detailed in the documentation to open a PR against the dev-1.23 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thu November 18, 11:59 PM PDT.

Also, if needed take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thanks!

[Priyankasaggu11929]

Hello @jiahuif 👋

Checking in once more as we approach 1.23 code freeze at 6:00 pm PST on Tuesday, November 16.

Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.
• Have a documentation placeholder PR open by Thursday, November 18.

As always, we are here to help should questions come up.

Thank you so much! 🙂

[Priyankasaggu11929]

Hello @jiahuif, just want to confirm on whether the following 2 PRs are also part of the implementation of this enhancements?

• Add Support for OpenAPIEnum in OpenAPI v2 kubernetes#105057
• add feature gate for OpenAPIEnums. kubernetes#105054

If yes, could you please add that in the issue description itself, it would be helpful for tracking. Thank you so much!

[Priyankasaggu11929]

Hello @jiahuif 👋, 1.24 Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00pm PT on Thursday Feb 3rd, 2022.

For note, this enhancement is targeting for stage beta for 1.24 (correct me, if otherwise)

Here’s where this enhancement currently stands:

• Updated KEP file using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for this release
• KEP has a test plan section filled out.
• KEP has up to date graduation criteria.
• KEP has a production readiness review that has been completed and merged into k/enhancements.

Looks like, for this one, we would require updating the open KEP PR #3184 & having it merged into k/enhancements, to satisfy all above requirements:

• update the existing kep.yaml to reflect the latest-milestone & stage.

For note, the status of this enhancement is marked as at risk. Please keep the issue description up-to-date with appropriate stages as well. Thank you so much! 🙂

[Priyankasaggu11929]

With KEP PR #3184 merged now, this enhancement is ready for 1.24 enhancements freeze! 🚀

For note, the status is tracked now in the 1.24 tracking sheet. Thank you!

[mehabhalodiya]

Hi @jiahuif 👋🏻 1.24 Docs shadow here.

This enhancement is marked as 'Needs Docs' for the 1.24 release.

Please follow the steps detailed in the documentation to open a PR against the dev-1.24 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thu March 31, 11:59 PM PDT.

Also, if needed take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thanks!

[Priyankasaggu11929]

Hello @jiahuif 👋

I'm just checking in once more as we approach the 1.24 Code Freeze on 18:00 PDT, Tuesday, March 29th 2022

Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are merged by the code freeze deadline.
• Have a documentation placeholder PR open by Thursday, March 31, 2022.

For note, the status of this enhancement is currently marked as at risk.

Could you please link any recent PRs for the enhancements in the issue description (if any)? I wasn't able to identify any related PRs on the Kubernetes/Kubernetes repository, other than the following two (could you also please confirm if they're part of implementation?). Thank you so much!

• remove enum markers on types without validation  kubernetes#108639

[Priyankasaggu11929]

@jiahuif, with the following code implementation k/k PRs merged now, the requirements for 1.24 code freeze are met.

• Graduate OpenAPI Enums to beta kubernetes#108898
• remove enum markers on types without validation  kubernetes#108639

For note, the status of this enhancement is now tracked. Thank you!

[jiahuif]

This feature needs no documentation updates. Could you remove it from "documentation needed" list?

Thank you!

[tengqm]

Docs update PR created.

[liggitt]

I opened kubernetes/kubernetes#109177 to track an issue with forward-compatibility of generated clients using language-level enums.

[Priyankasaggu11929]

/milestone clear

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

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.

[jiahuif]

/reopen

[k8s-ci-robot]

@jiahuif: Reopened this issue.

In response to this:

/reopen

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.

[NissesSenap]

Perhaps wrong, but in a way isn't this solved with the CEL addition to OpenAPI.
Sure, not as easy as adding an enum, but the functionality should be there.

[liangyuanpeng]

/lifecycle frozen