Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/clients/src/api/account/v2/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const jsonContentHeaders = {
/**
* Account API.
*
* User related data. This API allows you to manage projects.
* This API allows you to manage your Scaleway Projects.
*/
export class API extends ParentAPI {
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/account/v3/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const jsonContentHeaders = {
/**
* Account API.
*
* This API allows you to manage projects.
* This API allows you to manage your Scaleway Projects.
*/
export class ProjectAPI extends ParentAPI {
/**
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Apple silicon API. */
/**
* Apple silicon API.
*
* This API allows you to manage your Apple silicon machines.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
public static readonly LOCALITIES: Zone[] = ['fr-par-3']
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/baremetal/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ const jsonContentHeaders = {
/**
* Elastic Metal API.
*
* This API allows to manage your Elastic Metal server.
* This API allows you to manage your Elastic Metal servers.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
Expand Down
3 changes: 2 additions & 1 deletion packages/clients/src/api/billing/v2alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ import type {
/**
* Billing API.
*
* This API allows you to query your consumption.
* This API allows you to manage and query your Scaleway billing and
* consumption.
*/
export class API extends ParentAPI {
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clients/src/api/billing/v2beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ import type {
/**
* Billing API.
*
* This API allows you to query your consumption.
* This API allows you to manage and query your Scaleway billing and
* consumption.
*/
export class API extends ParentAPI {
protected pageOfListConsumptions = (
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/block/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const jsonContentHeaders = {
/**
* Scaleway Block Storage API.
*
* This API allows you to use and manage your Block Storage volumes.
* This API allows you to manage your Block Storage volumes.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
Expand Down
5 changes: 2 additions & 3 deletions packages/clients/src/api/cockpit/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,8 @@ const jsonContentHeaders = {
/**
* Cockpit API.
*
* The Cockpit API allows you to activate your Cockpit to store metrics and
* logs. It also provides you with a dedicated Grafana for dashboarding to
* visualize your metrics and logs.
* This API allows you to manage your Scaleway Cockpit, for storing and
* visualizing metrics and logs.
*/
export class API extends ParentAPI {
/**
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/container/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Serverless Containers API. */
/**
* Serverless Containers API.
*
* This API allows you to manage your Serverless Containers.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/document_db/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Managed Document Databases API. */
/**
* Managed Document Databases API.
*
* This API allows you to manage your Document Databases.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/domain/v2beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ const jsonContentHeaders = {
/**
* Domains and DNS API.
*
* Manage your domains, DNS zones and records with the Domains and DNS API.
* This API allows you to manage your domains, DNS zones and records.
*/
export class API extends ParentAPI {
protected pageOfListDNSZones = (request: Readonly<ListDNSZonesRequest>) =>
Expand Down
7 changes: 6 additions & 1 deletion packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Elastic Metal - Flexible IP API. */
/**
* Elastic Metal - Flexible IP API.
*
* This API allows you to manage your Elastic Metal servers' flexible public IP
* addresses.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
public static readonly LOCALITIES: Zone[] = [
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/function/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Serverless Functions API. */
/**
* Serverless Functions API.
*
* This API allows you to manage your Serverless Functions.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
7 changes: 6 additions & 1 deletion packages/clients/src/api/iam/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,12 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** IAM API. */
/**
* IAM API.
*
* This API allows you to manage Identity and Access Management (IAM) across
* your Scaleway Organizations, Projects and resources.
*/
export class API extends ParentAPI {
protected pageOfListSSHKeys = (request: Readonly<ListSSHKeysRequest> = {}) =>
this.client.fetch<ListSSHKeysResponse>(
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/instance/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Instance API. */
/**
* Instance API.
*
* This API allows you to manage your Instances.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
public static readonly LOCALITIES: Zone[] = [
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/iot/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ const jsonContentHeaders = {
/**
* IoT Hub API.
*
* This API allows you to manage IoT hubs and devices.
* This API allows you to manage your IoT hubs and devices.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/ipam/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const jsonContentHeaders = {
/**
* IPAM API.
*
* This API allows you to manage IP addresses with Scaleway's IP Address
* This API allows you to manage your Scaleway IP addresses with our IP Address
* Management tool.
*/
export class API extends ParentAPI {
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/jobs/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Serverless Jobs API. */
/**
* Serverless Jobs API.
*
* This API allows you to manage your Serverless Jobs.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/k8s/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Kubernetes API. */
/**
* Kubernetes API.
*
* This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/src/api/lb/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1463,7 +1463,7 @@ export class ZonedAPI extends ParentAPI {
/**
* Load balancer API.
*
* This API allows you to manage your load balancer service.
* This API allows you to manage your Load Balancers.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/llm_inference/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** LLM Inference API. */
/**
* LLM Inference API.
*
* This API allows you to manage your LLM Inference services.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par']
Expand Down
7 changes: 6 additions & 1 deletion packages/clients/src/api/marketplace/v2/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,12 @@ import type {
Version,
} from './types.gen'

/** Marketplace API. */
/**
* Marketplace API.
*
* This API allows you to find available images for use when launching a
* Scaleway Instance.
*/
export class API extends ParentAPI {
protected pageOfListImages = (request: Readonly<ListImagesRequest>) =>
this.client.fetch<ListImagesResponse>(
Expand Down
8 changes: 5 additions & 3 deletions packages/clients/src/api/mnq/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const jsonContentHeaders = {
/**
* Messaging and Queuing NATS API.
*
* This API allows you to manage Scaleway Messaging and Queueing NATS accounts.
* This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
*/
export class NatsAPI extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down Expand Up @@ -286,7 +286,8 @@ export class NatsAPI extends ParentAPI {
/**
* Messaging and Queuing SNS API.
*
* This API allows you to manage Scaleway Messaging and Queueing SNS brokers.
* This API allows you to manage your Scaleway Messaging and Queuing SNS
* brokers.
*/
export class SnsAPI extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down Expand Up @@ -478,7 +479,8 @@ export class SnsAPI extends ParentAPI {
/**
* Messaging and Queuing SQS API.
*
* This API allows you to manage Scaleway Messaging and Queueing SQS brokers.
* This API allows you to manage your Scaleway Messaging and Queuing SQS
* brokers.
*/
export class SqsAPI extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down
7 changes: 6 additions & 1 deletion packages/clients/src/api/rdb/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,12 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Managed Database for PostgreSQL and MySQL API. */
/**
* Managed Database for PostgreSQL and MySQL API.
*
* This API allows you to manage your Managed Databases for PostgreSQL and
* MySQL.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/redis/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Managed Database for Redis™ API. */
/**
* Managed Database for Redis™ API.
*
* This API allows you to manage your Managed Databases for Redis™.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
public static readonly LOCALITIES: Zone[] = [
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/registry/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Container Registry API. */
/**
* Container Registry API.
*
* This API allows you to manage your Container Registry resources.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
5 changes: 3 additions & 2 deletions packages/clients/src/api/secret/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ const jsonContentHeaders = {
/**
* Secret Manager API.
*
* Secret Manager API. This API allows you to conveniently store, access and
* share sensitive data.
* This API allows you to manage your Secret Manager services, for storing,
* accessing and sharing sensitive data such as passwords, API keys and
* certificates.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down
5 changes: 3 additions & 2 deletions packages/clients/src/api/secret/v1beta1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ const jsonContentHeaders = {
/**
* Secret Manager API.
*
* This API allows you to conveniently store, access and share sensitive data
* such as passwords, API keys and certificates.
* This API allows you to manage your Secret Manager services, for storing,
* accessing and sharing sensitive data such as passwords, API keys and
* certificates.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const jsonContentHeaders = {
/**
* Serverless SQL Databases API.
*
* This API allows you to manage your Serverless SQL DB databases.
* This API allows you to manage your Serverless SQL Databases.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down
6 changes: 5 additions & 1 deletion packages/clients/src/api/tem/v1alpha1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** Transactional Email API. */
/**
* Transactional Email API.
*
* This API allows you to manage your Transactional Email services.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par']
Expand Down
7 changes: 6 additions & 1 deletion packages/clients/src/api/vpc/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** VPC API. */
/**
* VPC API.
*
* This API allows you to manage your Virtual Private Clouds (VPCs) and Private
* Networks.
*/
export class API extends ParentAPI {
/** Lists the available zones of the API. */
public static readonly LOCALITIES: Zone[] = [
Expand Down
7 changes: 6 additions & 1 deletion packages/clients/src/api/vpc/v2/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@ const jsonContentHeaders = {
'Content-Type': 'application/json; charset=utf-8',
}

/** VPC API. */
/**
* VPC API.
*
* This API allows you to manage your Virtual Private Clouds (VPCs) and Private
* Networks.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']
Expand Down
Loading