Skip to content

Commit 6a6b25d

Browse files
authored
docs: harmonize API descriptions (#2070)
1 parent 358f61d commit 6a6b25d

File tree

35 files changed

+37
-29
lines changed

35 files changed

+37
-29
lines changed

api/account/v2/account_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ type UpdateProjectRequest struct {
182182
Description *string `json:"description,omitempty"`
183183
}
184184

185-
// This API allows you to manage projects.
185+
// This API allows you to manage your Scaleway Projects.
186186
type API struct {
187187
client *scw.Client
188188
}

api/account/v3/account_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ type ProjectAPIUpdateProjectRequest struct {
182182
Description *string `json:"description,omitempty"`
183183
}
184184

185-
// This API allows you to manage projects.
185+
// This API allows you to manage your Scaleway Projects.
186186
type ProjectAPI struct {
187187
client *scw.Client
188188
}

api/applesilicon/v1alpha1/applesilicon_sdk.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,7 @@ type UpdateServerRequest struct {
453453
Name *string `json:"name,omitempty"`
454454
}
455455

456+
// This API allows you to manage your Apple silicon machines.
456457
type API struct {
457458
client *scw.Client
458459
}

api/baremetal/v1/baremetal_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1615,7 +1615,7 @@ type UpdateSettingRequest struct {
16151615
Enabled *bool `json:"enabled,omitempty"`
16161616
}
16171617

1618-
// This API allows to manage your Elastic Metal server.
1618+
// This API allows you to manage your Elastic Metal servers.
16191619
type API struct {
16201620
client *scw.Client
16211621
}

api/billing/v2alpha1/billing_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ func (r *ListInvoicesResponse) UnsafeAppend(res interface{}) (uint32, error) {
476476
return uint32(len(results.Invoices)), nil
477477
}
478478

479-
// This API allows you to query your consumption.
479+
// This API allows you to manage and query your Scaleway billing and consumption.
480480
type API struct {
481481
client *scw.Client
482482
}

api/billing/v2beta1/billing_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -799,7 +799,7 @@ func (r *ListTaxesResponse) UnsafeAppend(res interface{}) (uint64, error) {
799799
return uint64(len(results.Taxes)), nil
800800
}
801801

802-
// This API allows you to query your consumption.
802+
// This API allows you to manage and query your Scaleway billing and consumption.
803803
type API struct {
804804
client *scw.Client
805805
}

api/block/v1alpha1/block_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ type UpdateVolumeRequest struct {
775775
PerfIops *uint32 `json:"perf_iops,omitempty"`
776776
}
777777

778-
// This API allows you to use and manage your Block Storage volumes.
778+
// This API allows you to manage your Block Storage volumes.
779779
type API struct {
780780
client *scw.Client
781781
}

api/cockpit/v1beta1/cockpit_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -931,7 +931,7 @@ type TriggerTestAlertRequest struct {
931931
ProjectID string `json:"project_id"`
932932
}
933933

934-
// The Cockpit API allows you to activate your Cockpit to store metrics and logs. It also provides you with a dedicated Grafana for dashboarding to visualize your metrics and logs.
934+
// This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs.
935935
type API struct {
936936
client *scw.Client
937937
}

api/container/v1beta1/container_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1605,7 +1605,7 @@ type UpdateTriggerRequest struct {
16051605
SqsConfig *UpdateTriggerRequestSqsClientConfig `json:"sqs_config,omitempty"`
16061606
}
16071607

1608-
// Serverless Containers API.
1608+
// This API allows you to manage your Serverless Containers.
16091609
type API struct {
16101610
client *scw.Client
16111611
}

api/documentdb/v1beta1/documentdb_sdk.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2311,6 +2311,7 @@ type UpgradeInstanceRequest struct {
23112311
MajorUpgradeWorkflow *UpgradeInstanceRequestMajorUpgradeWorkflow `json:"major_upgrade_workflow,omitempty"`
23122312
}
23132313

2314+
// This API allows you to manage your Document Databases.
23142315
type API struct {
23152316
client *scw.Client
23162317
}

0 commit comments

Comments
 (0)