Skip to content

Commit

Permalink
docs: harmonize API descriptions (#2070)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored May 17, 2024
1 parent 358f61d commit 6a6b25d
Show file tree
Hide file tree
Showing 35 changed files with 37 additions and 29 deletions.
2 changes: 1 addition & 1 deletion api/account/v2/account_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ type UpdateProjectRequest struct {
Description *string `json:"description,omitempty"`
}

// This API allows you to manage projects.
// This API allows you to manage your Scaleway Projects.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/account/v3/account_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ type ProjectAPIUpdateProjectRequest struct {
Description *string `json:"description,omitempty"`
}

// This API allows you to manage projects.
// This API allows you to manage your Scaleway Projects.
type ProjectAPI struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/applesilicon/v1alpha1/applesilicon_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,7 @@ type UpdateServerRequest struct {
Name *string `json:"name,omitempty"`
}

// This API allows you to manage your Apple silicon machines.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/baremetal/v1/baremetal_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1615,7 +1615,7 @@ type UpdateSettingRequest struct {
Enabled *bool `json:"enabled,omitempty"`
}

// This API allows to manage your Elastic Metal server.
// This API allows you to manage your Elastic Metal servers.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/billing/v2alpha1/billing_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ func (r *ListInvoicesResponse) UnsafeAppend(res interface{}) (uint32, error) {
return uint32(len(results.Invoices)), nil
}

// This API allows you to query your consumption.
// This API allows you to manage and query your Scaleway billing and consumption.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/billing/v2beta1/billing_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -799,7 +799,7 @@ func (r *ListTaxesResponse) UnsafeAppend(res interface{}) (uint64, error) {
return uint64(len(results.Taxes)), nil
}

// This API allows you to query your consumption.
// This API allows you to manage and query your Scaleway billing and consumption.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/block/v1alpha1/block_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@ type UpdateVolumeRequest struct {
PerfIops *uint32 `json:"perf_iops,omitempty"`
}

// This API allows you to use and manage your Block Storage volumes.
// This API allows you to manage your Block Storage volumes.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/cockpit/v1beta1/cockpit_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,7 @@ type TriggerTestAlertRequest struct {
ProjectID string `json:"project_id"`
}

// 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.
// This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/container/v1beta1/container_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1605,7 +1605,7 @@ type UpdateTriggerRequest struct {
SqsConfig *UpdateTriggerRequestSqsClientConfig `json:"sqs_config,omitempty"`
}

// Serverless Containers API.
// This API allows you to manage your Serverless Containers.
type API struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/documentdb/v1beta1/documentdb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -2311,6 +2311,7 @@ type UpgradeInstanceRequest struct {
MajorUpgradeWorkflow *UpgradeInstanceRequestMajorUpgradeWorkflow `json:"major_upgrade_workflow,omitempty"`
}

// This API allows you to manage your Document Databases.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/domain/v2beta1/domain_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -2922,7 +2922,7 @@ type UpdateDNSZoneRequest struct {
ProjectID string `json:"project_id"`
}

// Manage your domains, DNS zones and records with the Domains and DNS API.
// This API allows you to manage your domains, DNS zones and records.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/flexibleip/v1alpha1/flexibleip_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ type UpdateFlexibleIPRequest struct {
Reverse *string `json:"reverse,omitempty"`
}

// Elastic Metal - Flexible IP API.
// This API allows you to manage your Elastic Metal servers' flexible public IP addresses.
type API struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/function/v1beta1/function_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1737,6 +1737,7 @@ type UploadURL struct {
Headers map[string]*[]string `json:"headers"`
}

// This API allows you to manage your Serverless Functions.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/iam/v1alpha1/iam_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1986,7 +1986,7 @@ type UpdateUserRequest struct {
Tags *[]string `json:"tags,omitempty"`
}

// IAM API.
// This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/instance/v1/instance_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -3907,7 +3907,7 @@ type setSnapshotResponse struct {
Snapshot *Snapshot `json:"snapshot"`
}

// Instance API.
// This API allows you to manage your Instances.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/iot/v1/iot_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1578,7 +1578,7 @@ type UpdateRouteRequest struct {
RestConfig *UpdateRouteRequestRestConfig `json:"rest_config,omitempty"`
}

// This API allows you to manage IoT hubs and devices.
// This API allows you to manage your IoT hubs and devices.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/ipam/v1/ipam_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ type UpdateIPRequest struct {
Reverses []*Reverse `json:"reverses"`
}

// This API allows you to manage IP addresses with Scaleway's IP Address Management tool.
// This API allows you to manage your Scaleway IP addresses with our IP Address Management tool.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/ipam/v1alpha1/ipam_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ func (r *ListIPsResponse) UnsafeAppend(res interface{}) (uint64, error) {
return uint64(len(results.IPs)), nil
}

// IPAM API.
// This API allows you to manage your Scaleway IP addresses with our IP Address Management tool.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/jobs/v1alpha1/jobs_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ type UpdateJobDefinitionRequest struct {
CronSchedule *UpdateJobDefinitionRequestCronScheduleConfig `json:"cron_schedule,omitempty"`
}

