Skip to content

Commit c2e6c36

Browse files
authored
feat(cockpit): update wording (scaleway#2602)
1 parent 9c1bc4c commit c2e6c36

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

api/cockpit/v1/cockpit_sdk.go

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ type DataSource struct {
628628
// SynchronizedWithGrafana: indicates whether the data source is synchronized with Grafana.
629629
SynchronizedWithGrafana bool `json:"synchronized_with_grafana"`
630630

631-
// RetentionDays: bETA - Duration for which the data will be retained in the data source.
631+
// RetentionDays: duration for which the data will be retained in the data source.
632632
RetentionDays uint32 `json:"retention_days"`
633633

634634
// Region: region of the data source.
@@ -1149,7 +1149,7 @@ type RegionalAPICreateDataSourceRequest struct {
11491149
// Default value: unknown_type
11501150
Type DataSourceType `json:"type"`
11511151

1152-
// RetentionDays: default values are 30 days for metrics, 7 days for logs and traces.
1152+
// RetentionDays: default values are 31 days for metrics, 7 days for logs and traces.
11531153
RetentionDays *uint32 `json:"retention_days,omitempty"`
11541154
}
11551155

@@ -1357,11 +1357,11 @@ type RegionalAPIListDataSourcesRequest struct {
13571357
// ProjectID: project ID to filter for, only data sources from this Project will be returned.
13581358
ProjectID string `json:"-"`
13591359

1360-
// Origin: origin to filter for, only data sources with matching origin will be returned.
1360+
// Origin: origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned.
13611361
// Default value: unknown_origin
13621362
Origin DataSourceOrigin `json:"-"`
13631363

1364-
// Types: types to filter for, only data sources with matching types will be returned.
1364+
// Types: types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned.
13651365
Types []DataSourceType `json:"-"`
13661366
}
13671367

@@ -1423,7 +1423,7 @@ type RegionalAPIUpdateDataSourceRequest struct {
14231423
// Name: updated name of the data source.
14241424
Name *string `json:"name,omitempty"`
14251425

1426-
// RetentionDays: bETA - Duration for which the data will be retained in the data source.
1426+
// RetentionDays: duration for which the data will be retained in the data source.
14271427
RetentionDays *uint32 `json:"retention_days,omitempty"`
14281428
}
14291429

@@ -1828,11 +1828,7 @@ func (s *RegionalAPI) GetConfig(req *RegionalAPIGetConfigRequest, opts ...scw.Re
18281828
return &resp, nil
18291829
}
18301830

1831-
// CreateDataSource: You must specify the data source type upon creation. Available data source types include:
1832-
// - metrics
1833-
// - logs
1834-
// - traces
1835-
//
1831+
// CreateDataSource: You must specify the data source name and type (metrics, logs, traces) upon creation.
18361832
// The name of the data source will then be used as reference to name the associated Grafana data source.
18371833
func (s *RegionalAPI) CreateDataSource(req *RegionalAPICreateDataSourceRequest, opts ...scw.RequestOption) (*DataSource, error) {
18381834
var err error
@@ -1901,7 +1897,7 @@ func (s *RegionalAPI) GetDataSource(req *RegionalAPIGetDataSourceRequest, opts .
19011897
return &resp, nil
19021898
}
19031899

1904-
// DeleteDataSource: Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
1900+
// DeleteDataSource: Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.
19051901
func (s *RegionalAPI) DeleteDataSource(req *RegionalAPIDeleteDataSourceRequest, opts ...scw.RequestOption) error {
19061902
var err error
19071903

@@ -1931,7 +1927,6 @@ func (s *RegionalAPI) DeleteDataSource(req *RegionalAPIDeleteDataSourceRequest,
19311927
}
19321928

19331929
// ListDataSources: Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
1934-
// You can list data sources by Project, type and origin.
19351930
func (s *RegionalAPI) ListDataSources(req *RegionalAPIListDataSourcesRequest, opts ...scw.RequestOption) (*ListDataSourcesResponse, error) {
19361931
var err error
19371932

@@ -1977,7 +1972,7 @@ func (s *RegionalAPI) ListDataSources(req *RegionalAPIListDataSourcesRequest, op
19771972
return &resp, nil
19781973
}
19791974

1980-
// UpdateDataSource: Update a given data source name, specified by the data source ID.
1975+
// UpdateDataSource: Update a given data source attributes (name and/or retention_days).
19811976
func (s *RegionalAPI) UpdateDataSource(req *RegionalAPIUpdateDataSourceRequest, opts ...scw.RequestOption) (*DataSource, error) {
19821977
var err error
19831978

@@ -2013,7 +2008,7 @@ func (s *RegionalAPI) UpdateDataSource(req *RegionalAPIUpdateDataSourceRequest,
20132008
return &resp, nil
20142009
}
20152010

2016-
// GetUsageOverview: Retrieve the data source usage overview per type for the specified Project.
2011+
// GetUsageOverview: Retrieve the volume of data ingested for each of your data sources in the specified project and region.
20172012
func (s *RegionalAPI) GetUsageOverview(req *RegionalAPIGetUsageOverviewRequest, opts ...scw.RequestOption) (*UsageOverview, error) {
20182013
var err error
20192014

0 commit comments

Comments
 (0)