Skip to content

Commit 0501aa1

Browse files
authored
docs: harmonize short API descriptions (#1259)
1 parent c71af8b commit 0501aa1

File tree

33 files changed

+126
-39
lines changed

33 files changed

+126
-39
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const jsonContentHeaders = {
2929
/**
3030
* Account API.
3131
*
32-
* User related data. This API allows you to manage projects.
32+
* This API allows you to manage your Scaleway Projects.
3333
*/
3434
export class API extends ParentAPI {
3535
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const jsonContentHeaders = {
2929
/**
3030
* Account API.
3131
*
32-
* This API allows you to manage projects.
32+
* This API allows you to manage your Scaleway Projects.
3333
*/
3434
export class ProjectAPI extends ParentAPI {
3535
/**

packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ const jsonContentHeaders = {
4444
'Content-Type': 'application/json; charset=utf-8',
4545
}
4646

47-
/** Apple silicon API. */
47+
/**
48+
* Apple silicon API.
49+
*
50+
* This API allows you to manage your Apple silicon machines.
51+
*/
4852
export class API extends ParentAPI {
4953
/** Lists the available zones of the API. */
5054
public static readonly LOCALITIES: Zone[] = ['fr-par-3']

packages/clients/src/api/baremetal/v1/api.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ const jsonContentHeaders = {
9595
/**
9696
* Elastic Metal API.
9797
*
98-
* This API allows to manage your Elastic Metal server.
98+
* This API allows you to manage your Elastic Metal servers.
9999
*/
100100
export class API extends ParentAPI {
101101
/** Lists the available zones of the API. */

packages/clients/src/api/billing/v2alpha1/api.gen.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ import type {
2424
/**
2525
* Billing API.
2626
*
27-
* This API allows you to query your consumption.
27+
* This API allows you to manage and query your Scaleway billing and
28+
* consumption.
2829
*/
2930
export class API extends ParentAPI {
3031
/**

packages/clients/src/api/billing/v2beta1/api.gen.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ import type {
3232
/**
3333
* Billing API.
3434
*
35-
* This API allows you to query your consumption.
35+
* This API allows you to manage and query your Scaleway billing and
36+
* consumption.
3637
*/
3738
export class API extends ParentAPI {
3839
protected pageOfListConsumptions = (

packages/clients/src/api/block/v1alpha1/api.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const jsonContentHeaders = {
5151
/**
5252
* Scaleway Block Storage API.
5353
*
54-
* This API allows you to use and manage your Block Storage volumes.
54+
* This API allows you to manage your Block Storage volumes.
5555
*/
5656
export class API extends ParentAPI {
5757
/** Lists the available zones of the API. */

packages/clients/src/api/cockpit/v1beta1/api.gen.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,8 @@ const jsonContentHeaders = {
8787
/**
8888
* Cockpit API.
8989
*
90-
* The Cockpit API allows you to activate your Cockpit to store metrics and
91-
* logs. It also provides you with a dedicated Grafana for dashboarding to
92-
* visualize your metrics and logs.
90+
* This API allows you to manage your Scaleway Cockpit, for storing and
91+
* visualizing metrics and logs.
9392
*/
9493
export class API extends ParentAPI {
9594
/**

packages/clients/src/api/container/v1beta1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,11 @@ const jsonContentHeaders = {
9090
'Content-Type': 'application/json; charset=utf-8',
9191
}
9292

93-
/** Serverless Containers API. */
93+
/**
94+
* Serverless Containers API.
95+
*
96+
* This API allows you to manage your Serverless Containers.
97+
*/
9498
export class API extends ParentAPI {
9599
/** Lists the available regions of the API. */
96100
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/document_db/v1beta1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,11 @@ const jsonContentHeaders = {
147147
'Content-Type': 'application/json; charset=utf-8',
148148
}
149149

150-
/** Managed Document Databases API. */
150+
/**
151+
* Managed Document Databases API.
152+
*
153+
* This API allows you to manage your Document Databases.
154+
*/
151155
export class API extends ParentAPI {
152156
/** Lists the available regions of the API. */
153157
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/domain/v2beta1/api.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ const jsonContentHeaders = {
164164
/**
165165
* Domains and DNS API.
166166
*
167-
* Manage your domains, DNS zones and records with the Domains and DNS API.
167+
* This API allows you to manage your domains, DNS zones and records.
168168
*/
169169
export class API extends ParentAPI {
170170
protected pageOfListDNSZones = (request: Readonly<ListDNSZonesRequest>) =>

packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,12 @@ const jsonContentHeaders = {
4444
'Content-Type': 'application/json; charset=utf-8',
4545
}
4646

47-
/** Elastic Metal - Flexible IP API. */
47+
/**
48+
* Elastic Metal - Flexible IP API.
49+
*
50+
* This API allows you to manage your Elastic Metal servers' flexible public IP
51+
* addresses.
52+
*/
4853
export class API extends ParentAPI {
4954
/** Lists the available zones of the API. */
5055
public static readonly LOCALITIES: Zone[] = [

packages/clients/src/api/function/v1beta1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,11 @@ const jsonContentHeaders = {
9999
'Content-Type': 'application/json; charset=utf-8',
100100
}
101101

102-
/** Serverless Functions API. */
102+
/**
103+
* Serverless Functions API.
104+
*
105+
* This API allows you to manage your Serverless Functions.
106+
*/
103107
export class API extends ParentAPI {
104108
/** Lists the available regions of the API. */
105109
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/iam/v1alpha1/api.gen.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,12 @@ const jsonContentHeaders = {
124124
'Content-Type': 'application/json; charset=utf-8',
125125
}
126126

127-
/** IAM API. */
127+
/**
128+
* IAM API.
129+
*
130+
* This API allows you to manage Identity and Access Management (IAM) across
131+
* your Scaleway Organizations, Projects and resources.
132+
*/
128133
export class API extends ParentAPI {
129134
protected pageOfListSSHKeys = (request: Readonly<ListSSHKeysRequest> = {}) =>
130135
this.client.fetch<ListSSHKeysResponse>(

packages/clients/src/api/instance/v1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,11 @@ const jsonContentHeaders = {
240240
'Content-Type': 'application/json; charset=utf-8',
241241
}
242242

243-
/** Instance API. */
243+
/**
244+
* Instance API.
245+
*
246+
* This API allows you to manage your Instances.
247+
*/
244248
export class API extends ParentAPI {
245249
/** Lists the available zones of the API. */
246250
public static readonly LOCALITIES: Zone[] = [

packages/clients/src/api/iot/v1/api.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ const jsonContentHeaders = {
104104
/**
105105
* IoT Hub API.
106106
*
107-
* This API allows you to manage IoT hubs and devices.
107+
* This API allows you to manage your IoT hubs and devices.
108108
*/
109109
export class API extends ParentAPI {
110110
/** Lists the available regions of the API. */

packages/clients/src/api/jobs/v1alpha1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ const jsonContentHeaders = {
3838
'Content-Type': 'application/json; charset=utf-8',
3939
}
4040

41-
/** Serverless Jobs API. */
41+
/**
42+
* Serverless Jobs API.
43+
*
44+
* This API allows you to manage your Serverless Jobs.
45+
*/
4246
export class API extends ParentAPI {
4347
/** Lists the available regions of the API. */
4448
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/k8s/v1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,11 @@ const jsonContentHeaders = {
8282
'Content-Type': 'application/json; charset=utf-8',
8383
}
8484

85-
/** Kubernetes API. */
85+
/**
86+
* Kubernetes API.
87+
*
88+
* This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
89+
*/
8690
export class API extends ParentAPI {
8791
/** Lists the available regions of the API. */
8892
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/lb/v1/api.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1463,7 +1463,7 @@ export class ZonedAPI extends ParentAPI {
14631463
/**
14641464
* Load balancer API.
14651465
*
1466-
* This API allows you to manage your load balancer service.
1466+
* This API allows you to manage your Load Balancers.
14671467
*/
14681468
export class API extends ParentAPI {
14691469
/** Lists the available regions of the API. */

packages/clients/src/api/llm_inference/v1beta1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,11 @@ const jsonContentHeaders = {
6161
'Content-Type': 'application/json; charset=utf-8',
6262
}
6363

64-
/** LLM Inference API. */
64+
/**
65+
* LLM Inference API.
66+
*
67+
* This API allows you to manage your LLM Inference services.
68+
*/
6569
export class API extends ParentAPI {
6670
/** Lists the available regions of the API. */
6771
public static readonly LOCALITIES: Region[] = ['fr-par']

packages/clients/src/api/marketplace/v2/api.gen.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,12 @@ import type {
3636
Version,
3737
} from './types.gen'
3838

39-
/** Marketplace API. */
39+
/**
40+
* Marketplace API.
41+
*
42+
* This API allows you to find available images for use when launching a
43+
* Scaleway Instance.
44+
*/
4045
export class API extends ParentAPI {
4146
protected pageOfListImages = (request: Readonly<ListImagesRequest>) =>
4247
this.client.fetch<ListImagesResponse>(

packages/clients/src/api/mnq/v1beta1/api.gen.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ const jsonContentHeaders = {
7575
/**
7676
* Messaging and Queuing NATS API.
7777
*
78-
* This API allows you to manage Scaleway Messaging and Queueing NATS accounts.
78+
* This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
7979
*/
8080
export class NatsAPI extends ParentAPI {
8181
/** Lists the available regions of the API. */
@@ -286,7 +286,8 @@ export class NatsAPI extends ParentAPI {
286286
/**
287287
* Messaging and Queuing SNS API.
288288
*
289-
* This API allows you to manage Scaleway Messaging and Queueing SNS brokers.
289+
* This API allows you to manage your Scaleway Messaging and Queuing SNS
290+
* brokers.
290291
*/
291292
export class SnsAPI extends ParentAPI {
292293
/** Lists the available regions of the API. */
@@ -478,7 +479,8 @@ export class SnsAPI extends ParentAPI {
478479
/**
479480
* Messaging and Queuing SQS API.
480481
*
481-
* This API allows you to manage Scaleway Messaging and Queueing SQS brokers.
482+
* This API allows you to manage your Scaleway Messaging and Queuing SQS
483+
* brokers.
482484
*/
483485
export class SqsAPI extends ParentAPI {
484486
/** Lists the available regions of the API. */

packages/clients/src/api/rdb/v1/api.gen.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,12 @@ const jsonContentHeaders = {
166166
'Content-Type': 'application/json; charset=utf-8',
167167
}
168168

169-
/** Managed Database for PostgreSQL and MySQL API. */
169+
/**
170+
* Managed Database for PostgreSQL and MySQL API.
171+
*
172+
* This API allows you to manage your Managed Databases for PostgreSQL and
173+
* MySQL.
174+
*/
170175
export class API extends ParentAPI {
171176
/** Lists the available regions of the API. */
172177
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/redis/v1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,11 @@ const jsonContentHeaders = {
7575
'Content-Type': 'application/json; charset=utf-8',
7676
}
7777

78-
/** Managed Database for Redis™ API. */
78+
/**
79+
* Managed Database for Redis™ API.
80+
*
81+
* This API allows you to manage your Managed Databases for Redis™.
82+
*/
7983
export class API extends ParentAPI {
8084
/** Lists the available zones of the API. */
8185
public static readonly LOCALITIES: Zone[] = [

packages/clients/src/api/registry/v1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ const jsonContentHeaders = {
4949
'Content-Type': 'application/json; charset=utf-8',
5050
}
5151

52-
/** Container Registry API. */
52+
/**
53+
* Container Registry API.
54+
*
55+
* This API allows you to manage your Container Registry resources.
56+
*/
5357
export class API extends ParentAPI {
5458
/** Lists the available regions of the API. */
5559
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/secret/v1alpha1/api.gen.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,9 @@ const jsonContentHeaders = {
6767
/**
6868
* Secret Manager API.
6969
*
70-
* Secret Manager API. This API allows you to conveniently store, access and
71-
* share sensitive data.
70+
* This API allows you to manage your Secret Manager services, for storing,
71+
* accessing and sharing sensitive data such as passwords, API keys and
72+
* certificates.
7273
*/
7374
export class API extends ParentAPI {
7475
/** Lists the available regions of the API. */

packages/clients/src/api/secret/v1beta1/api.gen.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ const jsonContentHeaders = {
5757
/**
5858
* Secret Manager API.
5959
*
60-
* This API allows you to conveniently store, access and share sensitive data
61-
* such as passwords, API keys and certificates.
60+
* This API allows you to manage your Secret Manager services, for storing,
61+
* accessing and sharing sensitive data such as passwords, API keys and
62+
* certificates.
6263
*/
6364
export class API extends ParentAPI {
6465
/** Lists the available regions of the API. */

packages/clients/src/api/serverless_sqldb/v1alpha1/api.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const jsonContentHeaders = {
4141
/**
4242
* Serverless SQL Databases API.
4343
*
44-
* This API allows you to manage your Serverless SQL DB databases.
44+
* This API allows you to manage your Serverless SQL Databases.
4545
*/
4646
export class API extends ParentAPI {
4747
/** Lists the available regions of the API. */

packages/clients/src/api/tem/v1alpha1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,11 @@ const jsonContentHeaders = {
4848
'Content-Type': 'application/json; charset=utf-8',
4949
}
5050

51-
/** Transactional Email API. */
51+
/**
52+
* Transactional Email API.
53+
*
54+
* This API allows you to manage your Transactional Email services.
55+
*/
5256
export class API extends ParentAPI {
5357
/** Lists the available regions of the API. */
5458
public static readonly LOCALITIES: Region[] = ['fr-par']

packages/clients/src/api/vpc/v1/api.gen.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@ const jsonContentHeaders = {
2727
'Content-Type': 'application/json; charset=utf-8',
2828
}
2929

30-
/** VPC API. */
30+
/**
31+
* VPC API.
32+
*
33+
* This API allows you to manage your Virtual Private Clouds (VPCs) and Private
34+
* Networks.
35+
*/
3136
export class API extends ParentAPI {
3237
/** Lists the available zones of the API. */
3338
public static readonly LOCALITIES: Zone[] = [

packages/clients/src/api/vpc/v2/api.gen.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,12 @@ const jsonContentHeaders = {
5454
'Content-Type': 'application/json; charset=utf-8',
5555
}
5656

57-
/** VPC API. */
57+
/**
58+
* VPC API.
59+
*
60+
* This API allows you to manage your Virtual Private Clouds (VPCs) and Private
61+
* Networks.
62+
*/
5863
export class API extends ParentAPI {
5964
/** Lists the available regions of the API. */
6065
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

packages/clients/src/api/vpcgw/v1/api.gen.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,11 @@ const jsonContentHeaders = {
101101
'Content-Type': 'application/json; charset=utf-8',
102102
}
103103

104-
/** Public Gateways API. */
104+
/**
105+
* Public Gateways API.
106+
*
107+
* This API allows you to manage your Public Gateways.
108+
*/
105109
export class API extends ParentAPI {
106110
/** Lists the available zones of the API. */
107111
public static readonly LOCALITIES: Zone[] = [

0 commit comments

Comments
 (0)