Skip to content

Commit 6abd7b0

Browse files
committed
Fix sub fields comments
1 parent f7e615d commit 6abd7b0

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

api/v1/atlasintegration_types.go

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,40 @@ type AtlasThirdPartyIntegrationSpec struct {
5858
// +kubebuilder:validation:Required
5959
Type string `json:"type"`
6060

61+
// Datadog contains the config fields for Datadog's Integration
62+
// +kubebuilder:validation:Optional
6163
Datadog *DatadogIntegration `json:"datadog,omitempty"`
6264

65+
// MicrosoftTeams contains the config fields for Microsoft Teams's Integration
66+
// +kubebuilder:validation:Optional
6367
MicrosoftTeams *MicrosoftTeamsIntegration `json:"microsoftTeams,omitempty"`
6468

69+
// NewRelic contains the config fields for New Relic's Integration
70+
// +kubebuilder:validation:Optional
6571
NewRelic *NewRelicIntegration `json:"newRelic,omitempty"`
6672

73+
// OpsGenie contains the config fields for Ops Genie's Integration
74+
// +kubebuilder:validation:Optional
6775
OpsGenie *OpsGenieIntegration `json:"opsGenie,omitempty"`
6876

77+
// PagerDuty contains the config fields for PagerDuty's Integration
78+
// +kubebuilder:validation:Optional
6979
PagerDuty *PagerDutyIntegration `json:"pagerDuty,omitempty"`
7080

81+
// Prometheus contains the config fields for Prometheus's Integration
82+
// +kubebuilder:validation:Optional
7183
Prometheus *PrometheusIntegration `json:"prometheus,omitempty"`
7284

85+
// Slack contains the config fields for Slack's Integration
86+
// +kubebuilder:validation:Optional
7387
Slack *SlackIntegration `json:"slack,omitempty"`
7488

89+
// VictorOps contains the config fields for VictorOps's Integration
90+
// +kubebuilder:validation:Optional
7591
VictorOps *VictorOpsIntegration `json:"victorOps,omitempty"`
7692

93+
// Webhook contains the config fields for Webhook's Integration
94+
// +kubebuilder:validation:Optional
7795
Webhook *WebhookIntegration `json:"webhook,omitempty"`
7896
}
7997

config/crd/bases/atlas.mongodb.com_atlasthirdpartyintegrations.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ spec:
5454
- name
5555
type: object
5656
datadog:
57+
description: Datadog contains the config fields for Datadog's Integration
5758
properties:
5859
apiKeySecret:
5960
description: APIKeySecret is the name of a secret containing the
@@ -88,6 +89,8 @@ spec:
8889
- id
8990
type: object
9091
microsoftTeams:
92+
description: MicrosoftTeams contains the config fields for Microsoft
93+
Teams's Integration
9194
properties:
9295
apiKeySecret:
9396
description: URLSecret is the name of a secret containing the
@@ -97,6 +100,7 @@ spec:
97100
- apiKeySecret
98101
type: object
99102
newRelic:
103+
description: NewRelic contains the config fields for New Relic's Integration
100104
properties:
101105
credentialsSecret:
102106
description: |-
@@ -107,6 +111,7 @@ spec:
107111
- credentialsSecret
108112
type: object
109113
opsGenie:
114+
description: OpsGenie contains the config fields for Ops Genie's Integration
110115
properties:
111116
apiKeySecret:
112117
description: APIKeySecret is the name of a secret containing Ops
@@ -120,6 +125,8 @@ spec:
120125
- region
121126
type: object
122127
pagerDuty:
128+
description: PagerDuty contains the config fields for PagerDuty's
129+
Integration
123130
properties:
124131
region:
125132
description: Region is the Pager Duty region
@@ -147,6 +154,8 @@ spec:
147154
- name
148155
type: object
149156
prometheus:
157+
description: Prometheus contains the config fields for Prometheus's
158+
Integration
150159
properties:
151160
region:
152161
description: ServiceDiscovery to be used by Prometheus
@@ -168,6 +177,7 @@ spec:
168177
- usernameSecret
169178
type: object
170179
slack:
180+
description: Slack contains the config fields for Slack's Integration
171181
properties:
172182
channelName:
173183
description: ChannelName to be used by Prometheus
@@ -199,6 +209,8 @@ spec:
199209
- WEBHOOK
200210
type: string
201211
victorOps:
212+
description: VictorOps contains the config fields for VictorOps's
213+
Integration
202214
properties:
203215
keySecret:
204216
description: KeysSecret is the name of a secret containing Victor
@@ -208,6 +220,7 @@ spec:
208220
- keySecret
209221
type: object
210222
webhook:
223+
description: Webhook contains the config fields for Webhook's Integration
211224
properties:
212225
keySecret:
213226
description: URLSecret is the name of a secret containing Webhook

0 commit comments

Comments
 (0)