Skip to content

Conversation

@tnozicka
Copy link

This PR adds extra enum description in the openapi when wrapped within a slice. The listed enum values in the descriptions are the way that our website reference uses to present enums. (The api reference generator unfortunately can't read the Enum property.)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 23, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 23, 2025
@tnozicka tnozicka force-pushed the openapi-slice-enums branch from 75a0c13 to bf9229c Compare October 23, 2025 16:26
@tnozicka tnozicka changed the title Include description for allowed enum values for elements within a slice [WIP] Include description for allowed enum values for elements within a slice Oct 23, 2025
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 23, 2025
@tnozicka tnozicka force-pushed the openapi-slice-enums branch from bf9229c to e7dcd5b Compare October 23, 2025 16:42
@tnozicka tnozicka changed the title [WIP] Include description for allowed enum values for elements within a slice Include description for allowed enum values for elements within a slice Oct 23, 2025
@k8s-ci-robot 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 Oct 23, 2025
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. 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.

2 participants