fix: do not strip essential fields #6008
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Avoid stripping away the "description" field that collided with kubebuilder's appended "description" metadata field while generating the CRD schema. Fixes: prometheus-operator#5129 Signed-off-by: Pranshu Srivastava <rexagod@gmail.com>
xiu
approved these changes
Oct 15, 2023
There was a problem hiding this comment.
LGTM, I see the field in pagerdutyConfigs and opsgenieConfigs.
❯ diff -u stripped-down-crds.yaml stripped-down-crds.yaml-new
--- stripped-down-crds.yaml 2023-10-15 08:32:45
+++ stripped-down-crds.yaml-new 2023-10-15 08:32:31
@@ -505,6 +505,8 @@
- key
type: object
apiURL:
+ type: string
+ description:
type: string
details:
items:
@@ -761,6 +763,8 @@
clientURL:
type: string
component:
+ type: string
+ description:
type: string
details:
items:
Thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Avoid stripping away the "description" field that collided with kubebuilder's appended "description" metadata field while generating the CRD schema.
Fixes: #5129
Type of change
What type of changes does your code introduce to the Prometheus operator? Put an
xin the box that apply.CHANGE(fix or feature that would cause existing functionality to not work as expected)FEATURE(non-breaking change which adds functionality)BUGFIX(non-breaking change which fixes an issue)ENHANCEMENT(non-breaking change which improves existing functionality)NONE(if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)