Skip to content

Commit 7ba2445

Browse files
scaleway-botQuentin Brosse
andauthored
doc(instance): fix project documentation (#551)
Co-authored-by: Quentin Brosse <[email protected]>
1 parent 59dda9e commit 7ba2445

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

api/instance/v1/instance_sdk.go

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ type Bootscript struct {
613613
Initrd string `json:"initrd"`
614614
// Kernel: the server kernel version
615615
Kernel string `json:"kernel"`
616-
// Organization: the bootscript organization
616+
// Organization: the bootscript organization ID
617617
Organization string `json:"organization"`
618618
// Project: the bootscript project ID
619619
Project string `json:"project"`
@@ -892,7 +892,7 @@ type PlacementGroup struct {
892892
ID string `json:"id"`
893893
// Name: the placement group name
894894
Name string `json:"name"`
895-
// Organization: the placement group organization
895+
// Organization: the placement group organization ID
896896
Organization string `json:"organization"`
897897
// Project: the placement group project ID
898898
Project string `json:"project"`
@@ -950,11 +950,11 @@ type SecurityGroup struct {
950950
OutboundDefaultPolicy SecurityGroupPolicy `json:"outbound_default_policy"`
951951
// Organization: the security groups organization ID
952952
Organization string `json:"organization"`
953-
// Project: the project ID of the security group
953+
// Project: the security group project ID
954954
Project string `json:"project"`
955-
// OrganizationDefault: true if it is your default security group for this organization
955+
// OrganizationDefault: true if it is your default security group for this organization ID
956956
OrganizationDefault bool `json:"organization_default"`
957-
// ProjectDefault: true if it is your default security group for this project id
957+
// ProjectDefault: true if it is your default security group for this project ID
958958
ProjectDefault bool `json:"project_default"`
959959
// CreationDate: the security group creation date
960960
CreationDate *time.Time `json:"creation_date"`
@@ -1014,7 +1014,7 @@ type Server struct {
10141014
ID string `json:"id"`
10151015
// Name: the server name
10161016
Name string `json:"name"`
1017-
// Organization: the server organization
1017+
// Organization: the server organization ID
10181018
Organization string `json:"organization"`
10191019
// Project: the server project ID
10201020
Project string `json:"project"`
@@ -1277,7 +1277,7 @@ type Volume struct {
12771277
CreationDate *time.Time `json:"creation_date"`
12781278
// ModificationDate: the volumes modification date
12791279
ModificationDate *time.Time `json:"modification_date"`
1280-
// Organization: the volumes organization
1280+
// Organization: the volumes organization ID
12811281
Organization string `json:"organization"`
12821282
// Project: the volumes project ID
12831283
Project string `json:"project"`
@@ -1518,7 +1518,7 @@ type ListServersRequest struct {
15181518
PerPage *uint32 `json:"-"`
15191519
// Page: a positive integer to choose the page to return
15201520
Page *int32 `json:"-"`
1521-
// Organization: list only servers of this organization
1521+
// Organization: list only servers of this organization ID
15221522
Organization *string `json:"-"`
15231523
// Project: list only servers of this project ID
15241524
Project *string `json:"-"`
@@ -1774,7 +1774,7 @@ type setServerRequest struct {
17741774
ID string `json:"-"`
17751775
// Name: the server name
17761776
Name string `json:"name"`
1777-
// Organization: the server organization
1777+
// Organization: the server organization ID
17781778
Organization string `json:"organization"`
17791779
// Project: the server project ID
17801780
Project string `json:"project"`
@@ -2742,7 +2742,7 @@ type ListVolumesRequest struct {
27422742
PerPage *uint32 `json:"-"`
27432743
// Page: a positive integer to choose the page to return
27442744
Page *int32 `json:"-"`
2745-
// Organization: filter volume by organization
2745+
// Organization: filter volume by organization ID
27462746
Organization *string `json:"-"`
27472747
// Project: filter volume by project ID
27482748
Project *string `json:"-"`
@@ -3090,7 +3090,7 @@ type CreateSecurityGroupRequest struct {
30903090
Name string `json:"name,omitempty"`
30913091
// Description: description of the security group
30923092
Description string `json:"description,omitempty"`
3093-
// Organization: organization the security group belongs to
3093+
// Organization: organization ID the security group belongs to
30943094
// Precisely one of Organization, Project must be set.
30953095
Organization *string `json:"organization,omitempty"`
30963096
// Project: project ID the security group belong to
@@ -3637,7 +3637,7 @@ type ListPlacementGroupsRequest struct {
36373637
PerPage *uint32 `json:"-"`
36383638
// Page: a positive integer to choose the page to return
36393639
Page *int32 `json:"-"`
3640-
// Organization: list only placement groups of this organization
3640+
// Organization: list only placement groups of this organization ID
36413641
Organization *string `json:"-"`
36423642
// Project: list only placement groups of this project ID
36433643
Project *string `json:"-"`
@@ -4114,8 +4114,6 @@ func (s *API) UpdatePlacementGroupServers(req *UpdatePlacementGroupServersReques
41144114

41154115
type ListIPsRequest struct {
41164116
Zone scw.Zone `json:"-"`
4117-
// Project: the project ID the IPs are reserved in
4118-
Project *string `json:"-"`
41194117
// Organization: the organization ID the IPs are reserved in
41204118
Organization *string `json:"-"`
41214119
// Name: filter on the IP address (Works as a LIKE operation on the IP address)
@@ -4126,6 +4124,8 @@ type ListIPsRequest struct {
41264124
PerPage *uint32 `json:"-"`
41274125
// Page: a positive integer to choose the page to return
41284126
Page *int32 `json:"-"`
4127+
// Project: the project ID the IPs are reserved in
4128+
Project *string `json:"-"`
41294129
}
41304130

41314131
// ListIPs: list all flexible IPs
@@ -4143,11 +4143,11 @@ func (s *API) ListIPs(req *ListIPsRequest, opts ...scw.RequestOption) (*ListIPsR
41434143
}
41444144

41454145
query := url.Values{}
4146-
parameter.AddToQuery(query, "project", req.Project)
41474146
parameter.AddToQuery(query, "organization", req.Organization)
41484147
parameter.AddToQuery(query, "name", req.Name)
41494148
parameter.AddToQuery(query, "per_page", req.PerPage)
41504149
parameter.AddToQuery(query, "page", req.Page)
4150+
parameter.AddToQuery(query, "project", req.Project)
41514151

41524152
if fmt.Sprint(req.Zone) == "" {
41534153
return nil, errors.New("field Zone cannot be empty in request")

0 commit comments

Comments
 (0)