Skip to content

Commit 2142811

Browse files
authored
docs: fix various spelling (scaleway#2499)
1 parent 11d6084 commit 2142811

File tree

15 files changed

+29
-29
lines changed

15 files changed

+29
-29
lines changed

api/baremetal/v1/baremetal_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1244,7 +1244,7 @@ type Offer struct {
12441244
// CommercialRange: commercial range of the offer.
12451245
CommercialRange string `json:"commercial_range"`
12461246

1247-
// PricePerHour: price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).
1247+
// PricePerHour: price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).
12481248
PricePerHour *scw.Money `json:"price_per_hour"`
12491249

12501250
// PricePerMonth: monthly price of the offer, if subscribing on a monthly basis.

api/dedibox/v1/dedibox_sdk.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2725,7 +2725,7 @@ type OfferSANInfo struct {
27252725
// Size: sAN size (in bytes).
27262726
Size uint64 `json:"size"`
27272727

2728-
// Ha: high availabilty offer.
2728+
// Ha: high availability offer.
27292729
Ha bool `json:"ha"`
27302730

27312731
// DeviceType: type of SAN device (hdd / ssd).
@@ -2915,10 +2915,10 @@ type OS struct {
29152915
// PanelPasswordRegex: regex used to validate the panel installation password.
29162916
PanelPasswordRegex *string `json:"panel_password_regex"`
29172917

2918-
// RequiresValidHostname: if both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.
2918+
// RequiresValidHostname: if both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
29192919
RequiresValidHostname *bool `json:"requires_valid_hostname"`
29202920

2921-
// HostnameRegex: if both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.
2921+
// HostnameRegex: if both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
29222922
HostnameRegex *string `json:"hostname_regex"`
29232923

29242924
// HostnameMaxLength: hostname max length.

api/documentdb/v1beta1/documentdb_sdk.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1144,7 +1144,7 @@ type Volume struct {
11441144

11451145
// NodeTypeVolumeConstraintSizes: node type volume constraint sizes.
11461146
type NodeTypeVolumeConstraintSizes struct {
1147-
// MinSize: [deprecated] Mimimum size required for the Volume.
1147+
// MinSize: [deprecated] Minimum size required for the Volume.
11481148
MinSize scw.Size `json:"min_size"`
11491149

11501150
// MaxSize: [deprecated] Maximum size required for the Volume.
@@ -1160,7 +1160,7 @@ type NodeTypeVolumeType struct {
11601160
// Description: the description of the Volume.
11611161
Description string `json:"description"`
11621162

1163-
// MinSize: mimimum size required for the Volume.
1163+
// MinSize: minimum size required for the Volume.
11641164
MinSize scw.Size `json:"min_size"`
11651165

11661166
// MaxSize: maximum size required for the Volume.
@@ -3401,7 +3401,7 @@ func (s *API) DeleteInstanceSettings(req *DeleteInstanceSettingsRequest, opts ..
34013401
return &resp, nil
34023402
}
34033403

3404-
// SetInstanceSettings: Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
3404+
// SetInstanceSettings: Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
34053405
func (s *API) SetInstanceSettings(req *SetInstanceSettingsRequest, opts ...scw.RequestOption) (*SetInstanceSettingsResponse, error) {
34063406
var err error
34073407

api/edge_services/v1beta1/edge_services_sdk.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -703,7 +703,7 @@ const (
703703
PipelineStatusError = PipelineStatus("error")
704704
// The pipeline status is pending.
705705
PipelineStatusPending = PipelineStatus("pending")
706-
// An event occured and the pipeline may not work.
706+
// An event occurred and the pipeline may not work.
707707
PipelineStatusWarning = PipelineStatus("warning")
708708
PipelineStatusLocked = PipelineStatus("locked")
709709
)
@@ -788,7 +788,7 @@ type PurgeRequestStatus string
788788
const (
789789
// Purge request status unknown (default).
790790
PurgeRequestStatusUnknownStatus = PurgeRequestStatus("unknown_status")
791-
// The purge request has been processed sucessfully.
791+
// The purge request has been processed successfully.
792792
PurgeRequestStatusDone = PurgeRequestStatus("done")
793793
// An error occurred during the purge request.
794794
PurgeRequestStatusError = PurgeRequestStatus("error")

api/function/v1beta1/function_sdk.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ type Token struct {
11801180
// Precisely one of FunctionID, NamespaceID must be set.
11811181
FunctionID *string `json:"function_id,omitempty"`
11821182

1183-
// NamespaceID: UUID of the namespace the token is assoicated with.
1183+
// NamespaceID: UUID of the namespace the token is associated with.
11841184
// Precisely one of FunctionID, NamespaceID must be set.
11851185
NamespaceID *string `json:"namespace_id,omitempty"`
11861186

@@ -1287,7 +1287,7 @@ type CreateFunctionRequest struct {
12871287
// EnvironmentVariables: environment variables of the function.
12881288
EnvironmentVariables *map[string]string `json:"environment_variables,omitempty"`
12891289

1290-
// MinScale: minumum number of instances to scale the function to.
1290+
// MinScale: minimum number of instances to scale the function to.
12911291
MinScale *uint32 `json:"min_scale,omitempty"`
12921292

12931293
// MaxScale: maximum number of instances to scale the function to.
@@ -1603,7 +1603,7 @@ type ListDomainsRequest struct {
16031603
// Default value: created_at_asc
16041604
OrderBy ListDomainsRequestOrderBy `json:"-"`
16051605

1606-
// FunctionID: UUID of the function the domain is assoicated with.
1606+
// FunctionID: UUID of the function the domain is associated with.
16071607
FunctionID string `json:"-"`
16081608
}
16091609

@@ -1690,7 +1690,7 @@ type ListFunctionsRequest struct {
16901690
// Name: name of the function.
16911691
Name *string `json:"-"`
16921692

1693-
// OrganizationID: UUID of the Organziation the function belongs to.
1693+
// OrganizationID: UUID of the Organization the function belongs to.
16941694
OrganizationID *string `json:"-"`
16951695

16961696
// ProjectID: UUID of the Project the function belongs to.
@@ -1792,7 +1792,7 @@ type ListTokensRequest struct {
17921792
// Default value: created_at_asc
17931793
OrderBy ListTokensRequestOrderBy `json:"-"`
17941794

1795-
// FunctionID: UUID of the function the token is assoicated with.
1795+
// FunctionID: UUID of the function the token is associated with.
17961796
FunctionID *string `json:"-"`
17971797

17981798
// NamespaceID: UUID of the namespace the token is associated with.
@@ -1913,7 +1913,7 @@ type UpdateFunctionRequest struct {
19131913
// EnvironmentVariables: environment variables of the function to update.
19141914
EnvironmentVariables *map[string]string `json:"environment_variables,omitempty"`
19151915

1916-
// MinScale: minumum number of instances to scale the function to.
1916+
// MinScale: minimum number of instances to scale the function to.
19171917
MinScale *uint32 `json:"min_scale,omitempty"`
19181918

19191919
// MaxScale: maximum number of instances to scale the function to.

api/iam/v1alpha1/iam_sdk.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3243,7 +3243,7 @@ func (s *API) CreateGroup(req *CreateGroupRequest, opts ...scw.RequestOption) (*
32433243
return &resp, nil
32443244
}
32453245

3246-
// GetGroup: Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
3246+
// GetGroup: Retrieve information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
32473247
func (s *API) GetGroup(req *GetGroupRequest, opts ...scw.RequestOption) (*Group, error) {
32483248
var err error
32493249

@@ -3740,7 +3740,7 @@ func (s *API) CreateAPIKey(req *CreateAPIKeyRequest, opts ...scw.RequestOption)
37403740
return &resp, nil
37413741
}
37423742

3743-
// GetAPIKey: Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
3743+
// GetAPIKey: Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
37443744
func (s *API) GetAPIKey(req *GetAPIKeyRequest, opts ...scw.RequestOption) (*APIKey, error) {
37453745
var err error
37463746

api/inference/v1beta1/inference_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1254,7 +1254,7 @@ func (s *API) SetDeploymentACLRules(req *SetDeploymentACLRulesRequest, opts ...s
12541254
return &resp, nil
12551255
}
12561256

1257-
// DeleteDeploymentACLRule: Delete an exising ACL.
1257+
// DeleteDeploymentACLRule: Delete an existing ACL.
12581258
func (s *API) DeleteDeploymentACLRule(req *DeleteDeploymentACLRuleRequest, opts ...scw.RequestOption) error {
12591259
var err error
12601260

api/instance/v1/instance_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1906,7 +1906,7 @@ type Task struct {
19061906

19071907
HrefResult string `json:"href_result"`
19081908

1909-
// Zone: zone in which the task is excecuted.
1909+
// Zone: zone in which the task is executed.
19101910
Zone scw.Zone `json:"zone"`
19111911
}
19121912

api/interlink/v1beta1/interlink_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1513,7 +1513,7 @@ func (s *API) GetLink(req *GetLinkRequest, opts ...scw.RequestOption) (*Link, er
15131513
return &resp, nil
15141514
}
15151515

1516-
// CreateLink: Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
1516+
// CreateLink: Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (facilitated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
15171517
func (s *API) CreateLink(req *CreateLinkRequest, opts ...scw.RequestOption) (*Link, error) {
15181518
var err error
15191519

api/iot/v1/iot_sdk.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1283,7 +1283,7 @@ type ListDevicesRequest struct {
12831283
// HubID: hub ID to filter for, only devices attached to this Hub will be returned.
12841284
HubID *string `json:"-"`
12851285

1286-
// AllowInsecure: defines wheter to filter the allow_insecure flag.
1286+
// AllowInsecure: defines whether to filter the allow_insecure flag.
12871287
AllowInsecure *bool `json:"-"`
12881288

12891289
// Status: device status (enabled, disabled, etc.).

0 commit comments

Comments
 (0)