fix(cockpit): add small precisions in documentation (scaleway#2576)

scaleway-bot · Mia-Cross · web-flow · commit 0a569381b8f8 · 2025-06-02T15:13:10.000Z
Co-authored-by: Mia-Cross &lt;lmarabese@scaleway.com&gt;
diff --git a/api/cockpit/v1/cockpit_sdk.go b/api/cockpit/v1/cockpit_sdk.go
@@ -1314,7 +1314,7 @@ type RegionalAPIListAlertsRequest struct {
 	// Default value: unknown_state
 	State *AlertState `json:"-"`
 
-	// DataSourceID: if omitted, only alerts from the default scaleway data source will be listed.
+	// DataSourceID: if omitted, only alerts from the default Scaleway metrics data source will be listed.
 	DataSourceID *string `json:"-"`
 }
 
@@ -2453,7 +2453,7 @@ func (s *RegionalAPI) DeleteContactPoint(req *RegionalAPIDeleteContactPointReque
 	return nil
 }
 
-// ListAlerts: List preconfigured and/or custom alerts for the specified Project.
+// ListAlerts: List preconfigured and/or custom alerts for the specified Project and data source.
 func (s *RegionalAPI) ListAlerts(req *RegionalAPIListAlertsRequest, opts ...scw.RequestOption) (*ListAlertsResponse, error) {
 	var err error
 

Original file line number	Diff line number	Diff line change
`@@ -1314,7 +1314,7 @@ type RegionalAPIListAlertsRequest struct {`
`1314`	`1314`	`// Default value: unknown_state`
`1315`	`1315`	State *AlertState `json:"-"`
`1316`	`1316`
`1317`		`- // DataSourceID: if omitted, only alerts from the default scaleway data source will be listed.`
	`1317`	`+ // DataSourceID: if omitted, only alerts from the default Scaleway metrics data source will be listed.`
`1318`	`1318`	DataSourceID *string `json:"-"`
`1319`	`1319`	`}`
`1320`	`1320`
`@@ -2453,7 +2453,7 @@ func (s RegionalAPI) DeleteContactPoint(req RegionalAPIDeleteContactPointReque`
`2453`	`2453`	`return nil`
`2454`	`2454`	`}`
`2455`	`2455`
`2456`		`-// ListAlerts: List preconfigured and/or custom alerts for the specified Project.`
	`2456`	`+// ListAlerts: List preconfigured and/or custom alerts for the specified Project and data source.`
`2457`	`2457`	`func (s RegionalAPI) ListAlerts(req RegionalAPIListAlertsRequest, opts ...scw.RequestOption) (*ListAlertsResponse, error) {`
`2458`	`2458`	`var err error`
`2459`	`2459`