diff --git a/api/account/v2alpha1/account_sdk.go b/api/account/v2alpha1/account_sdk.go index cb9cc7422..d2a3de2d8 100644 --- a/api/account/v2alpha1/account_sdk.go +++ b/api/account/v2alpha1/account_sdk.go @@ -39,7 +39,7 @@ var ( _ = namegenerator.GetRandomName ) -// API: this API allows to manage your scaleway account +// API: account API type API struct { client *scw.Client } @@ -146,7 +146,7 @@ type ListSSHKeysRequest struct { ProjectID *string `json:"-"` } -// ListSSHKeys: list all SSH keys +// ListSSHKeys: list all SSH keys of your organization func (s *API) ListSSHKeys(req *ListSSHKeysRequest, opts ...scw.RequestOption) (*ListSSHKeysResponse, error) { var err error @@ -211,9 +211,9 @@ type CreateSSHKeyRequest struct { ProjectID *string `json:"project_id,omitempty"` } -// CreateSSHKey: add a SSH key to your Scaleway account +// CreateSSHKey: add a SSH key to your organization // -// Add a SSH key to your Scaleway account. +// Add a SSH key to your organization. func (s *API) CreateSSHKey(req *CreateSSHKeyRequest, opts ...scw.RequestOption) (*SSHKey, error) { var err error @@ -252,7 +252,9 @@ type GetSSHKeyRequest struct { SSHKeyID string `json:"-"` } -// GetSSHKey: get SSH key details +// GetSSHKey: get a SSH key from your organization +// +// Get a SSH key from your organization. func (s *API) GetSSHKey(req *GetSSHKeyRequest, opts ...scw.RequestOption) (*SSHKey, error) { var err error @@ -281,7 +283,9 @@ type UpdateSSHKeyRequest struct { Name *string `json:"name"` } -// UpdateSSHKey: update an SSH key +// UpdateSSHKey: update a SSH key on your organization +// +// Update a SSH key on your organization. func (s *API) UpdateSSHKey(req *UpdateSSHKeyRequest, opts ...scw.RequestOption) (*SSHKey, error) { var err error @@ -313,9 +317,9 @@ type DeleteSSHKeyRequest struct { SSHKeyID string `json:"-"` } -// DeleteSSHKey: remove a SSH key from your Scaleway account +// DeleteSSHKey: remove a SSH key from your organization // -// Remove a SSH key from your Scaleway account. +// Remove a SSH key from your organization. func (s *API) DeleteSSHKey(req *DeleteSSHKeyRequest, opts ...scw.RequestOption) error { var err error diff --git a/api/baremetal/v1/baremetal_sdk.go b/api/baremetal/v1/baremetal_sdk.go index 2716f5e9e..036d3cf5b 100644 --- a/api/baremetal/v1/baremetal_sdk.go +++ b/api/baremetal/v1/baremetal_sdk.go @@ -614,9 +614,9 @@ type ListServersRequest struct { OrganizationID *string `json:"-"` } -// ListServers: list servers +// ListServers: list baremetal servers // -// List all created servers. +// List baremetal servers. func (s *API) ListServers(req *ListServersRequest, opts ...scw.RequestOption) (*ListServersResponse, error) { var err error @@ -684,7 +684,7 @@ type GetServerRequest struct { ServerID string `json:"-"` } -// GetServer: get server +// GetServer: get a specific baremetal server // // Get the server associated with the given ID. func (s *API) GetServer(req *GetServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -732,9 +732,9 @@ type CreateServerRequest struct { Tags []string `json:"tags"` } -// CreateServer: create server +// CreateServer: create a baremetal server // -// Create a new server. Once the server is created, you probably want to install an OS. +// Create a new baremetal server. Once the server is created, you probably want to install an OS. func (s *API) CreateServer(req *CreateServerRequest, opts ...scw.RequestOption) (*Server, error) { var err error @@ -784,7 +784,7 @@ type UpdateServerRequest struct { Tags *[]string `json:"tags"` } -// UpdateServer: update server +// UpdateServer: update a baremetal server // // Update the server associated with the given ID. func (s *API) UpdateServer(req *UpdateServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -835,7 +835,7 @@ type InstallServerRequest struct { SSHKeyIDs []string `json:"ssh_key_ids"` } -// InstallServer: install server +// InstallServer: install a baremetal server // // Install an OS on the server associated with the given ID. func (s *API) InstallServer(req *InstallServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -920,7 +920,7 @@ type DeleteServerRequest struct { ServerID string `json:"-"` } -// DeleteServer: delete server +// DeleteServer: delete a baremetal server // // Delete the server associated with the given ID. func (s *API) DeleteServer(req *DeleteServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -964,7 +964,7 @@ type RebootServerRequest struct { BootType ServerBootType `json:"boot_type"` } -// RebootServer: reboot server +// RebootServer: reboot a baremetal server // // Reboot the server associated with the given ID, use boot param to reboot in rescue. func (s *API) RebootServer(req *RebootServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -1009,7 +1009,7 @@ type StartServerRequest struct { ServerID string `json:"-"` } -// StartServer: start server +// StartServer: start a baremetal server // // Start the server associated with the given ID. func (s *API) StartServer(req *StartServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -1054,7 +1054,7 @@ type StopServerRequest struct { ServerID string `json:"-"` } -// StopServer: stop server +// StopServer: stop a baremetal server // // Stop the server associated with the given ID. func (s *API) StopServer(req *StopServerRequest, opts ...scw.RequestOption) (*Server, error) { @@ -1468,7 +1468,7 @@ type ListOSRequest struct { OfferID *string `json:"-"` } -// ListOS: list OS +// ListOS: list all available OS that can be install on a baremetal server // // List all available OS that can be install on a baremetal server. func (s *API) ListOS(req *ListOSRequest, opts ...scw.RequestOption) (*ListOSResponse, error) { @@ -1530,11 +1530,11 @@ func (r *ListOSResponse) UnsafeAppend(res interface{}) (uint32, error) { type GetOSRequest struct { Zone scw.Zone `json:"-"` - // OsID: ID of the researched OS + // OsID: ID of the OS OsID string `json:"-"` } -// GetOS: get OS +// GetOS: get an OS with a given ID // // Return specific OS for the given ID. func (s *API) GetOS(req *GetOSRequest, opts ...scw.RequestOption) (*OS, error) { diff --git a/api/instance/v1/instance_sdk.go b/api/instance/v1/instance_sdk.go index efce077ba..31bf173c3 100644 --- a/api/instance/v1/instance_sdk.go +++ b/api/instance/v1/instance_sdk.go @@ -1492,7 +1492,7 @@ type ListServersRequest struct { Tags []string `json:"-"` } -// ListServers: list servers +// ListServers: list all servers func (s *API) ListServers(req *ListServersRequest, opts ...scw.RequestOption) (*ListServersResponse, error) { var err error @@ -1590,7 +1590,7 @@ type CreateServerRequest struct { PlacementGroup *string `json:"placement_group,omitempty"` } -// createServer: create server +// createServer: create a server func (s *API) createServer(req *CreateServerRequest, opts ...scw.RequestOption) (*CreateServerResponse, error) { var err error @@ -1638,7 +1638,7 @@ type DeleteServerRequest struct { ServerID string `json:"-"` } -// DeleteServer: delete server +// DeleteServer: delete a server // // Delete a server with the given ID. func (s *API) DeleteServer(req *DeleteServerRequest, opts ...scw.RequestOption) error { @@ -1676,7 +1676,7 @@ type GetServerRequest struct { ServerID string `json:"-"` } -// GetServer: get server +// GetServer: get a server // // Get the details of a specified Server. func (s *API) GetServer(req *GetServerRequest, opts ...scw.RequestOption) (*GetServerResponse, error) { @@ -1841,7 +1841,7 @@ type UpdateServerRequest struct { PlacementGroup *NullableStringValue `json:"placement_group,omitempty"` } -// updateServer: update server +// updateServer: update a server func (s *API) updateServer(req *UpdateServerRequest, opts ...scw.RequestOption) (*UpdateServerResponse, error) { var err error @@ -2073,7 +2073,7 @@ type ListImagesRequest struct { Arch *string `json:"-"` } -// ListImages: list images +// ListImages: list instance images // // List all images available in an account. func (s *API) ListImages(req *ListImagesRequest, opts ...scw.RequestOption) (*ListImagesResponse, error) { @@ -2142,7 +2142,7 @@ type GetImageRequest struct { ImageID string `json:"-"` } -// GetImage: get image +// GetImage: get an instance image // // Get details of an image with the given ID. func (s *API) GetImage(req *GetImageRequest, opts ...scw.RequestOption) (*GetImageResponse, error) { @@ -2196,7 +2196,7 @@ type CreateImageRequest struct { Public bool `json:"public,omitempty"` } -// CreateImage: create image +// CreateImage: create an instance image func (s *API) CreateImage(req *CreateImageRequest, opts ...scw.RequestOption) (*CreateImageResponse, error) { var err error @@ -2320,7 +2320,7 @@ type DeleteImageRequest struct { ImageID string `json:"-"` } -// DeleteImage: delete image +// DeleteImage: delete an instance image // // Delete the image with the given ID. func (s *API) DeleteImage(req *DeleteImageRequest, opts ...scw.RequestOption) error { @@ -2433,7 +2433,7 @@ type CreateSnapshotRequest struct { Organization string `json:"organization,omitempty"` } -// CreateSnapshot: create snapshot +// CreateSnapshot: create a snapshot from a given volume func (s *API) CreateSnapshot(req *CreateSnapshotRequest, opts ...scw.RequestOption) (*CreateSnapshotResponse, error) { var err error @@ -2481,7 +2481,7 @@ type GetSnapshotRequest struct { SnapshotID string `json:"-"` } -// GetSnapshot: get snapshot +// GetSnapshot: get a snapshot // // Get details of a snapshot with the given ID. func (s *API) GetSnapshot(req *GetSnapshotRequest, opts ...scw.RequestOption) (*GetSnapshotResponse, error) { @@ -2591,7 +2591,7 @@ type DeleteSnapshotRequest struct { SnapshotID string `json:"-"` } -// DeleteSnapshot: delete snapshot +// DeleteSnapshot: delete a snapshot // // Delete the snapshot with the given ID. func (s *API) DeleteSnapshot(req *DeleteSnapshotRequest, opts ...scw.RequestOption) error { @@ -2722,7 +2722,7 @@ type CreateVolumeRequest struct { BaseSnapshot *string `json:"base_snapshot,omitempty"` } -// CreateVolume: create volume +// CreateVolume: create a volume func (s *API) CreateVolume(req *CreateVolumeRequest, opts ...scw.RequestOption) (*CreateVolumeResponse, error) { var err error @@ -2766,7 +2766,7 @@ type GetVolumeRequest struct { VolumeID string `json:"-"` } -// GetVolume: get volume +// GetVolume: get a volume // // Get details of a volume with the given ID. func (s *API) GetVolume(req *GetVolumeRequest, opts ...scw.RequestOption) (*GetVolumeResponse, error) { @@ -2810,7 +2810,7 @@ type UpdateVolumeRequest struct { Size *scw.Size `json:"size,omitempty"` } -// UpdateVolume: update volume +// UpdateVolume: update a volume // // Replace name and/or size properties of given ID volume with the given value(s). Any volume name can be changed while, for now, only `b_ssd` volume growing is supported. func (s *API) UpdateVolume(req *UpdateVolumeRequest, opts ...scw.RequestOption) (*UpdateVolumeResponse, error) { @@ -2855,7 +2855,7 @@ type DeleteVolumeRequest struct { VolumeID string `json:"-"` } -// DeleteVolume: delete volume +// DeleteVolume: delete a volume // // Delete the volume with the given ID. func (s *API) DeleteVolume(req *DeleteVolumeRequest, opts ...scw.RequestOption) error { @@ -2988,7 +2988,7 @@ type CreateSecurityGroupRequest struct { OutboundDefaultPolicy SecurityGroupPolicy `json:"outbound_default_policy"` } -// CreateSecurityGroup: create security group +// CreateSecurityGroup: create a security group func (s *API) CreateSecurityGroup(req *CreateSecurityGroupRequest, opts ...scw.RequestOption) (*CreateSecurityGroupResponse, error) { var err error @@ -3036,7 +3036,7 @@ type GetSecurityGroupRequest struct { SecurityGroupID string `json:"-"` } -// GetSecurityGroup: get security group +// GetSecurityGroup: get a security group // // Get the details of a Security Group with the given ID. func (s *API) GetSecurityGroup(req *GetSecurityGroupRequest, opts ...scw.RequestOption) (*GetSecurityGroupResponse, error) { @@ -3076,7 +3076,7 @@ type DeleteSecurityGroupRequest struct { SecurityGroupID string `json:"-"` } -// DeleteSecurityGroup: delete security group +// DeleteSecurityGroup: delete a security group func (s *API) DeleteSecurityGroup(req *DeleteSecurityGroupRequest, opts ...scw.RequestOption) error { var err error @@ -3138,7 +3138,7 @@ type setSecurityGroupRequest struct { Stateful bool `json:"stateful"` } -// setSecurityGroup: update security group +// setSecurityGroup: update a security group // // Replace all security group properties with a security group message. func (s *API) setSecurityGroup(req *setSecurityGroupRequest, opts ...scw.RequestOption) (*setSecurityGroupResponse, error) { @@ -3574,7 +3574,7 @@ type CreatePlacementGroupRequest struct { PolicyType PlacementGroupPolicyType `json:"policy_type"` } -// CreatePlacementGroup: create placement group +// CreatePlacementGroup: create a placement group // // Create a new placement group. func (s *API) CreatePlacementGroup(req *CreatePlacementGroupRequest, opts ...scw.RequestOption) (*CreatePlacementGroupResponse, error) { @@ -3624,7 +3624,7 @@ type GetPlacementGroupRequest struct { PlacementGroupID string `json:"-"` } -// GetPlacementGroup: get placement group +// GetPlacementGroup: get a placement group // // Get the given placement group. func (s *API) GetPlacementGroup(req *GetPlacementGroupRequest, opts ...scw.RequestOption) (*GetPlacementGroupResponse, error) { @@ -3736,7 +3736,7 @@ type UpdatePlacementGroupRequest struct { PolicyType PlacementGroupPolicyType `json:"policy_type"` } -// UpdatePlacementGroup: update placement group +// UpdatePlacementGroup: update a placement group // // Update one or more parameter of the given placement group. func (s *API) UpdatePlacementGroup(req *UpdatePlacementGroupRequest, opts ...scw.RequestOption) (*UpdatePlacementGroupResponse, error) { @@ -3963,7 +3963,7 @@ type ListIPsRequest struct { Page *int32 `json:"-"` } -// ListIPs: list IPs +// ListIPs: list all flexible IPs func (s *API) ListIPs(req *ListIPsRequest, opts ...scw.RequestOption) (*ListIPsResponse, error) { var err error @@ -4037,7 +4037,7 @@ type CreateIPRequest struct { Tags []string `json:"tags,omitempty"` } -// CreateIP: reserve an IP +// CreateIP: reserve a flexible IP func (s *API) CreateIP(req *CreateIPRequest, opts ...scw.RequestOption) (*CreateIPResponse, error) { var err error @@ -4086,7 +4086,7 @@ type GetIPRequest struct { IP string `json:"-"` } -// GetIP: get IP +// GetIP: get a flexible IP // // Get details of an IP with the given ID or address. func (s *API) GetIP(req *GetIPRequest, opts ...scw.RequestOption) (*GetIPResponse, error) { @@ -4132,7 +4132,7 @@ type UpdateIPRequest struct { Server *NullableStringValue `json:"server,omitempty"` } -// UpdateIP: update IP +// UpdateIP: update a flexible IP func (s *API) UpdateIP(req *UpdateIPRequest, opts ...scw.RequestOption) (*UpdateIPResponse, error) { var err error @@ -4175,7 +4175,7 @@ type DeleteIPRequest struct { IP string `json:"-"` } -// DeleteIP: delete IP +// DeleteIP: delete a flexible IP // // Delete the IP with the given ID. func (s *API) DeleteIP(req *DeleteIPRequest, opts ...scw.RequestOption) error { diff --git a/api/k8s/v1/k8s_sdk.go b/api/k8s/v1/k8s_sdk.go index a2fea4e00..f13e4b509 100644 --- a/api/k8s/v1/k8s_sdk.go +++ b/api/k8s/v1/k8s_sdk.go @@ -39,7 +39,7 @@ var ( _ = namegenerator.GetRandomName ) -// API: this API allows you to manage your Kapsule clusters +// API: kapsule API type API struct { client *scw.Client } diff --git a/api/registry/v1/registry_sdk.go b/api/registry/v1/registry_sdk.go index 2019473fa..21013116e 100644 --- a/api/registry/v1/registry_sdk.go +++ b/api/registry/v1/registry_sdk.go @@ -39,7 +39,7 @@ var ( _ = namegenerator.GetRandomName ) -// API: docker registry API +// API: container registry API type API struct { client *scw.Client }