chore: fix typos (scaleway#2812)

scaleway-bot · web-flow · commit 84e9d4d53332 · 2025-11-04T14:17:27.000Z
diff --git a/api/applesilicon/v1alpha1/applesilicon_sdk.go b/api/applesilicon/v1alpha1/applesilicon_sdk.go
@@ -499,7 +499,7 @@ type OS struct {
 	// Deprecated: CompatibleServerTypes: list of compatible server types. Deprecated.
 	CompatibleServerTypes *[]string `json:"compatible_server_types,omitempty"`
 
-	// ReleaseNotesURL: url of the release notes for the OS image or softwares pre-installed.
+	// ReleaseNotesURL: url of the release notes for the OS image or software pre-installed.
 	ReleaseNotesURL string `json:"release_notes_url"`
 
 	// Description: a summary of the OS image content and configuration.
@@ -1531,7 +1531,7 @@ func (s *API) RebootServer(req *RebootServerRequest, opts ...scw.RequestOption)
 	return &resp, nil
 }
 
-// ReinstallServer: Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
+// ReinstallServer: Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the default configuration values of the image (OS).
 func (s *API) ReinstallServer(req *ReinstallServerRequest, opts ...scw.RequestOption) (*Server, error) {
 	var err error
 
diff --git a/api/baremetal/v1/baremetal_sdk.go b/api/baremetal/v1/baremetal_sdk.go
@@ -1531,10 +1531,10 @@ type BMCAccess struct {
 	// URL: URL to access to the server console.
 	URL string `json:"url"`
 
-	// Login: the login to use for the BMC (Baseboard Management Controller) access authentification.
+	// Login: the login to use for the BMC (Baseboard Management Controller) access authentication.
 	Login string `json:"login"`
 
-	// Password: the password to use for the BMC (Baseboard Management Controller) access authentification.
+	// Password: the password to use for the BMC (Baseboard Management Controller) access authentication.
 	Password string `json:"password"`
 
 	// ExpiresAt: the date after which the BMC (Baseboard Management Controller) access will be closed.
diff --git a/api/block/v1/block_sdk.go b/api/block/v1/block_sdk.go
@@ -721,7 +721,7 @@ type ListSnapshotsResponse struct {
 	// Snapshots: paginated returned list of snapshots.
 	Snapshots []*Snapshot `json:"snapshots"`
 
-	// TotalCount: total number of snpashots in the project.
+	// TotalCount: total number of snapshots in the project.
 	TotalCount uint64 `json:"total_count"`
 }
 
diff --git a/api/block/v1alpha1/block_sdk.go b/api/block/v1alpha1/block_sdk.go
@@ -742,7 +742,7 @@ type ListSnapshotsResponse struct {
 	// Snapshots: paginated returned list of snapshots.
 	Snapshots []*Snapshot `json:"snapshots"`
 
-	// TotalCount: total number of snpashots in the project.
+	// TotalCount: total number of snapshots in the project.
 	TotalCount uint64 `json:"total_count"`
 }
 
diff --git a/api/cockpit/v1/cockpit_sdk.go b/api/cockpit/v1/cockpit_sdk.go
@@ -1106,7 +1106,7 @@ func (r *ListGrafanaProductDashboardsResponse) UnsafeAppend(res any) (uint64, er
 	return uint64(len(results.Dashboards)), nil
 }
 
-// ListGrafanaUsersResponse: Ouptut returned when listing Grafana users.
+// ListGrafanaUsersResponse: Output returned when listing Grafana users.
 type ListGrafanaUsersResponse struct {
 	// TotalCount: total count of Grafana users.
 	TotalCount uint64 `json:"total_count"`
diff --git a/api/container/v1beta1/container_sdk.go b/api/container/v1beta1/container_sdk.go
@@ -1014,7 +1014,7 @@ type Cron struct {
 	// ContainerID: UUID of the container invoked by this cron.
 	ContainerID string `json:"container_id"`
 
-	// Schedule: uNIX cron shedule.
+	// Schedule: uNIX cron schedule.
 	Schedule string `json:"schedule"`
 
 	// Args: arguments to pass with the cron.
@@ -1272,7 +1272,7 @@ type CreateCronRequest struct {
 	// ContainerID: UUID of the container to invoke by the cron.
 	ContainerID string `json:"container_id"`
 
-	// Schedule: uNIX cron shedule.
+	// Schedule: uNIX cron schedule.
 	Schedule string `json:"schedule"`
 
 	// Args: arguments to pass with the cron.
diff --git a/api/dedibox/v1/dedibox_sdk.go b/api/dedibox/v1/dedibox_sdk.go
@@ -3592,7 +3592,7 @@ type Log struct {
 	// Group: rPN V2 group.
 	Group *RpnV2Group `json:"group"`
 
-	// Member: rPN V2 member (if appliable).
+	// Member: rPN V2 member (if applicable).
 	Member *RpnV2Member `json:"member"`
 
 	// Action: which action was performed.
@@ -3822,10 +3822,10 @@ type BMCAccess struct {
 	// URL: URL to access to the server console.
 	URL string `json:"url"`
 
-	// Login: the login to use for the BMC (Baseboard Management Controller) access authentification.
+	// Login: the login to use for the BMC (Baseboard Management Controller) access authentication.
 	Login string `json:"login"`
 
-	// Password: the password to use for the BMC (Baseboard Management Controller) access authentification.
+	// Password: the password to use for the BMC (Baseboard Management Controller) access authentication.
 	Password string `json:"password"`
 
 	// ExpiresAt: the date after which the BMC (Baseboard Management Controller) access will be closed.
@@ -5315,7 +5315,7 @@ type Rescue struct {
 	// Password: password of the rescue.
 	Password string `json:"password"`
 
-	// Protocol: protocol of the resuce.
+	// Protocol: protocol of the rescue.
 	// Default value: vnc
 	Protocol RescueProtocol `json:"protocol"`
 }
diff --git a/api/domain/v2beta1/domain_sdk.go b/api/domain/v2beta1/domain_sdk.go
@@ -3934,7 +3934,7 @@ func (s *API) RestoreDNSZoneVersion(req *RestoreDNSZoneVersionRequest, opts ...s
 	return &resp, nil
 }
 
-// GetSSLCertificate: Get the DNS zone's TLS certificate. If you do not have a certificate, the ouptut returns `no certificate found`.
+// GetSSLCertificate: Get the DNS zone's TLS certificate. If you do not have a certificate, the output returns `no certificate found`.
 func (s *API) GetSSLCertificate(req *GetSSLCertificateRequest, opts ...scw.RequestOption) (*SSLCertificate, error) {
 	var err error
 
@@ -4680,7 +4680,7 @@ func (s *RegistrarAPI) DisableDomainAutoRenew(req *RegistrarAPIDisableDomainAuto
 	return &resp, nil
 }
 
-// GetDomainAuthCode: Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked.
+// GetDomainAuthCode: Retrieve the authorization code to transfer an unlocked domain. The output returns an error if the domain is locked.
 // Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.
 func (s *RegistrarAPI) GetDomainAuthCode(req *RegistrarAPIGetDomainAuthCodeRequest, opts ...scw.RequestOption) (*GetDomainAuthCodeResponse, error) {
 	var err error
diff --git a/api/environmental_footprint/v1alpha1/environmental_footprint_sdk.go b/api/environmental_footprint/v1alpha1/environmental_footprint_sdk.go
@@ -41,13 +41,20 @@ var (
 type ProductCategory string
 
 const (
+	// Unknown product category.
 	ProductCategoryUnknownProductCategory = ProductCategory("unknown_product_category")
-	ProductCategoryAppleSilicon           = ProductCategory("apple_silicon")
-	ProductCategoryBlockStorage           = ProductCategory("block_storage")
-	ProductCategoryDedibox                = ProductCategory("dedibox")
-	ProductCategoryElasticMetal           = ProductCategory("elastic_metal")
-	ProductCategoryInstances              = ProductCategory("instances")
-	ProductCategoryObjectStorage          = ProductCategory("object_storage")
+	// The Apple Silicon product category.
+	ProductCategoryAppleSilicon = ProductCategory("apple_silicon")
+	// The Block Storage product category.
+	ProductCategoryBlockStorage = ProductCategory("block_storage")
+	// The Dedibox product category.
+	ProductCategoryDedibox = ProductCategory("dedibox")
+	// The Elastic Metal product category.
+	ProductCategoryElasticMetal = ProductCategory("elastic_metal")
+	// The Instances product category.
+	ProductCategoryInstances = ProductCategory("instances")
+	// The Object Storage product category.
+	ProductCategoryObjectStorage = ProductCategory("object_storage")
 )
 
 func (enum ProductCategory) String() string {
@@ -130,10 +137,14 @@ func (enum *ReportType) UnmarshalJSON(data []byte) error {
 type ServiceCategory string
 
 const (
+	// Unknown service category.
 	ServiceCategoryUnknownServiceCategory = ServiceCategory("unknown_service_category")
-	ServiceCategoryBaremetal              = ServiceCategory("baremetal")
-	ServiceCategoryCompute                = ServiceCategory("compute")
-	ServiceCategoryStorage                = ServiceCategory("storage")
+	// The Bare Metal service category.
+	ServiceCategoryBaremetal = ServiceCategory("baremetal")
+	// The Compute service category.
+	ServiceCategoryCompute = ServiceCategory("compute")
+	// The Storage service category.
+	ServiceCategoryStorage = ServiceCategory("storage")
 )
 
 func (enum ServiceCategory) String() string {
diff --git a/api/function/v1beta1/function_sdk.go b/api/function/v1beta1/function_sdk.go
@@ -1003,7 +1003,7 @@ type Domain struct {
 	// URL: URL of the function.
 	URL string `json:"url"`
 
-	// Status: state of the doamin.
+	// Status: state of the domain.
 	// Default value: unknown
 	Status DomainStatus `json:"status"`
 
@@ -1275,7 +1275,7 @@ type CreateDomainRequest struct {
 	// Region: region to target. If none is passed will use default region from the config.
 	Region scw.Region `json:"-"`
 
-	// Hostname: hostame to create.
+	// Hostname: hostname to create.
 	Hostname string `json:"hostname"`
 
 	// FunctionID: UUID of the function to associate the domain with.
diff --git a/api/iam/v1alpha1/iam_sdk.go b/api/iam/v1alpha1/iam_sdk.go
@@ -4053,7 +4053,7 @@ func (s *API) CreatePolicy(req *CreatePolicyRequest, opts ...scw.RequestOption)
 	return &resp, nil
 }
 
-// GetPolicy: Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response.
+// GetPolicy: Retrieve information about a policy, specified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response.
 func (s *API) GetPolicy(req *GetPolicyRequest, opts ...scw.RequestOption) (*Policy, error) {
 	var err error
 
diff --git a/api/iot/v1/iot_sdk.go b/api/iot/v1/iot_sdk.go
@@ -807,7 +807,7 @@ type Hub struct {
 	// OrganizationID: organization owning the resource.
 	OrganizationID string `json:"organization_id"`
 
-	// EnableDeviceAutoProvisioning: when an unknown device connects to your hub using a valid certificate chain, it will be automatically provisioned inside your Hub. The Hub uses the common name of the device certifcate to find out if a device with the same name already exists. This setting can only be enabled on a hub with a custom certificate authority.
+	// EnableDeviceAutoProvisioning: when an unknown device connects to your hub using a valid certificate chain, it will be automatically provisioned inside your Hub. The Hub uses the common name of the device certificate to find out if a device with the same name already exists. This setting can only be enabled on a hub with a custom certificate authority.
 	EnableDeviceAutoProvisioning bool `json:"enable_device_auto_provisioning"`
 
 	// HasCustomCa: flag is automatically set to `false` after Hub creation, as Hub certificates are managed by Scaleway. Once a custom certificate authority is set, the flag will be set to `true`.
diff --git a/api/jobs/v1alpha1/jobs_sdk.go b/api/jobs/v1alpha1/jobs_sdk.go
@@ -823,7 +823,7 @@ func (s *API) UpdateJobDefinition(req *UpdateJobDefinitionRequest, opts ...scw.R
 	return &resp, nil
 }
 
-// DeleteJobDefinition: Delete an exsisting job definition by its unique identifier.
+// DeleteJobDefinition: Delete an existing job definition by its unique identifier.
 func (s *API) DeleteJobDefinition(req *DeleteJobDefinitionRequest, opts ...scw.RequestOption) error {
 	var err error
 
diff --git a/api/kafka/v1alpha1/kafka_sdk.go b/api/kafka/v1alpha1/kafka_sdk.go
@@ -363,7 +363,7 @@ type NodeTypeVolumeType struct {
 	// Description: the description of the volume.
 	Description string `json:"description"`
 
-	// MinSizeBytes: mimimum size required for the volume.
+	// MinSizeBytes: minimum size required for the volume.
 	MinSizeBytes scw.Size `json:"min_size_bytes"`
 
 	// MaxSizeBytes: maximum size required for the volume.
diff --git a/api/mnq/v1beta1/mnq_sdk.go b/api/mnq/v1beta1/mnq_sdk.go
@@ -1315,7 +1315,7 @@ func (s *SnsAPI) ActivateSns(req *SnsAPIActivateSnsRequest, opts ...scw.RequestO
 	return &resp, nil
 }
 
-// GetSnsInfo: Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.
+// GetSnsInfo: Retrieve the Topics and Events information of the specified Project ID. information include the activation status and the Topics and Events API endpoint URL.
 func (s *SnsAPI) GetSnsInfo(req *SnsAPIGetSnsInfoRequest, opts ...scw.RequestOption) (*SnsInfo, error) {
 	var err error
 
@@ -1617,7 +1617,7 @@ func (s *SqsAPI) ActivateSqs(req *SqsAPIActivateSqsRequest, opts ...scw.RequestO
 	return &resp, nil
 }
 
-// GetSqsInfo: Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.
+// GetSqsInfo: Retrieve the Queues information of the specified Project ID. information include the activation status and the Queues API endpoint URL.
 func (s *SqsAPI) GetSqsInfo(req *SqsAPIGetSqsInfoRequest, opts ...scw.RequestOption) (*SqsInfo, error) {
 	var err error
 
diff --git a/api/qaas/v1alpha1/qaas_sdk.go b/api/qaas/v1alpha1/qaas_sdk.go
@@ -2659,7 +2659,7 @@ func (s *API) ListProcessResults(req *ListProcessResultsRequest, opts ...scw.Req
 	return &resp, nil
 }
 
-// GetApplication: Retrieve information about the provided **applcation ID**, such as name, type and compatible platforms.
+// GetApplication: Retrieve information about the provided **application ID**, such as name, type and compatible platforms.
 func (s *API) GetApplication(req *GetApplicationRequest, opts ...scw.RequestOption) (*Application, error) {
 	var err error
 

Original file line number	Diff line number	Diff line change
`@@ -721,7 +721,7 @@ type ListSnapshotsResponse struct {`
`721`	`721`	`// Snapshots: paginated returned list of snapshots.`
`722`	`722`	Snapshots []*Snapshot `json:"snapshots"`
`723`	`723`
`724`		`- // TotalCount: total number of snpashots in the project.`
	`724`	`+ // TotalCount: total number of snapshots in the project.`
`725`	`725`	TotalCount uint64 `json:"total_count"`
`726`	`726`	`}`
`727`	`727`
Original file line number	Diff line number	Diff line change
`@@ -742,7 +742,7 @@ type ListSnapshotsResponse struct {`
`742`	`742`	`// Snapshots: paginated returned list of snapshots.`
`743`	`743`	Snapshots []*Snapshot `json:"snapshots"`
`744`	`744`
`745`		`- // TotalCount: total number of snpashots in the project.`
	`745`	`+ // TotalCount: total number of snapshots in the project.`
`746`	`746`	TotalCount uint64 `json:"total_count"`
`747`	`747`	`}`
`748`	`748`
Original file line number	Diff line number	Diff line change
`@@ -1106,7 +1106,7 @@ func (r *ListGrafanaProductDashboardsResponse) UnsafeAppend(res any) (uint64, er`
`1106`	`1106`	`return uint64(len(results.Dashboards)), nil`
`1107`	`1107`	`}`
`1108`	`1108`
`1109`		`-// ListGrafanaUsersResponse: Ouptut returned when listing Grafana users.`
	`1109`	`+// ListGrafanaUsersResponse: Output returned when listing Grafana users.`
`1110`	`1110`	`type ListGrafanaUsersResponse struct {`
`1111`	`1111`	`// TotalCount: total count of Grafana users.`
`1112`	`1112`	TotalCount uint64 `json:"total_count"`
Original file line number	Diff line number	Diff line change
`@@ -3934,7 +3934,7 @@ func (s API) RestoreDNSZoneVersion(req RestoreDNSZoneVersionRequest, opts ...s`
`3934`	`3934`	`return &resp, nil`
`3935`	`3935`	`}`
`3936`	`3936`
`3937`		-// GetSSLCertificate: Get the DNS zone's TLS certificate. If you do not have a certificate, the ouptut returns `no certificate found`.
	`3937`	+// GetSSLCertificate: Get the DNS zone's TLS certificate. If you do not have a certificate, the output returns `no certificate found`.
`3938`	`3938`	`func (s API) GetSSLCertificate(req GetSSLCertificateRequest, opts ...scw.RequestOption) (*SSLCertificate, error) {`
`3939`	`3939`	`var err error`
`3940`	`3940`
`@@ -4680,7 +4680,7 @@ func (s RegistrarAPI) DisableDomainAutoRenew(req RegistrarAPIDisableDomainAuto`
`4680`	`4680`	`return &resp, nil`
`4681`	`4681`	`}`
`4682`	`4682`
`4683`		`-// GetDomainAuthCode: Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked.`
	`4683`	`+// GetDomainAuthCode: Retrieve the authorization code to transfer an unlocked domain. The output returns an error if the domain is locked.`
`4684`	`4684`	`// Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.`
`4685`	`4685`	`func (s RegistrarAPI) GetDomainAuthCode(req RegistrarAPIGetDomainAuthCodeRequest, opts ...scw.RequestOption) (*GetDomainAuthCodeResponse, error) {`
`4686`	`4686`	`var err error`