Skip to content

Commit e3bfb40

Browse files
scaleway-botscaleway-bot
authored
docs: update doc generation (#1568)
1 parent eb02d5e commit e3bfb40

File tree

26 files changed

+4537
-6660
lines changed

26 files changed

+4537
-6660
lines changed

‎api/account/v2/account_sdk.go‎

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,7 @@ var (
3939
_ = namegenerator.GetRandomName
4040
)
4141

42-
// API: user related data
43-
//
44-
// This API allows you to manage projects.
42+
// API: this API allows you to manage projects.
4543
type API struct {
4644
client *scw.Client
4745
}
@@ -85,42 +83,42 @@ func (enum *ListProjectsRequestOrderBy) UnmarshalJSON(data []byte) error {
8583
return nil
8684
}
8785

88-
// ListProjectsResponse: list projects response
86+
// ListProjectsResponse: list projects response.
8987
type ListProjectsResponse struct {
90-
// TotalCount: the total number of projects
88+
// TotalCount: the total number of projects.
9189
TotalCount uint32 `json:"total_count"`
92-
// Projects: the paginated returned projects
90+
// Projects: the paginated returned projects.
9391
Projects []*Project `json:"projects"`
9492
}
9593

96-
// Project: project
94+
// Project: project.
9795
type Project struct {
98-
// ID: the ID of the project
96+
// ID: the ID of the project.
9997
ID string `json:"id"`
100-
// Name: the name of the project
98+
// Name: the name of the project.
10199
Name string `json:"name"`
102-
// OrganizationID: the organization ID of the project
100+
// OrganizationID: the organization ID of the project.
103101
OrganizationID string `json:"organization_id"`
104-
// CreatedAt: the creation date of the project
102+
// CreatedAt: the creation date of the project.
105103
CreatedAt *time.Time `json:"created_at"`
106-
// UpdatedAt: the update date of the project
104+
// UpdatedAt: the update date of the project.
107105
UpdatedAt *time.Time `json:"updated_at"`
108-
// Description: the description of the project
106+
// Description: the description of the project.
109107
Description string `json:"description"`
110108
}
111109

112110
// Service API
113111

114112
type CreateProjectRequest struct {
115-
// Name: the name of the project
113+
// Name: the name of the project.
116114
Name string `json:"name"`
117-
// OrganizationID: the organization ID of the project
115+
// OrganizationID: the organization ID of the project.
118116
OrganizationID string `json:"organization_id"`
119-
// Description: the description of the project
117+
// Description: the description of the project.
120118
Description *string `json:"description"`
121119
}
122120

123-
// CreateProject: create project
121+
// CreateProject: create project.
124122
func (s *API) CreateProject(req *CreateProjectRequest, opts ...scw.RequestOption) (*Project, error) {
125123
var err error
126124

@@ -150,23 +148,22 @@ func (s *API) CreateProject(req *CreateProjectRequest, opts ...scw.RequestOption
150148
}
151149

152150
type ListProjectsRequest struct {
153-
// OrganizationID: the organization ID of the project
151+
// OrganizationID: the organization ID of the project.
154152
OrganizationID string `json:"-"`
155-
// Name: the name of the project
153+
// Name: the name of the project.
156154
Name *string `json:"-"`
157-
// Page: the page number for the returned projects
155+
// Page: the page number for the returned projects.
158156
Page *int32 `json:"-"`
159-
// PageSize: the maximum number of project per page
157+
// PageSize: the maximum number of project per page.
160158
PageSize *uint32 `json:"-"`
161-
// OrderBy: the sort order of the returned projects
162-
//
159+
// OrderBy: the sort order of the returned projects.
163160
// Default value: created_at_asc
164161
OrderBy ListProjectsRequestOrderBy `json:"-"`
165-
// ProjectIDs: filter out by a list of project ID
162+
// ProjectIDs: filter out by a list of project ID.
166163
ProjectIDs []string `json:"-"`
167164
}
168165

169-
// ListProjects: list projects
166+
// ListProjects: list projects.
170167
func (s *API) ListProjects(req *ListProjectsRequest, opts ...scw.RequestOption) (*ListProjectsResponse, error) {
171168
var err error
172169

@@ -205,11 +202,11 @@ func (s *API) ListProjects(req *ListProjectsRequest, opts ...scw.RequestOption)
205202
}
206203

207204
type GetProjectRequest struct {
208-
// ProjectID: the project ID of the project
205+
// ProjectID: the project ID of the project.
209206
ProjectID string `json:"-"`
210207
}
211208

212-
// GetProject: get project
209+
// GetProject: get project.
213210
func (s *API) GetProject(req *GetProjectRequest, opts ...scw.RequestOption) (*Project, error) {
214211
var err error
215212

@@ -238,11 +235,11 @@ func (s *API) GetProject(req *GetProjectRequest, opts ...scw.RequestOption) (*Pr
238235
}
239236

240237
type DeleteProjectRequest struct {
241-
// ProjectID: the project ID of the project
238+
// ProjectID: the project ID of the project.
242239
ProjectID string `json:"-"`
243240
}
244241

245-
// DeleteProject: delete project
242+
// DeleteProject: delete project.
246243
func (s *API) DeleteProject(req *DeleteProjectRequest, opts ...scw.RequestOption) error {
247244
var err error
248245

@@ -269,15 +266,15 @@ func (s *API) DeleteProject(req *DeleteProjectRequest, opts ...scw.RequestOption
269266
}
270267

271268
type UpdateProjectRequest struct {
272-
// ProjectID: the project ID of the project
269+
// ProjectID: the project ID of the project.
273270
ProjectID string `json:"-"`
274-
// Name: the name of the project
271+
// Name: the name of the project.
275272
Name *string `json:"name"`
276-
// Description: the description of the project
273+
// Description: the description of the project.
277274
Description *string `json:"description"`
278275
}
279276

280-
// UpdateProject: update project
277+
// UpdateProject: update project.
281278
func (s *API) UpdateProject(req *UpdateProjectRequest, opts ...scw.RequestOption) (*Project, error) {
282279
var err error
283280

‎api/account/v2alpha1/account_sdk.go‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var (
3939
_ = namegenerator.GetRandomName
4040
)
4141

42-
// API: account API
42+
// API: account API.
4343
type API struct {
4444
client *scw.Client
4545
}
@@ -85,14 +85,14 @@ func (enum *ListSSHKeysRequestOrderBy) UnmarshalJSON(data []byte) error {
8585
return nil
8686
}
8787

88-
// ListSSHKeysResponse: list ssh keys response
88+
// ListSSHKeysResponse: list ssh keys response.
8989
type ListSSHKeysResponse struct {
9090
SSHKeys []*SSHKey `json:"ssh_keys"`
9191

9292
TotalCount uint32 `json:"total_count"`
9393
}
9494

95-
// SSHKey: ssh key
95+
// SSHKey: ssh key.
9696
type SSHKey struct {
9797
ID string `json:"id"`
9898

@@ -125,7 +125,6 @@ type SSHKeyCreationInfo struct {
125125

126126
type ListSSHKeysRequest struct {
127127
// OrderBy:
128-
//
129128
// Default value: created_at_asc
130129
OrderBy ListSSHKeysRequestOrderBy `json:"-"`
131130

@@ -140,7 +139,7 @@ type ListSSHKeysRequest struct {
140139
ProjectID *string `json:"-"`
141140
}
142141

143-
// ListSSHKeys: list all SSH keys of your project
142+
// ListSSHKeys: list all SSH keys of your project.
144143
func (s *API) ListSSHKeys(req *ListSSHKeysRequest, opts ...scw.RequestOption) (*ListSSHKeysResponse, error) {
145144
var err error
146145

@@ -174,19 +173,19 @@ func (s *API) ListSSHKeys(req *ListSSHKeysRequest, opts ...scw.RequestOption) (*
174173
}
175174

176175
type CreateSSHKeyRequest struct {
177-
// Name: the name of the SSH key
176+
// Name: the name of the SSH key.
178177
Name string `json:"name"`
179-
// PublicKey: SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported
178+
// PublicKey: SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported.
180179
PublicKey string `json:"public_key"`
181-
// Deprecated: OrganizationID: use project_id field instead
180+
// Deprecated: OrganizationID: use project_id field instead.
182181
// Precisely one of OrganizationID, ProjectID must be set.
183182
OrganizationID *string `json:"organization_id,omitempty"`
184-
// ProjectID: project owning the resource
183+
// ProjectID: project owning the resource.
185184
// Precisely one of OrganizationID, ProjectID must be set.
186185
ProjectID *string `json:"project_id,omitempty"`
187186
}
188187

189-
// CreateSSHKey: add an SSH key to your project
188+
// CreateSSHKey: add an SSH key to your project.
190189
func (s *API) CreateSSHKey(req *CreateSSHKeyRequest, opts ...scw.RequestOption) (*SSHKey, error) {
191190
var err error
192191

@@ -221,11 +220,11 @@ func (s *API) CreateSSHKey(req *CreateSSHKeyRequest, opts ...scw.RequestOption)
221220
}
222221

223222
type GetSSHKeyRequest struct {
224-
// SSHKeyID: the ID of the SSH key
223+
// SSHKeyID: the ID of the SSH key.
225224
SSHKeyID string `json:"-"`
226225
}
227226

228-
// GetSSHKey: get an SSH key from your project
227+
// GetSSHKey: get an SSH key from your project.
229228
func (s *API) GetSSHKey(req *GetSSHKeyRequest, opts ...scw.RequestOption) (*SSHKey, error) {
230229
var err error
231230

@@ -250,11 +249,11 @@ func (s *API) GetSSHKey(req *GetSSHKeyRequest, opts ...scw.RequestOption) (*SSHK
250249

251250
type UpdateSSHKeyRequest struct {
252251
SSHKeyID string `json:"-"`
253-
// Name: name of the SSH key
252+
// Name: name of the SSH key.
254253
Name *string `json:"name"`
255254
}
256255

257-
// UpdateSSHKey: update an SSH key on your project
256+
// UpdateSSHKey: update an SSH key on your project.
258257
func (s *API) UpdateSSHKey(req *UpdateSSHKeyRequest, opts ...scw.RequestOption) (*SSHKey, error) {
259258
var err error
260259

@@ -286,7 +285,7 @@ type DeleteSSHKeyRequest struct {
286285
SSHKeyID string `json:"-"`
287286
}
288287

289-
// DeleteSSHKey: remove an SSH key from your project
288+
// DeleteSSHKey: remove an SSH key from your project.
290289
func (s *API) DeleteSSHKey(req *DeleteSSHKeyRequest, opts ...scw.RequestOption) error {
291290
var err error
292291

0 commit comments

Comments
 (0)