feat(dashboards): deprecate Dynamic widget interpretation field#656
Open
lavrov wants to merge 1 commit into
Open
feat(dashboards): deprecate Dynamic widget interpretation field#656lavrov wants to merge 1 commit into
lavrov wants to merge 1 commit into
Conversation
Contributor
|
The latest Buf updates on your PR. Results from workflow [Protobuf] Lint & Build Facade / protobuf_lint_and_build (pull_request).
|
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
Mark the interpretation field on the Dynamic widget as deprecated in the protobuf definition. The visualization field is the supported replacement going forward. Related to CX-48065.
lavrov
force-pushed
the
deprecate-dynamic-widget-interpretation
branch
from
bfa2848 to
d12de17
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
User description
Summary
Marks the
interpretationfield on the Dynamic widget (dashboards API) as deprecated. Consumers should use thevisualizationfield instead, which is the supported replacement going forward.This is an iteration that lands separately while being related to (but not directly part of) CX-48065.
Changes
proto/com/coralogixapis/dashboards/v1/ast/widgets/dynamic.proto: adddeprecated = trueto theinterpretationfield and update its description to point tovisualization.go/internal/coralogixapis/dashboards/v1/ast/widgets/dynamic.pb.go: regenerated so the field declaration andGetInterpretationgetter carry the// Deprecated: Marked as deprecated in ...comment, matching the existing pattern used for the deprecatedqueryfield.interpretationasdeprecated: truewith an updated description:openapi.yamlspecs/dashboard_service.jsontools/openapi-split/openapi.yamlgo/openapi/gen/dashboard_service/api/openapi.yamlgo/openapi/gen/dashboard_service/model_widgets_dynamic.go: added// Deprecateddoc comments on the field and its accessors (GetInterpretation,GetInterpretationOk,HasInterpretation,SetInterpretation), mirroring the openapi-generator pattern used for other deprecated fields (e.g.TextboxDefaultValueSingleNumeric).Verification
go build ./...passes.go vet ./...passes.protoc-gen-go v1.36.11(matching the version already checked into the repo) to keep the diff minimal.Related Jira: CX-48065
EOF 2>&1 | tail -10
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Mark the Dynamic widget
interpretationfield as deprecated in the dashboard AST proto and highlightvisualizationas the preferred replacement. Regenerate the associated OpenAPI sources and Go models so consumers see the deprecation reflected in clients and docs.Latest Contributors(0)