// Serverless Jobs API.
// This API allows you to manage your Serverless Jobs.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/k8s/v1/k8s_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1780,7 +1780,7 @@ type UpgradePoolRequest struct {
Version string `json:"version"`
}

// Kubernetes API.
// This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/lb/v1/lb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -6295,7 +6295,7 @@ func (s *ZonedAPI) DetachPrivateNetwork(req *ZonedAPIDetachPrivateNetworkRequest
return nil
}

// This API allows you to manage your load balancer service.
// This API allows you to manage your Load Balancers.
type API struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/llm_inference/v1beta1/llm_inference_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,7 @@ type UpdateEndpointRequest struct {
DisableAuth *bool `json:"disable_auth,omitempty"`
}

// This API allows you to manage your LLM Inference services.
type API struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/marketplace/v2/marketplace_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ func (r *ListVersionsResponse) UnsafeAppend(res interface{}) (uint32, error) {
return uint32(len(results.Versions)), nil
}

// This API allows you to find available images for use when launching a Scaleway Instance.
type API struct {
client *scw.Client
}
Expand Down
6 changes: 3 additions & 3 deletions api/mnq/v1beta1/mnq_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -868,7 +868,7 @@ type SqsInfo struct {
SqsEndpointURL string `json:"sqs_endpoint_url"`
}

// This API allows you to manage Scaleway Messaging and Queueing NATS accounts.
// This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
type NatsAPI struct {
client *scw.Client
}
Expand Down Expand Up @@ -1194,7 +1194,7 @@ func (s *NatsAPI) ListNatsCredentials(req *NatsAPIListNatsCredentialsRequest, op
return &resp, nil
}

// This API allows you to manage Scaleway Messaging and Queueing SNS brokers.
// This API allows you to manage your Scaleway Messaging and Queuing SNS brokers.
type SnsAPI struct {
client *scw.Client
}
Expand Down Expand Up @@ -1495,7 +1495,7 @@ func (s *SnsAPI) ListSnsCredentials(req *SnsAPIListSnsCredentialsRequest, opts .
return &resp, nil
}

// This API allows you to manage Scaleway Messaging and Queueing SQS brokers.
// This API allows you to manage your Scaleway Messaging and Queuing SQS brokers.
type SqsAPI struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/rdb/v1/rdb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -2614,6 +2614,7 @@ type UpgradeInstanceRequest struct {
MajorUpgradeWorkflow *UpgradeInstanceRequestMajorUpgradeWorkflow `json:"major_upgrade_workflow,omitempty"`
}

// This API allows you to manage your Managed Databases for PostgreSQL and MySQL.
type API struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/redis/v1/redis_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -936,6 +936,7 @@ type UpdateEndpointRequest struct {
PublicNetwork *EndpointSpecPublicNetworkSpec `json:"public_network,omitempty"`
}

// This API allows you to manage your Managed Databases for Redis™.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/registry/v1/registry_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ type UpdateNamespaceRequest struct {
IsPublic *bool `json:"is_public,omitempty"`
}

// Container Registry API.
// This API allows you to manage your Container Registry resources.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/secret/v1alpha1/secret_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -969,7 +969,7 @@ type UpdateSecretVersionRequest struct {
EphemeralProperties *EphemeralProperties `json:"ephemeral_properties,omitempty"`
}

// This API allows you to conveniently store, access and share sensitive data.
// This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/secret/v1beta1/secret_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -912,7 +912,7 @@ type UpdateSecretVersionRequest struct {
EphemeralProperties *EphemeralProperties `json:"ephemeral_properties,omitempty"`
}

// This API allows you to conveniently store, access and share sensitive data such as passwords, API keys and certificates.
// This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/serverless_sqldb/v1alpha1/serverless_sqldb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ type UpdateDatabaseRequest struct {
CPUMax *uint32 `json:"cpu_max,omitempty"`
}

// This API allows you to manage your Serverless SQL DB databases.
// This API allows you to manage your Serverless SQL Databases.
type API struct {
client *scw.Client
}
Expand Down
1 change: 1 addition & 0 deletions api/tem/v1alpha1/tem_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,7 @@ type Statistics struct {
CanceledCount uint32 `json:"canceled_count"`
}

// This API allows you to manage your Transactional Email services.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/vpc/v1/vpc_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ type UpdatePrivateNetworkRequest struct {
Subnets *[]string `json:"subnets,omitempty"`
}

// VPC API.
// This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/vpc/v2/vpc_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ type UpdateVPCRequest struct {
Tags *[]string `json:"tags,omitempty"`
}

// VPC API.
// This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/vpcgw/v1/vpcgw_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -1565,7 +1565,7 @@ type UpgradeGatewayRequest struct {
GatewayID string `json:"-"`
}

// Public Gateways API.
// This API allows you to manage your Public Gateways.
type API struct {
client *scw.Client
}
Expand Down
2 changes: 1 addition & 1 deletion api/webhosting/v1alpha1/webhosting_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -801,7 +801,7 @@ type UpdateHostingRequest struct {
Protected *bool `json:"protected,omitempty"`
}

// Web Hosting API.
// This API allows you to manage your Web Hosting services.
type API struct {
client *scw.Client
}
Expand Down

0 comments on commit 6a6b25d

Please sign in to comment.