This repository has been archived by the owner on Apr 26, 2021. It is now read-only.
Fix yaml annotations for embedded type #33
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
owen-d
reviewed
Mar 19, 2021
| @@ -184,7 +184,7 @@ type GettableUserConfig struct { | |||
| AlertmanagerConfig GettableApiAlertingConfig `yaml:"alertmanager_config" json:"alertmanager_config"` | |||
| } | |||
| type GettableApiAlertingConfig struct { | |||
| config.Config | |||
| Config `yaml:",inline"` | |||
There was a problem hiding this comment.
This looks fine, but you can still leave the config object as an embedded struct if you like, exactly like how we do in:
type ExtendedRuleNode struct {
// note: this works with yaml v3 but not v2 (the inline tag isn't accepted on pointers in v2)
*ApiRuleNode `yaml:",inline"`
//GrafanaManagedAlert yaml.Node `yaml:"grafana_alert,omitempty"`
GrafanaManagedAlert *ExtendedUpsertAlertDefinitionCommand `yaml:"grafana_alert,omitempty" json:"grafana_alert,omitempty"`
}| @@ -241,8 +241,17 @@ func (c *GettableApiAlertingConfig) Type() (backend Backend) { | |||
| return | |||
| } | |||
|
|
|||
| // Config is the top-level configuration for Alertmanager's config files. | |||
There was a problem hiding this comment.
Why do we need to copy this struct over? Can't we continue to reference it as config.Config?
There was a problem hiding this comment.
The difference is the yaml:"-" tag for the Receivers field because otherwise it conflicts with the Receivers field of the PostableApiAlertingConfig struct.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is required because we have to store (in the DB) the alert manager configuration in YAML.