Skip to content

Commit 61bc600

Browse files
docs: fix minor documentation blocks (#1970)
Co-authored-by: Rémy Léone <[email protected]>
1 parent b24b7a0 commit 61bc600

File tree

65 files changed

+13917
-7804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+13917
-7804
lines changed

packages/clients/src/api/account/v3/api.gen.ts

Lines changed: 17 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,14 @@ const jsonContentHeaders = {
4545

4646
/**
4747
* Contract API.
48-
*
49-
* The Contract API allows you to manage contracts.
48+
49+
The Contract API allows you to manage contracts.
5050
*/
5151
export class ContractAPI extends ParentAPI {
5252
/**
5353
* Download a contract content.
5454
*
55-
* @param request - The request
56-
* {@link ContractApiDownloadContractSignatureRequest}
55+
* @param request - The request {@link ContractApiDownloadContractSignatureRequest}
5756
* @returns A Promise of Blob
5857
*/
5958
downloadContractSignature = (
@@ -67,11 +66,9 @@ export class ContractAPI extends ParentAPI {
6766
})
6867

6968
/**
70-
* Create a signature for your Organization for the latest version of the
71-
* requested contract.
69+
* Create a signature for your Organization for the latest version of the requested contract.
7270
*
73-
* @param request - The request
74-
* {@link ContractApiCreateContractSignatureRequest}
71+
* @param request - The request {@link ContractApiCreateContractSignatureRequest}
7572
* @returns A Promise of ContractSignature
7673
*/
7774
createContractSignature = (
@@ -95,8 +92,7 @@ export class ContractAPI extends ParentAPI {
9592
/**
9693
* Sign a contract for your Organization.
9794
*
98-
* @param request - The request
99-
* {@link ContractApiValidateContractSignatureRequest}
95+
* @param request - The request {@link ContractApiValidateContractSignatureRequest}
10096
* @returns A Promise of ContractSignature
10197
*/
10298
validateContractSignature = (
@@ -115,8 +111,7 @@ export class ContractAPI extends ParentAPI {
115111
/**
116112
* Check if a contract is signed for your Organization.
117113
*
118-
* @param request - The request
119-
* {@link ContractApiCheckContractSignatureRequest}
114+
* @param request - The request {@link ContractApiCheckContractSignatureRequest}
120115
* @returns A Promise of CheckContractSignatureResponse
121116
*/
122117
checkContractSignature = (
@@ -164,8 +159,7 @@ export class ContractAPI extends ParentAPI {
164159
/**
165160
* List contract signatures for an Organization.
166161
*
167-
* @param request - The request
168-
* {@link ContractApiListContractSignaturesRequest}
162+
* @param request - The request {@link ContractApiListContractSignaturesRequest}
169163
* @returns A Promise of ListContractSignaturesResponse
170164
*/
171165
listContractSignatures = (
@@ -180,13 +174,12 @@ export class ContractAPI extends ParentAPI {
180174

181175
/**
182176
* Account API.
183-
*
184-
* This API allows you to manage your Scaleway Projects.
177+
178+
This API allows you to manage your Scaleway Projects.
185179
*/
186180
export class ProjectAPI extends ParentAPI {
187181
/**
188-
* Create a new Project for an Organization. Generate a new Project for an
189-
* Organization, specifying its configuration including name and description.
182+
* Create a new Project for an Organization. Generate a new Project for an Organization, specifying its configuration including name and description.
190183
*
191184
* @param request - The request {@link ProjectApiCreateProjectRequest}
192185
* @returns A Promise of Project
@@ -231,10 +224,7 @@ export class ProjectAPI extends ParentAPI {
231224
)
232225

233226
/**
234-
* List all Projects of an Organization. List all Projects of an Organization.
235-
* The response will include the total number of Projects as well as their
236-
* associated Organizations, names, and IDs. Other information includes the
237-
* creation and update date of the Project.
227+
* List all Projects of an Organization. List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names, and IDs. Other information includes the creation and update date of the Project.
238228
*
239229
* @param request - The request {@link ProjectApiListProjectsRequest}
240230
* @returns A Promise of ListProjectsResponse
@@ -243,9 +233,7 @@ export class ProjectAPI extends ParentAPI {
243233
enrichForPagination('projects', this.pageOfListProjects, request)
244234

245235
/**
246-
* Get an existing Project. Retrieve information about an existing Project,
247-
* specified by its Project ID. Its full details, including ID, name and
248-
* description, are returned in the response object.
236+
* Get an existing Project. Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
249237
*
250238
* @param request - The request {@link ProjectApiGetProjectRequest}
251239
* @returns A Promise of Project
@@ -260,10 +248,7 @@ export class ProjectAPI extends ParentAPI {
260248
)
261249

262250
/**
263-
* Delete an existing Project. Delete an existing Project, specified by its
264-
* Project ID. The Project needs to be empty (meaning there are no resources
265-
* left in it) to be deleted effectively. Note that deleting a Project is
266-
* permanent, and cannot be undone.
251+
* Delete an existing Project. Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
267252
*
268253
* @param request - The request {@link ProjectApiDeleteProjectRequest}
269254
*/
@@ -274,8 +259,7 @@ export class ProjectAPI extends ParentAPI {
274259
})
275260

276261
/**
277-
* Update Project. Update the parameters of an existing Project, specified by
278-
* its Project ID. These parameters include the name and description.
262+
* Update Project. Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
279263
*
280264
* @param request - The request {@link ProjectApiUpdateProjectRequest}
281265
* @returns A Promise of Project
@@ -294,12 +278,9 @@ export class ProjectAPI extends ParentAPI {
294278
)
295279

296280
/**
297-
* Set project use case. Set the project use case for a new or existing
298-
* Project, specified by its Project ID. You can customize the use case, sub
299-
* use case, and architecture type you want to use in the Project.
281+
* Set project use case. Set the project use case for a new or existing Project, specified by its Project ID. You can customize the use case, sub use case, and architecture type you want to use in the Project.
300282
*
301-
* @param request - The request
302-
* {@link ProjectApiSetProjectQualificationRequest}
283+
* @param request - The request {@link ProjectApiSetProjectQualificationRequest}
303284
* @returns A Promise of ProjectQualification
304285
*/
305286
setProjectQualification = (

0 commit comments

Comments
 (0)