diff --git a/packages/clients/src/api/account/v2/api.gen.ts b/packages/clients/src/api/account/v2/api.gen.ts index cbbeeec88..63cb39bf4 100644 --- a/packages/clients/src/api/account/v2/api.gen.ts +++ b/packages/clients/src/api/account/v2/api.gen.ts @@ -29,12 +29,12 @@ const jsonContentHeaders = { /** * Account API. * - * This API allows you to manage projects. + * User related data. This API allows you to manage projects. */ export class API extends ParentAPI { /** - * Generate a new Project for an Organization, specifying its configuration - * including name and description. + * Create a new Project for an Organization. Generate a new Project for an + * Organization, specifying its configuration including name and description. * * @param request - The request {@link CreateProjectRequest} * @returns A Promise of Project @@ -79,10 +79,10 @@ export class API extends ParentAPI { ) /** - * 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 include the creation and update date of the - * Project. + * 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 include the + * creation and update date of the Project. * * @param request - The request {@link ListProjectsRequest} * @returns A Promise of ListProjectsResponse @@ -91,9 +91,9 @@ export class API extends ParentAPI { enrichForPagination('projects', this.pageOfListProjects, request) /** - * 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. + * 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. * * @param request - The request {@link GetProjectRequest} * @returns A Promise of Project @@ -111,10 +111,10 @@ export class API extends ParentAPI { ) /** - * 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. + * 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. * * @param request - The request {@link DeleteProjectRequest} */ @@ -128,8 +128,8 @@ export class API extends ParentAPI { }) /** - * Update the parameters of an existing Project, specified by its Project ID. - * These parameters include the name and description. + * Update Project. Update the parameters of an existing Project, specified by + * its Project ID. These parameters include the name and description. * * @param request - The request {@link UpdateProjectRequest} * @returns A Promise of Project diff --git a/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts index 376f6c33a..8a2a4ea19 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts @@ -46,8 +46,8 @@ const jsonContentHeaders = { /** * Apple silicon. * - * Scaleway Apple silicon as-a-Service is built using the latest generation of - * Apple Mac mini hardware (fifth generation). + * Apple Mac mini as a service. Scaleway Apple silicon as-a-Service is built + * using the latest generation of Apple Mac mini hardware (fifth generation). * * These dedicated Mac mini M1s are designed for developing, building, testing, * and signing applications for Apple devices, including iPhones, iPads, Mac @@ -69,9 +69,9 @@ export class API extends ParentAPI { public static readonly LOCALITIES: Zone[] = ['fr-par-3'] /** - * List all technical details about Apple silicon server types available in - * the specified zone. Since there is only one Availability Zone for Apple - * silicon servers, the targeted value is `fr-par-3`. + * List server types. List all technical details about Apple silicon server + * types available in the specified zone. Since there is only one Availability + * Zone for Apple silicon servers, the targeted value is `fr-par-3`. * * @param request - The request {@link ListServerTypesRequest} * @returns A Promise of ListServerTypesResponse @@ -89,7 +89,7 @@ export class API extends ParentAPI { ) /** - * Get a server technical details. + * Get a server type. Get a server technical details. * * @param request - The request {@link GetServerTypeRequest} * @returns A Promise of ServerType @@ -107,8 +107,8 @@ export class API extends ParentAPI { ) /** - * Create a new server in the targeted zone, specifying its configuration - * including name and type. + * Create a server. Create a new server in the targeted zone, specifying its + * configuration including name and type. * * @param request - The request {@link CreateServerRequest} * @returns A Promise of Server @@ -152,9 +152,9 @@ export class API extends ParentAPI { ) /** - * List all servers in the specified zone. By default, returned servers in the - * list are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List all servers. List all servers in the specified zone. By default, + * returned servers in the list are ordered by creation date in ascending + * order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListServersRequest} * @returns A Promise of ListServersResponse @@ -184,8 +184,9 @@ export class API extends ParentAPI { ) /** - * List all Operating System (OS). The response will include the total number - * of OS as well as their associated IDs, names and labels. + * List all Operating System (OS). List all Operating System (OS). The + * response will include the total number of OS as well as their associated + * IDs, names and labels. * * @param request - The request {@link ListOSRequest} * @returns A Promise of ListOSResponse @@ -194,8 +195,8 @@ export class API extends ParentAPI { enrichForPagination('os', this.pageOfListOS, request) /** - * Get an Operating System (OS). The response will include the OS's unique ID - * as well as its name and label. + * Get an Operating System (OS). Get an Operating System (OS). The response + * will include the OS's unique ID as well as its name and label. * * @param request - The request {@link GetOSRequest} * @returns A Promise of OS @@ -213,9 +214,9 @@ export class API extends ParentAPI { ) /** - * Retrieve information about an existing Apple silicon server, specified by - * its server ID. Its full details, including name, status and IP address, are - * returned in the response object. + * Get a server. Retrieve information about an existing Apple silicon server, + * specified by its server ID. Its full details, including name, status and IP + * address, are returned in the response object. * * @param request - The request {@link GetServerRequest} * @returns A Promise of Server @@ -253,8 +254,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of an existing Apple silicon server, specified by its - * server ID. + * Update a server. Update the parameters of an existing Apple silicon server, + * specified by its server ID. * * @param request - The request {@link UpdateServerRequest} * @returns A Promise of Server @@ -276,10 +277,10 @@ export class API extends ParentAPI { ) /** - * Delete an existing Apple silicon server, specified by its server ID. - * Deleting a server is permanent, and cannot be undone. Note that the minimum - * allocation period for Apple silicon-as-a-service is 24 hours, meaning you - * cannot delete your server prior to that. + * Delete a server. Delete an existing Apple silicon server, specified by its + * server ID. Deleting a server is permanent, and cannot be undone. Note that + * the minimum allocation period for Apple silicon-as-a-service is 24 hours, + * meaning you cannot delete your server prior to that. * * @param request - The request {@link DeleteServerRequest} */ @@ -293,7 +294,8 @@ export class API extends ParentAPI { }) /** - * Reboot an existing Apple silicon server, specified by its server ID. + * Reboot a server. Reboot an existing Apple silicon server, specified by its + * server ID. * * @param request - The request {@link RebootServerRequest} * @returns A Promise of Server @@ -313,10 +315,10 @@ export class API extends ParentAPI { ) /** - * Reinstall an existing Apple silicon server (specified by its server ID) - * from a new image (OS). All the data on the disk is deleted and all - * configuration is reset to the defailt configuration values of the image - * (OS). + * Reinstall a server. Reinstall an existing Apple silicon server (specified + * by its server ID) from a new image (OS). All the data on the disk is + * deleted and all configuration is reset to the defailt configuration values + * of the image (OS). * * @param request - The request {@link ReinstallServerRequest} * @returns A Promise of Server diff --git a/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts index 7d595f2de..ae409d75e 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts @@ -98,7 +98,10 @@ export interface ServerType { memory?: ServerTypeMemory /** Current stock. */ stock: ServerTypeStock - /** Minimum duration of the lease in seconds (example. 3.4s). */ + /** + * Minimum duration of the lease in seconds. Minimum duration of the lease in + * seconds (example. 3.4s). + */ minimumLeaseDuration?: string } diff --git a/packages/clients/src/api/baremetal/v1/api.gen.ts b/packages/clients/src/api/baremetal/v1/api.gen.ts index 2680b907c..c4a0a60af 100644 --- a/packages/clients/src/api/baremetal/v1/api.gen.ts +++ b/packages/clients/src/api/baremetal/v1/api.gen.ts @@ -95,7 +95,7 @@ const jsonContentHeaders = { /** * Elastic Metal API. * - * This API allows to manage your Elastic Metal server. + * This API allows to manage your Elastic Metal server. Elastic Metal API. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -132,7 +132,8 @@ export class API extends ParentAPI { ) /** - * List Elastic Metal servers for a specific organization. + * List Elastic Metal servers for an organization. List Elastic Metal servers + * for a specific organization. * * @param request - The request {@link ListServersRequest} * @returns A Promise of ListServersResponse @@ -141,8 +142,8 @@ export class API extends ParentAPI { enrichForPagination('servers', this.pageOfListServers, request) /** - * Get full details of an existing Elastic Metal server associated with the - * ID. + * Get a specific Elastic Metal server. Get full details of an existing + * Elastic Metal server associated with the ID. * * @param request - The request {@link GetServerRequest} * @returns A Promise of Server @@ -180,8 +181,8 @@ export class API extends ParentAPI { ) /** - * Create a new Elastic Metal server. Once the server is created, proceed with - * the [installation of an OS](#post-3e949e). + * Create an Elastic Metal server. Create a new Elastic Metal server. Once the + * server is created, proceed with the [installation of an OS](#post-3e949e). * * @param request - The request {@link CreateServerRequest} * @returns A Promise of Server @@ -203,9 +204,9 @@ export class API extends ParentAPI { ) /** - * Update the server associated with the ID. You can update parameters such as - * the server's name, tags and description. Any parameters left null in the - * request body are not updated. + * Update an Elastic Metal server. Update the server associated with the ID. + * You can update parameters such as the server's name, tags and description. + * Any parameters left null in the request body are not updated. * * @param request - The request {@link UpdateServerRequest} * @returns A Promise of Server @@ -227,8 +228,8 @@ export class API extends ParentAPI { ) /** - * Install an Operating System (OS) on the Elastic Metal server with a - * specific ID. + * Install an Elastic Metal server. Install an Operating System (OS) on the + * Elastic Metal server with a specific ID. * * @param request - The request {@link InstallServerRequest} * @returns A Promise of Server @@ -250,7 +251,8 @@ export class API extends ParentAPI { ) /** - * Get the ping status of the server associated with the ID. + * Return server metrics. Get the ping status of the server associated with + * the ID. * * @param request - The request {@link GetServerMetricsRequest} * @returns A Promise of GetServerMetricsResponse @@ -268,7 +270,7 @@ export class API extends ParentAPI { ) /** - * Delete the server associated with the ID. + * Delete an Elastic Metal server. Delete the server associated with the ID. * * @param request - The request {@link DeleteServerRequest} * @returns A Promise of Server @@ -286,8 +288,9 @@ export class API extends ParentAPI { ) /** - * Reboot the Elastic Metal server associated with the ID, use the `boot_type` - * `rescue` to reboot the server in rescue mode. + * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated + * with the ID, use the `boot_type` `rescue` to reboot the server in rescue + * mode. * * @param request - The request {@link RebootServerRequest} * @returns A Promise of Server @@ -309,7 +312,7 @@ export class API extends ParentAPI { ) /** - * Start the server associated with the ID. + * Start an Elastic Metal server. Start the server associated with the ID. * * @param request - The request {@link StartServerRequest} * @returns A Promise of Server @@ -331,8 +334,9 @@ export class API extends ParentAPI { ) /** - * Stop the server associated with the ID. The server remains allocated to - * your account and all data remains on the local storage of the server. + * Stop an Elastic Metal server. Stop the server associated with the ID. The + * server remains allocated to your account and all data remains on the local + * storage of the server. * * @param request - The request {@link StopServerRequest} * @returns A Promise of Server @@ -374,7 +378,8 @@ export class API extends ParentAPI { ) /** - * List event (i.e. start/stop/reboot) associated to the server ID. + * List server events. List event (i.e. start/stop/reboot) associated to the + * server ID. * * @param request - The request {@link ListServerEventsRequest} * @returns A Promise of ListServerEventsResponse @@ -383,10 +388,11 @@ export class API extends ParentAPI { enrichForPagination('events', this.pageOfListServerEvents, request) /** - * Start BMC (Baseboard Management Controller) access associated with the ID. - * The BMC (Baseboard Management Controller) access is available one hour - * after the installation of the server. You need first to create an option - * Remote Access. You will find the ID and the price with a call to listOffers + * Start BMC access. Start BMC (Baseboard Management Controller) access + * associated with the ID. The BMC (Baseboard Management Controller) access is + * available one hour after the installation of the server. You need first to + * create an option Remote Access. You will find the ID and the price with a + * call to listOffers * (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). * Then add the option * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. @@ -418,8 +424,9 @@ export class API extends ParentAPI { ) /** - * Get the BMC (Baseboard Management Controller) access associated with the - * ID, including the URL and login information needed to connect. + * Get BMC access. Get the BMC (Baseboard Management Controller) access + * associated with the ID, including the URL and login information needed to + * connect. * * @param request - The request {@link GetBMCAccessRequest} * @returns A Promise of BMCAccess @@ -440,7 +447,8 @@ export class API extends ParentAPI { ) /** - * Stop BMC (Baseboard Management Controller) access associated with the ID. + * Stop BMC access. Stop BMC (Baseboard Management Controller) access + * associated with the ID. * * @param request - The request {@link StopBMCAccessRequest} */ @@ -454,8 +462,8 @@ export class API extends ParentAPI { }) /** - * Configure the IP address associated with the server ID and IP ID. You can - * use this method to set a reverse DNS for an IP address. + * Update IP. Configure the IP address associated with the server ID and IP + * ID. You can use this method to set a reverse DNS for an IP address. * * @param request - The request {@link UpdateIPRequest} * @returns A Promise of IP @@ -480,7 +488,8 @@ export class API extends ParentAPI { ) /** - * Add an option, such as Private Networks, to a specific server. + * Add server option. Add an option, such as Private Networks, to a specific + * server. * * @param request - The request {@link AddOptionServerRequest} * @returns A Promise of Server @@ -505,7 +514,7 @@ export class API extends ParentAPI { ) /** - * Delete an option from a specific server. + * Delete server option. Delete an option from a specific server. * * @param request - The request {@link DeleteOptionServerRequest} * @returns A Promise of Server @@ -549,7 +558,7 @@ export class API extends ParentAPI { ) /** - * List all available Elastic Metal server configurations. + * List offers. List all available Elastic Metal server configurations. * * @param request - The request {@link ListOffersRequest} * @returns A Promise of ListOffersResponse @@ -558,7 +567,7 @@ export class API extends ParentAPI { enrichForPagination('offers', this.pageOfListOffers, request) /** - * Get details of an offer identified by its offer ID. + * Get offer. Get details of an offer identified by its offer ID. * * @param request - The request {@link GetOfferRequest} * @returns A Promise of Offer @@ -576,7 +585,7 @@ export class API extends ParentAPI { ) /** - * Return specific option for the ID. + * Get option. Return specific option for the ID. * * @param request - The request {@link GetOptionRequest} * @returns A Promise of Option @@ -615,7 +624,7 @@ export class API extends ParentAPI { ) /** - * List all options matching with filters. + * List options. List all options matching with filters. * * @param request - The request {@link ListOptionsRequest} * @returns A Promise of ListOptionsResponse @@ -650,7 +659,7 @@ export class API extends ParentAPI { ) /** - * Return all settings for a project ID. + * List all settings. Return all settings for a project ID. * * @param request - The request {@link ListSettingsRequest} * @returns A Promise of ListSettingsResponse @@ -659,7 +668,7 @@ export class API extends ParentAPI { enrichForPagination('settings', this.pageOfListSettings, request) /** - * Update a setting for a project ID (enable or disable). + * Update setting. Update a setting for a project ID (enable or disable). * * @param request - The request {@link UpdateSettingRequest} * @returns A Promise of Setting @@ -701,7 +710,8 @@ export class API extends ParentAPI { ) /** - * List all OSes that are available for installation on Elastic Metal servers. + * List available OSes. List all OSes that are available for installation on + * Elastic Metal servers. * * @param request - The request {@link ListOSRequest} * @returns A Promise of ListOSResponse @@ -710,7 +720,7 @@ export class API extends ParentAPI { enrichForPagination('os', this.pageOfListOS, request) /** - * Return specific OS for the ID. + * Get an OS with an ID. Return specific OS for the ID. * * @param request - The request {@link GetOSRequest} * @returns A Promise of OS @@ -734,7 +744,7 @@ export class PrivateNetworkAPI extends ParentAPI { public static readonly LOCALITIES: Zone[] = ['fr-par-2'] /** - * Add a server to a Private Network + * Add a server to a Private Network. * * @param request - The request * {@link PrivateNetworkApiAddServerPrivateNetworkRequest} @@ -765,7 +775,7 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * Set multiple Private Networks on a server + * Set multiple Private Networks on a server. * * @param request - The request * {@link PrivateNetworkApiSetServerPrivateNetworksRequest} @@ -822,7 +832,7 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * List the Private Networks of a server + * List the Private Networks of a server. * * @param request - The request * {@link PrivateNetworkApiListServerPrivateNetworksRequest} @@ -838,7 +848,7 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * Delete a Private Network + * Delete a Private Network. * * @param request - The request * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} diff --git a/packages/clients/src/api/baremetal/v1/types.gen.ts b/packages/clients/src/api/baremetal/v1/types.gen.ts index 21053efa6..c94370dfd 100644 --- a/packages/clients/src/api/baremetal/v1/types.gen.ts +++ b/packages/clients/src/api/baremetal/v1/types.gen.ts @@ -313,8 +313,8 @@ export interface OfferOptionOffer { /** Name of the option. */ name: string /** - * If true the option is enabled and included by default in the offer If false - * the option is available for the offer but not included by default. + * If true the option is enabled and included by default in the offer. If + * false the option is available for the offer but not included by default. */ enabled: boolean /** Period of subscription for the offer. */ diff --git a/packages/clients/src/api/cockpit/v1beta1/api.gen.ts b/packages/clients/src/api/cockpit/v1beta1/api.gen.ts index c08373133..4eaf410fa 100644 --- a/packages/clients/src/api/cockpit/v1beta1/api.gen.ts +++ b/packages/clients/src/api/cockpit/v1beta1/api.gen.ts @@ -65,11 +65,12 @@ const jsonContentHeaders = { /** * Cockpit API. * - * This API allows to manage Cockpits. + * This API allows to manage Cockpits. Cockpit API. */ export class API extends ParentAPI { /** - * Activate a cockpit associated with the given project ID. + * Activate a cockpit. Activate a cockpit associated with the given project + * ID. * * @param request - The request {@link ActivateCockpitRequest} * @returns A Promise of Cockpit @@ -88,7 +89,7 @@ export class API extends ParentAPI { ) /** - * Get the cockpit associated with the given project ID. + * Get cockpit. Get the cockpit associated with the given project ID. * * @param request - The request {@link GetCockpitRequest} * @returns A Promise of Cockpit @@ -127,7 +128,8 @@ export class API extends ParentAPI { ) /** - * Deactivate a cockpit associated with the given project ID. + * Deactivate a cockpit. Deactivate a cockpit associated with the given + * project ID. * * @param request - The request {@link DeactivateCockpitRequest} * @returns A Promise of Cockpit @@ -146,7 +148,8 @@ export class API extends ParentAPI { ) /** - * Reset the Grafana of your cockpit associated with the given project ID. + * Reset Grafana. Reset the Grafana of your cockpit associated with the given + * project ID. * * @param request - The request {@link ResetCockpitGrafanaRequest} * @returns A Promise of Cockpit @@ -165,7 +168,7 @@ export class API extends ParentAPI { ) /** - * Create a token associated with the given project ID. + * Create a token. Create a token associated with the given project ID. * * @param request - The request {@link CreateTokenRequest} * @returns A Promise of Token @@ -205,7 +208,7 @@ export class API extends ParentAPI { ) /** - * List tokens associated with the given project ID. + * List tokens. List tokens associated with the given project ID. * * @param request - The request {@link ListTokensRequest} * @returns A Promise of ListTokensResponse @@ -214,7 +217,7 @@ export class API extends ParentAPI { enrichForPagination('tokens', this.pageOfListTokens, request) /** - * Get the token associated with the given ID. + * Get token. Get the token associated with the given ID. * * @param request - The request {@link GetTokenRequest} * @returns A Promise of Token @@ -232,7 +235,7 @@ export class API extends ParentAPI { ) /** - * Delete the token associated with the given ID. + * Delete token. Delete the token associated with the given ID. * * @param request - The request {@link DeleteTokenRequest} */ @@ -246,7 +249,8 @@ export class API extends ParentAPI { }) /** - * Create an alert contact point for the default receiver. + * Create an alert contact point. Create an alert contact point for the + * default receiver. * * @param request - The request {@link CreateContactPointRequest} * @returns A Promise of ContactPoint @@ -287,7 +291,8 @@ export class API extends ParentAPI { ) /** - * List alert contact points associated with the given cockpit ID. + * List alert contact points. List alert contact points associated with the + * given cockpit ID. * * @param request - The request {@link ListContactPointsRequest} * @returns A Promise of ListContactPointsResponse @@ -296,7 +301,8 @@ export class API extends ParentAPI { enrichForPagination('contactPoints', this.pageOfListContactPoints, request) /** - * Delete an alert contact point for the default receiver. + * Delete an alert contact point. Delete an alert contact point for the + * default receiver. * * @param request - The request {@link DeleteContactPointRequest} */ @@ -343,7 +349,7 @@ export class API extends ParentAPI { }) /** - * Trigger a test alert to all receivers. + * Trigger a test alert. Trigger a test alert to all receivers. * * @param request - The request {@link TriggerTestAlertRequest} */ @@ -358,7 +364,7 @@ export class API extends ParentAPI { }) /** - * Create a grafana user for your grafana instance. + * Create a grafana user. Create a grafana user for your grafana instance. * * @param request - The request {@link CreateGrafanaUserRequest} * @returns A Promise of GrafanaUser @@ -400,7 +406,8 @@ export class API extends ParentAPI { ) /** - * List grafana users who are able to connect to your grafana instance. + * List grafana users. List grafana users who are able to connect to your + * grafana instance. * * @param request - The request {@link ListGrafanaUsersRequest} * @returns A Promise of ListGrafanaUsersResponse @@ -409,7 +416,7 @@ export class API extends ParentAPI { enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request) /** - * Delete a grafana user from your grafana instance. + * Delete a grafana user. Delete a grafana user from your grafana instance. * * @param request - The request {@link DeleteGrafanaUserRequest} */ @@ -427,7 +434,8 @@ export class API extends ParentAPI { }) /** - * Reset the Grafana user password from your grafana instance. + * Reset Grafana user password. Reset the Grafana user password from your + * grafana instance. * * @param request - The request {@link ResetGrafanaUserPasswordRequest} * @returns A Promise of GrafanaUser diff --git a/packages/clients/src/api/cockpit/v1beta1/types.gen.ts b/packages/clients/src/api/cockpit/v1beta1/types.gen.ts index 07d169015..631c4ed4b 100644 --- a/packages/clients/src/api/cockpit/v1beta1/types.gen.ts +++ b/packages/clients/src/api/cockpit/v1beta1/types.gen.ts @@ -43,7 +43,7 @@ export interface CockpitEndpoints { grafanaUrl: string } -/** Alert contact point. */ +/** Alert contact point. Contact point. */ export interface ContactPoint { /** * Alert contact point configuration. diff --git a/packages/clients/src/api/container/v1beta1/api.gen.ts b/packages/clients/src/api/container/v1beta1/api.gen.ts index 5716fb892..b0cad9026 100644 --- a/packages/clients/src/api/container/v1beta1/api.gen.ts +++ b/packages/clients/src/api/container/v1beta1/api.gen.ts @@ -84,7 +84,7 @@ const jsonContentHeaders = { /** * Containers API. * - * Serverless Containers API. + * Serverless Containers API. Containers API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -116,7 +116,7 @@ export class API extends ParentAPI { ) /** - * List all your namespaces + * List all your namespaces. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -125,7 +125,7 @@ export class API extends ParentAPI { enrichForPagination('namespaces', this.pageOfListNamespaces, request) /** - * Get the namespace associated with the given id. + * Get a namespace. Get the namespace associated with the given id. * * @param request - The request {@link GetNamespaceRequest} * @returns A Promise of Namespace @@ -163,7 +163,7 @@ export class API extends ParentAPI { ) /** - * Create a new namespace + * Create a new namespace. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -185,7 +185,8 @@ export class API extends ParentAPI { ) /** - * Update the space associated with the given id. + * Update an existing namespace. Update the space associated with the given + * id. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -207,7 +208,8 @@ export class API extends ParentAPI { ) /** - * Delete the namespace associated with the given id. + * Delete an existing namespace. Delete the namespace associated with the + * given id. * * @param request - The request {@link DeleteNamespaceRequest} * @returns A Promise of Namespace @@ -249,7 +251,7 @@ export class API extends ParentAPI { ) /** - * List all your containers + * List all your containers. * * @param request - The request {@link ListContainersRequest} * @returns A Promise of ListContainersResponse @@ -258,7 +260,7 @@ export class API extends ParentAPI { enrichForPagination('containers', this.pageOfListContainers, request) /** - * Get the container associated with the given id. + * Get a container. Get the container associated with the given id. * * @param request - The request {@link GetContainerRequest} * @returns A Promise of Container @@ -296,7 +298,7 @@ export class API extends ParentAPI { ) /** - * Create a new container + * Create a new container. * * @param request - The request {@link CreateContainerRequest} * @returns A Promise of Container @@ -318,7 +320,8 @@ export class API extends ParentAPI { ) /** - * Update the container associated with the given id. + * Update an existing container. Update the container associated with the + * given id. * * @param request - The request {@link UpdateContainerRequest} * @returns A Promise of Container @@ -340,7 +343,7 @@ export class API extends ParentAPI { ) /** - * Delete the container associated with the given id. + * Delete a container. Delete the container associated with the given id. * * @param request - The request {@link DeleteContainerRequest} * @returns A Promise of Container @@ -358,7 +361,7 @@ export class API extends ParentAPI { ) /** - * Deploy a container associated with the given id. + * Deploy a container. Deploy a container associated with the given id. * * @param request - The request {@link DeployContainerRequest} * @returns A Promise of Container @@ -402,7 +405,7 @@ export class API extends ParentAPI { ) /** - * List all your crons + * List all your crons. * * @param request - The request {@link ListCronsRequest} * @returns A Promise of ListCronsResponse @@ -411,7 +414,7 @@ export class API extends ParentAPI { enrichForPagination('crons', this.pageOfListCrons, request) /** - * Get the cron associated with the given id. + * Get a cron. Get the cron associated with the given id. * * @param request - The request {@link GetCronRequest} * @returns A Promise of Cron @@ -448,7 +451,7 @@ export class API extends ParentAPI { ) /** - * Create a new cron + * Create a new cron. * * @param request - The request {@link CreateCronRequest} * @returns A Promise of Cron @@ -470,7 +473,7 @@ export class API extends ParentAPI { ) /** - * Update the cron associated with the given id. + * Update an existing cron. Update the cron associated with the given id. * * @param request - The request {@link UpdateCronRequest} * @returns A Promise of Cron @@ -492,7 +495,7 @@ export class API extends ParentAPI { ) /** - * Delete the cron associated with the given id. + * Delete an existing cron. Delete the cron associated with the given id. * * @param request - The request {@link DeleteCronRequest} * @returns A Promise of Cron @@ -533,7 +536,7 @@ export class API extends ParentAPI { ) /** - * List your container logs + * List your container logs. * * @param request - The request {@link ListLogsRequest} * @returns A Promise of ListLogsResponse @@ -563,7 +566,7 @@ export class API extends ParentAPI { ) /** - * List all domain name bindings + * List all domain name bindings. * * @param request - The request {@link ListDomainsRequest} * @returns A Promise of ListDomainsResponse @@ -572,7 +575,7 @@ export class API extends ParentAPI { enrichForPagination('domains', this.pageOfListDomains, request) /** - * Get a domain name binding + * Get a domain name binding. * * @param request - The request {@link GetDomainRequest} * @returns A Promise of Domain @@ -610,7 +613,7 @@ export class API extends ParentAPI { ) /** - * Create a domain name binding + * Create a domain name binding. * * @param request - The request {@link CreateDomainRequest} * @returns A Promise of Domain @@ -632,7 +635,7 @@ export class API extends ParentAPI { ) /** - * Delete a domain name binding + * Delete a domain name binding. * * @param request - The request {@link DeleteDomainRequest} * @returns A Promise of Domain @@ -649,7 +652,11 @@ export class API extends ParentAPI { unmarshalDomain, ) - /** @deprecated */ + /** + * @deprecated + * @param request - The request {@link IssueJWTRequest} + * @returns A Promise of Token + */ issueJWT = (request: Readonly = {}) => this.client.fetch( { @@ -678,7 +685,7 @@ export class API extends ParentAPI { ) /** - * Create a new revocable token + * Create a new revocable token. * * @param request - The request {@link CreateTokenRequest} * @returns A Promise of Token @@ -700,7 +707,7 @@ export class API extends ParentAPI { ) /** - * Get a token + * Get a token. * * @param request - The request {@link GetTokenRequest} * @returns A Promise of Token @@ -760,7 +767,7 @@ export class API extends ParentAPI { ) /** - * List all tokens + * List all tokens. * * @param request - The request {@link ListTokensRequest} * @returns A Promise of ListTokensResponse @@ -769,7 +776,7 @@ export class API extends ParentAPI { enrichForPagination('tokens', this.pageOfListTokens, request) /** - * Delete a token + * Delete a token. * * @param request - The request {@link DeleteTokenRequest} * @returns A Promise of Token diff --git a/packages/clients/src/api/container/v1beta1/types.gen.ts b/packages/clients/src/api/container/v1beta1/types.gen.ts index c0ce5e0ae..31ad47b6d 100644 --- a/packages/clients/src/api/container/v1beta1/types.gen.ts +++ b/packages/clients/src/api/container/v1beta1/types.gen.ts @@ -104,7 +104,7 @@ export interface Container { port: number secretEnvironmentVariables: SecretHashedValue[] /** - * Possible values: + * Configure how HTTP and HTTPS requests are handled. Possible values: * * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients * to use HTTPS. @@ -325,7 +325,7 @@ export type CreateContainerRequest = { port?: number secretEnvironmentVariables?: Secret[] /** - * Possible values: + * Configure how HTTP and HTTPS requests are handled. Possible values: * * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients * to use HTTPS. @@ -355,7 +355,7 @@ export type UpdateContainerRequest = { port?: number secretEnvironmentVariables?: Secret[] /** - * Possible values: + * Configure how HTTP and HTTPS requests are handled. Possible values: * * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients * to use HTTPS. diff --git a/packages/clients/src/api/domain/v2beta1/api.gen.ts b/packages/clients/src/api/domain/v2beta1/api.gen.ts index 0107b28f6..c1478bab1 100644 --- a/packages/clients/src/api/domain/v2beta1/api.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/api.gen.ts @@ -161,7 +161,7 @@ const jsonContentHeaders = { /** * DNS API. * - * Manage your DNS zones and records. + * DNS API. Manage your DNS zones and records. */ export class API extends ParentAPI { protected pageOfListDNSZones = (request: Readonly) => @@ -186,8 +186,8 @@ export class API extends ParentAPI { ) /** - * Returns a list of manageable DNS zones. You can filter the DNS zones by - * domain name. + * List DNS zones. Returns a list of manageable DNS zones. You can filter the + * DNS zones by domain name. * * @param request - The request {@link ListDNSZonesRequest} * @returns A Promise of ListDNSZonesResponse @@ -196,7 +196,7 @@ export class API extends ParentAPI { enrichForPagination('dnsZones', this.pageOfListDNSZones, request) /** - * Create a new DNS zone. + * Create a DNS zone. Create a new DNS zone. * * @param request - The request {@link CreateDNSZoneRequest} * @returns A Promise of DNSZone @@ -215,7 +215,7 @@ export class API extends ParentAPI { ) /** - * Update the name and/or the organizations for a DNS zone. + * Update a DNS zone. Update the name and/or the organizations for a DNS zone. * * @param request - The request {@link UpdateDNSZoneRequest} * @returns A Promise of DNSZone @@ -237,7 +237,8 @@ export class API extends ParentAPI { ) /** - * Clone an existed DNS zone with all its records into a new one. + * Clone a DNS zone. Clone an existed DNS zone with all its records into a new + * one. * * @param request - The request {@link CloneDNSZoneRequest} * @returns A Promise of DNSZone @@ -259,7 +260,7 @@ export class API extends ParentAPI { ) /** - * Delete a DNS zone and all it's records. + * Delete DNS zone. Delete a DNS zone and all it's records. * * @param request - The request {@link DeleteDNSZoneRequest} * @returns A Promise of DeleteDNSZoneResponse @@ -307,8 +308,8 @@ export class API extends ParentAPI { ) /** - * Returns a list of DNS records of a DNS zone with default NS. You can filter - * the records by type and name. + * List DNS zone records. Returns a list of DNS records of a DNS zone with + * default NS. You can filter the records by type and name. * * @param request - The request {@link ListDNSZoneRecordsRequest} * @returns A Promise of ListDNSZoneRecordsResponse @@ -317,7 +318,8 @@ export class API extends ParentAPI { enrichForPagination('records', this.pageOfListDNSZoneRecords, request) /** - * Only available with default NS.
Send a list of actions and records. + * Update DNS zone records. Only available with default NS.
Send a list + * of actions and records. * * Action can be: * @@ -355,8 +357,8 @@ export class API extends ParentAPI { ) /** - * Returns a list of Nameservers and their optional glue records for a DNS - * zone. + * List DNS zone nameservers. Returns a list of Nameservers and their optional + * glue records for a DNS zone. * * @param request - The request {@link ListDNSZoneNameserversRequest} * @returns A Promise of ListDNSZoneNameserversResponse @@ -375,7 +377,8 @@ export class API extends ParentAPI { ) /** - * Update DNS zone nameservers and set optional glue records. + * Update DNS zone nameservers. Update DNS zone nameservers and set optional + * glue records. * * @param request - The request {@link UpdateDNSZoneNameserversRequest} * @returns A Promise of UpdateDNSZoneNameserversResponse @@ -399,8 +402,8 @@ export class API extends ParentAPI { ) /** - * Only available with default NS.
Delete all the records from a DNS - * zone. All edits will be versioned. + * Clear DNS zone records. Only available with default NS.
Delete all the + * records from a DNS zone. All edits will be versioned. * * @param request - The request {@link ClearDNSZoneRecordsRequest} * @returns A Promise of ClearDNSZoneRecordsResponse @@ -418,7 +421,7 @@ export class API extends ParentAPI { ) /** - * Get a DNS zone in a given format with default NS. + * Export raw DNS zone. Get a DNS zone in a given format with default NS. * * @param request - The request {@link ExportRawDNSZoneRequest} * @returns A Promise of Blob @@ -438,7 +441,8 @@ export class API extends ParentAPI { }) /** - * Import and replace records from a given provider format with default NS. + * Import raw DNS zone. Import and replace records from a given provider + * format with default NS. * * @param request - The request {@link ImportRawDNSZoneRequest} * @returns A Promise of ImportRawDNSZoneResponse @@ -460,7 +464,8 @@ export class API extends ParentAPI { ) /** - * Import and replace records from a given provider format with default NS. + * Import provider DNS zone. Import and replace records from a given provider + * format with default NS. * * @param request - The request {@link ImportProviderDNSZoneRequest} * @returns A Promise of ImportProviderDNSZoneResponse @@ -482,8 +487,8 @@ export class API extends ParentAPI { ) /** - * Refresh SOA DNS zone. You can recreate the given DNS zone and its sub DNS - * zone if needed. + * Refresh DNS zone. Refresh SOA DNS zone. You can recreate the given DNS zone + * and its sub DNS zone if needed. * * @param request - The request {@link RefreshDNSZoneRequest} * @returns A Promise of RefreshDNSZoneResponse @@ -526,9 +531,9 @@ export class API extends ParentAPI { ) /** - * Get a list of DNS zone versions.
The maximum version count is - * 100.
If the count reaches this limit, the oldest version will be - * deleted after each new modification. + * List DNS zone versions. Get a list of DNS zone versions.
The maximum + * version count is 100.
If the count reaches this limit, the oldest + * version will be deleted after each new modification. * * @param request - The request {@link ListDNSZoneVersionsRequest} * @returns A Promise of ListDNSZoneVersionsResponse @@ -558,7 +563,8 @@ export class API extends ParentAPI { ) /** - * Get a list of records from a previous DNS zone version. + * List DNS zone version records. Get a list of records from a previous DNS + * zone version. * * @param request - The request {@link ListDNSZoneVersionRecordsRequest} * @returns A Promise of ListDNSZoneVersionRecordsResponse @@ -573,7 +579,8 @@ export class API extends ParentAPI { ) /** - * Get all differences from a previous DNS zone version. + * Get DNS zone version diff. Get all differences from a previous DNS zone + * version. * * @param request - The request {@link GetDNSZoneVersionDiffRequest} * @returns A Promise of GetDNSZoneVersionDiffResponse @@ -591,7 +598,7 @@ export class API extends ParentAPI { ) /** - * Restore and activate a previous DNS zone version. + * Restore DNS zone version. Restore and activate a previous DNS zone version. * * @param request - The request {@link RestoreDNSZoneVersionRequest} * @returns A Promise of RestoreDNSZoneVersionResponse @@ -611,7 +618,7 @@ export class API extends ParentAPI { ) /** - * Get the zone TLS certificate if it exists + * Get the zone TLS certificate if it exists. * * @param request - The request {@link GetSSLCertificateRequest} * @returns A Promise of SSLCertificate @@ -651,7 +658,7 @@ export class API extends ParentAPI { ) /** - * Create or return the zone TLS certificate + * Create or return the zone TLS certificate. * * @param request - The request {@link CreateSSLCertificateRequest} * @returns A Promise of SSLCertificate @@ -690,7 +697,7 @@ export class API extends ParentAPI { ) /** - * List all user TLS certificates + * List all user TLS certificates. * * @param request - The request {@link ListSSLCertificatesRequest} * @returns A Promise of ListSSLCertificatesResponse @@ -699,7 +706,7 @@ export class API extends ParentAPI { enrichForPagination('certificates', this.pageOfListSSLCertificates, request) /** - * Delete an TLS certificate + * Delete an TLS certificate. * * @param request - The request {@link DeleteSSLCertificateRequest} * @returns A Promise of DeleteSSLCertificateResponse @@ -717,7 +724,7 @@ export class API extends ParentAPI { ) /** - * Get the DNS zone TSIG Key to allow AXFR request. + * Get the DNS zone TSIG Key. Get the DNS zone TSIG Key to allow AXFR request. * * @param request - The request {@link GetDNSZoneTsigKeyRequest} * @returns A Promise of GetDNSZoneTsigKeyResponse @@ -735,7 +742,7 @@ export class API extends ParentAPI { ) /** - * Delete the DNS zone TSIG Key + * Delete the DNS zone TSIG Key. * * @param request - The request {@link DeleteDNSZoneTsigKeyRequest} */ @@ -752,7 +759,7 @@ export class API extends ParentAPI { /** * Domains registrar API. * - * Manage your domains and contacts. + * Domains registrar API. Manage your domains and contacts. */ export class RegistrarAPI extends ParentAPI { protected pageOfListTasks = ( @@ -780,7 +787,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * List all account tasks. You can filter the list by domain name. + * List tasks. List all account tasks. You can filter the list by domain name. * * @param request - The request {@link RegistrarApiListTasksRequest} * @returns A Promise of ListTasksResponse @@ -789,8 +796,8 @@ export class RegistrarAPI extends ParentAPI { enrichForPagination('tasks', this.pageOfListTasks, request) /** - * Request the registration of domain names. You can provide an already - * existing domain's contact or a new contact. + * Buy one or more domains. Request the registration of domain names. You can + * provide an already existing domain's contact or a new contact. * * @param request - The request {@link RegistrarApiBuyDomainsRequest} * @returns A Promise of OrderResponse @@ -809,7 +816,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Request the renewal of domain names. + * Renew one or more domains. Request the renewal of domain names. * * @param request - The request {@link RegistrarApiRenewDomainsRequest} * @returns A Promise of OrderResponse @@ -828,7 +835,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Request the transfer from another registrar domain to Scaleway. + * Transfer a domain. Request the transfer from another registrar domain to + * Scaleway. * * @param request - The request {@link RegistrarApiTransferInDomainRequest} * @returns A Promise of OrderResponse @@ -850,11 +858,11 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Request a trade for the contact owner.
If an `organization_id` is - * given, the change is from the current Scaleway account to another Scaleway - * account.
If no contact is given, the first contact of the other - * Scaleway account is taken.
If the other Scaleway account has no - * contact. An error occurs. + * Trade a domain contact. Request a trade for the contact owner.
If an + * `organization_id` is given, the change is from the current Scaleway account + * to another Scaleway account.
If no contact is given, the first contact + * of the other Scaleway account is taken.
If the other Scaleway account + * has no contact. An error occurs. * * @param request - The request {@link RegistrarApiTradeDomainRequest} * @returns A Promise of OrderResponse @@ -876,7 +884,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Request the registration of an external domain name. + * Register an external domain. Request the registration of an external domain + * name. * * @param request - The request * {@link RegistrarApiRegisterExternalDomainRequest} @@ -901,7 +910,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Delete an external domain name. + * Delete an external domain. Delete an external domain name. * * @param request - The request {@link RegistrarApiDeleteExternalDomainRequest} * @returns A Promise of DeleteExternalDomainResponse @@ -921,8 +930,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Check if contacts are compatible against a domain or a tld. If not, it will - * return the information requiring a correction. + * Check if contacts are compatible against a domain or a tld. Check if + * contacts are compatible against a domain or a tld. If not, it will return + * the information requiring a correction. * * @param request - The request * {@link RegistrarApiCheckContactsCompatibilityRequest} @@ -968,8 +978,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Return a list of contacts with their domains and roles. You can filter the - * list by domain name. + * List contacts. Return a list of contacts with their domains and roles. You + * can filter the list by domain name. * * @param request - The request {@link RegistrarApiListContactsRequest} * @returns A Promise of ListContactsResponse @@ -978,8 +988,8 @@ export class RegistrarAPI extends ParentAPI { enrichForPagination('contacts', this.pageOfListContacts, request) /** - * Return a contact details retrieved from the registrar using a given contact - * ID. + * Get a contact. Return a contact details retrieved from the registrar using + * a given contact ID. * * @param request - The request {@link RegistrarApiGetContactRequest} * @returns A Promise of Contact @@ -997,7 +1007,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * You can edit the contact coordinates. + * Update contact. You can edit the contact coordinates. * * @param request - The request {@link RegistrarApiUpdateContactRequest} * @returns A Promise of Contact @@ -1047,7 +1057,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Returns a list of domains owned by the user. + * List domains. Returns a list of domains owned by the user. * * @param request - The request {@link RegistrarApiListDomainsRequest} * @returns A Promise of ListDomainsResponse @@ -1077,8 +1087,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Returns a list of domains owned by the user with a renew status and if - * renewable, the maximum renew duration in years. + * List scaleway domains that can or not be renewed. Returns a list of domains + * owned by the user with a renew status and if renewable, the maximum renew + * duration in years. * * @param request - The request {@link RegistrarApiListRenewableDomainsRequest} * @returns A Promise of ListRenewableDomainsResponse @@ -1088,7 +1099,7 @@ export class RegistrarAPI extends ParentAPI { ) => enrichForPagination('domains', this.pageOfListRenewableDomains, request) /** - * Returns a the domain with more informations. + * Get domain. Returns a the domain with more informations. * * @param request - The request {@link RegistrarApiGetDomainRequest} * @returns A Promise of Domain @@ -1126,9 +1137,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Update the domain contacts or create a new one.
If you add the same - * contact for multiple roles. Only one ID will be created and used for all of - * them. + * Update a domain. Update the domain contacts or create a new one.
If + * you add the same contact for multiple roles. Only one ID will be created + * and used for all of them. * * @param request - The request {@link RegistrarApiUpdateDomainRequest} * @returns A Promise of Domain @@ -1150,8 +1161,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Lock domain transfer. A locked domain transfer can't be transferred and the - * auth code can't be requested. + * Lock domain transfer. Lock domain transfer. A locked domain transfer can't + * be transferred and the auth code can't be requested. * * @param request - The request {@link RegistrarApiLockDomainTransferRequest} * @returns A Promise of Domain @@ -1173,8 +1184,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Unlock domain transfer. An unlocked domain can be transferred and the auth - * code can be requested for this. + * Unlock domain transfer. Unlock domain transfer. An unlocked domain can be + * transferred and the auth code can be requested for this. * * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest} * @returns A Promise of Domain @@ -1196,7 +1207,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Enable domain auto renew + * Enable domain auto renew. * * @param request - The request * {@link RegistrarApiEnableDomainAutoRenewRequest} @@ -1219,7 +1230,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Disable domain auto renew + * Disable domain auto renew. * * @param request - The request * {@link RegistrarApiDisableDomainAutoRenewRequest} @@ -1242,10 +1253,10 @@ export class RegistrarAPI extends ParentAPI { ) /** - * If possible, return the auth code for an unlocked domain transfer, or an - * error if the domain is locked. Some TLD may have a different procedure to - * retrieve the auth code, in that case, the information is given in the - * message field. + * Return domain auth code. If possible, return the auth code for an unlocked + * domain transfer, or an error if the domain is locked. Some TLD may have a + * different procedure to retrieve the auth code, in that case, the + * information is given in the message field. * * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest} * @returns A Promise of GetDomainAuthCodeResponse @@ -1265,9 +1276,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * If your domain has the default Scaleway NS and uses another registrar, you - * have to update the DS record manually. For the algorithm, here are the code - * numbers for each type: + * Update domain DNSSEC. If your domain has the default Scaleway NS and uses + * another registrar, you have to update the DS record manually. For the + * algorithm, here are the code numbers for each type: * * - 1: RSAMD5 * - 2: DIFFIE_HELLMAN @@ -1313,7 +1324,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Disable domain DNSSEC + * Disable domain DNSSEC. * * @param request - The request {@link RegistrarApiDisableDomainDNSSECRequest} * @returns A Promise of Domain @@ -1335,7 +1346,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Search a domain (or at maximum, 10 domains). + * Search available domains. Search a domain (or at maximum, 10 domains). * * If the TLD list is empty or not set the search returns the results from the * most popular TLDs. @@ -1361,7 +1372,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Create domain hostname with glue IPs + * Create domain hostname with glue IPs. * * @param request - The request {@link RegistrarApiCreateDomainHostRequest} * @returns A Promise of Host @@ -1407,7 +1418,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * List domain hostnames with they glue IPs + * List domain hostnames with they glue IPs. * * @param request - The request {@link RegistrarApiListDomainHostsRequest} * @returns A Promise of ListDomainHostsResponse @@ -1416,7 +1427,7 @@ export class RegistrarAPI extends ParentAPI { enrichForPagination('hosts', this.pageOfListDomainHosts, request) /** - * Update domain hostname with glue IPs + * Update domain hostname with glue IPs. * * @param request - The request {@link RegistrarApiUpdateDomainHostRequest} * @returns A Promise of Host @@ -1441,7 +1452,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Delete domain hostname + * Delete domain hostname. * * @param request - The request {@link RegistrarApiDeleteDomainHostRequest} * @returns A Promise of Host diff --git a/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts b/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts index 202d2e97e..64f5bf970 100644 --- a/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts @@ -54,7 +54,7 @@ export class API extends ParentAPI { ] /** - * Create a Flexible IP + * Create a Flexible IP. * * @param request - The request {@link CreateFlexibleIPRequest} * @returns A Promise of FlexibleIP @@ -76,7 +76,7 @@ export class API extends ParentAPI { ) /** - * Get a Flexible IP + * Get a Flexible IP. * * @param request - The request {@link GetFlexibleIPRequest} * @returns A Promise of FlexibleIP @@ -143,7 +143,7 @@ export class API extends ParentAPI { ) /** - * List Flexible IPs + * List Flexible IPs. * * @param request - The request {@link ListFlexibleIPsRequest} * @returns A Promise of ListFlexibleIPsResponse @@ -152,7 +152,7 @@ export class API extends ParentAPI { enrichForPagination('flexibleIps', this.pageOfListFlexibleIPs, request) /** - * Update a Flexible IP + * Update a Flexible IP. * * @param request - The request {@link UpdateFlexibleIPRequest} * @returns A Promise of FlexibleIP @@ -174,7 +174,7 @@ export class API extends ParentAPI { ) /** - * Delete a Flexible IP + * Delete a Flexible IP. * * @param request - The request {@link DeleteFlexibleIPRequest} */ @@ -188,7 +188,7 @@ export class API extends ParentAPI { }) /** - * Attach a Flexible IP to a server + * Attach a Flexible IP to a server. * * @param request - The request {@link AttachFlexibleIPRequest} * @returns A Promise of AttachFlexibleIPsResponse @@ -210,7 +210,7 @@ export class API extends ParentAPI { ) /** - * Detach a Flexible IP from a server + * Detach a Flexible IP from a server. * * @param request - The request {@link DetachFlexibleIPRequest} * @returns A Promise of DetachFlexibleIPsResponse @@ -232,7 +232,7 @@ export class API extends ParentAPI { ) /** - * Generate a virtual MAC on a given Flexible IP + * Generate a virtual MAC on a given Flexible IP. * * @param request - The request {@link GenerateMACAddrRequest} * @returns A Promise of FlexibleIP @@ -254,8 +254,8 @@ export class API extends ParentAPI { ) /** - * Duplicate a Virtual MAC from a given Flexible IP onto another attached on - * the same server. + * Duplicate a Virtual MAC. Duplicate a Virtual MAC from a given Flexible IP + * onto another attached on the same server. * * @param request - The request {@link DuplicateMACAddrRequest} * @returns A Promise of FlexibleIP @@ -293,7 +293,7 @@ export class API extends ParentAPI { ) /** - * Remove a virtual MAC from a Flexible IP + * Remove a virtual MAC from a Flexible IP. * * @param request - The request {@link DeleteMACAddrRequest} */ diff --git a/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts b/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts index f72b55e28..c911f5096 100644 --- a/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts @@ -56,6 +56,8 @@ export interface FlexibleIP { /** Date of creation of the Flexible IP. */ createdAt?: Date /** + * Status of the Flexible IP. + * * - Ready : Flexible IP is created and ready to be attached to a server or to * have a virtual MAC generated. * - Updating: Flexible IP is being attached to a server or a virtual MAC @@ -173,8 +175,9 @@ export type AttachFlexibleIPRequest = { /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** - * Multiple IDs can be provided as long as Flexible IPs belong to the same MAC - * groups (see details about MAC groups). + * A list of Flexible IP IDs to attach. Multiple IDs can be provided as long + * as Flexible IPs belong to the same MAC groups (see details about MAC + * groups). */ fipsIds: string[] /** A server ID on which to attach the Flexible IPs. */ @@ -185,8 +188,9 @@ export type DetachFlexibleIPRequest = { /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** - * Multiple IDs can be provided as long as Flexible IPs belong to the same MAC - * groups (see details about MAC groups). + * A list of Flexible IP IDs to detach. Multiple IDs can be provided as long + * as Flexible IPs belong to the same MAC groups (see details about MAC + * groups). */ fipsIds: string[] } @@ -203,9 +207,15 @@ export type GenerateMACAddrRequest = { export type DuplicateMACAddrRequest = { /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Flexible IPs need to be attached to the same server. */ + /** + * Flexible IP ID on which to duplicate the Virtual MAC. Flexible IPs need to + * be attached to the same server. + */ fipId: string - /** Flexible IPs need to be attached to the same server. */ + /** + * Flexible IP ID to duplicate the Virtual MAC from. Flexible IPs need to be + * attached to the same server. + */ duplicateFromFipId: string } @@ -220,8 +230,9 @@ export type DeleteMACAddrRequest = { /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** - * If the Flexible IP belongs to a MAC group, the MAC will be removed from the - * MAC group and from the Flexible IP. + * Flexible IP ID from which to delete the Virtual MAC. If the Flexible IP + * belongs to a MAC group, the MAC will be removed from the MAC group and from + * the Flexible IP. */ fipId: string } diff --git a/packages/clients/src/api/function/v1beta1/api.gen.ts b/packages/clients/src/api/function/v1beta1/api.gen.ts index 471f9baf4..f65e1ac33 100644 --- a/packages/clients/src/api/function/v1beta1/api.gen.ts +++ b/packages/clients/src/api/function/v1beta1/api.gen.ts @@ -105,7 +105,7 @@ const jsonContentHeaders = { /** * Functions API. * - * Serverless functions API. + * Serverless functions API. Functions API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -137,7 +137,7 @@ export class API extends ParentAPI { ) /** - * List all your namespaces + * List all your namespaces. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -146,7 +146,7 @@ export class API extends ParentAPI { enrichForPagination('namespaces', this.pageOfListNamespaces, request) /** - * Get the namespace associated with the given id. + * Get a namespace. Get the namespace associated with the given id. * * @param request - The request {@link GetNamespaceRequest} * @returns A Promise of Namespace @@ -184,7 +184,7 @@ export class API extends ParentAPI { ) /** - * Create a new namespace + * Create a new namespace. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -206,7 +206,8 @@ export class API extends ParentAPI { ) /** - * Update the space associated with the given id. + * Update an existing namespace. Update the space associated with the given + * id. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -228,7 +229,8 @@ export class API extends ParentAPI { ) /** - * Delete the namespace associated with the given id. + * Delete an existing namespace. Delete the namespace associated with the + * given id. * * @param request - The request {@link DeleteNamespaceRequest} * @returns A Promise of Namespace @@ -270,7 +272,7 @@ export class API extends ParentAPI { ) /** - * List all your functions + * List all your functions. * * @param request - The request {@link ListFunctionsRequest} * @returns A Promise of ListFunctionsResponse @@ -279,7 +281,7 @@ export class API extends ParentAPI { enrichForPagination('functions', this.pageOfListFunctions, request) /** - * Get the function associated with the given id. + * Get a function. Get the function associated with the given id. * * @param request - The request {@link GetFunctionRequest} * @returns A Promise of Function @@ -317,7 +319,7 @@ export class API extends ParentAPI { ) /** - * Create a new function + * Create a new function. * * @param request - The request {@link CreateFunctionRequest} * @returns A Promise of Function @@ -339,7 +341,8 @@ export class API extends ParentAPI { ) /** - * Update the function associated with the given id. + * Update an existing function. Update the function associated with the given + * id. * * @param request - The request {@link UpdateFunctionRequest} * @returns A Promise of Function @@ -361,7 +364,7 @@ export class API extends ParentAPI { ) /** - * Delete the function associated with the given id. + * Delete a function. Delete the function associated with the given id. * * @param request - The request {@link DeleteFunctionRequest} * @returns A Promise of Function @@ -379,7 +382,7 @@ export class API extends ParentAPI { ) /** - * Deploy a function associated with the given id. + * Deploy a function. Deploy a function associated with the given id. * * @param request - The request {@link DeployFunctionRequest} * @returns A Promise of Function @@ -402,7 +405,7 @@ export class API extends ParentAPI { ) /** - * List available function runtimes. + * List function runtimes. List available function runtimes. * * @param request - The request {@link ListFunctionRuntimesRequest} * @returns A Promise of ListFunctionRuntimesResponse @@ -422,7 +425,8 @@ export class API extends ParentAPI { ) /** - * Get an upload URL of a function associated with the given id. + * Get an upload URL of a function. Get an upload URL of a function associated + * with the given id. * * @param request - The request {@link GetFunctionUploadURLRequest} * @returns A Promise of UploadURL @@ -444,7 +448,8 @@ export class API extends ParentAPI { ) /** - * Get a download URL for a function associated with the given id. + * Get a download URL of a function. Get a download URL for a function + * associated with the given id. * * @param request - The request {@link GetFunctionDownloadURLRequest} * @returns A Promise of DownloadURL @@ -486,7 +491,7 @@ export class API extends ParentAPI { ) /** - * List all your crons + * List all your crons. * * @param request - The request {@link ListCronsRequest} * @returns A Promise of ListCronsResponse @@ -495,7 +500,7 @@ export class API extends ParentAPI { enrichForPagination('crons', this.pageOfListCrons, request) /** - * Get the cron associated with the given id. + * Get a cron. Get the cron associated with the given id. * * @param request - The request {@link GetCronRequest} * @returns A Promise of Cron @@ -532,7 +537,7 @@ export class API extends ParentAPI { ) /** - * Create a new cron + * Create a new cron. * * @param request - The request {@link CreateCronRequest} * @returns A Promise of Cron @@ -554,7 +559,7 @@ export class API extends ParentAPI { ) /** - * Update the cron associated with the given id. + * Update an existing cron. Update the cron associated with the given id. * * @param request - The request {@link UpdateCronRequest} * @returns A Promise of Cron @@ -576,7 +581,7 @@ export class API extends ParentAPI { ) /** - * Delete the cron associated with the given id. + * Delete an existing cron. Delete the cron associated with the given id. * * @param request - The request {@link DeleteCronRequest} * @returns A Promise of Cron @@ -617,7 +622,7 @@ export class API extends ParentAPI { ) /** - * List your application logs + * List your application logs. * * @param request - The request {@link ListLogsRequest} * @returns A Promise of ListLogsResponse @@ -647,7 +652,7 @@ export class API extends ParentAPI { ) /** - * List all domain name bindings + * List all domain name bindings. * * @param request - The request {@link ListDomainsRequest} * @returns A Promise of ListDomainsResponse @@ -656,7 +661,7 @@ export class API extends ParentAPI { enrichForPagination('domains', this.pageOfListDomains, request) /** - * Get a domain name binding + * Get a domain name binding. * * @param request - The request {@link GetDomainRequest} * @returns A Promise of Domain @@ -694,7 +699,7 @@ export class API extends ParentAPI { ) /** - * Create a domain name binding + * Create a domain name binding. * * @param request - The request {@link CreateDomainRequest} * @returns A Promise of Domain @@ -716,7 +721,7 @@ export class API extends ParentAPI { ) /** - * Delete a domain name binding + * Delete a domain name binding. * * @param request - The request {@link DeleteDomainRequest} * @returns A Promise of Domain @@ -733,7 +738,11 @@ export class API extends ParentAPI { unmarshalDomain, ) - /** @deprecated */ + /** + * @deprecated + * @param request - The request {@link IssueJWTRequest} + * @returns A Promise of Token + */ issueJWT = (request: Readonly = {}) => this.client.fetch( { @@ -762,7 +771,7 @@ export class API extends ParentAPI { ) /** - * Create a new revocable token + * Create a new revocable token. * * @param request - The request {@link CreateTokenRequest} * @returns A Promise of Token @@ -784,7 +793,7 @@ export class API extends ParentAPI { ) /** - * Get a token + * Get a token. * * @param request - The request {@link GetTokenRequest} * @returns A Promise of Token @@ -844,7 +853,7 @@ export class API extends ParentAPI { ) /** - * List all tokens + * List all tokens. * * @param request - The request {@link ListTokensRequest} * @returns A Promise of ListTokensResponse @@ -853,7 +862,7 @@ export class API extends ParentAPI { enrichForPagination('tokens', this.pageOfListTokens, request) /** - * Delete a token + * Delete a token. * * @param request - The request {@link DeleteTokenRequest} * @returns A Promise of Token diff --git a/packages/clients/src/api/function/v1beta1/types.gen.ts b/packages/clients/src/api/function/v1beta1/types.gen.ts index f5b4e6e31..d8e0ce6e4 100644 --- a/packages/clients/src/api/function/v1beta1/types.gen.ts +++ b/packages/clients/src/api/function/v1beta1/types.gen.ts @@ -197,7 +197,7 @@ export interface Function { secretEnvironmentVariables: SecretHashedValue[] region: Region /** - * Possible values: + * Configure how HTTP and HTTPS requests are handled. Possible values: * * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients * to use HTTPS. @@ -492,7 +492,7 @@ export type CreateFunctionRequest = { description?: string secretEnvironmentVariables?: Secret[] /** - * Possible values: + * Configure how HTTP and HTTPS requests are handled. Possible values: * * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients * to use HTTPS. @@ -520,7 +520,7 @@ export type UpdateFunctionRequest = { description?: string secretEnvironmentVariables?: Secret[] /** - * Possible values: + * Configure how HTTP and HTTPS requests are handled. Possible values: * * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients * to use HTTPS. diff --git a/packages/clients/src/api/iam/v1alpha1/api.gen.ts b/packages/clients/src/api/iam/v1alpha1/api.gen.ts index e856dc5a2..be2ef12f5 100644 --- a/packages/clients/src/api/iam/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/iam/v1alpha1/api.gen.ts @@ -132,10 +132,10 @@ export class API extends ParentAPI { ) /** - * List SSH keys. By default, the SSH keys listed are ordered by creation date - * in ascending order. This can be modified via the `order_by` field. You can - * define additional parameters for your query such as `organization_id`, - * `name`, `project_id` and `disabled`. + * List SSH keys. List SSH keys. By default, the SSH keys listed are ordered + * by creation date in ascending order. This can be modified via the + * `order_by` field. You can define additional parameters for your query such + * as `organization_id`, `name`, `project_id` and `disabled`. * * @param request - The request {@link ListSSHKeysRequest} * @returns A Promise of ListSSHKeysResponse @@ -144,8 +144,8 @@ export class API extends ParentAPI { enrichForPagination('sshKeys', this.pageOfListSSHKeys, request) /** - * Add a new SSH key to a Scaleway Project. You must specify the `name`, - * `public_key` and `project_id`. + * Create an SSH key. Add a new SSH key to a Scaleway Project. You must + * specify the `name`, `public_key` and `project_id`. * * @param request - The request {@link CreateSSHKeyRequest} * @returns A Promise of SSHKey @@ -164,9 +164,9 @@ export class API extends ParentAPI { ) /** - * Retrieve information about a given SSH key, specified by the `ssh_key_id` - * parameter. The SSH key's full details, including `id`, `name`, - * `public_key`, and `project_id` are returned in the response. + * Get an SSH key. Retrieve information about a given SSH key, specified by + * the `ssh_key_id` parameter. The SSH key's full details, including `id`, + * `name`, `public_key`, and `project_id` are returned in the response. * * @param request - The request {@link GetSSHKeyRequest} * @returns A Promise of SSHKey @@ -184,7 +184,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of an SSH key, including `name` and `disable`. + * Update an SSH key. Update the parameters of an SSH key, including `name` + * and `disable`. * * @param request - The request {@link UpdateSSHKeyRequest} * @returns A Promise of SSHKey @@ -206,9 +207,9 @@ export class API extends ParentAPI { ) /** - * Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is - * permanent, and cannot be undone. Note that you might need to update any - * configurations that used the SSH key. + * Delete an SSH key. Delete a given SSH key, specified by the `ssh_key_id`. + * Deleting an SSH is permanent, and cannot be undone. Note that you might + * need to update any configurations that used the SSH key. * * @param request - The request {@link DeleteSSHKeyRequest} */ @@ -245,11 +246,11 @@ export class API extends ParentAPI { ) /** - * List the users of an Organization. By default, the users listed are ordered - * by creation date in ascending order. This can be modified via the - * `order_by` field. You must define the `organization_id` in the query path - * of your request. You can also define additional parameters for your query - * such as `user_ids`. + * List users of an Organization. List the users of an Organization. By + * default, the users listed are ordered by creation date in ascending order. + * This can be modified via the `order_by` field. You must define the + * `organization_id` in the query path of your request. You can also define + * additional parameters for your query such as `user_ids`. * * @param request - The request {@link ListUsersRequest} * @returns A Promise of ListUsersResponse @@ -258,9 +259,10 @@ export class API extends ParentAPI { enrichForPagination('users', this.pageOfListUsers, request) /** - * Retrieve information about a user, specified by the `user_id` parameter. - * The user's full details, including `id`, `email`, `organization_id`, - * `status` and `two_factor_enabled` are returned in the response. + * Get a given user. Retrieve information about a user, specified by the + * `user_id` parameter. The user's full details, including `id`, `email`, + * `organization_id`, `status` and `two_factor_enabled` are returned in the + * response. * * @param request - The request {@link GetUserRequest} * @returns A Promise of User @@ -278,10 +280,11 @@ export class API extends ParentAPI { ) /** - * Remove a user from an Organization in which they are a guest. You must - * define the `user_id` in your request. Note that removing a user from an - * Organization automatically deletes their API keys, and any policies - * directly attached to them become orphaned. + * Delete a guest user from an Organization. Remove a user from an + * Organization in which they are a guest. You must define the `user_id` in + * your request. Note that removing a user from an Organization automatically + * deletes their API keys, and any policies directly attached to them become + * orphaned. * * @param request - The request {@link DeleteUserRequest} */ @@ -322,11 +325,12 @@ export class API extends ParentAPI { ) /** - * List the applications of an Organization. By default, the applications - * listed are ordered by creation date in ascending order. This can be - * modified via the `order_by` field. You must define the `organization_id` in - * the query path of your request. You can also define additional parameters - * for your query such as `application_ids`. + * List applications of an Organization. List the applications of an + * Organization. By default, the applications listed are ordered by creation + * date in ascending order. This can be modified via the `order_by` field. You + * must define the `organization_id` in the query path of your request. You + * can also define additional parameters for your query such as + * `application_ids`. * * @param request - The request {@link ListApplicationsRequest} * @returns A Promise of ListApplicationsResponse @@ -335,8 +339,8 @@ export class API extends ParentAPI { enrichForPagination('applications', this.pageOfListApplications, request) /** - * Create a new application. You must define the `name` parameter in the - * request. + * Create a new application. Create a new application. You must define the + * `name` parameter in the request. * * @param request - The request {@link CreateApplicationRequest} * @returns A Promise of Application @@ -355,10 +359,10 @@ export class API extends ParentAPI { ) /** - * Retrieve information about an application, specified by the - * `application_id` parameter. The application's full details, including `id`, - * `email`, `organization_id`, `status` and `two_factor_enabled` are returned - * in the response. + * Get a given application. Retrieve information about an application, + * specified by the `application_id` parameter. The application's full + * details, including `id`, `email`, `organization_id`, `status` and + * `two_factor_enabled` are returned in the response. * * @param request - The request {@link GetApplicationRequest} * @returns A Promise of Application @@ -376,8 +380,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of an application, including `name` and - * `description`. + * Update an application. Update the parameters of an application, including + * `name` and `description`. * * @param request - The request {@link UpdateApplicationRequest} * @returns A Promise of Application @@ -399,9 +403,10 @@ export class API extends ParentAPI { ) /** - * Delete an application. Note that this action is irreversible and will - * automatically delete the application's API keys. Policies attached to users - * and applications via this group will no longer apply. + * Delete an application. Delete an application. Note that this action is + * irreversible and will automatically delete the application's API keys. + * Policies attached to users and applications via this group will no longer + * apply. * * @param request - The request {@link DeleteApplicationRequest} */ @@ -437,11 +442,11 @@ export class API extends ParentAPI { ) /** - * List groups. By default, the groups listed are ordered by creation date in - * ascending order. This can be modified via the `order_by` field. You can - * define additional parameters to filter your query. Use `user_ids` or - * `application_ids` to list all groups certain users or applications belong - * to. + * List groups. List groups. By default, the groups listed are ordered by + * creation date in ascending order. This can be modified via the `order_by` + * field. You can define additional parameters to filter your query. Use + * `user_ids` or `application_ids` to list all groups certain users or + * applications belong to. * * @param request - The request {@link ListGroupsRequest} * @returns A Promise of ListGroupsResponse @@ -450,8 +455,8 @@ export class API extends ParentAPI { enrichForPagination('groups', this.pageOfListGroups, request) /** - * Create a new group. You must define the `name` and `organization_id` - * parameters in the request. + * Create a group. Create a new group. You must define the `name` and + * `organization_id` parameters in the request. * * @param request - The request {@link CreateGroupRequest} * @returns A Promise of Group @@ -470,8 +475,8 @@ export class API extends ParentAPI { ) /** - * Retrive information about a given group, specified by the `group_id` - * parameter. The group's full details, including `user_ids` and + * Get a group. Retrive information about a given group, specified by the + * `group_id` parameter. The group's full details, including `user_ids` and * `application_ids` are returned in the response. * * @param request - The request {@link GetGroupRequest} @@ -490,7 +495,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of group, including `name` and `description`. + * Update a group. Update the parameters of group, including `name` and + * `description`. * * @param request - The request {@link UpdateGroupRequest} * @returns A Promise of Group @@ -512,8 +518,9 @@ export class API extends ParentAPI { ) /** - * Overwrite users and applications configuration in a group. Any information - * that you add using this command will overwrite the previous configuration. + * Overwrite users and applications of a group. Overwrite users and + * applications configuration in a group. Any information that you add using + * this command will overwrite the previous configuration. * * @param request - The request {@link SetGroupMembersRequest} * @returns A Promise of Group @@ -535,9 +542,9 @@ export class API extends ParentAPI { ) /** - * Add a user or an application to a group. You can specify a `user_id` and - * and `application_id` in the body of your request. Note that you can only - * add one of each per request. + * Add a user or an application to a group. Add a user or an application to a + * group. You can specify a `user_id` and and `application_id` in the body of + * your request. Note that you can only add one of each per request. * * @param request - The request {@link AddGroupMemberRequest} * @returns A Promise of Group @@ -559,12 +566,13 @@ export class API extends ParentAPI { ) /** - * Remove a user or an application from a group. You can specify a `user_id` - * and and `application_id` in the body of your request. Note that you can - * only remove one of each per request. Removing a user from a group means - * that any permissions given to them via the group (i.e. from an attached - * policy) will no longer apply. Be sure you want to remove these permissions - * from the user before proceeding. + * Remove a user or an application from a group. Remove a user or an + * application from a group. You can specify a `user_id` and and + * `application_id` in the body of your request. Note that you can only remove + * one of each per request. Removing a user from a group means that any + * permissions given to them via the group (i.e. from an attached policy) will + * no longer apply. Be sure you want to remove these permissions from the user + * before proceeding. * * @param request - The request {@link RemoveGroupMemberRequest} * @returns A Promise of Group @@ -586,9 +594,9 @@ export class API extends ParentAPI { ) /** - * Delete a group. Note that this action is irreversible and could delete - * permissions for group members. Policies attached to users and applications - * via this group will no longer apply. + * Delete a group. Delete a group. Note that this action is irreversible and + * could delete permissions for group members. Policies attached to users and + * applications via this group will no longer apply. * * @param request - The request {@link DeleteGroupRequest} */ @@ -632,12 +640,12 @@ export class API extends ParentAPI { ) /** - * List the policies of an Organization. By default, the policies listed are - * ordered by creation date in ascending order. This can be modified via the - * `order_by` field. You must define the `organization_id` in the query path - * of your request. You can also define additional parameters to filter your - * query, such as `user_ids`, `groups_ids`, `application_ids`, and - * `policy_name`. + * List policies of an Organization. List the policies of an Organization. By + * default, the policies listed are ordered by creation date in ascending + * order. This can be modified via the `order_by` field. You must define the + * `organization_id` in the query path of your request. You can also define + * additional parameters to filter your query, such as `user_ids`, + * `groups_ids`, `application_ids`, and `policy_name`. * * @param request - The request {@link ListPoliciesRequest} * @returns A Promise of ListPoliciesResponse @@ -646,9 +654,10 @@ export class API extends ParentAPI { enrichForPagination('policies', this.pageOfListPolicies, request) /** - * Create a new application. You must define the `name` parameter in the - * request. You can specify parameters such as `user_id`, `groups_id`, - * `application_id`, `no_principal`, `rules` and its child attributes. + * Create a new policy. Create a new application. You must define the `name` + * parameter in the request. You can specify parameters such as `user_id`, + * `groups_id`, `application_id`, `no_principal`, `rules` and its child + * attributes. * * @param request - The request {@link CreatePolicyRequest} * @returns A Promise of Policy @@ -667,10 +676,10 @@ export class API extends ParentAPI { ) /** - * Retrieve information about a policy, speficified by the `policy_id` - * parameter. The policy's full details, including `id`, `name`, - * `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are - * returned in the response. + * Get an existing policy. Retrieve information about a policy, speficified by + * the `policy_id` parameter. The policy's full details, including `id`, + * `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` + * are returned in the response. * * @param request - The request {@link GetPolicyRequest} * @returns A Promise of Policy @@ -688,8 +697,9 @@ export class API extends ParentAPI { ) /** - * Update the parameters of a policy, including `name`, `description`, - * `user_id`, `group_id`, `application_id` and `no_principal`. + * Update an existing policy. Update the parameters of a policy, including + * `name`, `description`, `user_id`, `group_id`, `application_id` and + * `no_principal`. * * @param request - The request {@link UpdatePolicyRequest} * @returns A Promise of Policy @@ -711,9 +721,10 @@ export class API extends ParentAPI { ) /** - * Delete a policy. You must define specify the `policy_id` parameter in your - * request. Note that when deleting a policy, all permissions it gives to its - * principal (user, group or application) will be revoked. + * Delete a policy. Delete a policy. You must define specify the `policy_id` + * parameter in your request. Note that when deleting a policy, all + * permissions it gives to its principal (user, group or application) will be + * revoked. * * @param request - The request {@link DeletePolicyRequest} */ @@ -741,12 +752,12 @@ export class API extends ParentAPI { ) /** - * Overwrite the rules of a given policy. Any information that you add using - * this command will overwrite the previous configuration. If you include some - * of the rules you already had in your previous configuration in your new - * one, but you change their order, the new order of display will apply. While - * policy rules are ordered, they have no impact on the access logic of IAM - * because rules are allow-only. + * Set rules of a given policy. Overwrite the rules of a given policy. Any + * information that you add using this command will overwrite the previous + * configuration. If you include some of the rules you already had in your + * previous configuration in your new one, but you change their order, the new + * order of display will apply. While policy rules are ordered, they have no + * impact on the access logic of IAM because rules are allow-only. * * @param request - The request {@link SetRulesRequest} * @returns A Promise of SetRulesResponse @@ -782,10 +793,10 @@ export class API extends ParentAPI { ) /** - * List the rules of a given policy. By default, the rules listed are ordered - * by creation date in ascending order. This can be modified via the - * `order_by` field. You must define the `policy_id` in the query path of your - * request. + * List rules of a given policy. List the rules of a given policy. By default, + * the rules listed are ordered by creation date in ascending order. This can + * be modified via the `order_by` field. You must define the `policy_id` in + * the query path of your request. * * @param request - The request {@link ListRulesRequest} * @returns A Promise of ListRulesResponse @@ -818,8 +829,9 @@ export class API extends ParentAPI { ) /** - * List permission sets available for given Organization. You must define the - * `organization_id` in the query path of your request. + * List permission sets. List permission sets available for given + * Organization. You must define the `organization_id` in the query path of + * your request. * * @param request - The request {@link ListPermissionSetsRequest} * @returns A Promise of ListPermissionSetsResponse @@ -872,10 +884,10 @@ export class API extends ParentAPI { ) /** - * List API keys. By default, the API keys listed are ordered by creation date - * in ascending order. This can be modified via the `order_by` field. You can - * define additional parameters for your query such as `editable`, `expired`, - * `access_key` and `bearer_id`. + * List API keys. List API keys. By default, the API keys listed are ordered + * by creation date in ascending order. This can be modified via the + * `order_by` field. You can define additional parameters for your query such + * as `editable`, `expired`, `access_key` and `bearer_id`. * * @param request - The request {@link ListAPIKeysRequest} * @returns A Promise of ListAPIKeysResponse @@ -884,12 +896,12 @@ export class API extends ParentAPI { enrichForPagination('apiKeys', this.pageOfListAPIKeys, request) /** - * Create an API key. You must specify the `application_id` or the `user_id` - * and the description. You can also specify the `default_project_id` which is - * the Project ID of your preferred Project, to use with Object Storage. The - * `access_key` and `secret_key` values are returned in the response. Note - * that he secret key is only showed once. Make sure that you copy and store - * both keys somewhere safe. + * Create an API key. Create an API key. You must specify the `application_id` + * or the `user_id` and the description. You can also specify the + * `default_project_id` which is the Project ID of your preferred Project, to + * use with Object Storage. The `access_key` and `secret_key` values are + * returned in the response. Note that he secret key is only showed once. Make + * sure that you copy and store both keys somewhere safe. * * @param request - The request {@link CreateAPIKeyRequest} * @returns A Promise of APIKey @@ -908,12 +920,12 @@ export class API extends ParentAPI { ) /** - * Retrive information about an API key, specified by the `access_key` - * parameter. The API key's details, including either the `user_id` or - * `application_id` of its bearer are returned in the response. Note that the - * string value for the `secret_key` is nullable, and therefore is not - * displayed in the response. The `secret_key` value is only displayed upon - * API key creation. + * Get an API key. Retrive information about an API key, specified by the + * `access_key` parameter. The API key's details, including either the + * `user_id` or `application_id` of its bearer are returned in the response. + * Note that the string value for the `secret_key` is nullable, and therefore + * is not displayed in the response. The `secret_key` value is only displayed + * upon API key creation. * * @param request - The request {@link GetAPIKeyRequest} * @returns A Promise of APIKey @@ -931,8 +943,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of an API key, including `default_project_id` and - * `description`. + * Update an API key. Update the parameters of an API key, including + * `default_project_id` and `description`. * * @param request - The request {@link UpdateAPIKeyRequest} * @returns A Promise of APIKey @@ -954,9 +966,9 @@ export class API extends ParentAPI { ) /** - * Delete an API key. Note that this action is irreversible and cannot be - * undone. Make sure you update any configurations using the API keys you - * delete. + * Delete an API key. Delete an API key. Note that this action is irreversible + * and cannot be undone. Make sure you update any configurations using the API + * keys you delete. * * @param request - The request {@link DeleteAPIKeyRequest} */ @@ -992,10 +1004,11 @@ export class API extends ParentAPI { ) /** - * List all product and features quota for an Organization, with their - * associated limits. By default, the quota listed are ordered by creation - * date in ascending order. This can be modified via the `order_by` field. You - * must define the `organization_id` in the query path of your request. + * List all quotas in the Organization. List all product and features quota + * for an Organization, with their associated limits. By default, the quota + * listed are ordered by creation date in ascending order. This can be + * modified via the `order_by` field. You must define the `organization_id` in + * the query path of your request. * * @param request - The request {@link ListQuotaRequest} * @returns A Promise of ListQuotaResponse @@ -1004,9 +1017,9 @@ export class API extends ParentAPI { enrichForPagination('quota', this.pageOfListQuota, request) /** - * Retrieve information about a resource quota, speficified by the - * `quotum_name` parameter. The quota's `limit`, or whether it is unlimited, - * is returned in the response. + * Get a quota in the Organization. Retrieve information about a resource + * quota, speficified by the `quotum_name` parameter. The quota's `limit`, or + * whether it is unlimited, is returned in the response. * * @param request - The request {@link GetQuotumRequest} * @returns A Promise of Quotum @@ -1047,7 +1060,7 @@ export class API extends ParentAPI { ) /** - * List JWTs + * List JWTs. * * @param request - The request {@link ListJWTsRequest} * @returns A Promise of ListJWTsResponse @@ -1056,7 +1069,7 @@ export class API extends ParentAPI { enrichForPagination('jwts', this.pageOfListJWTs, request) /** - * Get a JWT + * Get a JWT. * * @param request - The request {@link GetJWTRequest} * @returns A Promise of JWT @@ -1071,7 +1084,7 @@ export class API extends ParentAPI { ) /** - * Delete a JWT + * Delete a JWT. * * @param request - The request {@link DeleteJWTRequest} */ diff --git a/packages/clients/src/api/instance/v1/api.gen.ts b/packages/clients/src/api/instance/v1/api.gen.ts index efbdd47e5..ff8fbfc57 100644 --- a/packages/clients/src/api/instance/v1/api.gen.ts +++ b/packages/clients/src/api/instance/v1/api.gen.ts @@ -224,7 +224,7 @@ export class API extends ParentAPI { ] /** - * Get availability for all server types. + * Get availability. Get availability for all server types. * * @param request - The request {@link GetServerTypesAvailabilityRequest} * @returns A Promise of GetServerTypesAvailabilityResponse @@ -248,7 +248,7 @@ export class API extends ParentAPI { ) /** - * Get server types technical details. + * List server types. Get server types technical details. * * @param request - The request {@link ListServersTypesRequest} * @returns A Promise of ListServersTypesResponse @@ -270,7 +270,7 @@ export class API extends ParentAPI { ) /** - * Get volumes technical details. + * List volumes types. Get volumes technical details. * * @param request - The request {@link ListVolumesTypesRequest} * @returns A Promise of ListVolumesTypesResponse @@ -323,7 +323,7 @@ export class API extends ParentAPI { ) /** - * List all servers + * List all servers. * * @param request - The request {@link ListServersRequest} * @returns A Promise of ListServersResponse @@ -348,7 +348,7 @@ export class API extends ParentAPI { ) /** - * Delete a server with the given ID. + * Delete a server. Delete a server with the given ID. * * @param request - The request {@link DeleteServerRequest} */ @@ -362,7 +362,7 @@ export class API extends ParentAPI { }) /** - * Get the details of a specified Server. + * Get a server. Get the details of a specified Server. * * @param request - The request {@link GetServerRequest} * @returns A Promise of GetServerResponse @@ -412,7 +412,8 @@ export class API extends ParentAPI { ) /** - * List all actions that can currently be performed on a server. + * List server actions. List all actions that can currently be performed on a + * server. * * @param request - The request {@link ListServerActionsRequest} * @returns A Promise of ListServerActionsResponse @@ -430,12 +431,13 @@ export class API extends ParentAPI { ) /** - * Perform power related actions on a server. Be wary that when terminating a - * server, all the attached volumes (local _and_ block storage) are deleted. - * So, if you want to keep your local volumes, you must use the `archive` - * action instead of `terminate`. And if you want to keep block-storage - * volumes, **you must** detach it beforehand you issue the `terminate` call. - * For more information, read the [Volumes](#volumes-7e8a39) documentation. + * Perform action. Perform power related actions on a server. Be wary that + * when terminating a server, all the attached volumes (local _and_ block + * storage) are deleted. So, if you want to keep your local volumes, you must + * use the `archive` action instead of `terminate`. And if you want to keep + * block-storage volumes, **you must** detach it beforehand you issue the + * `terminate` call. For more information, read the [Volumes](#volumes-7e8a39) + * documentation. * * @param request - The request {@link ServerActionRequest} * @returns A Promise of ServerActionResponse @@ -457,7 +459,7 @@ export class API extends ParentAPI { ) /** - * List all user data keys registered on a given server. + * List user data. List all user data keys registered on a given server. * * @param request - The request {@link ListServerUserDataRequest} * @returns A Promise of ListServerUserDataResponse @@ -478,7 +480,7 @@ export class API extends ParentAPI { ) /** - * Delete the given key from a server user data. + * Delete user data. Delete the given key from a server user data. * * @param request - The request {@link DeleteServerUserDataRequest} */ @@ -517,7 +519,7 @@ export class API extends ParentAPI { ) /** - * List all images available in an account. + * List instance images. List all images available in an account. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -526,7 +528,7 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get details of an image with the given ID. + * Get an instance image. Get details of an image with the given ID. * * @param request - The request {@link GetImageRequest} * @returns A Promise of GetImageResponse @@ -544,7 +546,7 @@ export class API extends ParentAPI { ) /** - * Create an instance image + * Create an instance image. * * @param request - The request {@link CreateImageRequest} * @returns A Promise of CreateImageResponse @@ -582,7 +584,7 @@ export class API extends ParentAPI { ) /** - * Delete the image with the given ID. + * Delete an instance image. Delete the image with the given ID. * * @param request - The request {@link DeleteImageRequest} */ @@ -618,7 +620,7 @@ export class API extends ParentAPI { ) /** - * List snapshots + * List snapshots. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -627,7 +629,7 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Create a snapshot from a given volume or from a QCOW2 file + * Create a snapshot from a given volume or from a QCOW2 file. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of CreateSnapshotResponse @@ -649,7 +651,7 @@ export class API extends ParentAPI { ) /** - * Get details of a snapshot with the given ID. + * Get a snapshot. Get details of a snapshot with the given ID. * * @param request - The request {@link GetSnapshotRequest} * @returns A Promise of GetSnapshotResponse @@ -683,7 +685,7 @@ export class API extends ParentAPI { ) /** - * Delete the snapshot with the given ID. + * Delete a snapshot. Delete the snapshot with the given ID. * * @param request - The request {@link DeleteSnapshotRequest} */ @@ -697,7 +699,8 @@ export class API extends ParentAPI { }) /** - * Export a snapshot to a given S3 bucket in the same region. + * Export a snapshot. Export a snapshot to a given S3 bucket in the same + * region. * * @param request - The request {@link ExportSnapshotRequest} * @returns A Promise of ExportSnapshotResponse @@ -748,7 +751,7 @@ export class API extends ParentAPI { ) /** - * List volumes + * List volumes. * * @param request - The request {@link ListVolumesRequest} * @returns A Promise of ListVolumesResponse @@ -757,7 +760,7 @@ export class API extends ParentAPI { enrichForPagination('volumes', this.pageOfListVolumes, request) /** - * Create a volume + * Create a volume. * * @param request - The request {@link CreateVolumeRequest} * @returns A Promise of CreateVolumeResponse @@ -779,7 +782,7 @@ export class API extends ParentAPI { ) /** - * Get details of a volume with the given ID. + * Get a volume. Get details of a volume with the given ID. * * @param request - The request {@link GetVolumeRequest} * @returns A Promise of GetVolumeResponse @@ -797,9 +800,9 @@ export class API extends ParentAPI { ) /** - * Replace name and/or size properties of given ID volume with the given - * value(s). Any volume name can be changed while, for now, only `b_ssd` - * volume growing is supported. + * Update a volume. Replace name and/or size properties of given ID volume + * with the given value(s). Any volume name can be changed while, for now, + * only `b_ssd` volume growing is supported. * * @param request - The request {@link UpdateVolumeRequest} * @returns A Promise of UpdateVolumeResponse @@ -821,7 +824,7 @@ export class API extends ParentAPI { ) /** - * Delete the volume with the given ID. + * Delete a volume. Delete the volume with the given ID. * * @param request - The request {@link DeleteVolumeRequest} */ @@ -863,7 +866,7 @@ export class API extends ParentAPI { ) /** - * List all security groups available in an account. + * List security groups. List all security groups available in an account. * * @param request - The request {@link ListSecurityGroupsRequest} * @returns A Promise of ListSecurityGroupsResponse @@ -876,7 +879,7 @@ export class API extends ParentAPI { ) /** - * Create a security group + * Create a security group. * * @param request - The request {@link CreateSecurityGroupRequest} * @returns A Promise of CreateSecurityGroupResponse @@ -898,7 +901,8 @@ export class API extends ParentAPI { ) /** - * Get the details of a Security Group with the given ID. + * Get a security group. Get the details of a Security Group with the given + * ID. * * @param request - The request {@link GetSecurityGroupRequest} * @returns A Promise of GetSecurityGroupResponse @@ -919,7 +923,7 @@ export class API extends ParentAPI { ) /** - * Delete a security group + * Delete a security group. * * @param request - The request {@link DeleteSecurityGroupRequest} */ @@ -952,7 +956,8 @@ export class API extends ParentAPI { ) /** - * Lists the default rules applied to all the security groups. + * Get default rules. Lists the default rules applied to all the security + * groups. * * @param request - The request {@link ListDefaultSecurityGroupRulesRequest} * @returns A Promise of ListSecurityGroupRulesResponse @@ -993,7 +998,7 @@ export class API extends ParentAPI { ) /** - * List rules + * List rules. * * @param request - The request {@link ListSecurityGroupRulesRequest} * @returns A Promise of ListSecurityGroupRulesResponse @@ -1002,7 +1007,7 @@ export class API extends ParentAPI { enrichForPagination('rules', this.pageOfListSecurityGroupRules, request) /** - * Create rule + * Create rule. * * @param request - The request {@link CreateSecurityGroupRuleRequest} * @returns A Promise of CreateSecurityGroupRuleResponse @@ -1029,9 +1034,10 @@ export class API extends ParentAPI { ) /** - * Replaces the rules of the security group with the rules provided. This - * endpoint supports the update of existing rules, creation of new rules and - * deletion of existing rules when they are not passed in the request. + * Update all the rules of a security group. Replaces the rules of the + * security group with the rules provided. This endpoint supports the update + * of existing rules, creation of new rules and deletion of existing rules + * when they are not passed in the request. * * @param request - The request {@link SetSecurityGroupRulesRequest} * @returns A Promise of SetSecurityGroupRulesResponse @@ -1056,7 +1062,7 @@ export class API extends ParentAPI { ) /** - * Delete a security group rule with the given ID. + * Delete rule. Delete a security group rule with the given ID. * * @param request - The request {@link DeleteSecurityGroupRuleRequest} */ @@ -1078,7 +1084,7 @@ export class API extends ParentAPI { }) /** - * Get details of a security group rule with the given ID. + * Get rule. Get details of a security group rule with the given ID. * * @param request - The request {@link GetSecurityGroupRuleRequest} * @returns A Promise of GetSecurityGroupRuleResponse @@ -1153,7 +1159,7 @@ export class API extends ParentAPI { ) /** - * List all placement groups. + * List placement groups. List all placement groups. * * @param request - The request {@link ListPlacementGroupsRequest} * @returns A Promise of ListPlacementGroupsResponse @@ -1166,7 +1172,7 @@ export class API extends ParentAPI { ) /** - * Create a new placement group. + * Create a placement group. Create a new placement group. * * @param request - The request {@link CreatePlacementGroupRequest} * @returns A Promise of CreatePlacementGroupResponse @@ -1190,7 +1196,7 @@ export class API extends ParentAPI { ) /** - * Get the given placement group. + * Get a placement group. Get the given placement group. * * @param request - The request {@link GetPlacementGroupRequest} * @returns A Promise of GetPlacementGroupResponse @@ -1211,7 +1217,7 @@ export class API extends ParentAPI { ) /** - * Set all parameters of the given placement group. + * Set placement group. Set all parameters of the given placement group. * * @param request - The request {@link SetPlacementGroupRequest} * @returns A Promise of SetPlacementGroupResponse @@ -1236,7 +1242,8 @@ export class API extends ParentAPI { ) /** - * Update one or more parameter of the given placement group. + * Update a placement group. Update one or more parameter of the given + * placement group. * * @param request - The request {@link UpdatePlacementGroupRequest} * @returns A Promise of UpdatePlacementGroupResponse @@ -1278,7 +1285,8 @@ export class API extends ParentAPI { }) /** - * Get all servers belonging to the given placement group. + * Get placement group servers. Get all servers belonging to the given + * placement group. * * @param request - The request {@link GetPlacementGroupServersRequest} * @returns A Promise of GetPlacementGroupServersResponse @@ -1301,7 +1309,8 @@ export class API extends ParentAPI { ) /** - * Set all servers belonging to the given placement group. + * Set placement group servers. Set all servers belonging to the given + * placement group. * * @param request - The request {@link SetPlacementGroupServersRequest} * @returns A Promise of SetPlacementGroupServersResponse @@ -1328,7 +1337,8 @@ export class API extends ParentAPI { ) /** - * Update all servers belonging to the given placement group. + * Update placement group servers. Update all servers belonging to the given + * placement group. * * @param request - The request {@link UpdatePlacementGroupServersRequest} * @returns A Promise of UpdatePlacementGroupServersResponse @@ -1383,7 +1393,7 @@ export class API extends ParentAPI { ) /** - * List all flexible IPs + * List all flexible IPs. * * @param request - The request {@link ListIpsRequest} * @returns A Promise of ListIpsResponse @@ -1392,7 +1402,7 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIps, request) /** - * Reserve a flexible IP + * Reserve a flexible IP. * * @param request - The request {@link CreateIpRequest} * @returns A Promise of CreateIpResponse @@ -1414,7 +1424,7 @@ export class API extends ParentAPI { ) /** - * Get details of an IP with the given ID or address. + * Get a flexible IP. Get details of an IP with the given ID or address. * * @param request - The request {@link GetIpRequest} * @returns A Promise of GetIpResponse @@ -1432,7 +1442,7 @@ export class API extends ParentAPI { ) /** - * Update a flexible IP + * Update a flexible IP. * * @param request - The request {@link UpdateIpRequest} * @returns A Promise of UpdateIpResponse @@ -1454,7 +1464,7 @@ export class API extends ParentAPI { ) /** - * Delete the IP with the given ID. + * Delete a flexible IP. Delete the IP with the given ID. * * @param request - The request {@link DeleteIpRequest} */ @@ -1495,7 +1505,7 @@ export class API extends ParentAPI { ) /** - * List all private NICs of a given server. + * List all private NICs. List all private NICs of a given server. * * @param request - The request {@link ListPrivateNICsRequest} * @returns A Promise of ListPrivateNICsResponse @@ -1529,7 +1539,7 @@ export class API extends ParentAPI { ) /** - * Get private NIC properties. + * Get a private NIC. Get private NIC properties. * * @param request - The request {@link GetPrivateNICRequest} * @returns A Promise of GetPrivateNICResponse @@ -1553,7 +1563,8 @@ export class API extends ParentAPI { ) /** - * Update one or more parameter/s to a given private NIC. + * Update a private NIC. Update one or more parameter/s to a given private + * NIC. * * @param request - The request {@link UpdatePrivateNICRequest} * @returns A Promise of PrivateNIC @@ -1623,7 +1634,7 @@ export class API extends ParentAPI { ) /** - * List bootscripts + * List bootscripts. * * @deprecated * @param request - The request {@link ListBootscriptsRequest} @@ -1633,7 +1644,7 @@ export class API extends ParentAPI { enrichForPagination('bootscripts', this.pageOfListBootscripts, request) /** - * Get details of a bootscript with the given ID. + * Get bootscripts. Get details of a bootscript with the given ID. * * @deprecated * @param request - The request {@link GetBootscriptRequest} diff --git a/packages/clients/src/api/instance/v1/types.gen.ts b/packages/clients/src/api/instance/v1/types.gen.ts index 33f184bcb..169f53196 100644 --- a/packages/clients/src/api/instance/v1/types.gen.ts +++ b/packages/clients/src/api/instance/v1/types.gen.ts @@ -545,8 +545,9 @@ export interface Server { /** Server action request. volume backup template. */ export interface ServerActionRequestVolumeBackupTemplate { /** - * Overrides the volume_type of the snapshot for this volume. If omitted, the - * volume type of the original volume will be used. + * The snapshot's volume type. Overrides the volume_type of the snapshot for + * this volume. If omitted, the volume type of the original volume will be + * used. */ volumeType: SnapshotVolumeType } @@ -992,13 +993,15 @@ export type ServerActionRequest = { /** The action to perform on the server. */ action?: ServerAction /** - * The name of the backup you want to create. This field should only be - * specified when performing a backup action. + * The name of the backup you want to create. The name of the backup you want + * to create. This field should only be specified when performing a backup + * action. */ name?: string /** - * For each volume UUID, the snapshot parameters of the volume. This field - * should only be specified when performing a backup action. + * For each volume UUID, the snapshot parameters of the volume. For each + * volume UUID, the snapshot parameters of the volume. This field should only + * be specified when performing a backup action. */ volumes?: Record } @@ -1114,8 +1117,8 @@ export type CreateSnapshotRequest = { */ project?: string /** - * Overrides the volume_type of the snapshot. If omitted, the volume type of - * the original volume will be used. + * The volume type of the snapshot. Overrides the volume_type of the snapshot. + * If omitted, the volume type of the original volume will be used. */ volumeType?: SnapshotVolumeType /** Bucket name for snapshot imports. */ diff --git a/packages/clients/src/api/iot/v1/api.gen.ts b/packages/clients/src/api/iot/v1/api.gen.ts index 823a21d41..4bc5e2689 100644 --- a/packages/clients/src/api/iot/v1/api.gen.ts +++ b/packages/clients/src/api/iot/v1/api.gen.ts @@ -104,7 +104,7 @@ const jsonContentHeaders = { /** * IoT API. * - * This API allows you to manage IoT hubs and devices. + * This API allows you to manage IoT hubs and devices. IoT API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -134,7 +134,7 @@ export class API extends ParentAPI { ) /** - * List hubs + * List hubs. * * @param request - The request {@link ListHubsRequest} * @returns A Promise of ListHubsResponse @@ -143,7 +143,7 @@ export class API extends ParentAPI { enrichForPagination('hubs', this.pageOfListHubs, request) /** - * Create a hub + * Create a hub. * * @param request - The request {@link CreateHubRequest} * @returns A Promise of Hub @@ -165,7 +165,7 @@ export class API extends ParentAPI { ) /** - * Get a hub + * Get a hub. * * @param request - The request {@link GetHubRequest} * @returns A Promise of Hub @@ -202,7 +202,7 @@ export class API extends ParentAPI { ) /** - * Update a hub + * Update a hub. * * @param request - The request {@link UpdateHubRequest} * @returns A Promise of Hub @@ -224,7 +224,7 @@ export class API extends ParentAPI { ) /** - * Enable a hub + * Enable a hub. * * @param request - The request {@link EnableHubRequest} * @returns A Promise of Hub @@ -244,7 +244,7 @@ export class API extends ParentAPI { ) /** - * Disable a hub + * Disable a hub. * * @param request - The request {@link DisableHubRequest} * @returns A Promise of Hub @@ -264,7 +264,7 @@ export class API extends ParentAPI { ) /** - * Delete a hub + * Delete a hub. * * @param request - The request {@link DeleteHubRequest} */ @@ -279,7 +279,7 @@ export class API extends ParentAPI { }) /** - * Get a hub's metrics + * Get a hub's metrics. * * @deprecated * @param request - The request {@link GetHubMetricsRequest} @@ -299,7 +299,7 @@ export class API extends ParentAPI { ) /** - * Set the certificate authority of a hub + * Set the certificate authority of a hub. * * @param request - The request {@link SetHubCARequest} * @returns A Promise of Hub @@ -321,7 +321,7 @@ export class API extends ParentAPI { ) /** - * Get the certificate authority of a hub + * Get the certificate authority of a hub. * * @param request - The request {@link GetHubCARequest} * @returns A Promise of GetHubCAResponse @@ -363,7 +363,7 @@ export class API extends ParentAPI { ) /** - * List devices + * List devices. * * @param request - The request {@link ListDevicesRequest} * @returns A Promise of ListDevicesResponse @@ -372,7 +372,7 @@ export class API extends ParentAPI { enrichForPagination('devices', this.pageOfListDevices, request) /** - * Add a device + * Add a device. * * @param request - The request {@link CreateDeviceRequest} * @returns A Promise of CreateDeviceResponse @@ -394,7 +394,7 @@ export class API extends ParentAPI { ) /** - * Get a device + * Get a device. * * @param request - The request {@link GetDeviceRequest} * @returns A Promise of Device @@ -412,7 +412,7 @@ export class API extends ParentAPI { ) /** - * Update a device + * Update a device. * * @param request - The request {@link UpdateDeviceRequest} * @returns A Promise of Device @@ -434,7 +434,7 @@ export class API extends ParentAPI { ) /** - * Enable a device + * Enable a device. * * @param request - The request {@link EnableDeviceRequest} * @returns A Promise of Device @@ -454,7 +454,7 @@ export class API extends ParentAPI { ) /** - * Disable a device + * Disable a device. * * @param request - The request {@link DisableDeviceRequest} * @returns A Promise of Device @@ -474,7 +474,7 @@ export class API extends ParentAPI { ) /** - * Renew a device certificate + * Renew a device certificate. * * @param request - The request {@link RenewDeviceCertificateRequest} * @returns A Promise of RenewDeviceCertificateResponse @@ -497,7 +497,7 @@ export class API extends ParentAPI { ) /** - * Set a custom certificate on a device + * Set a custom certificate on a device. * * @param request - The request {@link SetDeviceCertificateRequest} * @returns A Promise of SetDeviceCertificateResponse @@ -522,7 +522,7 @@ export class API extends ParentAPI { ) /** - * Get a device's certificate + * Get a device's certificate. * * @param request - The request {@link GetDeviceCertificateRequest} * @returns A Promise of GetDeviceCertificateResponse @@ -543,7 +543,7 @@ export class API extends ParentAPI { ) /** - * Remove a device + * Remove a device. * * @param request - The request {@link DeleteDeviceRequest} */ @@ -557,7 +557,7 @@ export class API extends ParentAPI { }) /** - * Get a device's metrics + * Get a device's metrics. * * @deprecated * @param request - The request {@link GetDeviceMetricsRequest} @@ -599,7 +599,7 @@ export class API extends ParentAPI { ) /** - * List routes + * List routes. * * @param request - The request {@link ListRoutesRequest} * @returns A Promise of ListRoutesResponse @@ -608,7 +608,7 @@ export class API extends ParentAPI { enrichForPagination('routes', this.pageOfListRoutes, request) /** - * Multiple route kinds can be created: + * Create a route. Multiple route kinds can be created: * * - Database Route. Create a route that will record subscribed MQTT messages * into your database. You need to manage the database by yourself. @@ -639,7 +639,7 @@ export class API extends ParentAPI { ) /** - * Update a route + * Update a route. * * @param request - The request {@link UpdateRouteRequest} * @returns A Promise of Route @@ -661,7 +661,7 @@ export class API extends ParentAPI { ) /** - * Get a route + * Get a route. * * @param request - The request {@link GetRouteRequest} * @returns A Promise of Route @@ -679,7 +679,7 @@ export class API extends ParentAPI { ) /** - * Delete a route + * Delete a route. * * @param request - The request {@link DeleteRouteRequest} */ @@ -718,7 +718,7 @@ export class API extends ParentAPI { ) /** - * List the Networks + * List the Networks. * * @param request - The request {@link ListNetworksRequest} * @returns A Promise of ListNetworksResponse @@ -727,7 +727,7 @@ export class API extends ParentAPI { enrichForPagination('networks', this.pageOfListNetworks, request) /** - * Create a new Network + * Create a new Network. * * @param request - The request {@link CreateNetworkRequest} * @returns A Promise of CreateNetworkResponse @@ -749,7 +749,7 @@ export class API extends ParentAPI { ) /** - * Retrieve a specific Network + * Retrieve a specific Network. * * @param request - The request {@link GetNetworkRequest} * @returns A Promise of Network @@ -767,7 +767,7 @@ export class API extends ParentAPI { ) /** - * Delete a Network + * Delete a Network. * * @param request - The request {@link DeleteNetworkRequest} */ @@ -781,7 +781,7 @@ export class API extends ParentAPI { }) /** - * BETA - Get a Cloud Twin Document + * BETA - Get a Cloud Twin Document. * * @param request - The request {@link GetTwinDocumentRequest} * @returns A Promise of TwinDocument @@ -805,7 +805,7 @@ export class API extends ParentAPI { ) /** - * BETA - Update a Cloud Twin Document + * BETA - Update a Cloud Twin Document. * * @param request - The request {@link PutTwinDocumentRequest} * @returns A Promise of TwinDocument @@ -833,7 +833,7 @@ export class API extends ParentAPI { ) /** - * BETA - Patch a Cloud Twin Document + * BETA - Patch a Cloud Twin Document. * * @param request - The request {@link PatchTwinDocumentRequest} * @returns A Promise of TwinDocument @@ -861,7 +861,7 @@ export class API extends ParentAPI { ) /** - * BETA - Delete a Cloud Twin Document + * BETA - Delete a Cloud Twin Document. * * @param request - The request {@link DeleteTwinDocumentRequest} */ @@ -878,7 +878,7 @@ export class API extends ParentAPI { }) /** - * BETA - List the documents of a Cloud Twin + * BETA - List the documents of a Cloud Twin. * * @param request - The request {@link ListTwinDocumentsRequest} * @returns A Promise of ListTwinDocumentsResponse @@ -896,7 +896,7 @@ export class API extends ParentAPI { ) /** - * BETA - Delete all the documents of a Cloud Twin + * BETA - Delete all the documents of a Cloud Twin. * * @param request - The request {@link DeleteTwinDocumentsRequest} */ diff --git a/packages/clients/src/api/iot/v1/types.gen.ts b/packages/clients/src/api/iot/v1/types.gen.ts index 007a96fa3..db1d1e339 100644 --- a/packages/clients/src/api/iot/v1/types.gen.ts +++ b/packages/clients/src/api/iot/v1/types.gen.ts @@ -152,8 +152,9 @@ export interface Device { /** Filter-sets to restrict the topics the device can publish/subscribe to. */ messageFilters?: DeviceMessageFilters /** - * Assigning a custom certificate allows a device to authenticate using that - * specific certificate without checking the hub's CA certificate. + * Whether the device was assigned a custom certificate. Assigning a custom + * certificate allows a device to authenticate using that specific certificate + * without checking the hub's CA certificate. */ hasCustomCertificate: boolean /** Device add date. */ @@ -173,9 +174,9 @@ export interface DeviceMessageFilters { /** Device. message filters. rule. */ export interface DeviceMessageFiltersRule { /** - * If accept, the set will accept all topics in the topics list, but no other. - * If reject, the set will deny all topics in the topics list, but all others - * will be allowed. + * How to use the topic list. If accept, the set will accept all topics in the + * topics list, but no other. If reject, the set will deny all topics in the + * topics list, but all others will be allowed. */ policy: DeviceMessageFiltersRulePolicy /** @@ -226,9 +227,9 @@ export interface Hub { /** Number of currently connected devices. */ connectedDeviceCount: number /** - * Devices should be connected to this host, port may be 1883 (MQTT), 8883 - * (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over Websocket over - * TLS). + * Host to connect your devices to. Devices should be connected to this host, + * port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or + * 443 (MQTT over Websocket over TLS). */ endpoint: string /** Disable Hub events. */ @@ -246,17 +247,18 @@ export interface Hub { /** Organization owning the resource. */ organizationId: string /** - * When an unknown device connects to your hub using a valid certificate - * chain, it will be automatically provisioned inside your hub. The hub uses - * the common name of the device certifcate to find out if a device with the - * same name already exists. This setting can only be enabled on a hub with a - * custom certificate authority. + * Enable device auto provisioning. When an unknown device connects to your + * hub using a valid certificate chain, it will be automatically provisioned + * inside your hub. The hub uses the common name of the device certifcate to + * find out if a device with the same name already exists. This setting can + * only be enabled on a hub with a custom certificate authority. */ enableDeviceAutoProvisioning: boolean /** - * After creating a hub, this flag is set to False as the hub certificates are - * managed by Scaleway. Once a custom certificate authority is installed, this - * flag will be set to true. + * Whether the hub is using a custom certificate authority. After creating a + * hub, this flag is set to False as the hub certificates are managed by + * Scaleway. Once a custom certificate authority is installed, this flag will + * be set to true. */ hasCustomCa: boolean /** @@ -330,7 +332,10 @@ export interface Network { hubId: string /** Network creation date. */ createdAt?: Date - /** This prefix will be prepended to all topics for this Network. */ + /** + * Topic prefix for the Network. This prefix will be prepended to all topics + * for this Network. + */ topicPrefix: string } @@ -631,9 +636,9 @@ export type SetHubCARequest = { /** The CA's PEM-encoded certificate. */ caCertPem: string /** - * The challenge is a PEM-encoded certificate to prove the possession of the - * CA. It must be signed by the CA, and have a Common Name equal to the Hub - * ID. + * Proof of possession PEM-encoded certificate. The challenge is a PEM-encoded + * certificate to prove the possession of the CA. It must be signed by the CA, + * and have a Common Name equal to the Hub ID. */ challengeCertPem: string } @@ -995,11 +1000,14 @@ export type PutTwinDocumentRequest = { /** Document name. */ documentName: string /** - * If set, ensures that the document's current version matches before - * persisting the update. + * The version of the document to update. If set, ensures that the document's + * current version matches before persisting the update. */ version?: number - /** The new data that will replace the contents of the document. */ + /** + * New document data. The new data that will replace the contents of the + * document. + */ data?: Record } @@ -1014,17 +1022,17 @@ export type PatchTwinDocumentRequest = { /** Document name. */ documentName: string /** - * If set, ensures that the document's current version matches before - * persisting the update. + * The version of the document to update. If set, ensures that the document's + * current version matches before persisting the update. */ version?: number /** - * A json data that will be applied on the document's current data. Patching - * rules: The patch goes recursively through the patch objects. If the patch - * object property is null, then it is removed from the final object. If the - * patch object property is a value (number, strings, bool, arrays), it is - * replaced. If the patch object property is an object, the previous rules - * will be applied recursively on it. + * Patch data. A json data that will be applied on the document's current + * data. Patching rules: The patch goes recursively through the patch objects. + * If the patch object property is null, then it is removed from the final + * object. If the patch object property is a value (number, strings, bool, + * arrays), it is replaced. If the patch object property is an object, the + * previous rules will be applied recursively on it. */ data?: Record } diff --git a/packages/clients/src/api/k8s/v1/api.gen.ts b/packages/clients/src/api/k8s/v1/api.gen.ts index 1006fc43f..28bb1892d 100644 --- a/packages/clients/src/api/k8s/v1/api.gen.ts +++ b/packages/clients/src/api/k8s/v1/api.gen.ts @@ -104,7 +104,8 @@ export class API extends ParentAPI { ) /** - * List all the existing Kubernetes clusters in a specific Region. + * List all clusters. List all the existing Kubernetes clusters in a specific + * Region. * * @param request - The request {@link ListClustersRequest} * @returns A Promise of ListClustersResponse @@ -113,7 +114,8 @@ export class API extends ParentAPI { enrichForPagination('clusters', this.pageOfListClusters, request) /** - * Create a new Kubernetes cluster on a Scaleway account. + * Create a new cluster. Create a new Kubernetes cluster on a Scaleway + * account. * * @param request - The request {@link CreateClusterRequest} * @returns A Promise of Cluster @@ -135,7 +137,8 @@ export class API extends ParentAPI { ) /** - * Get details about a specific Kubernetes cluster. + * Get specific cluster information. Get details about a specific Kubernetes + * cluster. * * @param request - The request {@link GetClusterRequest} * @returns A Promise of Cluster @@ -173,10 +176,10 @@ export class API extends ParentAPI { ) /** - * Update a specific Kubernetes cluster. Note that this method is designed to - * update details such as name, description, tags and configuration. However, - * you cannot upgrade a cluster with this method. To do so, use the dedicated - * endpoint. + * Update a cluster. Update a specific Kubernetes cluster. Note that this + * method is designed to update details such as name, description, tags and + * configuration. However, you cannot upgrade a cluster with this method. To + * do so, use the dedicated endpoint. * * @param request - The request {@link UpdateClusterRequest} * @returns A Promise of Cluster @@ -198,9 +201,9 @@ export class API extends ParentAPI { ) /** - * Delete a specific cluster and all its associated pools and nodes. Note that - * this method will not delete any Load Balancers or Block Volumes that are - * associated with the cluster. + * Delete a cluster. Delete a specific cluster and all its associated pools + * and nodes. Note that this method will not delete any Load Balancers or + * Block Volumes that are associated with the cluster. * * @param request - The request {@link DeleteClusterRequest} * @returns A Promise of Cluster @@ -222,8 +225,8 @@ export class API extends ParentAPI { ) /** - * Upgrade a specific Kubernetes cluster and/or its associated pools to a - * specific and supported Kubernetes version. + * Upgrade a cluster. Upgrade a specific Kubernetes cluster and/or its + * associated pools to a specific and supported Kubernetes version. * * @param request - The request {@link UpgradeClusterRequest} * @returns A Promise of Cluster @@ -248,10 +251,11 @@ export class API extends ParentAPI { ) /** - * List the versions that a specific Kubernetes cluster is allowed to upgrade - * to. Results will comprise every patch version greater than the current - * patch, as well as one minor version ahead of the current version. Any - * upgrade skipping a minor version will not work. + * List available versions for a cluster. List the versions that a specific + * Kubernetes cluster is allowed to upgrade to. Results will comprise every + * patch version greater than the current patch, as well as one minor version + * ahead of the current version. Any upgrade skipping a minor version will not + * work. * * @param request - The request {@link ListClusterAvailableVersionsRequest} * @returns A Promise of ListClusterAvailableVersionsResponse @@ -290,10 +294,10 @@ export class API extends ParentAPI { }) /** - * Reset the admin token for a specific Kubernetes cluster. This will - * invalidate the old admin token (which will not be usable afterwards) and - * create a new one. Note that you will need to redownload kubeconfig in order - * to keep interacting with the cluster. + * Reset the admin token of a cluster. Reset the admin token for a specific + * Kubernetes cluster. This will invalidate the old admin token (which will + * not be usable afterwards) and create a new one. Note that you will need to + * redownload kubeconfig in order to keep interacting with the cluster. * * @param request - The request {@link ResetClusterAdminTokenRequest} */ @@ -334,7 +338,8 @@ export class API extends ParentAPI { ) /** - * List all the existing pools for a specific Kubernetes cluster. + * List all the pools in a cluster. List all the existing pools for a specific + * Kubernetes cluster. * * @param request - The request {@link ListPoolsRequest} * @returns A Promise of ListPoolsResponse @@ -343,7 +348,8 @@ export class API extends ParentAPI { enrichForPagination('pools', this.pageOfListPools, request) /** - * Create a new pool in a specific Kubernetes cluster. + * Create a new pool in a cluster. Create a new pool in a specific Kubernetes + * cluster. * * @param request - The request {@link CreatePoolRequest} * @returns A Promise of Pool @@ -365,7 +371,8 @@ export class API extends ParentAPI { ) /** - * Get details about a specific pool in a Kubernetes cluster. + * Get a pool in a cluster. Get details about a specific pool in a Kubernetes + * cluster. * * @param request - The request {@link GetPoolRequest} * @returns A Promise of Pool @@ -402,8 +409,9 @@ export class API extends ParentAPI { ) /** - * Upgrade the Kubernetes version of a specific pool. Note that this will work - * when the targeted version is the same than the version of the cluster. + * Upgrade a pool in a cluster. Upgrade the Kubernetes version of a specific + * pool. Note that this will work when the targeted version is the same than + * the version of the cluster. * * @param request - The request {@link UpgradePoolRequest} * @returns A Promise of Pool @@ -425,8 +433,8 @@ export class API extends ParentAPI { ) /** - * Update attributes of a specific pool, such as size, autoscaling settings, - * and tags. + * Update a pool in a cluster. Update attributes of a specific pool, such as + * size, autoscaling settings, and tags. * * @param request - The request {@link UpdatePoolRequest} * @returns A Promise of Pool @@ -448,8 +456,8 @@ export class API extends ParentAPI { ) /** - * Delete a specific pool from a cluster. All of the pool's nodes will also be - * deleted. + * Delete a pool in a cluster. Delete a specific pool from a cluster. All of + * the pool's nodes will also be deleted. * * @param request - The request {@link DeletePoolRequest} * @returns A Promise of Pool @@ -467,8 +475,9 @@ export class API extends ParentAPI { ) /** - * Get metadata about a Kosmos node. This method is not intended to be - * directly called by end users, only by the kapsule-node-agent. + * Create a Kosmos node. Get metadata about a Kosmos node. This method is not + * intended to be directly called by end users, only by the + * kapsule-node-agent. * * @param request - The request {@link CreateExternalNodeRequest} * @returns A Promise of ExternalNode @@ -511,7 +520,8 @@ export class API extends ParentAPI { ) /** - * List all the existing nodes for a specific Kubernetes cluster. + * List all the nodes in a cluster. List all the existing nodes for a specific + * Kubernetes cluster. * * @param request - The request {@link ListNodesRequest} * @returns A Promise of ListNodesResponse @@ -520,7 +530,7 @@ export class API extends ParentAPI { enrichForPagination('nodes', this.pageOfListNodes, request) /** - * Get details about a specific Kubernetes node. + * Get a node in a cluster. Get details about a specific Kubernetes node. * * @param request - The request {@link GetNodeRequest} * @returns A Promise of Node @@ -557,12 +567,13 @@ export class API extends ParentAPI { ) /** - * Replace a specific node. The node will be set cordoned, meaning that - * scheduling will be disabled. Then the existing pods on the node will be - * drained and reschedule onto another schedulable node. Then the node will be - * deleted, and a new one will be created after the deletion. Note that when - * there is not enough space to reschedule all the pods (in a one node cluster - * for instance), you may experience some disruption of your applications. + * Replace a node in a cluster. Replace a specific node. The node will be set + * cordoned, meaning that scheduling will be disabled. Then the existing pods + * on the node will be drained and reschedule onto another schedulable node. + * Then the node will be deleted, and a new one will be created after the + * deletion. Note that when there is not enough space to reschedule all the + * pods (in a one node cluster for instance), you may experience some + * disruption of your applications. * * @deprecated * @param request - The request {@link ReplaceNodeRequest} @@ -583,11 +594,12 @@ export class API extends ParentAPI { ) /** - * Reboot a specific node. This node will first be cordoned, meaning that - * scheduling will be disabled. Then the existing pods on the node will be - * drained and rescheduled onto another schedulable node. Note that when there - * is not enough space to reschedule all the pods (in a one-node cluster, for - * instance), you may experience some disruption of your applications. + * Reboot a node in a cluster. Reboot a specific node. This node will first be + * cordoned, meaning that scheduling will be disabled. Then the existing pods + * on the node will be drained and rescheduled onto another schedulable node. + * Note that when there is not enough space to reschedule all the pods (in a + * one-node cluster, for instance), you may experience some disruption of your + * applications. * * @param request - The request {@link RebootNodeRequest} * @returns A Promise of Node @@ -607,9 +619,9 @@ export class API extends ParentAPI { ) /** - * Delete a specific node. Note that when there is not enough space to - * reschedule all the pods (in a one-node cluster for instance), you may - * experience some disruption of your applications. + * Delete a node in a cluster. Delete a specific node. Note that when there is + * not enough space to reschedule all the pods (in a one-node cluster for + * instance), you may experience some disruption of your applications. * * @param request - The request {@link DeleteNodeRequest} * @returns A Promise of Node @@ -631,7 +643,8 @@ export class API extends ParentAPI { ) /** - * List all available versions for the creation of a new Kubernetes cluster. + * List all available versions. List all available versions for the creation + * of a new Kubernetes cluster. * * @param request - The request {@link ListVersionsRequest} * @returns A Promise of ListVersionsResponse @@ -649,7 +662,8 @@ export class API extends ParentAPI { ) /** - * Get a specific Kubernetes version and the details about the version. + * Get details about a specific version. Get a specific Kubernetes version and + * the details about the version. * * @param request - The request {@link GetVersionRequest} * @returns A Promise of Version diff --git a/packages/clients/src/api/k8s/v1/types.gen.ts b/packages/clients/src/api/k8s/v1/types.gen.ts index 6af622dc6..f6dca8e08 100644 --- a/packages/clients/src/api/k8s/v1/types.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.gen.ts @@ -151,8 +151,9 @@ export interface Cluster { /** List of enabled admission plugins. */ admissionPlugins: string[] /** - * This feature is in ALPHA state, it may be deleted or modified. This - * configuration is the [OpenID Connect + * ALPHA - The OpenID Connect configuration of the cluster. This feature is in + * ALPHA state, it may be deleted or modified. This configuration is the + * [OpenID Connect * configuration](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens) * of the Kubernetes API server. */ @@ -190,9 +191,10 @@ export interface ClusterAutoscalerConfig { /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups: boolean /** - * Pods with priority below cutoff will be expendable. They can be killed - * without any consideration during scale down and they don't cause scale up. - * Pods with null priority (PodPriority disabled) are non expendable. + * Pods with priority below cutoff will be expendable. Pods with priority + * below cutoff will be expendable. They can be killed without any + * consideration during scale down and they don't cause scale up. Pods with + * null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff: number /** How long a node should be unneeded before it is eligible for scale down. */ @@ -213,8 +215,9 @@ export interface ClusterAutoscalerConfig { export interface ClusterOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing - * keys. Only URLs which use the `https://` scheme are accepted. This is - * typically the provider's discovery URL without a path, for example + * keys. URL of the provider which allows the API server to discover public + * signing keys. Only URLs which use the `https://` scheme are accepted. This + * is typically the provider's discovery URL without a path, for example * "https://accounts.google.com" or "https://login.salesforce.com". This URL * should point to the level below .well-known/openid-configuration. */ @@ -222,31 +225,33 @@ export interface ClusterOpenIDConnectConfig { /** A client id that all tokens must be issued for. */ clientId: string /** - * JWT claim to use as the user name. By default `sub`, which is expected to - * be a unique identifier of the end user. Admins can choose other claims, - * such as `email` or `name`, depending on their provider. However, claims - * other than `email` will be prefixed with the issuer URL to prevent naming - * clashes with other plugins. + * JWT claim to use as the user name. JWT claim to use as the user name. By + * default `sub`, which is expected to be a unique identifier of the end user. + * Admins can choose other claims, such as `email` or `name`, depending on + * their provider. However, claims other than `email` will be prefixed with + * the issuer URL to prevent naming clashes with other plugins. */ usernameClaim: string /** - * Prefix prepended to username claims to prevent clashes with existing names - * (such as `system:` users). For example, the value `oidc:` will create - * usernames like `oidc:jane.doe`. If this flag isn't provided and - * `username_claim` is a value other than `email` the prefix defaults to `( - * Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The - * value `-` can be used to disable all prefixing. + * Prefix prepended to username. Prefix prepended to username claims to + * prevent clashes with existing names (such as `system:` users). For example, + * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag + * isn't provided and `username_claim` is a value other than `email` the + * prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of + * `issuer_url`. The value `-` can be used to disable all prefixing. */ usernamePrefix: string /** JWT claim to use as the user's group. */ groupsClaim: string[] /** - * Prefix prepended to group claims to prevent clashes with existing names - * (such as `system:` groups). For example, the value `oidc:` will create - * group names like `oidc:engineering` and `oidc:infra`. + * Prefix prepended to group claims. Prefix prepended to group claims to + * prevent clashes with existing names (such as `system:` groups). For + * example, the value `oidc:` will create group names like `oidc:engineering` + * and `oidc:infra`. */ groupsPrefix: string /** + * Multiple key=value pairs that describes a required claim in the ID token. * Multiple key=value pairs that describes a required claim in the ID token. * If set, the claims are verified to be present in the ID token with a * matching value. @@ -280,9 +285,10 @@ export interface CreateClusterRequestAutoscalerConfig { /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups?: boolean /** - * Pods with priority below cutoff will be expendable. They can be killed - * without any consideration during scale down and they don't cause scale up. - * Pods with null priority (PodPriority disabled) are non expendable. + * Pods with priority below cutoff will be expendable. Pods with priority + * below cutoff will be expendable. They can be killed without any + * consideration during scale down and they don't cause scale up. Pods with + * null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff?: number /** How long a node should be unneeded before it is eligible for scale down. */ @@ -303,8 +309,9 @@ export interface CreateClusterRequestAutoscalerConfig { export interface CreateClusterRequestOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing - * keys. Only URLs which use the `https://` scheme are accepted. This is - * typically the provider's discovery URL without a path, for example + * keys. URL of the provider which allows the API server to discover public + * signing keys. Only URLs which use the `https://` scheme are accepted. This + * is typically the provider's discovery URL without a path, for example * "https://accounts.google.com" or "https://login.salesforce.com". This URL * should point to the level below .well-known/openid-configuration. */ @@ -312,31 +319,33 @@ export interface CreateClusterRequestOpenIDConnectConfig { /** A client id that all tokens must be issued for. */ clientId: string /** - * JWT claim to use as the user name. By default `sub`, which is expected to - * be a unique identifier of the end user. Admins can choose other claims, - * such as `email` or `name`, depending on their provider. However, claims - * other than `email` will be prefixed with the issuer URL to prevent naming - * clashes with other plugins. + * JWT claim to use as the user name. JWT claim to use as the user name. By + * default `sub`, which is expected to be a unique identifier of the end user. + * Admins can choose other claims, such as `email` or `name`, depending on + * their provider. However, claims other than `email` will be prefixed with + * the issuer URL to prevent naming clashes with other plugins. */ usernameClaim?: string /** - * Prefix prepended to username claims to prevent clashes with existing names - * (such as `system:` users). For example, the value `oidc:` will create - * usernames like `oidc:jane.doe`. If this flag isn't provided and - * `username_claim` is a value other than `email` the prefix defaults to `( - * Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The - * value `-` can be used to disable all prefixing. + * Prefix prepended to username. Prefix prepended to username claims to + * prevent clashes with existing names (such as `system:` users). For example, + * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag + * isn't provided and `username_claim` is a value other than `email` the + * prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of + * `issuer_url`. The value `-` can be used to disable all prefixing. */ usernamePrefix?: string /** JWT claim to use as the user's group. */ groupsClaim?: string[] /** - * Prefix prepended to group claims to prevent clashes with existing names - * (such as `system:` groups). For example, the value `oidc:` will create - * group names like `oidc:engineering` and `oidc:infra`. + * Prefix prepended to group claims. Prefix prepended to group claims to + * prevent clashes with existing names (such as `system:` groups). For + * example, the value `oidc:` will create group names like `oidc:engineering` + * and `oidc:infra`. */ groupsPrefix?: string /** + * Multiple key=value pairs that describes a required claim in the ID token. * Multiple key=value pairs that describes a required claim in the ID token. * If set, the claims are verified to be present in the ID token with a * matching value. @@ -349,7 +358,8 @@ export interface CreateClusterRequestPoolConfig { /** Name of the pool. */ name: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Nodes with + * Node type is the type of Scaleway Instance wanted for the pool. Node type + * is the type of Scaleway Instance wanted for the pool. Nodes with * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). * 'external' is a special node type used to provision instances from other * cloud providers. @@ -362,18 +372,19 @@ export interface CreateClusterRequestPoolConfig { /** Size (number of nodes) of the pool. */ size: number /** - * Defines the minimum size of the pool. Note that this field will be used - * only when autoscaling is enabled. + * Minimum size of the pool. Defines the minimum size of the pool. Note that + * this field will be used only when autoscaling is enabled. */ minSize?: number /** - * Defines the maximum size of the pool. Note that this field will be used - * only when autoscaling is enabled. + * Maximum size of the pool. Defines the maximum size of the pool. Note that + * this field will be used only when autoscaling is enabled. */ maxSize?: number /** - * Customization of the container runtime is available for each pool. Note - * that `docker` is deprecated since 1.20 and will be removed in 1.24. + * Container runtime for the nodes of the pool. Customization of the container + * runtime is available for each pool. Note that `docker` is deprecated since + * 1.20 and will be removed in 1.24. */ containerRuntime: Runtime /** Defines whether the autohealing feature is enabled for the pool. */ @@ -390,10 +401,11 @@ export interface CreateClusterRequestPoolConfig { /** Zone in which the pool's nodes will be spawned. */ zone: Zone /** - * Defines the system volume disk type, we provide two different types of - * volume (`volume_type`): `l_ssd` is a local block storage: your system is - * stored locally on the hypervisor of your node. `b_ssd` is a remote block - * storage: your system is stored on a centralised and resilient cluster. + * System volume disk type. Defines the system volume disk type, we provide + * two different types of volume (`volume_type`): `l_ssd` is a local block + * storage: your system is stored locally on the hypervisor of your node. + * `b_ssd` is a remote block storage: your system is stored on a centralised + * and resilient cluster. */ rootVolumeType: PoolVolumeType /** System volume disk size. */ @@ -476,7 +488,8 @@ export interface Node { /** Cluster ID of the node. */ clusterId: string /** - * It is prefixed by instance type and location information (see + * Underlying instance ID. It is prefixed by instance type and location + * information (see * https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderID). */ providerId: string @@ -489,8 +502,8 @@ export interface Node { /** @deprecated Public IPv6 address of the node. */ publicIpV6?: string /** - * @deprecated These conditions contains the Node Problem Detector conditions, - * as well as some in house conditions. + * @deprecated Conditions of the node. These conditions contains the Node + * Problem Detector conditions, as well as some in house conditions. */ conditions?: Record /** Status of the node. */ @@ -520,7 +533,8 @@ export interface Pool { /** Version of the pool. */ version: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Nodes with + * Node type is the type of Scaleway Instance wanted for the pool. Node type + * is the type of Scaleway Instance wanted for the pool. Nodes with * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). * 'external' is a special node type used to provision instances from other * cloud providers. @@ -531,18 +545,19 @@ export interface Pool { /** Size (number of nodes) of the pool. */ size: number /** - * Defines the minimum size of the pool. Note that this field will be used - * only when autoscaling is enabled. + * Minimum size of the pool. Defines the minimum size of the pool. Note that + * this field will be used only when autoscaling is enabled. */ minSize: number /** - * Defines the maximum size of the pool. Note that this field will be used - * only when autoscaling is enabled. + * Maximum size of the pool. Defines the maximum size of the pool. Note that + * this field will be used only when autoscaling is enabled. */ maxSize: number /** - * Customization of the container runtime is available for each pool. Note - * that `docker` is deprecated since 1.20 and will be removed in 1.24. + * Container runtime for the nodes of the pool. Customization of the container + * runtime is available for each pool. Note that `docker` is deprecated since + * 1.20 and will be removed in 1.24. */ containerRuntime: Runtime /** Defines whether the autohealing feature is enabled for the pool. */ @@ -561,10 +576,11 @@ export interface Pool { /** Zone in which the pool's nodes will be spawned. */ zone: Zone /** - * Defines the system volume disk type, we provide two different types of - * volume (`volume_type`): `l_ssd` is a local block storage: your system is - * stored locally on the hypervisor of your node. `b_ssd` is a remote block - * storage: your system is stored on a centralised and resilient cluster. + * System volume disk type. Defines the system volume disk type, we provide + * two different types of volume (`volume_type`): `l_ssd` is a local block + * storage: your system is stored locally on the hypervisor of your node. + * `b_ssd` is a remote block storage: your system is stored on a centralised + * and resilient cluster. */ rootVolumeType: PoolVolumeType /** System volume disk size. */ @@ -604,9 +620,10 @@ export interface UpdateClusterRequestAutoscalerConfig { /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups?: boolean /** - * Pods with priority below cutoff will be expendable. They can be killed - * without any consideration during scale down and they don't cause scale up. - * Pods with null priority (PodPriority disabled) are non expendable. + * Pods with priority below cutoff will be expendable. Pods with priority + * below cutoff will be expendable. They can be killed without any + * consideration during scale down and they don't cause scale up. Pods with + * null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff?: number /** How long a node should be unneeded before it is eligible for scale down. */ @@ -627,8 +644,9 @@ export interface UpdateClusterRequestAutoscalerConfig { export interface UpdateClusterRequestOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing - * keys. Only URLs which use the `https://` scheme are accepted. This is - * typically the provider's discovery URL without a path, for example + * keys. URL of the provider which allows the API server to discover public + * signing keys. Only URLs which use the `https://` scheme are accepted. This + * is typically the provider's discovery URL without a path, for example * "https://accounts.google.com" or "https://login.salesforce.com". This URL * should point to the level below .well-known/openid-configuration. */ @@ -636,31 +654,33 @@ export interface UpdateClusterRequestOpenIDConnectConfig { /** A client id that all tokens must be issued for. */ clientId?: string /** - * JWT claim to use as the user name. By default `sub`, which is expected to - * be a unique identifier of the end user. Admins can choose other claims, - * such as `email` or `name`, depending on their provider. However, claims - * other than `email` will be prefixed with the issuer URL to prevent naming - * clashes with other plugins. + * JWT claim to use as the user name. JWT claim to use as the user name. By + * default `sub`, which is expected to be a unique identifier of the end user. + * Admins can choose other claims, such as `email` or `name`, depending on + * their provider. However, claims other than `email` will be prefixed with + * the issuer URL to prevent naming clashes with other plugins. */ usernameClaim?: string /** - * Prefix prepended to username claims to prevent clashes with existing names - * (such as `system:` users). For example, the value `oidc:` will create - * usernames like `oidc:jane.doe`. If this flag isn't provided and - * `username_claim` is a value other than `email` the prefix defaults to `( - * Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The - * value `-` can be used to disable all prefixing. + * Prefix prepended to username. Prefix prepended to username claims to + * prevent clashes with existing names (such as `system:` users). For example, + * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag + * isn't provided and `username_claim` is a value other than `email` the + * prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of + * `issuer_url`. The value `-` can be used to disable all prefixing. */ usernamePrefix?: string /** JWT claim to use as the user's group. */ groupsClaim?: string[] /** - * Prefix prepended to group claims to prevent clashes with existing names - * (such as `system:` groups). For example, the value `oidc:` will create - * group names like `oidc:engineering` and `oidc:infra`. + * Prefix prepended to group claims. Prefix prepended to group claims to + * prevent clashes with existing names (such as `system:` groups). For + * example, the value `oidc:` will create group names like `oidc:engineering` + * and `oidc:infra`. */ groupsPrefix?: string /** + * Multiple key=value pairs that describes a required claim in the ID token. * Multiple key=value pairs that describes a required claim in the ID token. * If set, the claims are verified to be present in the ID token with a * matching value. @@ -739,7 +759,10 @@ export type CreateClusterRequest = { * could be set. */ projectId?: string - /** Type of the cluster (possible values are kapsule, multicloud). */ + /** + * Type of the cluster. Type of the cluster (possible values are kapsule, + * multicloud). + */ type: string /** Name of the cluster. */ name?: string @@ -758,15 +781,15 @@ export type CreateClusterRequest = { /** Pools to be created along with the cluster. */ pools?: CreateClusterRequestPoolConfig[] /** - * This field allows to specify some configuration for the autoscaler, which - * is an implementation of the + * Autoscaler config for the cluster. This field allows to specify some + * configuration for the autoscaler, which is an implementation of the * [cluster-autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/). */ autoscalerConfig?: CreateClusterRequestAutoscalerConfig /** - * This configuration enables to set a specific 2-hour time window in which - * the cluster can be automatically updated to the latest patch version in the - * current minor one. + * Auto upgrade configuration of the cluster. This configuration enables to + * set a specific 2-hour time window in which the cluster can be automatically + * updated to the latest patch version in the current minor one. */ autoUpgrade?: CreateClusterRequestAutoUpgrade /** List of feature gates to enable. */ @@ -774,8 +797,9 @@ export type CreateClusterRequest = { /** List of admission plugins to enable. */ admissionPlugins?: string[] /** - * This feature is in ALPHA state, it may be deleted or modified. This - * configuration enables to set the [OpenID Connect + * ALPHA - OpenID Connect configuration of the cluster. This feature is in + * ALPHA state, it may be deleted or modified. This configuration enables to + * set the [OpenID Connect * configuration](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens) * of the Kubernetes API server. */ @@ -812,8 +836,8 @@ export type UpdateClusterRequest = { /** New tags associated with the cluster. */ tags?: string[] /** - * Object defining the configuration for the autoscaler, which is an - * implementation of the + * New autoscaler config for the cluster. Object defining the configuration + * for the autoscaler, which is an implementation of the * [cluster-autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/). */ autoscalerConfig?: UpdateClusterRequestAutoscalerConfig @@ -822,8 +846,8 @@ export type UpdateClusterRequest = { /** @deprecated New Ingress Controller for the cluster. */ ingress?: Ingress /** - * New auto upgrade configuration of the cluster. Note that all fields need to - * be set. + * New auto upgrade configuration of the cluster. New auto upgrade + * configuration of the cluster. Note that all fields need to be set. */ autoUpgrade?: UpdateClusterRequestAutoUpgrade /** List of feature gates to enable. */ @@ -831,8 +855,9 @@ export type UpdateClusterRequest = { /** List of admission plugins to enable. */ admissionPlugins?: string[] /** - * This feature is in ALPHA state, it may be deleted or modified. This - * configuration enables to update the [OpenID Connect + * ALPHA - New OpenID Connect configuration of the cluster. This feature is in + * ALPHA state, it may be deleted or modified. This configuration enables to + * update the [OpenID Connect * configuration](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens) * of the Kubernetes API server. */ @@ -868,14 +893,14 @@ export type UpgradeClusterRequest = { /** ID of the cluster to upgrade. */ clusterId: string /** - * New Kubernetes version of the cluster. Note that the version shoud either - * be a higher patch version of the same minor version or the direct minor - * version after the current one. + * New Kubernetes version of the cluster. New Kubernetes version of the + * cluster. Note that the version shoud either be a higher patch version of + * the same minor version or the direct minor version after the current one. */ version: string /** - * This field makes the upgrade upgrades the pool once the Kubernetes master - * in upgrade. + * Enablement of the pools upgrade. This field makes the upgrade upgrades the + * pool once the Kubernetes master in upgrade. */ upgradePools: boolean } @@ -934,7 +959,8 @@ export type CreatePoolRequest = { /** Name of the pool. */ name?: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Nodes with + * Node type is the type of Scaleway Instance wanted for the pool. Node type + * is the type of Scaleway Instance wanted for the pool. Nodes with * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). * 'external' is a special node type used to provision instances from other * cloud providers. @@ -947,18 +973,19 @@ export type CreatePoolRequest = { /** Size (number of nodes) of the pool. */ size: number /** - * Defines the minimum size of the pool. Note that this field will be used - * only when autoscaling is enabled. + * Minimum size of the pool. Defines the minimum size of the pool. Note that + * this field will be used only when autoscaling is enabled. */ minSize?: number /** - * Defines the maximum size of the pool. Note that this field will be used - * only when autoscaling is enabled. + * Maximum size of the pool. Defines the maximum size of the pool. Note that + * this field will be used only when autoscaling is enabled. */ maxSize?: number /** - * Customization of the container runtime is available for each pool. Note - * that `docker` is deprecated since 1.20 and will be removed in 1.24. + * Container runtime for the nodes of the pool. Customization of the container + * runtime is available for each pool. Note that `docker` is deprecated since + * 1.20 and will be removed in 1.24. */ containerRuntime?: Runtime /** Defines whether the autohealing feature is enabled for the pool. */ @@ -975,10 +1002,11 @@ export type CreatePoolRequest = { /** Zone in which the pool's nodes will be spawned. */ zone?: Zone /** - * Defines the system volume disk type, we provide two different types of - * volume (`volume_type`): `l_ssd` is a local block storage: your system is - * stored locally on the hypervisor of your node. `b_ssd` is a remote block - * storage: your system is stored on a centralised and resilient cluster. + * System volume disk type. Defines the system volume disk type, we provide + * two different types of volume (`volume_type`): `l_ssd` is a local block + * storage: your system is stored locally on the hypervisor of your node. + * `b_ssd` is a remote block storage: your system is stored on a centralised + * and resilient cluster. */ rootVolumeType?: PoolVolumeType /** System volume disk size. */ diff --git a/packages/clients/src/api/lb/v1/api.gen.ts b/packages/clients/src/api/lb/v1/api.gen.ts index b42ea7805..f42462e27 100644 --- a/packages/clients/src/api/lb/v1/api.gen.ts +++ b/packages/clients/src/api/lb/v1/api.gen.ts @@ -224,7 +224,7 @@ const jsonContentHeaders = { /** * Load balancer API. * - * This API allows you to manage your load balancer service. + * This API allows you to manage your load balancer service. Load balancer API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -254,7 +254,7 @@ export class API extends ParentAPI { ) /** - * List load balancers + * List load balancers. * * @param request - The request {@link ListLbsRequest} * @returns A Promise of ListLbsResponse @@ -263,7 +263,7 @@ export class API extends ParentAPI { enrichForPagination('lbs', this.pageOfListLbs, request) /** - * Create a load balancer + * Create a load balancer. * * @param request - The request {@link CreateLbRequest} * @returns A Promise of Lb @@ -285,7 +285,7 @@ export class API extends ParentAPI { ) /** - * Get a load balancer + * Get a load balancer. * * @param request - The request {@link GetLbRequest} * @returns A Promise of Lb @@ -322,7 +322,7 @@ export class API extends ParentAPI { ) /** - * Update a load balancer + * Update a load balancer. * * @param request - The request {@link UpdateLbRequest} * @returns A Promise of Lb @@ -344,7 +344,7 @@ export class API extends ParentAPI { ) /** - * Delete a load balancer + * Delete a load balancer. * * @param request - The request {@link DeleteLbRequest} */ @@ -359,7 +359,7 @@ export class API extends ParentAPI { }) /** - * Migrate a load balancer + * Migrate a load balancer. * * @param request - The request {@link MigrateLbRequest} * @returns A Promise of Lb @@ -403,7 +403,7 @@ export class API extends ParentAPI { ) /** - * List IPs + * List IPs. * * @param request - The request {@link ListIPsRequest} * @returns A Promise of ListIpsResponse @@ -412,7 +412,7 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Create an IP + * Create an IP. * * @param request - The request {@link CreateIpRequest} * @returns A Promise of Ip @@ -434,7 +434,7 @@ export class API extends ParentAPI { ) /** - * Get an IP + * Get an IP. * * @param request - The request {@link GetIpRequest} * @returns A Promise of Ip @@ -452,7 +452,7 @@ export class API extends ParentAPI { ) /** - * Delete an IP + * Delete an IP. * * @param request - The request {@link ReleaseIpRequest} */ @@ -466,7 +466,7 @@ export class API extends ParentAPI { }) /** - * Update an IP + * Update an IP. * * @param request - The request {@link UpdateIpRequest} * @returns A Promise of Ip @@ -509,7 +509,7 @@ export class API extends ParentAPI { ) /** - * List backends in a given load balancer + * List backends in a given load balancer. * * @param request - The request {@link ListBackendsRequest} * @returns A Promise of ListBackendsResponse @@ -518,7 +518,7 @@ export class API extends ParentAPI { enrichForPagination('backends', this.pageOfListBackends, request) /** - * Create a backend in a given load balancer + * Create a backend in a given load balancer. * * @param request - The request {@link CreateBackendRequest} * @returns A Promise of Backend @@ -540,7 +540,7 @@ export class API extends ParentAPI { ) /** - * Get a backend in a given load balancer + * Get a backend in a given load balancer. * * @param request - The request {@link GetBackendRequest} * @returns A Promise of Backend @@ -558,7 +558,7 @@ export class API extends ParentAPI { ) /** - * Update a backend in a given load balancer + * Update a backend in a given load balancer. * * @param request - The request {@link UpdateBackendRequest} * @returns A Promise of Backend @@ -580,7 +580,7 @@ export class API extends ParentAPI { ) /** - * Delete a backend in a given load balancer + * Delete a backend in a given load balancer. * * @param request - The request {@link DeleteBackendRequest} */ @@ -594,7 +594,7 @@ export class API extends ParentAPI { }) /** - * Add a set of servers in a given backend + * Add a set of servers in a given backend. * * @param request - The request {@link AddBackendServersRequest} * @returns A Promise of Backend @@ -619,7 +619,7 @@ export class API extends ParentAPI { ) /** - * Remove a set of servers for a given backend + * Remove a set of servers for a given backend. * * @param request - The request {@link RemoveBackendServersRequest} * @returns A Promise of Backend @@ -644,7 +644,7 @@ export class API extends ParentAPI { ) /** - * Define all servers in a given backend + * Define all servers in a given backend. * * @param request - The request {@link SetBackendServersRequest} * @returns A Promise of Backend @@ -669,7 +669,7 @@ export class API extends ParentAPI { ) /** - * Update an health check for a given backend + * Update an health check for a given backend. * * @param request - The request {@link UpdateHealthCheckRequest} * @returns A Promise of HealthCheck @@ -715,7 +715,7 @@ export class API extends ParentAPI { ) /** - * List frontends in a given load balancer + * List frontends in a given load balancer. * * @param request - The request {@link ListFrontendsRequest} * @returns A Promise of ListFrontendsResponse @@ -724,7 +724,7 @@ export class API extends ParentAPI { enrichForPagination('frontends', this.pageOfListFrontends, request) /** - * Create a frontend in a given load balancer + * Create a frontend in a given load balancer. * * @param request - The request {@link CreateFrontendRequest} * @returns A Promise of Frontend @@ -746,7 +746,7 @@ export class API extends ParentAPI { ) /** - * Get a frontend + * Get a frontend. * * @param request - The request {@link GetFrontendRequest} * @returns A Promise of Frontend @@ -764,7 +764,7 @@ export class API extends ParentAPI { ) /** - * Update a frontend + * Update a frontend. * * @param request - The request {@link UpdateFrontendRequest} * @returns A Promise of Frontend @@ -786,7 +786,7 @@ export class API extends ParentAPI { ) /** - * Delete a frontend + * Delete a frontend. * * @param request - The request {@link DeleteFrontendRequest} */ @@ -821,7 +821,7 @@ export class API extends ParentAPI { ) /** - * List all backend redirections + * List all backend redirections. * * @param request - The request {@link ListRoutesRequest} * @returns A Promise of ListRoutesResponse @@ -830,7 +830,7 @@ export class API extends ParentAPI { enrichForPagination('routes', this.pageOfListRoutes, request) /** - * Create a backend redirection + * Create a backend redirection. * * @param request - The request {@link CreateRouteRequest} * @returns A Promise of Route @@ -852,7 +852,7 @@ export class API extends ParentAPI { ) /** - * Get single backend redirection + * Get single backend redirection. * * @param request - The request {@link GetRouteRequest} * @returns A Promise of Route @@ -870,7 +870,7 @@ export class API extends ParentAPI { ) /** - * Edit a backend redirection + * Edit a backend redirection. * * @param request - The request {@link UpdateRouteRequest} * @returns A Promise of Route @@ -892,7 +892,7 @@ export class API extends ParentAPI { ) /** - * Delete a backend redirection + * Delete a backend redirection. * * @param request - The request {@link DeleteRouteRequest} */ @@ -906,7 +906,7 @@ export class API extends ParentAPI { }) /** - * Get usage statistics of a given load balancer + * Get usage statistics of a given load balancer. * * @deprecated * @param request - The request {@link GetLbStatsRequest} @@ -977,7 +977,7 @@ export class API extends ParentAPI { ) /** - * List ACL for a given frontend + * List ACL for a given frontend. * * @param request - The request {@link ListAclsRequest} * @returns A Promise of ListAclResponse @@ -986,7 +986,7 @@ export class API extends ParentAPI { enrichForPagination('acls', this.pageOfListAcls, request) /** - * Create an ACL for a given frontend + * Create an ACL for a given frontend. * * @param request - The request {@link CreateAclRequest} * @returns A Promise of Acl @@ -1011,7 +1011,7 @@ export class API extends ParentAPI { ) /** - * Get an ACL + * Get an ACL. * * @param request - The request {@link GetAclRequest} * @returns A Promise of Acl @@ -1029,7 +1029,7 @@ export class API extends ParentAPI { ) /** - * Update an ACL + * Update an ACL. * * @param request - The request {@link UpdateAclRequest} * @returns A Promise of Acl @@ -1051,7 +1051,7 @@ export class API extends ParentAPI { ) /** - * Delete an ACL + * Delete an ACL. * * @param request - The request {@link DeleteAclRequest} */ @@ -1065,8 +1065,8 @@ export class API extends ParentAPI { }) /** - * Generate a new TLS certificate using Let's Encrypt or import your - * certificate. + * Create a TLS certificate. Generate a new TLS certificate using Let's + * Encrypt or import your certificate. * * @param request - The request {@link CreateCertificateRequest} * @returns A Promise of Certificate @@ -1111,7 +1111,7 @@ export class API extends ParentAPI { ) /** - * List all TLS certificates on a given load balancer + * List all TLS certificates on a given load balancer. * * @param request - The request {@link ListCertificatesRequest} * @returns A Promise of ListCertificatesResponse @@ -1120,7 +1120,7 @@ export class API extends ParentAPI { enrichForPagination('certificates', this.pageOfListCertificates, request) /** - * Get a TLS certificate + * Get a TLS certificate. * * @param request - The request {@link GetCertificateRequest} * @returns A Promise of Certificate @@ -1163,7 +1163,7 @@ export class API extends ParentAPI { ) /** - * Update a TLS certificate + * Update a TLS certificate. * * @param request - The request {@link UpdateCertificateRequest} * @returns A Promise of Certificate @@ -1188,7 +1188,7 @@ export class API extends ParentAPI { ) /** - * Delete a TLS certificate + * Delete a TLS certificate. * * @param request - The request {@link DeleteCertificateRequest} */ @@ -1224,7 +1224,7 @@ export class API extends ParentAPI { ) /** - * List all load balancer offer type + * List all load balancer offer type. * * @param request - The request {@link ListLbTypesRequest} * @returns A Promise of ListLbTypesResponse @@ -1233,7 +1233,7 @@ export class API extends ParentAPI { enrichForPagination('lbTypes', this.pageOfListLbTypes, request) /** - * Create a subscriber, webhook or email + * Create a subscriber, webhook or email. * * @param request - The request {@link CreateSubscriberRequest} * @returns A Promise of Subscriber @@ -1255,7 +1255,7 @@ export class API extends ParentAPI { ) /** - * Get a subscriber + * Get a subscriber. * * @param request - The request {@link GetSubscriberRequest} * @returns A Promise of Subscriber @@ -1299,7 +1299,7 @@ export class API extends ParentAPI { ) /** - * List all subscriber + * List all subscriber. * * @param request - The request {@link ListSubscriberRequest} * @returns A Promise of ListSubscriberResponse @@ -1308,7 +1308,7 @@ export class API extends ParentAPI { enrichForPagination('subscribers', this.pageOfListSubscriber, request) /** - * Update a subscriber + * Update a subscriber. * * @param request - The request {@link UpdateSubscriberRequest} * @returns A Promise of Subscriber @@ -1333,7 +1333,7 @@ export class API extends ParentAPI { ) /** - * Delete a subscriber + * Delete a subscriber. * * @param request - The request {@link DeleteSubscriberRequest} */ @@ -1350,7 +1350,7 @@ export class API extends ParentAPI { }) /** - * Subscribe a subscriber to a given load balancer + * Subscribe a subscriber to a given load balancer. * * @param request - The request {@link SubscribeToLbRequest} * @returns A Promise of Lb @@ -1372,7 +1372,7 @@ export class API extends ParentAPI { ) /** - * Unsubscribe a subscriber from a given load balancer + * Unsubscribe a subscriber from a given load balancer. * * @param request - The request {@link UnsubscribeFromLbRequest} * @returns A Promise of Lb @@ -1412,7 +1412,7 @@ export class API extends ParentAPI { ) /** - * List attached private network of load balancer + * List attached private network of load balancer. * * @param request - The request {@link ListLbPrivateNetworksRequest} * @returns A Promise of ListLbPrivateNetworksResponse @@ -1425,7 +1425,7 @@ export class API extends ParentAPI { ) /** - * Add load balancer on instance private network + * Add load balancer on instance private network. * * @param request - The request {@link AttachPrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -1453,7 +1453,7 @@ export class API extends ParentAPI { ) /** - * Remove load balancer of private network + * Remove load balancer of private network. * * @param request - The request {@link DetachPrivateNetworkRequest} */ @@ -1478,7 +1478,8 @@ export class API extends ParentAPI { /** * Load Balancer API. * - * This API allows you to manage your Scaleway Load Balancer services. + * This API allows you to manage your Scaleway Load Balancer services. Load + * Balancer API. */ export class ZonedAPI extends ParentAPI { /** Lists the available zones of the API. */ @@ -1515,10 +1516,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all Load Balancers in the specified zone, for a Scaleway Organization - * or Scaleway Project. By default, the Load Balancers returned in the list - * are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List Load Balancers. List all Load Balancers in the specified zone, for a + * Scaleway Organization or Scaleway Project. By default, the Load Balancers + * returned in the list are ordered by creation date in ascending order, + * though this can be modified via the `order_by` field. * * @param request - The request {@link ZonedApiListLbsRequest} * @returns A Promise of ListLbsResponse @@ -1527,9 +1528,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('lbs', this.pageOfListLbs, request) /** - * Create a new Load Balancer. Note that the Load Balancer will be created - * without frontends or backends; these must be created separately via the - * dedicated endpoints. + * Create a Load Balancer. Create a new Load Balancer. Note that the Load + * Balancer will be created without frontends or backends; these must be + * created separately via the dedicated endpoints. * * @param request - The request {@link ZonedApiCreateLbRequest} * @returns A Promise of Lb @@ -1551,9 +1552,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Retrieve information about an existing Load Balancer, specified by its Load - * Balancer ID. Its full details, including name, status and IP address, are - * returned in the response object. + * Get a Load Balancer. Retrieve information about an existing Load Balancer, + * specified by its Load Balancer ID. Its full details, including name, status + * and IP address, are returned in the response object. * * @param request - The request {@link ZonedApiGetLbRequest} * @returns A Promise of Lb @@ -1590,9 +1591,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update the parameters of an existing Load Balancer, specified by its Load - * Balancer ID. Note that the request type is PUT and not PATCH. You must set - * all parameters. + * Update a Load Balancer. Update the parameters of an existing Load Balancer, + * specified by its Load Balancer ID. Note that the request type is PUT and + * not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateLbRequest} * @returns A Promise of Lb @@ -1614,10 +1615,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an existing Load Balancer, specified by its Load Balancer ID. - * Deleting a Load Balancer is permanent, and cannot be undone. The Load - * Balancer's flexible IP address can either be deleted with the Load - * Balancer, or kept in your account for future use. + * Delete a Load Balancer. Delete an existing Load Balancer, specified by its + * Load Balancer ID. Deleting a Load Balancer is permanent, and cannot be + * undone. The Load Balancer's flexible IP address can either be deleted with + * the Load Balancer, or kept in your account for future use. * * @param request - The request {@link ZonedApiDeleteLbRequest} */ @@ -1632,9 +1633,9 @@ export class ZonedAPI extends ParentAPI { }) /** - * Migrate an existing Load Balancer from one commercial type to another. - * Allows you to scale your Load Balancer up or down in terms of bandwidth or - * multi-cloud provision. + * Migrate a Load Balancer. Migrate an existing Load Balancer from one + * commercial type to another. Allows you to scale your Load Balancer up or + * down in terms of bandwidth or multi-cloud provision. * * @param request - The request {@link ZonedApiMigrateLbRequest} * @returns A Promise of Lb @@ -1678,9 +1679,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * List the Load Balancer flexible IP addresses held in the account (filtered - * by Organization ID or Project ID). It is also possible to search for a - * specific IP address. + * List IP addresses. List the Load Balancer flexible IP addresses held in the + * account (filtered by Organization ID or Project ID). It is also possible to + * search for a specific IP address. * * @param request - The request {@link ZonedApiListIPsRequest} * @returns A Promise of ListIpsResponse @@ -1689,8 +1690,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Create a new Load Balancer flexible IP address, in the specified Scaleway - * Project. This can be attached to new Load Balancers created in the future. + * Create an IP address. Create a new Load Balancer flexible IP address, in + * the specified Scaleway Project. This can be attached to new Load Balancers + * created in the future. * * @param request - The request {@link ZonedApiCreateIpRequest} * @returns A Promise of Ip @@ -1712,7 +1714,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Retrieve the full details of a Load Balancer flexible IP address. + * Get an IP address. Retrieve the full details of a Load Balancer flexible IP + * address. * * @param request - The request {@link ZonedApiGetIpRequest} * @returns A Promise of Ip @@ -1730,8 +1733,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a Load Balancer flexible IP address. This action is irreversible, - * and cannot be undone. + * Delete an IP address. Delete a Load Balancer flexible IP address. This + * action is irreversible, and cannot be undone. * * @param request - The request {@link ZonedApiReleaseIpRequest} */ @@ -1745,7 +1748,8 @@ export class ZonedAPI extends ParentAPI { }) /** - * Update the reverse DNS of a Load Balancer flexible IP address. + * Update an IP address. Update the reverse DNS of a Load Balancer flexible IP + * address. * * @param request - The request {@link ZonedApiUpdateIpRequest} * @returns A Promise of Ip @@ -1790,11 +1794,12 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all the backends of a Load Balancer, specified by its Load Balancer - * ID. By default, results are returned in ascending order by the creation - * date of each backend. The response is an array of backend objects, - * containing full details of each one including their configuration - * parameters such as protocol, port and forwarding algorithm. + * List the backends of a given Load Balancer. List all the backends of a Load + * Balancer, specified by its Load Balancer ID. By default, results are + * returned in ascending order by the creation date of each backend. The + * response is an array of backend objects, containing full details of each + * one including their configuration parameters such as protocol, port and + * forwarding algorithm. * * @param request - The request {@link ZonedApiListBackendsRequest} * @returns A Promise of ListBackendsResponse @@ -1803,8 +1808,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('backends', this.pageOfListBackends, request) /** - * Create a new backend for a given Load Balancer, specifying its full - * configuration including protocol, port and forwarding algorithm. + * Create a backend for a given Load Balancer. Create a new backend for a + * given Load Balancer, specifying its full configuration including protocol, + * port and forwarding algorithm. * * @param request - The request {@link ZonedApiCreateBackendRequest} * @returns A Promise of Backend @@ -1826,9 +1832,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get the full details of a given backend, specified by its backend ID. The - * response contains the backend's full configuration parameters including - * protocol, port and forwarding algorithm. + * Get a backend of a given Load Balancer. Get the full details of a given + * backend, specified by its backend ID. The response contains the backend's + * full configuration parameters including protocol, port and forwarding + * algorithm. * * @param request - The request {@link ZonedApiGetBackendRequest} * @returns A Promise of Backend @@ -1846,9 +1853,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a backend of a given Load Balancer, specified by its backend ID. - * Note that the request type is PUT and not PATCH. You must set all - * parameters. + * Update a backend of a given Load Balancer. Update a backend of a given Load + * Balancer, specified by its backend ID. Note that the request type is PUT + * and not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateBackendRequest} * @returns A Promise of Backend @@ -1870,8 +1877,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a backend of a given Load Balancer, specified by its backend ID. - * This action is irreversible and cannot be undone. + * Delete a backend of a given Load Balancer. Delete a backend of a given Load + * Balancer, specified by its backend ID. This action is irreversible and + * cannot be undone. * * @param request - The request {@link ZonedApiDeleteBackendRequest} */ @@ -1885,10 +1893,10 @@ export class ZonedAPI extends ParentAPI { }) /** - * For a given backend specified by its backend ID, add a set of backend - * servers (identified by their IP addresses) it should forward traffic to. - * These will be appended to any existing set of backend servers for this - * backend. + * Add a set of backend servers to a given backend. For a given backend + * specified by its backend ID, add a set of backend servers (identified by + * their IP addresses) it should forward traffic to. These will be appended to + * any existing set of backend servers for this backend. * * @param request - The request {@link ZonedApiAddBackendServersRequest} * @returns A Promise of Backend @@ -1916,9 +1924,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * For a given backend specified by its backend ID, remove the specified - * backend servers (identified by their IP addresses) so that it no longer - * forwards traffic to them. + * Remove a set of servers for a given backend. For a given backend specified + * by its backend ID, remove the specified backend servers (identified by + * their IP addresses) so that it no longer forwards traffic to them. * * @param request - The request {@link ZonedApiRemoveBackendServersRequest} * @returns A Promise of Backend @@ -1948,10 +1956,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * For a given backend specified by its backend ID, define the set of backend - * servers (identified by their IP addresses) that it should forward traffic - * to. Any existing backend servers configured for this backend will be - * removed. + * Define all backend servers for a given backend. For a given backend + * specified by its backend ID, define the set of backend servers (identified + * by their IP addresses) that it should forward traffic to. Any existing + * backend servers configured for this backend will be removed. * * @param request - The request {@link ZonedApiSetBackendServersRequest} * @returns A Promise of Backend @@ -1979,10 +1987,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update the configuration of the health check performed by a given backend - * to verify the health of its backend servers, identified by its backend ID. - * Note that the request type is PUT and not PATCH. You must set all - * parameters. + * Update a health check for a given backend. Update the configuration of the + * health check performed by a given backend to verify the health of its + * backend servers, identified by its backend ID. Note that the request type + * is PUT and not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateHealthCheckRequest} * @returns A Promise of HealthCheck @@ -2033,11 +2041,12 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all the frontends of a Load Balancer, specified by its Load Balancer - * ID. By default, results are returned in ascending order by the creation - * date of each frontend. The response is an array of frontend objects, - * containing full details of each one including the port they listen on and - * the backend they are attached to. + * List frontends of a given Load Balancer. List all the frontends of a Load + * Balancer, specified by its Load Balancer ID. By default, results are + * returned in ascending order by the creation date of each frontend. The + * response is an array of frontend objects, containing full details of each + * one including the port they listen on and the backend they are attached + * to. * * @param request - The request {@link ZonedApiListFrontendsRequest} * @returns A Promise of ListFrontendsResponse @@ -2046,9 +2055,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('frontends', this.pageOfListFrontends, request) /** - * Create a new frontend for a given Load Balancer, specifying its - * configuration including the port it should listen on and the backend to - * attach it to. + * Create a frontend in a given Load Balancer. Create a new frontend for a + * given Load Balancer, specifying its configuration including the port it + * should listen on and the backend to attach it to. * * @param request - The request {@link ZonedApiCreateFrontendRequest} * @returns A Promise of Frontend @@ -2070,10 +2079,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get the full details of a given frontend, specified by its frontend ID. The - * response contains the frontend's full configuration parameters including - * the backend it is attached to, the port it listens on, and any certificates - * it has. + * Get a frontend. Get the full details of a given frontend, specified by its + * frontend ID. The response contains the frontend's full configuration + * parameters including the backend it is attached to, the port it listens on, + * and any certificates it has. * * @param request - The request {@link ZonedApiGetFrontendRequest} * @returns A Promise of Frontend @@ -2091,10 +2100,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a given frontend, specified by its frontend ID. You can update - * configuration parameters including its name and the port it listens on. - * Note that the request type is PUT and not PATCH. You must set all - * parameters. + * Update a frontend. Update a given frontend, specified by its frontend ID. + * You can update configuration parameters including its name and the port it + * listens on. Note that the request type is PUT and not PATCH. You must set + * all parameters. * * @param request - The request {@link ZonedApiUpdateFrontendRequest} * @returns A Promise of Frontend @@ -2116,8 +2125,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a given frontend, specified by its frontend ID. This action is - * irreversible and cannot be undone. + * Delete a frontend. Delete a given frontend, specified by its frontend ID. + * This action is irreversible and cannot be undone. * * @param request - The request {@link ZonedApiDeleteFrontendRequest} */ @@ -2154,9 +2163,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all routes for a given frontend. The response is an array of routes, - * each one with a specified backend to direct to if a certain condition is - * matched (based on the value of the SNI field or HTTP Host header). + * List all routes. List all routes for a given frontend. The response is an + * array of routes, each one with a specified backend to direct to if a + * certain condition is matched (based on the value of the SNI field or HTTP + * Host header). * * @param request - The request {@link ZonedApiListRoutesRequest} * @returns A Promise of ListRoutesResponse @@ -2165,9 +2175,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('routes', this.pageOfListRoutes, request) /** - * Create a new route on a given frontend. To configure a route, specify the - * backend to direct to if a certain condition is matched (based on the value - * of the SNI field or HTTP Host header). + * Create a route. Create a new route on a given frontend. To configure a + * route, specify the backend to direct to if a certain condition is matched + * (based on the value of the SNI field or HTTP Host header). * * @param request - The request {@link ZonedApiCreateRouteRequest} * @returns A Promise of Route @@ -2189,9 +2199,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Retrieve information about an existing route, specified by its route ID. - * Its full details, origin frontend, target backend and match condition, are - * returned in the response object. + * Get a route. Retrieve information about an existing route, specified by its + * route ID. Its full details, origin frontend, target backend and match + * condition, are returned in the response object. * * @param request - The request {@link ZonedApiGetRouteRequest} * @returns A Promise of Route @@ -2209,7 +2219,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update the configuration of an existing route, specified by its route ID. + * Update a route. Update the configuration of an existing route, specified by + * its route ID. * * @param request - The request {@link ZonedApiUpdateRouteRequest} * @returns A Promise of Route @@ -2231,8 +2242,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an existing route, specified by its route ID. Deleting a route is - * permanent, and cannot be undone. + * Delete a route. Delete an existing route, specified by its route ID. + * Deleting a route is permanent, and cannot be undone. * * @param request - The request {@link ZonedApiDeleteRouteRequest} */ @@ -2246,7 +2257,7 @@ export class ZonedAPI extends ParentAPI { }) /** - * Get usage statistics of a given Load Balancer + * Get usage statistics of a given Load Balancer. * * @deprecated * @param request - The request {@link ZonedApiGetLbStatsRequest} @@ -2286,8 +2297,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * List information about your backend servers, including their state and the - * result of their last health check. + * List backend server statistics. List information about your backend + * servers, including their state and the result of their last health check. * * @param request - The request {@link ZonedApiListBackendStatsRequest} * @returns A Promise of ListBackendStatsResponse @@ -2324,9 +2335,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * List the ACLs for a given frontend, specified by its frontend ID. The - * response is an array of ACL objects, each one representing an ACL that - * denies or allows traffic based on certain conditions. + * List ACLs for a given frontend. List the ACLs for a given frontend, + * specified by its frontend ID. The response is an array of ACL objects, each + * one representing an ACL that denies or allows traffic based on certain + * conditions. * * @param request - The request {@link ZonedApiListAclsRequest} * @returns A Promise of ListAclResponse @@ -2335,9 +2347,10 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('acls', this.pageOfListAcls, request) /** - * Create a new ACL for a given frontend. Each ACL must have a name, an action - * to perform (allow or deny), and a match rule (the action is carried out - * when the incoming traffic matches the rule). + * Create an ACL for a given frontend. Create a new ACL for a given frontend. + * Each ACL must have a name, an action to perform (allow or deny), and a + * match rule (the action is carried out when the incoming traffic matches the + * rule). * * @param request - The request {@link ZonedApiCreateAclRequest} * @returns A Promise of Acl @@ -2362,9 +2375,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get information for a particular ACL, specified by its ACL ID. The response - * returns full details of the ACL, including its name, action, match rule and - * frontend. + * Get an ACL. Get information for a particular ACL, specified by its ACL ID. + * The response returns full details of the ACL, including its name, action, + * match rule and frontend. * * @param request - The request {@link ZonedApiGetAclRequest} * @returns A Promise of Acl @@ -2382,8 +2395,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a particular ACL, specified by its ACL ID. You can update details - * including its name, action and match rule. + * Update an ACL. Update a particular ACL, specified by its ACL ID. You can + * update details including its name, action and match rule. * * @param request - The request {@link ZonedApiUpdateAclRequest} * @returns A Promise of Acl @@ -2405,8 +2418,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an ACL, specified by its ACL ID. Deleting an ACL is irreversible and - * cannot be undone. + * Delete an ACL. Delete an ACL, specified by its ACL ID. Deleting an ACL is + * irreversible and cannot be undone. * * @param request - The request {@link ZonedApiDeleteAclRequest} */ @@ -2420,9 +2433,9 @@ export class ZonedAPI extends ParentAPI { }) /** - * For a given frontend specified by its frontend ID, define and add the - * complete set of ACLS for that frontend. Any existing ACLs on this frontend - * will be removed. + * Define all ACLs for a given frontend. For a given frontend specified by its + * frontend ID, define and add the complete set of ACLS for that frontend. Any + * existing ACLs on this frontend will be removed. * * @param request - The request {@link ZonedApiSetAclsRequest} * @returns A Promise of SetAclsResponse @@ -2447,9 +2460,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Generate a new SSL/TLS certificate for a given Load Balancer. You can - * choose to create a Let's Encrypt certificate, or import a custom - * certificate. + * Create an SSL/TLS certificate. Generate a new SSL/TLS certificate for a + * given Load Balancer. You can choose to create a Let's Encrypt certificate, + * or import a custom certificate. * * @param request - The request {@link ZonedApiCreateCertificateRequest} * @returns A Promise of Certificate @@ -2497,9 +2510,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all the SSL/TLS certificates on a given Load Balancer. The response is - * an array of certificate objects, which are by default listed in ascending - * order of creation date. + * List all SSL/TLS certificates on a given Load Balancer. List all the + * SSL/TLS certificates on a given Load Balancer. The response is an array of + * certificate objects, which are by default listed in ascending order of + * creation date. * * @param request - The request {@link ZonedApiListCertificatesRequest} * @returns A Promise of ListCertificatesResponse @@ -2508,9 +2522,10 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('certificates', this.pageOfListCertificates, request) /** - * Get information for a particular SSL/TLS certificate, specified by its - * certificate ID. The response returns full details of the certificate, - * including its type, main domain name, and alternative domain names. + * Get an SSL/TLS certificate. Get information for a particular SSL/TLS + * certificate, specified by its certificate ID. The response returns full + * details of the certificate, including its type, main domain name, and + * alternative domain names. * * @param request - The request {@link ZonedApiGetCertificateRequest} * @returns A Promise of Certificate @@ -2553,8 +2568,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update the name of a particular SSL/TLS certificate, specified by its - * certificate ID. + * Update an SSL/TLS certificate. Update the name of a particular SSL/TLS + * certificate, specified by its certificate ID. * * @param request - The request {@link ZonedApiUpdateCertificateRequest} * @returns A Promise of Certificate @@ -2582,8 +2597,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an SSL/TLS certificate, specified by its certificate ID. Deleting a - * certificate is irreversible and cannot be undone. + * Delete an SSL/TLS certificate. Delete an SSL/TLS certificate, specified by + * its certificate ID. Deleting a certificate is irreversible and cannot be + * undone. * * @param request - The request {@link ZonedApiDeleteCertificateRequest} */ @@ -2621,9 +2637,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all the different commercial Load Balancer types. The response - * includes an array of offer types, each with a name, description, and - * information about its stock availability. + * List all Load Balancer offer types. List all the different commercial Load + * Balancer types. The response includes an array of offer types, each with a + * name, description, and information about its stock availability. * * @param request - The request {@link ZonedApiListLbTypesRequest} * @returns A Promise of ListLbTypesResponse @@ -2632,8 +2648,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('lbTypes', this.pageOfListLbTypes, request) /** - * Create a new subscriber, either with an email configuration or a webhook - * configuration, for a specified Scaleway Project. + * Create a subscriber. Create a new subscriber, either with an email + * configuration or a webhook configuration, for a specified Scaleway + * Project. * * @param request - The request {@link ZonedApiCreateSubscriberRequest} * @returns A Promise of Subscriber @@ -2655,9 +2672,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Retrieve information about an existing subscriber, specified by its - * subscriber ID. Its full details, including name and email/webhook - * configuration, are returned in the response object. + * Get a subscriber. Retrieve information about an existing subscriber, + * specified by its subscriber ID. Its full details, including name and + * email/webhook configuration, are returned in the response object. * * @param request - The request {@link ZonedApiGetSubscriberRequest} * @returns A Promise of Subscriber @@ -2703,9 +2720,10 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all subscribers to Load Balancer alerts. By default, returns all - * subscribers to Load Balancer alerts for the Organization associated with - * the authentication token used for the request. + * List all subscribers. List all subscribers to Load Balancer alerts. By + * default, returns all subscribers to Load Balancer alerts for the + * Organization associated with the authentication token used for the + * request. * * @param request - The request {@link ZonedApiListSubscriberRequest} * @returns A Promise of ListSubscriberResponse @@ -2714,8 +2732,9 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('subscribers', this.pageOfListSubscriber, request) /** - * Update the parameters of a given subscriber (e.g. name, webhook - * configuration, email configuration), specified by its subscriber ID. + * Update a subscriber. Update the parameters of a given subscriber (e.g. + * name, webhook configuration, email configuration), specified by its + * subscriber ID. * * @param request - The request {@link ZonedApiUpdateSubscriberRequest} * @returns A Promise of Subscriber @@ -2740,8 +2759,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an existing subscriber, specified by its subscriber ID. Deleting a - * subscriber is permanent, and cannot be undone. + * Delete a subscriber. Delete an existing subscriber, specified by its + * subscriber ID. Deleting a subscriber is permanent, and cannot be undone. * * @param request - The request {@link ZonedApiDeleteSubscriberRequest} */ @@ -2758,7 +2777,8 @@ export class ZonedAPI extends ParentAPI { }) /** - * Subscribe an existing subscriber to alerts for a given Load Balancer. + * Subscribe a subscriber to alerts for a given Load Balancer. Subscribe an + * existing subscriber to alerts for a given Load Balancer. * * @param request - The request {@link ZonedApiSubscribeToLbRequest} * @returns A Promise of Lb @@ -2780,9 +2800,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Unsubscribe a subscriber from alerts for a given Load Balancer. The - * subscriber is not deleted, and can be resubscribed in the future if - * necessary. + * Unsubscribe a subscriber from alerts for a given Load Balancer. Unsubscribe + * a subscriber from alerts for a given Load Balancer. The subscriber is not + * deleted, and can be resubscribed in the future if necessary. * * @param request - The request {@link ZonedApiUnsubscribeFromLbRequest} * @returns A Promise of Lb @@ -2822,10 +2842,11 @@ export class ZonedAPI extends ParentAPI { ) /** - * List the Private Networks attached to a given Load Balancer, specified by - * its Load Balancer ID. The response is an array of Private Network objects, - * giving information including the status, configuration, name and creation - * date of each Private Network. + * List Private Networks attached to a Load Balancer. List the Private + * Networks attached to a given Load Balancer, specified by its Load Balancer + * ID. The response is an array of Private Network objects, giving information + * including the status, configuration, name and creation date of each Private + * Network. * * @param request - The request {@link ZonedApiListLbPrivateNetworksRequest} * @returns A Promise of ListLbPrivateNetworksResponse @@ -2840,8 +2861,9 @@ export class ZonedAPI extends ParentAPI { ) /** - * Attach a specified Load Balancer to a specified Private Network, defining a - * static or DHCP configuration for the Load Balancer on the network. + * Attach a Load Balancer to a Private Network. Attach a specified Load + * Balancer to a specified Private Network, defining a static or DHCP + * configuration for the Load Balancer on the network. * * @param request - The request {@link ZonedApiAttachPrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -2874,7 +2896,8 @@ export class ZonedAPI extends ParentAPI { ) /** - * Detach a specified Load Balancer from a specified Private Network. + * Detach Load Balancer from Private Network. Detach a specified Load Balancer + * from a specified Private Network. * * @param request - The request {@link ZonedApiDetachPrivateNetworkRequest} */ diff --git a/packages/clients/src/api/lb/v1/types.gen.ts b/packages/clients/src/api/lb/v1/types.gen.ts index c56d51a9c..1782875a8 100644 --- a/packages/clients/src/api/lb/v1/types.gen.ts +++ b/packages/clients/src/api/lb/v1/types.gen.ts @@ -112,6 +112,7 @@ export type Protocol = 'tcp' | 'http' * protocol must be supported by the backend servers' software. For more * information on the different protocols available, see the [dedicated * documentation](https://www.scaleway.com/en/docs/network/load-balancer/reference-content/configuring-load-balancer/#choosing-a-proxy-protocol). + * Proxy protocol. */ export type ProxyProtocol = | 'proxy_protocol_unknown' @@ -478,41 +479,55 @@ export interface HealthCheck { /** Health check. http config. */ export interface HealthCheckHttpConfig { - /** The HTTP URI to use when performing a health check on backend servers. */ + /** + * HTTP URI used for the health check. The HTTP URI to use when performing a + * health check on backend servers. + */ uri: string - /** The HTTP method used when performing a health check on backend servers. */ + /** + * HTTP method used for the health check. The HTTP method used when performing + * a health check on backend servers. + */ method: string /** - * The HTTP response code that should be returned for a health check to be - * considered successful. + * HTTP response code expected for a successful health check. The HTTP + * response code that should be returned for a health check to be considered + * successful. */ code?: number /** - * The HTTP host header used when performing a health check on backend - * servers. + * HTTP host header used for the health check. The HTTP host header used when + * performing a health check on backend servers. */ hostHeader: string } /** Health check. https config. */ export interface HealthCheckHttpsConfig { - /** The HTTP URI to use when performing a health check on backend servers. */ + /** + * HTTP URI used for the health check. The HTTP URI to use when performing a + * health check on backend servers. + */ uri: string - /** The HTTP method used when performing a health check on backend servers. */ + /** + * HTTP method used for the health check. The HTTP method used when performing + * a health check on backend servers. + */ method: string /** - * The HTTP response code that should be returned for a health check to be - * considered successful. + * HTTP response code expected for a successful health check. The HTTP + * response code that should be returned for a health check to be considered + * successful. */ code?: number /** - * The HTTP host header used when performing a health check on backend - * servers. + * HTTP host header used for the health check. The HTTP host header used when + * performing a health check on backend servers. */ hostHeader: string /** - * The SNI value used when performing a health check on backend servers over - * SSL. + * SNI used for SSL health checks. The SNI value used when performing a health + * check on backend servers over SSL. */ sni: string } @@ -787,16 +802,18 @@ export interface Route { /** Route. match. */ export interface RouteMatch { /** - * Value to match in the Server Name Indication TLS extension (SNI) field from - * an incoming connection made via an SSL/TLS transport layer. This field - * should be set for routes on TCP Load Balancers. + * Server Name Indication (SNI) value to match. Value to match in the Server + * Name Indication TLS extension (SNI) field from an incoming connection made + * via an SSL/TLS transport layer. This field should be set for routes on TCP + * Load Balancers. * * One-of ('matchType'): at most one of 'sni', 'hostHeader' could be set. */ sni?: string /** - * Value to match in the HTTP Host request header from an incoming connection. - * This field should be set for routes on HTTP Load Balancers. + * HTTP host header to match. Value to match in the HTTP Host request header + * from an incoming connection. This field should be set for routes on HTTP + * Load Balancers. * * One-of ('matchType'): at most one of 'sni', 'hostHeader' could be set. */ @@ -839,7 +856,7 @@ export interface SubscriberEmailConfig { email: string } -/** Webhook alert of subscriber. */ +/** Webhook alert of subscriber. Subscriber. webhook config. */ export interface SubscriberWebhookConfig { /** URI to receive POST requests. */ uri: string diff --git a/packages/clients/src/api/marketplace/v1/api.gen.ts b/packages/clients/src/api/marketplace/v1/api.gen.ts index 30593be22..d87bae35d 100644 --- a/packages/clients/src/api/marketplace/v1/api.gen.ts +++ b/packages/clients/src/api/marketplace/v1/api.gen.ts @@ -39,7 +39,7 @@ export class API extends ParentAPI { ) /** - * List marketplace images + * List marketplace images. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -48,7 +48,7 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get a specific marketplace image + * Get a specific marketplace image. * * @param request - The request {@link GetImageRequest} * @returns A Promise of GetImageResponse diff --git a/packages/clients/src/api/marketplace/v1/types.gen.ts b/packages/clients/src/api/marketplace/v1/types.gen.ts index 70fc6dbf4..e9eb5f49b 100644 --- a/packages/clients/src/api/marketplace/v1/types.gen.ts +++ b/packages/clients/src/api/marketplace/v1/types.gen.ts @@ -28,7 +28,10 @@ export interface Image { modificationDate?: Date /** Expiration date of this image. */ validUntil?: Date - /** Typically an identifier for a distribution (ex. "ubuntu_focal"). */ + /** + * Label of this image. Typically an identifier for a distribution (ex. + * "ubuntu_focal"). + */ label: string /** List of versions of this image. */ versions: Version[] @@ -49,7 +52,10 @@ export interface ListVersionsResponse { /** Local image. */ export interface LocalImage { - /** Version you will typically use to define an image in an API call. */ + /** + * UUID of this local image. Version you will typically use to define an image + * in an API call. + */ id: string /** List of all commercial types that are compatible with this local image. */ compatibleCommercialTypes: string[] diff --git a/packages/clients/src/api/marketplace/v2/api.gen.ts b/packages/clients/src/api/marketplace/v2/api.gen.ts index f0bfa3968..e5e8978b1 100644 --- a/packages/clients/src/api/marketplace/v2/api.gen.ts +++ b/packages/clients/src/api/marketplace/v2/api.gen.ts @@ -59,7 +59,7 @@ export class API extends ParentAPI { ) /** - * List marketplace images + * List marketplace images. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -68,7 +68,7 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get a specific marketplace image + * Get a specific marketplace image. * * @param request - The request {@link GetImageRequest} * @returns A Promise of Image @@ -155,7 +155,7 @@ export class API extends ParentAPI { ) /** - * List local images from a specific image or version + * List local images from a specific image or version. * * @param request - The request {@link ListLocalImagesRequest} * @returns A Promise of ListLocalImagesResponse diff --git a/packages/clients/src/api/marketplace/v2/types.gen.ts b/packages/clients/src/api/marketplace/v2/types.gen.ts index 829f85da4..69a7c818c 100644 --- a/packages/clients/src/api/marketplace/v2/types.gen.ts +++ b/packages/clients/src/api/marketplace/v2/types.gen.ts @@ -38,7 +38,10 @@ export interface Image { updatedAt?: Date /** Expiration date of this image. */ validUntil?: Date - /** Typically an identifier for a distribution (ex. "ubuntu_focal"). */ + /** + * Label of this image. Typically an identifier for a distribution (ex. + * "ubuntu_focal"). + */ label: string } @@ -64,7 +67,10 @@ export interface ListVersionsResponse { /** Local image. */ export interface LocalImage { - /** Version you will typically use to define an image in an API call. */ + /** + * UUID of this local image. Version you will typically use to define an image + * in an API call. + */ id: string /** List of all commercial types that are compatible with this local image. */ compatibleCommercialTypes: string[] diff --git a/packages/clients/src/api/mnq/v1alpha1/api.gen.ts b/packages/clients/src/api/mnq/v1alpha1/api.gen.ts index 8d3c8f292..3c9ae8302 100644 --- a/packages/clients/src/api/mnq/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/mnq/v1alpha1/api.gen.ts @@ -41,7 +41,7 @@ const jsonContentHeaders = { /** * MnQ API (beta). * - * This API allows you to manage Messaging or Queueing brokers. + * This API allows you to manage Messaging or Queueing brokers. MnQ API (beta). */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -72,7 +72,7 @@ export class API extends ParentAPI { ) /** - * List namespaces + * List namespaces. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -81,7 +81,7 @@ export class API extends ParentAPI { enrichForPagination('namespaces', this.pageOfListNamespaces, request) /** - * Create a namespace + * Create a namespace. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -103,7 +103,7 @@ export class API extends ParentAPI { ) /** - * Update the name of a namespace + * Update the name of a namespace. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -125,7 +125,7 @@ export class API extends ParentAPI { ) /** - * Get a namespace + * Get a namespace. * * @param request - The request {@link GetNamespaceRequest} * @returns A Promise of Namespace @@ -143,7 +143,7 @@ export class API extends ParentAPI { ) /** - * Delete a namespace + * Delete a namespace. * * @param request - The request {@link DeleteNamespaceRequest} */ @@ -157,7 +157,8 @@ export class API extends ParentAPI { }) /** - * Create a set of credentials for a specific namespace. + * Create a set of credentials. Create a set of credentials for a specific + * namespace. * * @param request - The request {@link CreateCredentialRequest} * @returns A Promise of Credential @@ -179,7 +180,7 @@ export class API extends ParentAPI { ) /** - * Delete credentials + * Delete credentials. * * @param request - The request {@link DeleteCredentialRequest} */ @@ -219,7 +220,7 @@ export class API extends ParentAPI { ) /** - * List credentials + * List credentials. * * @param request - The request {@link ListCredentialsRequest} * @returns A Promise of ListCredentialsResponse @@ -253,7 +254,7 @@ export class API extends ParentAPI { ) /** - * Get a set of credentials + * Get a set of credentials. * * @param request - The request {@link GetCredentialRequest} * @returns A Promise of Credential diff --git a/packages/clients/src/api/rdb/v1/api.gen.ts b/packages/clients/src/api/rdb/v1/api.gen.ts index 22cc0a26c..470f0395f 100644 --- a/packages/clients/src/api/rdb/v1/api.gen.ts +++ b/packages/clients/src/api/rdb/v1/api.gen.ts @@ -191,7 +191,8 @@ export class API extends ParentAPI { ) /** - * List the PostgreSQL and MySQL database engines available at Scaleway. + * List available database engines. List the PostgreSQL and MySQL database + * engines available at Scaleway. * * @param request - The request {@link ListDatabaseEnginesRequest} * @returns A Promise of ListDatabaseEnginesResponse @@ -220,9 +221,9 @@ export class API extends ParentAPI { ) /** - * List all available node types. By default, the databases returned in the - * list are ordered by creation date in ascending order, though this can be - * modified via the order_by field. + * List available node types. List all available node types. By default, the + * databases returned in the list are ordered by creation date in ascending + * order, though this can be modified via the order_by field. * * @param request - The request {@link ListNodeTypesRequest} * @returns A Promise of ListNodeTypesResponse @@ -257,9 +258,10 @@ export class API extends ParentAPI { ) /** - * List all backups in a specified zone, for a given Scaleway Organization or - * Scaleway Project. By default, the backups listed are ordered by creation - * date in ascending order. This can be modified via the `order_by` field. + * List database backups. List all backups in a specified zone, for a given + * Scaleway Organization or Scaleway Project. By default, the backups listed + * are ordered by creation date in ascending order. This can be modified via + * the `order_by` field. * * @param request - The request {@link ListDatabaseBackupsRequest} * @returns A Promise of ListDatabaseBackupsResponse @@ -272,8 +274,8 @@ export class API extends ParentAPI { ) /** - * Create a new backup. You must set the `instance_id`, `database_name`, - * `name` and `expires_at` parameters. + * Create a database backup. Create a new backup. You must set the + * `instance_id`, `database_name`, `name` and `expires_at` parameters. * * @param request - The request {@link CreateDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -295,9 +297,9 @@ export class API extends ParentAPI { ) /** - * Retrieve information about a given backup, specified by its database backup - * ID and region. Full details about the backup, like size, URL and expiration - * date, are returned in the response. + * Get a database backup. Retrieve information about a given backup, specified + * by its database backup ID and region. Full details about the backup, like + * size, URL and expiration date, are returned in the response. * * @param request - The request {@link GetDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -340,7 +342,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of a backup, including name and expiration date. + * Update a database backup. Update the parameters of a backup, including name + * and expiration date. * * @param request - The request {@link UpdateDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -365,8 +368,8 @@ export class API extends ParentAPI { ) /** - * Delete a backup, specified by its database backup ID and region. Deleting a - * backup is permanent, and cannot be undone. + * Delete a database backup. Delete a backup, specified by its database backup + * ID and region. Deleting a backup is permanent, and cannot be undone. * * @param request - The request {@link DeleteDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -387,10 +390,10 @@ export class API extends ParentAPI { ) /** - * Launch the process of restoring database backup. You must specify the - * `instance_id` of the Database Instance of destination, where the backup - * will be restored. Note that large database backups can take up to several - * hours to restore. + * Restore a database backup. Launch the process of restoring database backup. + * You must specify the `instance_id` of the Database Instance of destination, + * where the backup will be restored. Note that large database backups can + * take up to several hours to restore. * * @param request - The request {@link RestoreDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -415,8 +418,9 @@ export class API extends ParentAPI { ) /** - * Export a backup, specified by the `database_backup_id` and the `region` - * parameters. The download URL is returned in the response. + * Export a database backup. Export a backup, specified by the + * `database_backup_id` and the `region` parameters. The download URL is + * returned in the response. * * @param request - The request {@link ExportDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -439,9 +443,10 @@ export class API extends ParentAPI { ) /** - * Upgrade your current Database Instance specifications like node type, high - * availability, volume, or the database engine version. Note that upon - * upgrade the `enable_ha` parameter can only be set to `true`. + * Upgrade a Database Instance. Upgrade your current Database Instance + * specifications like node type, high availability, volume, or the database + * engine version. Note that upon upgrade the `enable_ha` parameter can only + * be set to `true`. * * @param request - The request {@link UpgradeInstanceRequest} * @returns A Promise of Instance @@ -492,13 +497,14 @@ export class API extends ParentAPI { ) /** - * List all Database Instances in the specified zone, for a given Scaleway - * Organization or Scaleway Project. By default, the Database Instances - * returned in the list are ordered by creation date in ascending order, - * though this can be modified via the order_by field. You can define - * additional parameters for your query, such as `tags` and `name`. For the - * `name` parameter, the value you include will be checked against the whole - * name string to see if it includes the string you put in the parameter. + * List Database Instances. List all Database Instances in the specified zone, + * for a given Scaleway Organization or Scaleway Project. By default, the + * Database Instances returned in the list are ordered by creation date in + * ascending order, though this can be modified via the order_by field. You + * can define additional parameters for your query, such as `tags` and `name`. + * For the `name` parameter, the value you include will be checked against the + * whole name string to see if it includes the string you put in the + * parameter. * * @param request - The request {@link ListInstancesRequest} * @returns A Promise of ListInstancesResponse @@ -507,9 +513,10 @@ export class API extends ParentAPI { enrichForPagination('instances', this.pageOfListInstances, request) /** - * Retrieve information about a given Database Instance, specified by the - * `region` and `instance_id` parameters. Its full details, including name, - * status, IP address and port, are returned in the response object. + * Get a Database Instance. Retrieve information about a given Database + * Instance, specified by the `region` and `instance_id` parameters. Its full + * details, including name, status, IP address and port, are returned in the + * response object. * * @param request - The request {@link GetInstanceRequest} * @returns A Promise of Instance @@ -547,9 +554,9 @@ export class API extends ParentAPI { ) /** - * Create a new Database Instance. You must set the `engine`, `user_name`, - * `password` and `node_type` parameters. Optionally, you can specify the - * volume type and size. + * Create a Database Instance. Create a new Database Instance. You must set + * the `engine`, `user_name`, `password` and `node_type` parameters. + * Optionally, you can specify the volume type and size. * * @param request - The request {@link CreateInstanceRequest} * @returns A Promise of Instance @@ -571,8 +578,8 @@ export class API extends ParentAPI { ) /** - * Update the parameters of a Database Instance, including name, tags and - * backup schedule details. + * Update a Database Instance. Update the parameters of a Database Instance, + * including name, tags and backup schedule details. * * @param request - The request {@link UpdateInstanceRequest} * @returns A Promise of Instance @@ -594,9 +601,10 @@ export class API extends ParentAPI { ) /** - * Delete a given Database Instance, specified by the `region` and - * `instance_id` parameters. Deleting a Database Instance is permanent, and - * cannot be undone. Note that upon deletion all your data will be lost. + * Delete a Database Instance. Delete a given Database Instance, specified by + * the `region` and `instance_id` parameters. Deleting a Database Instance is + * permanent, and cannot be undone. Note that upon deletion all your data will + * be lost. * * @param request - The request {@link DeleteInstanceRequest} * @returns A Promise of Instance @@ -614,11 +622,11 @@ export class API extends ParentAPI { ) /** - * Clone a given Database Instance, specified by the `region` and - * `instance_id` parameters. The clone feature allows you to create a new - * Database Instance from an existing one. The clone includes all existing - * databases, users and permissions. You can create a clone on a Database - * Instance bigger than your current one. + * Clone a Database Instance. Clone a given Database Instance, specified by + * the `region` and `instance_id` parameters. The clone feature allows you to + * create a new Database Instance from an existing one. The clone includes all + * existing databases, users and permissions. You can create a clone on a + * Database Instance bigger than your current one. * * @param request - The request {@link CloneInstanceRequest} * @returns A Promise of Instance @@ -643,9 +651,9 @@ export class API extends ParentAPI { ) /** - * Restart a given Database Instance, specified by the `region` and - * `instance_id` parameters. The status of the Database Instance returned in - * the response. + * Restart Database Instance. Restart a given Database Instance, specified by + * the `region` and `instance_id` parameters. The status of the Database + * Instance returned in the response. * * @param request - The request {@link RestartInstanceRequest} * @returns A Promise of Instance @@ -668,8 +676,9 @@ export class API extends ParentAPI { ) /** - * Retrieve information about the TLS certificate of a given Database - * Instance. Details like name and content are returned in the response. + * Get the TLS certificate of a Database Instance. Retrieve information about + * the TLS certificate of a given Database Instance. Details like name and + * content are returned in the response. * * @param request - The request {@link GetInstanceCertificateRequest} * @returns A Promise of Blob @@ -689,10 +698,11 @@ export class API extends ParentAPI { }) /** - * Renew a TLS for a Database Instance. Renewing a certificate means that you - * will not be able to connect to your Database Instance using the previous - * certificate. You will also need to download and update the new certificate - * for all database clients. + * Renew the TLS certificate of a Database Instance. Renew a TLS for a + * Database Instance. Renewing a certificate means that you will not be able + * to connect to your Database Instance using the previous certificate. You + * will also need to download and update the new certificate for all database + * clients. * * @param request - The request {@link RenewInstanceCertificateRequest} */ @@ -713,9 +723,9 @@ export class API extends ParentAPI { }) /** - * Retrieve the time series metrics of a give Database Instance. You can - * define the period from which to retrieve metrics by specifying the - * `start_date` and `end_date`. + * Get Database Instance metrics. Retrieve the time series metrics of a give + * Database Instance. You can define the period from which to retrieve metrics + * by specifying the `start_date` and `end_date`. * * @param request - The request {@link GetInstanceMetricsRequest} * @returns A Promise of InstanceMetrics @@ -741,9 +751,9 @@ export class API extends ParentAPI { ) /** - * Create a new Read Replica of a Database Instance. You must specify the - * `region` and the `instance_id`. You can only create a maximum of 3 Read - * Replicas per Database Instance. + * Create a Read Replica. Create a new Read Replica of a Database Instance. + * You must specify the `region` and the `instance_id`. You can only create a + * maximum of 3 Read Replicas per Database Instance. * * @param request - The request {@link CreateReadReplicaRequest} * @returns A Promise of ReadReplica @@ -765,9 +775,9 @@ export class API extends ParentAPI { ) /** - * Retrieve information about a Database Instance Read Replica. Full details - * about the Read Replica, like `endpoints`, `status` and `region` are - * returned in the response. + * Get a Read Replica. Retrieve information about a Database Instance Read + * Replica. Full details about the Read Replica, like `endpoints`, `status` + * and `region` are returned in the response. * * @param request - The request {@link GetReadReplicaRequest} * @returns A Promise of ReadReplica @@ -810,8 +820,9 @@ export class API extends ParentAPI { ) /** - * Delete a Read Replica of a Database Instance. You must specify the `region` - * and `read_replica_id` parameters of the Read Replica you want to delete. + * Delete a Read Replica. Delete a Read Replica of a Database Instance. You + * must specify the `region` and `read_replica_id` parameters of the Read + * Replica you want to delete. * * @param request - The request {@link DeleteReadReplicaRequest} * @returns A Promise of ReadReplica @@ -832,11 +843,11 @@ export class API extends ParentAPI { ) /** - * When you resync a Read Replica, first it is reset, then its data is - * resynchronized from the primary node. Your Read Replica remains unavailable - * during the resync process. The duration of this process is proportional to - * the size of your Database Instance. The configured endpoints do not - * change. + * Resync a Read Replica. When you resync a Read Replica, first it is reset, + * then its data is resynchronized from the primary node. Your Read Replica + * remains unavailable during the resync process. The duration of this process + * is proportional to the size of your Database Instance. The configured + * endpoints do not change. * * @param request - The request {@link ResetReadReplicaRequest} * @returns A Promise of ReadReplica @@ -859,8 +870,9 @@ export class API extends ParentAPI { ) /** - * Create a new endpoint for a Read Replica. Read Replicas can have at most - * one direct access and one Private Network endpoint. + * Create an endpoint for a Read Replica. Create a new endpoint for a Read + * Replica. Read Replicas can have at most one direct access and one Private + * Network endpoint. * * @param request - The request {@link CreateReadReplicaEndpointRequest} * @returns A Promise of ReadReplica @@ -890,12 +902,12 @@ export class API extends ParentAPI { ) /** - * Prepare your Database Instance logs. You can define the `start_date` and - * `end_date` parameters for your query. The download URL is returned in the - * response. Logs are recorded from 00h00 to 23h59 and then aggregated in a - * `.log` file once a day. Therefore, even if you specify a timeframe from - * which you want to get the logs, you will receive logs from the full 24 - * hours. + * Prepare logs of a Database Instance. Prepare your Database Instance logs. + * You can define the `start_date` and `end_date` parameters for your query. + * The download URL is returned in the response. Logs are recorded from 00h00 + * to 23h59 and then aggregated in a `.log` file once a day. Therefore, even + * if you specify a timeframe from which you want to get the logs, you will + * receive logs from the full 24 hours. * * @param request - The request {@link PrepareInstanceLogsRequest} * @returns A Promise of PrepareInstanceLogsResponse @@ -920,9 +932,10 @@ export class API extends ParentAPI { ) /** - * List the available logs of a Database Instance. By default, the logs - * returned in the list are ordered by creation date in ascending order, - * though this can be modified via the order_by field. + * List available logs of a Database Instance. List the available logs of a + * Database Instance. By default, the logs returned in the list are ordered by + * creation date in ascending order, though this can be modified via the + * order_by field. * * @param request - The request {@link ListInstanceLogsRequest} * @returns A Promise of ListInstanceLogsResponse @@ -944,10 +957,10 @@ export class API extends ParentAPI { ) /** - * Retrieve information about the logs of a Database Instance. Specify the - * `instance_log_id` and `region` in your request to get information such as - * `download_url`, `status`, `expires_at` and `created_at` about your logs in - * the response. + * Get given logs of a Database Instance. Retrieve information about the logs + * of a Database Instance. Specify the `instance_log_id` and `region` in your + * request to get information such as `download_url`, `status`, `expires_at` + * and `created_at` about your logs in the response. * * @param request - The request {@link GetInstanceLogRequest} * @returns A Promise of InstanceLog @@ -987,8 +1000,9 @@ export class API extends ParentAPI { ) /** - * Purge a given remote log from a Database Instance. You can specify the - * `log_name` of the log you wish to clean from your Database Instance. + * Purge remote Database Instance logs. Purge a given remote log from a + * Database Instance. You can specify the `log_name` of the log you wish to + * clean from your Database Instance. * * @param request - The request {@link PurgeInstanceLogsRequest} */ @@ -1009,9 +1023,9 @@ export class API extends ParentAPI { }) /** - * List remote log details. By default, the details returned in the list are - * ordered by creation date in ascending order, though this can be modified - * via the order_by field. + * List remote Database Instance logs details. List remote log details. By + * default, the details returned in the list are ordered by creation date in + * ascending order, though this can be modified via the order_by field. * * @param request - The request {@link ListInstanceLogsDetailsRequest} * @returns A Promise of ListInstanceLogsDetailsResponse @@ -1034,8 +1048,9 @@ export class API extends ParentAPI { ) /** - * Add an advanced setting to a Database Instance. You must set the `name` and - * the `value` of each setting. + * Add Database Instance advanced settings. Add an advanced setting to a + * Database Instance. You must set the `name` and the `value` of each + * setting. * * @param request - The request {@link AddInstanceSettingsRequest} * @returns A Promise of AddInstanceSettingsResponse @@ -1060,8 +1075,9 @@ export class API extends ParentAPI { ) /** - * Delete an advanced setting in a Database Instance. You must specify the - * names of the settings you want to delete in the request. + * Delete Database Instance advanced settings. Delete an advanced setting in a + * Database Instance. You must specify the names of the settings you want to + * delete in the request. * * @param request - The request {@link DeleteInstanceSettingsRequest} * @returns A Promise of DeleteInstanceSettingsResponse @@ -1086,9 +1102,9 @@ export class API extends ParentAPI { ) /** - * Update an advanced setting for a Database Instance. Settings added upon - * database engine initalization can only be defined once, and cannot, - * therefore, be updated. + * Set Database Instance advanced settings. Update an advanced setting for a + * Database Instance. Settings added upon database engine initalization can + * only be defined once, and cannot, therefore, be updated. * * @param request - The request {@link SetInstanceSettingsRequest} * @returns A Promise of SetInstanceSettingsResponse @@ -1137,9 +1153,10 @@ export class API extends ParentAPI { ) /** - * List the ACL rules for a given Database Instance. The response is an array - * of ACL objects, each one representing an ACL that denies, allows or - * redirects traffic based on certain conditions. + * List ACL rules of a Database Instance. List the ACL rules for a given + * Database Instance. The response is an array of ACL objects, each one + * representing an ACL that denies, allows or redirects traffic based on + * certain conditions. * * @param request - The request {@link ListInstanceACLRulesRequest} * @returns A Promise of ListInstanceACLRulesResponse @@ -1148,7 +1165,8 @@ export class API extends ParentAPI { enrichForPagination('rules', this.pageOfListInstanceACLRules, request) /** - * Add an additional ACL rule to a Database Instance. + * Add an ACL rule to a Database Instance. Add an additional ACL rule to a + * Database Instance. * * @param request - The request {@link AddInstanceACLRulesRequest} * @returns A Promise of AddInstanceACLRulesResponse @@ -1173,7 +1191,8 @@ export class API extends ParentAPI { ) /** - * Replace all the ACL rules of a Database Instance. + * Set ACL rules for a Database Instance. Replace all the ACL rules of a + * Database Instance. * * @param request - The request {@link SetInstanceACLRulesRequest} * @returns A Promise of SetInstanceACLRulesResponse @@ -1198,7 +1217,8 @@ export class API extends ParentAPI { ) /** - * Delete one or more ACL rules of a Database Instance. + * Delete ACL rules of a Database Instance. Delete one or more ACL rules of a + * Database Instance. * * @param request - The request {@link DeleteInstanceACLRulesRequest} * @returns A Promise of DeleteInstanceACLRulesResponse @@ -1247,9 +1267,10 @@ export class API extends ParentAPI { ) /** - * List all users of a given Database Instance. By default, the users returned - * in the list are ordered by creation date in ascending order, though this - * can be modified via the order_by field. + * List users of a Database Instance. List all users of a given Database + * Instance. By default, the users returned in the list are ordered by + * creation date in ascending order, though this can be modified via the + * order_by field. * * @param request - The request {@link ListUsersRequest} * @returns A Promise of ListUsersResponse @@ -1258,8 +1279,9 @@ export class API extends ParentAPI { enrichForPagination('users', this.pageOfListUsers, request) /** - * Create a new user for a Database Instance. You must define the `name`, - * `password` and `is_admin` parameters. + * Create a user for a Database Instance. Create a new user for a Database + * Instance. You must define the `name`, `password` and `is_admin` + * parameters. * * @param request - The request {@link CreateUserRequest} * @returns A Promise of User @@ -1284,9 +1306,9 @@ export class API extends ParentAPI { ) /** - * Update the parameters of a user on a Database Instance. You can update the - * `password` and `is_admin` parameters, but you cannot change the name of the - * user. + * Update a user on a Database Instance. Update the parameters of a user on a + * Database Instance. You can update the `password` and `is_admin` parameters, + * but you cannot change the name of the user. * * @param request - The request {@link UpdateUserRequest} * @returns A Promise of User @@ -1311,9 +1333,9 @@ export class API extends ParentAPI { ) /** - * Delete a given user on a Database Instance. You must specify, in the - * endpoint, the `region`, `instance_id` and `name` parameters of the user you - * want to delete. + * Delete a user on a Database Instance. Delete a given user on a Database + * Instance. You must specify, in the endpoint, the `region`, `instance_id` + * and `name` parameters of the user you want to delete. * * @param request - The request {@link DeleteUserRequest} */ @@ -1356,11 +1378,11 @@ export class API extends ParentAPI { ) /** - * List all databases of a given Database Instance. By default, the databases - * returned in the list are ordered by creation date in ascending order, - * though this can be modified via the order_by field. You can define - * additional parameters for your query, such as `name`, `managed` and - * `owner`. + * List databases in a Database Instance. List all databases of a given + * Database Instance. By default, the databases returned in the list are + * ordered by creation date in ascending order, though this can be modified + * via the order_by field. You can define additional parameters for your + * query, such as `name`, `managed` and `owner`. * * @param request - The request {@link ListDatabasesRequest} * @returns A Promise of ListDatabasesResponse @@ -1369,7 +1391,8 @@ export class API extends ParentAPI { enrichForPagination('databases', this.pageOfListDatabases, request) /** - * Create a new database. You must define the `name` parameter in the request. + * Create a database in a Database Instance. Create a new database. You must + * define the `name` parameter in the request. * * @param request - The request {@link CreateDatabaseRequest} * @returns A Promise of Database @@ -1394,9 +1417,9 @@ export class API extends ParentAPI { ) /** - * Delete a given database on a Database Instance. You must specify, in the - * endpoint, the `region`, `instance_id` and `name` parameters of the database - * you want to delete. + * Delete a database in a Database Instance. Delete a given database on a + * Database Instance. You must specify, in the endpoint, the `region`, + * `instance_id` and `name` parameters of the database you want to delete. * * @param request - The request {@link DeleteDatabaseRequest} */ @@ -1438,10 +1461,11 @@ export class API extends ParentAPI { ) /** - * List privileges of a user on a database. By default, the details returned - * in the list are ordered by creation date in ascending order, though this - * can be modified via the order_by field. You can define additional - * parameters for your query, such as `database_name` and `user_name`. + * List user privileges for a database. List privileges of a user on a + * database. By default, the details returned in the list are ordered by + * creation date in ascending order, though this can be modified via the + * order_by field. You can define additional parameters for your query, such + * as `database_name` and `user_name`. * * @param request - The request {@link ListPrivilegesRequest} * @returns A Promise of ListPrivilegesResponse @@ -1450,8 +1474,9 @@ export class API extends ParentAPI { enrichForPagination('privileges', this.pageOfListPrivileges, request) /** - * Set the privileges of a user on a database. You must define - * `database_name`, `user_name` and `permission` in the request body. + * Set user privileges for a database. Set the privileges of a user on a + * database. You must define `database_name`, `user_name` and `permission` in + * the request body. * * @param request - The request {@link SetPrivilegeRequest} * @returns A Promise of Privilege @@ -1502,11 +1527,11 @@ export class API extends ParentAPI { ) /** - * List snapshots. You can include the `instance_id` or `project_id` in your - * query to get the list of snaphots for specific Database Instances and/or - * Projects. By default, the details returned in the list are ordered by - * creation date in ascending order, though this can be modified via the - * order_by field. + * List snapshots. List snapshots. You can include the `instance_id` or + * `project_id` in your query to get the list of snaphots for specific + * Database Instances and/or Projects. By default, the details returned in the + * list are ordered by creation date in ascending order, though this can be + * modified via the order_by field. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -1515,9 +1540,9 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Retrieve information about a given snapshot, specified by its `snapshot_id` - * and `region`. Full details about the snapshot, like size and expiration - * date, are returned in the response. + * Get a Database Instance snapshot. Retrieve information about a given + * snapshot, specified by its `snapshot_id` and `region`. Full details about + * the snapshot, like size and expiration date, are returned in the response. * * @param request - The request {@link GetSnapshotRequest} * @returns A Promise of Snapshot @@ -1555,8 +1580,8 @@ export class API extends ParentAPI { ) /** - * Create a new snapshot of a Database Instance. You must define the `name` - * parameter in the request. + * Create a Database Instance snapshot. Create a new snapshot of a Database + * Instance. You must define the `name` parameter in the request. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of Snapshot @@ -1581,8 +1606,9 @@ export class API extends ParentAPI { ) /** - * Update the parameters of a snapshot of a Database Instance. You can update - * the `name` and `expires_at` parameters. + * Update a Database Instance snapshot. Update the parameters of a snapshot of + * a Database Instance. You can update the `name` and `expires_at` + * parameters. * * @param request - The request {@link UpdateSnapshotRequest} * @returns A Promise of Snapshot @@ -1604,9 +1630,9 @@ export class API extends ParentAPI { ) /** - * Delete a given snapshot of a Database Instance. You must specify, in the - * endpoint, the `region` and `snapshot_id` parameters of the snapshot you - * want to delete. + * Delete a Database Instance snapshot. Delete a given snapshot of a Database + * Instance. You must specify, in the endpoint, the `region` and `snapshot_id` + * parameters of the snapshot you want to delete. * * @param request - The request {@link DeleteSnapshotRequest} * @returns A Promise of Snapshot @@ -1624,13 +1650,14 @@ export class API extends ParentAPI { ) /** - * Restore a snapshot. When you restore a snapshot, a new Instance is created - * and billed to your account. Note that is possible to select a larger node - * type for your new Database Instance. However, the Block volume size will be - * the same as the size of the restored snapshot. All Instance settings will - * be restored if you chose a node type with the same or more memory size than - * the initial Instance. Settings will be reset to the default if your node - * type has less memory. + * Create a new Database Instance from a snapshot. Restore a snapshot. When + * you restore a snapshot, a new Instance is created and billed to your + * account. Note that is possible to select a larger node type for your new + * Database Instance. However, the Block volume size will be the same as the + * size of the restored snapshot. All Instance settings will be restored if + * you chose a node type with the same or more memory size than the initial + * Instance. Settings will be reset to the default if your node type has less + * memory. * * @param request - The request {@link CreateInstanceFromSnapshotRequest} * @returns A Promise of Instance @@ -1660,10 +1687,11 @@ export class API extends ParentAPI { ) /** - * Create a new endpoint for a Database Instance. You can add `load_balacer` - * and `private_network` specifications to the body of the request. Note that - * this action replaces your current endpoint, which means you might need to - * update any environment configurations that point to the old endpoint. + * Create a new Database Instance endpoint. Create a new endpoint for a + * Database Instance. You can add `load_balacer` and `private_network` + * specifications to the body of the request. Note that this action replaces + * your current endpoint, which means you might need to update any environment + * configurations that point to the old endpoint. * * @param request - The request {@link CreateEndpointRequest} * @returns A Promise of Endpoint @@ -1688,10 +1716,10 @@ export class API extends ParentAPI { ) /** - * Delete the endpoint of a Database Instance. You must specify the `region` - * and `endpoint_id` parameters of the endpoint you want to delete. Note that - * might need to update any environment configurations that point to the - * deleted endpoint. + * Delete a Database Instance endpoint. Delete the endpoint of a Database + * Instance. You must specify the `region` and `endpoint_id` parameters of the + * endpoint you want to delete. Note that might need to update any environment + * configurations that point to the deleted endpoint. * * @param request - The request {@link DeleteEndpointRequest} */ @@ -1705,9 +1733,10 @@ export class API extends ParentAPI { }) /** - * Retrieve information about a Database Instance endpoint. Full details about - * the endpoint, like `ip`, `port`, `private_network` and `load_balancer` - * specifications are returned in the response. + * Get a Database Instance endpoint. Retrieve information about a Database + * Instance endpoint. Full details about the endpoint, like `ip`, `port`, + * `private_network` and `load_balancer` specifications are returned in the + * response. * * @param request - The request {@link GetEndpointRequest} * @returns A Promise of Endpoint @@ -1725,7 +1754,7 @@ export class API extends ParentAPI { ) /** - * Migrate an existing instance endpoint to another instance + * Migrate an existing instance endpoint to another instance. * * @param request - The request {@link MigrateEndpointRequest} * @returns A Promise of Endpoint diff --git a/packages/clients/src/api/rdb/v1/types.gen.ts b/packages/clients/src/api/rdb/v1/types.gen.ts index c2ea7ad7c..6294d1d30 100644 --- a/packages/clients/src/api/rdb/v1/types.gen.ts +++ b/packages/clients/src/api/rdb/v1/types.gen.ts @@ -916,8 +916,9 @@ export type UpgradeInstanceRequest = { */ volumeType?: VolumeType /** - * This will create a new Database Instance with same specifications as the - * current one and perform a Database Engine upgrade. + * Update your database engine to a newer version. This will create a new + * Database Instance with same specifications as the current one and perform a + * Database Engine upgrade. * * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', * 'volumeSize', 'volumeType', 'upgradableVersionId' could be set. @@ -1542,7 +1543,10 @@ export type DeleteEndpointRequest = { * config. */ region?: Region - /** This endpoint can also be used to delete a Read Replica endpoint. */ + /** + * UUID of the endpoint you want to delete. This endpoint can also be used to + * delete a Read Replica endpoint. + */ endpointId: string } diff --git a/packages/clients/src/api/redis/v1/api.gen.ts b/packages/clients/src/api/redis/v1/api.gen.ts index d6ffb2ce3..d01ac18bb 100644 --- a/packages/clients/src/api/redis/v1/api.gen.ts +++ b/packages/clients/src/api/redis/v1/api.gen.ts @@ -88,7 +88,7 @@ export class API extends ParentAPI { ] /** - * Create a cluster + * Create a cluster. * * @param request - The request {@link CreateClusterRequest} * @returns A Promise of Cluster @@ -110,7 +110,7 @@ export class API extends ParentAPI { ) /** - * Update a cluster + * Update a cluster. * * @param request - The request {@link UpdateClusterRequest} * @returns A Promise of Cluster @@ -132,7 +132,7 @@ export class API extends ParentAPI { ) /** - * Get a cluster + * Get a cluster. * * @param request - The request {@link GetClusterRequest} * @returns A Promise of Cluster @@ -197,7 +197,7 @@ export class API extends ParentAPI { ) /** - * List clusters + * List clusters. * * @param request - The request {@link ListClustersRequest} * @returns A Promise of ListClustersResponse @@ -206,10 +206,11 @@ export class API extends ParentAPI { enrichForPagination('clusters', this.pageOfListClusters, request) /** - * Upgrade your Database for Redis® cluster to a new version or scale it - * vertically / horizontally. Please note: scaling horizontally your Database - * for Redis® cluster won't renew its TLS certificate. In order to refresh the - * SSL certificate, you have to use the dedicated api route. + * Migrate your cluster architecture. Upgrade your Database for Redis® cluster + * to a new version or scale it vertically / horizontally. Please note: + * scaling horizontally your Database for Redis® cluster won't renew its TLS + * certificate. In order to refresh the SSL certificate, you have to use the + * dedicated api route. * * @param request - The request {@link MigrateClusterRequest} * @returns A Promise of Cluster @@ -234,7 +235,7 @@ export class API extends ParentAPI { ) /** - * Delete a cluster + * Delete a cluster. * * @param request - The request {@link DeleteClusterRequest} * @returns A Promise of Cluster @@ -252,7 +253,7 @@ export class API extends ParentAPI { ) /** - * Get metrics of a cluster + * Get metrics of a cluster. * * @param request - The request {@link GetClusterMetricsRequest} * @returns A Promise of ClusterMetricsResponse @@ -298,7 +299,7 @@ export class API extends ParentAPI { ) /** - * List available node types + * List available node types. * * @param request - The request {@link ListNodeTypesRequest} * @returns A Promise of ListNodeTypesResponse @@ -332,7 +333,7 @@ export class API extends ParentAPI { ) /** - * List available Redis™ versions + * List available Redis™ versions. * * @param request - The request {@link ListClusterVersionsRequest} * @returns A Promise of ListClusterVersionsResponse @@ -341,7 +342,7 @@ export class API extends ParentAPI { enrichForPagination('versions', this.pageOfListClusterVersions, request) /** - * Get the TLS certificate of a cluster + * Get the TLS certificate of a cluster. * * @param request - The request {@link GetClusterCertificateRequest} * @returns A Promise of Blob @@ -361,7 +362,7 @@ export class API extends ParentAPI { }) /** - * Renew the TLS certificate of a cluster + * Renew the TLS certificate of a cluster. * * @param request - The request {@link RenewClusterCertificateRequest} * @returns A Promise of Cluster @@ -386,7 +387,7 @@ export class API extends ParentAPI { ) /** - * Add cluster settings + * Add cluster settings. * * @param request - The request {@link AddClusterSettingsRequest} * @returns A Promise of ClusterSettingsResponse @@ -411,7 +412,7 @@ export class API extends ParentAPI { ) /** - * Delete a cluster setting + * Delete a cluster setting. * * @param request - The request {@link DeleteClusterSettingRequest} * @returns A Promise of Cluster @@ -432,7 +433,7 @@ export class API extends ParentAPI { ) /** - * Set cluster settings + * Set cluster settings. * * @param request - The request {@link SetClusterSettingsRequest} * @returns A Promise of ClusterSettingsResponse @@ -457,7 +458,7 @@ export class API extends ParentAPI { ) /** - * Set ACL rules for a given cluster + * Set ACL rules for a given cluster. * * @param request - The request {@link SetAclRulesRequest} * @returns A Promise of SetAclRulesResponse @@ -479,7 +480,7 @@ export class API extends ParentAPI { ) /** - * Add ACL rules for a given cluster + * Add ACL rules for a given cluster. * * @param request - The request {@link AddAclRulesRequest} * @returns A Promise of AddAclRulesResponse @@ -501,7 +502,7 @@ export class API extends ParentAPI { ) /** - * Delete an ACL rule for a given cluster + * Delete an ACL rule for a given cluster. * * @param request - The request {@link DeleteAclRuleRequest} * @returns A Promise of Cluster @@ -519,7 +520,7 @@ export class API extends ParentAPI { ) /** - * Get an ACL rule + * Get an ACL rule. * * @param request - The request {@link GetAclRuleRequest} * @returns A Promise of ACLRule @@ -537,7 +538,7 @@ export class API extends ParentAPI { ) /** - * Set endpoints for a given cluster + * Set endpoints for a given cluster. * * @param request - The request {@link SetEndpointsRequest} * @returns A Promise of SetEndpointsResponse @@ -562,7 +563,7 @@ export class API extends ParentAPI { ) /** - * Add endpoints for a given cluster + * Add endpoints for a given cluster. * * @param request - The request {@link AddEndpointsRequest} * @returns A Promise of AddEndpointsResponse @@ -587,7 +588,7 @@ export class API extends ParentAPI { ) /** - * Delete an endpoint for a given cluster + * Delete an endpoint for a given cluster. * * @param request - The request {@link DeleteEndpointRequest} * @returns A Promise of Cluster @@ -605,7 +606,7 @@ export class API extends ParentAPI { ) /** - * Get an endpoint + * Get an endpoint. * * @param request - The request {@link GetEndpointRequest} * @returns A Promise of Endpoint diff --git a/packages/clients/src/api/redis/v1/types.gen.ts b/packages/clients/src/api/redis/v1/types.gen.ts index e593c7852..1642efb3b 100644 --- a/packages/clients/src/api/redis/v1/types.gen.ts +++ b/packages/clients/src/api/redis/v1/types.gen.ts @@ -305,8 +305,9 @@ export type CreateClusterRequest = { aclRules?: ACLRuleSpec[] /** * Zero or multiple EndpointSpec used to expose your cluster publicly and - * inside private networks. If no EndpoindSpec is given the cluster will be - * publicly exposed by default. + * inside private networks. Zero or multiple EndpointSpec used to expose your + * cluster publicly and inside private networks. If no EndpoindSpec is given + * the cluster will be publicly exposed by default. */ endpoints?: EndpointSpec[] /** Whether or not TLS is enabled. */ diff --git a/packages/clients/src/api/registry/v1/api.gen.ts b/packages/clients/src/api/registry/v1/api.gen.ts index 18b9d14c8..cb9c9f0c2 100644 --- a/packages/clients/src/api/registry/v1/api.gen.ts +++ b/packages/clients/src/api/registry/v1/api.gen.ts @@ -52,7 +52,7 @@ const jsonContentHeaders = { /** * Registry API. * - * Container registry API. + * Container registry API. Registry API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -84,7 +84,7 @@ export class API extends ParentAPI { ) /** - * List all your namespaces + * List all your namespaces. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -93,7 +93,7 @@ export class API extends ParentAPI { enrichForPagination('namespaces', this.pageOfListNamespaces, request) /** - * Get the namespace associated with the given id. + * Get a namespace. Get the namespace associated with the given id. * * @param request - The request {@link GetNamespaceRequest} * @returns A Promise of Namespace @@ -131,7 +131,7 @@ export class API extends ParentAPI { ) /** - * Create a new namespace + * Create a new namespace. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -153,7 +153,8 @@ export class API extends ParentAPI { ) /** - * Update the namespace associated with the given id. + * Update an existing namespace. Update the namespace associated with the + * given id. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -175,7 +176,8 @@ export class API extends ParentAPI { ) /** - * Delete the namespace associated with the given id. + * Delete an existing namespace. Delete the namespace associated with the + * given id. * * @param request - The request {@link DeleteNamespaceRequest} * @returns A Promise of Namespace @@ -217,7 +219,7 @@ export class API extends ParentAPI { ) /** - * List all your images + * List all your images. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -226,7 +228,7 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get the image associated with the given id. + * Get a image. Get the image associated with the given id. * * @param request - The request {@link GetImageRequest} * @returns A Promise of Image @@ -264,7 +266,7 @@ export class API extends ParentAPI { ) /** - * Update the image associated with the given id. + * Update an existing image. Update the image associated with the given id. * * @param request - The request {@link UpdateImageRequest} * @returns A Promise of Image @@ -286,7 +288,7 @@ export class API extends ParentAPI { ) /** - * Delete the image associated with the given id. + * Delete an image. Delete the image associated with the given id. * * @param request - The request {@link DeleteImageRequest} * @returns A Promise of Image @@ -325,7 +327,7 @@ export class API extends ParentAPI { ) /** - * List all your tags + * List all your tags. * * @param request - The request {@link ListTagsRequest} * @returns A Promise of ListTagsResponse @@ -334,7 +336,7 @@ export class API extends ParentAPI { enrichForPagination('tags', this.pageOfListTags, request) /** - * Get the tag associated with the given id. + * Get a tag. Get the tag associated with the given id. * * @param request - The request {@link GetTagRequest} * @returns A Promise of Tag @@ -371,7 +373,7 @@ export class API extends ParentAPI { ) /** - * Delete the tag associated with the given id. + * Delete a tag. Delete the tag associated with the given id. * * @param request - The request {@link DeleteTagRequest} * @returns A Promise of Tag diff --git a/packages/clients/src/api/registry/v1/types.gen.ts b/packages/clients/src/api/registry/v1/types.gen.ts index 63372454b..ffbdd1eb0 100644 --- a/packages/clients/src/api/registry/v1/types.gen.ts +++ b/packages/clients/src/api/registry/v1/types.gen.ts @@ -58,9 +58,10 @@ export interface Image { */ visibility: ImageVisibility /** - * Image size in bytes, calculated from the size of image layers. One layer - * used in two tags of the same image is counted once but one layer used in - * two images is counted twice. + * Image size in bytes, calculated from the size of image layers. Image size + * in bytes, calculated from the size of image layers. One layer used in two + * tags of the same image is counted once but one layer used in two images is + * counted twice. */ size: number /** Creation date. */ diff --git a/packages/clients/src/api/secret/v1alpha1/api.gen.ts b/packages/clients/src/api/secret/v1alpha1/api.gen.ts index d5633012e..242959278 100644 --- a/packages/clients/src/api/secret/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/secret/v1alpha1/api.gen.ts @@ -51,13 +51,14 @@ const jsonContentHeaders = { * Secret API (beta). * * This API allows you to conveniently store, access and share sensitive data. + * Secret API (beta). */ export class API extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: Region[] = ['fr-par'] /** - * Create a Secret containing no versions + * Create a Secret containing no versions. * * @param request - The request {@link CreateSecretRequest} * @returns A Promise of Secret @@ -79,7 +80,7 @@ export class API extends ParentAPI { ) /** - * Get metadata of a Secret + * Get metadata of a Secret. * * @param request - The request {@link GetSecretRequest} * @returns A Promise of Secret @@ -97,7 +98,7 @@ export class API extends ParentAPI { ) /** - * Get metadata of a Secret + * Get metadata of a Secret. * * @param request - The request {@link GetSecretByNameRequest} * @returns A Promise of Secret @@ -118,7 +119,7 @@ export class API extends ParentAPI { ) /** - * Update metadata of a Secret + * Update metadata of a Secret. * * @param request - The request {@link UpdateSecretRequest} * @returns A Promise of Secret @@ -164,7 +165,7 @@ export class API extends ParentAPI { ) /** - * List Secrets + * List Secrets. * * @param request - The request {@link ListSecretsRequest} * @returns A Promise of ListSecretsResponse @@ -173,7 +174,7 @@ export class API extends ParentAPI { enrichForPagination('secrets', this.pageOfListSecrets, request) /** - * Delete a secret + * Delete a secret. * * @param request - The request {@link DeleteSecretRequest} */ @@ -187,7 +188,7 @@ export class API extends ParentAPI { }) /** - * Create a SecretVersion + * Create a SecretVersion. * * @param request - The request {@link CreateSecretVersionRequest} * @returns A Promise of SecretVersion @@ -209,7 +210,7 @@ export class API extends ParentAPI { ) /** - * Get metadata of a SecretVersion + * Get metadata of a SecretVersion. * * @param request - The request {@link GetSecretVersionRequest} * @returns A Promise of SecretVersion @@ -230,7 +231,7 @@ export class API extends ParentAPI { ) /** - * Get metadata of a SecretVersion + * Get metadata of a SecretVersion. * * @param request - The request {@link GetSecretVersionByNameRequest} * @returns A Promise of SecretVersion @@ -251,7 +252,7 @@ export class API extends ParentAPI { ) /** - * Update metadata of a SecretVersion + * Update metadata of a SecretVersion. * * @param request - The request {@link UpdateSecretVersionRequest} * @returns A Promise of SecretVersion @@ -298,7 +299,7 @@ export class API extends ParentAPI { ) /** - * List versions of a secret, not returning any sensitive data + * List versions of a secret, not returning any sensitive data. * * @param request - The request {@link ListSecretVersionsRequest} * @returns A Promise of ListSecretVersionsResponse @@ -332,7 +333,7 @@ export class API extends ParentAPI { ) /** - * List versions of a secret, not returning any sensitive data + * List versions of a secret, not returning any sensitive data. * * @param request - The request {@link ListSecretVersionsByNameRequest} * @returns A Promise of ListSecretVersionsResponse @@ -347,7 +348,7 @@ export class API extends ParentAPI { ) /** - * Destroy a SecretVersion, permanently destroying the sensitive data + * Destroy a SecretVersion, permanently destroying the sensitive data. * * @param request - The request {@link DestroySecretVersionRequest} * @returns A Promise of SecretVersion @@ -370,7 +371,7 @@ export class API extends ParentAPI { ) /** - * Enable a SecretVersion + * Enable a SecretVersion. * * @param request - The request {@link EnableSecretVersionRequest} * @returns A Promise of SecretVersion @@ -393,7 +394,7 @@ export class API extends ParentAPI { ) /** - * Disable a SecretVersion + * Disable a SecretVersion. * * @param request - The request {@link DisableSecretVersionRequest} * @returns A Promise of SecretVersion @@ -416,7 +417,7 @@ export class API extends ParentAPI { ) /** - * Access a SecretVersion, returning the sensitive data + * Access a SecretVersion, returning the sensitive data. * * @param request - The request {@link AccessSecretVersionRequest} * @returns A Promise of AccessSecretVersionResponse @@ -437,7 +438,7 @@ export class API extends ParentAPI { ) /** - * Access a SecretVersion, returning the sensitive data + * Access a SecretVersion, returning the sensitive data. * * @param request - The request {@link AccessSecretVersionByNameRequest} * @returns A Promise of AccessSecretVersionResponse diff --git a/packages/clients/src/api/secret/v1alpha1/types.gen.ts b/packages/clients/src/api/secret/v1alpha1/types.gen.ts index a41765baa..f5abf0216 100644 --- a/packages/clients/src/api/secret/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/secret/v1alpha1/types.gen.ts @@ -52,7 +52,10 @@ export interface Secret { projectId: string /** Name of the Secret. */ name: string - /** - `ready`: the Secret is ready. `locked`: the Secret is locked. */ + /** + * Current status of the Secret. `ready`: the Secret is ready. `locked`: the + * Secret is locked. + */ status: SecretStatus /** The time at which the Secret was created. */ createdAt?: Date @@ -75,10 +78,10 @@ export interface SecretVersion { /** Revision of the SecretVersion. */ revision: number /** - * - `unknown`: the SecretVersion is in an invalid state. `enabled`: the - * SecretVersion is accessible. `disabled`: the SecretVersion is not - * accessible but can be enabled. `destroyed`: the SecretVersion is - * permanently destroyed. + * Current status of the SecretVersion. `unknown`: the SecretVersion is in an + * invalid state. `enabled`: the SecretVersion is accessible. `disabled`: the + * SecretVersion is not accessible but can be enabled. `destroyed`: the + * SecretVersion is permanently destroyed. */ status: SecretVersionStatus /** The time at which the SecretVersion was created. */ diff --git a/packages/clients/src/api/tem/v1alpha1/api.gen.ts b/packages/clients/src/api/tem/v1alpha1/api.gen.ts index c70ce85fa..10d50f22c 100644 --- a/packages/clients/src/api/tem/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/tem/v1alpha1/api.gen.ts @@ -48,14 +48,14 @@ const jsonContentHeaders = { /** * Transactional Email API. * - * Tem. + * Tem. Transactional Email API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: Region[] = ['fr-par'] /** - * Send an email + * Send an email. * * @param request - The request {@link CreateEmailRequest} * @returns A Promise of CreateEmailResponse @@ -77,7 +77,7 @@ export class API extends ParentAPI { ) /** - * Get information about an email + * Get information about an email. * * @param request - The request {@link GetEmailRequest} * @returns A Promise of Email @@ -144,7 +144,7 @@ export class API extends ParentAPI { /** * List emails sent from a domain and/or for a project and/or for an - * organization + * organization. * * @param request - The request {@link ListEmailsRequest} * @returns A Promise of ListEmailsResponse @@ -153,7 +153,7 @@ export class API extends ParentAPI { enrichForPagination('emails', this.pageOfListEmails, request) /** - * Get statistics on the email statuses + * Get statistics on the email statuses. * * @param request - The request {@link GetStatisticsRequest} * @returns A Promise of Statistics @@ -178,7 +178,7 @@ export class API extends ParentAPI { ) /** - * Try to cancel an email if it has not yet been sent + * Try to cancel an email if it has not yet been sent. * * @param request - The request {@link CancelEmailRequest} * @returns A Promise of Email @@ -198,7 +198,7 @@ export class API extends ParentAPI { ) /** - * Register a domain in a project + * Register a domain in a project. * * @param request - The request {@link CreateDomainRequest} * @returns A Promise of Domain @@ -220,7 +220,7 @@ export class API extends ParentAPI { ) /** - * Get information about a domain + * Get information about a domain. * * @param request - The request {@link GetDomainRequest} * @returns A Promise of Domain @@ -281,7 +281,7 @@ export class API extends ParentAPI { ) /** - * List domains in a project and/or in an organization + * List domains in a project and/or in an organization. * * @param request - The request {@link ListDomainsRequest} * @returns A Promise of ListDomainsResponse @@ -290,7 +290,7 @@ export class API extends ParentAPI { enrichForPagination('domains', this.pageOfListDomains, request) /** - * Revoke a domain + * Revoke a domain. * * @param request - The request {@link RevokeDomainRequest} * @returns A Promise of Domain @@ -310,7 +310,7 @@ export class API extends ParentAPI { ) /** - * Ask for an immediate check of a domain (DNS check) + * Ask for an immediate check of a domain (DNS check). * * @param request - The request {@link CheckDomainRequest} * @returns A Promise of Domain diff --git a/packages/clients/src/api/test/v1/api.gen.ts b/packages/clients/src/api/test/v1/api.gen.ts index 4e22bb1ad..344cff723 100644 --- a/packages/clients/src/api/test/v1/api.gen.ts +++ b/packages/clients/src/api/test/v1/api.gen.ts @@ -38,8 +38,8 @@ const jsonContentHeaders = { /** * Fake API. * - * Test is a fake service that aim to manage fake humans. It is used for - * internal and public end-to-end tests. + * No Auth Service for end-to-end testing. Test is a fake service that aim to + * manage fake humans. It is used for internal and public end-to-end tests. * * This service don't use the Scaleway authentication service but a fake one. It * allows to use this test service publicly without requiring a Scaleway @@ -51,8 +51,8 @@ const jsonContentHeaders = { */ export class API extends ParentAPI { /** - * Register a human and return a access-key and a secret-key that must be used - * in all other commands. + * Register a user. Register a human and return a access-key and a secret-key + * that must be used in all other commands. * * Hint: you can use other test commands by setting the SCW_SECRET_KEY env * variable. @@ -93,7 +93,7 @@ export class API extends ParentAPI { ) /** - * List all your humans + * List all your humans. * * @param request - The request {@link ListHumansRequest} * @returns A Promise of ListHumansResponse @@ -102,7 +102,7 @@ export class API extends ParentAPI { enrichForPagination('humans', this.pageOfListHumans, request) /** - * Get the human details associated with the given id. + * Get human details. Get the human details associated with the given id. * * @param request - The request {@link GetHumanRequest} * @returns A Promise of Human @@ -140,7 +140,7 @@ export class API extends ParentAPI { ) /** - * Create a new human + * Create a new human. * * @param request - The request {@link CreateHumanRequest} * @returns A Promise of Human @@ -159,7 +159,7 @@ export class API extends ParentAPI { ) /** - * Update the human associated with the given id. + * Update an existing human. Update the human associated with the given id. * * @param request - The request {@link UpdateHumanRequest} * @returns A Promise of Human @@ -181,7 +181,7 @@ export class API extends ParentAPI { ) /** - * Delete the human associated with the given id. + * Delete an existing human. Delete the human associated with the given id. * * @param request - The request {@link DeleteHumanRequest} * @returns A Promise of Human @@ -199,7 +199,8 @@ export class API extends ParentAPI { ) /** - * Start a one hour running for the given human. + * Start a 1h running for the given human. Start a one hour running for the + * given human. * * @param request - The request {@link RunHumanRequest} * @returns A Promise of Human diff --git a/packages/clients/src/api/vpc/v1/api.gen.ts b/packages/clients/src/api/vpc/v1/api.gen.ts index 1be4df84a..ba7b10ac7 100644 --- a/packages/clients/src/api/vpc/v1/api.gen.ts +++ b/packages/clients/src/api/vpc/v1/api.gen.ts @@ -68,7 +68,7 @@ export class API extends ParentAPI { ) /** - * List private networks + * List private networks. * * @param request - The request {@link ListPrivateNetworksRequest} * @returns A Promise of ListPrivateNetworksResponse @@ -81,7 +81,7 @@ export class API extends ParentAPI { ) /** - * Create a private network + * Create a private network. * * @param request - The request {@link CreatePrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -105,7 +105,7 @@ export class API extends ParentAPI { ) /** - * Get a private network + * Get a private network. * * @param request - The request {@link GetPrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -126,7 +126,7 @@ export class API extends ParentAPI { ) /** - * Update private network + * Update private network. * * @param request - The request {@link UpdatePrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -151,7 +151,7 @@ export class API extends ParentAPI { ) /** - * Delete a private network + * Delete a private network. * * @param request - The request {@link DeletePrivateNetworkRequest} */ diff --git a/packages/clients/src/api/vpcgw/v1/api.gen.ts b/packages/clients/src/api/vpcgw/v1/api.gen.ts index 38428c2b4..24726c06c 100644 --- a/packages/clients/src/api/vpcgw/v1/api.gen.ts +++ b/packages/clients/src/api/vpcgw/v1/api.gen.ts @@ -142,8 +142,9 @@ export class API extends ParentAPI { ) /** - * List Public Gateways in a given Scaleway Organization or Project. By - * default, results are displayed in ascending order of creation date. + * List Public Gateways. List Public Gateways in a given Scaleway Organization + * or Project. By default, results are displayed in ascending order of + * creation date. * * @param request - The request {@link ListGatewaysRequest} * @returns A Promise of ListGatewaysResponse @@ -152,9 +153,9 @@ export class API extends ParentAPI { enrichForPagination('gateways', this.pageOfListGateways, request) /** - * Get details of a Public Gateway, specified by its gateway ID. The response - * object contains full details of the gateway, including its **name**, - * **type**, **status** and more. + * Get a Public Gateway. Get details of a Public Gateway, specified by its + * gateway ID. The response object contains full details of the gateway, + * including its **name**, **type**, **status** and more. * * @param request - The request {@link GetGatewayRequest} * @returns A Promise of Gateway @@ -192,9 +193,9 @@ export class API extends ParentAPI { ) /** - * Create a new Public Gateway in the specified Scaleway Project, defining its - * **name**, **type** and other configuration details such as whether to - * enable SSH bastion. + * Create a Public Gateway. Create a new Public Gateway in the specified + * Scaleway Project, defining its **name**, **type** and other configuration + * details such as whether to enable SSH bastion. * * @param request - The request {@link CreateGatewayRequest} * @returns A Promise of Gateway @@ -216,8 +217,9 @@ export class API extends ParentAPI { ) /** - * Update the parameters of an existing Public Gateway, for example, its - * **name**, **tags**, **SSH bastion configuration**, and **DNS servers**. + * Update a Public Gateway. Update the parameters of an existing Public + * Gateway, for example, its **name**, **tags**, **SSH bastion + * configuration**, and **DNS servers**. * * @param request - The request {@link UpdateGatewayRequest} * @returns A Promise of Gateway @@ -239,8 +241,8 @@ export class API extends ParentAPI { ) /** - * Delete an existing Public Gateway, specified by its gateway ID. This action - * is irreversible. + * Delete a Public Gateway. Delete an existing Public Gateway, specified by + * its gateway ID. This action is irreversible. * * @param request - The request {@link DeleteGatewayRequest} */ @@ -255,9 +257,10 @@ export class API extends ParentAPI { }) /** - * Upgrade a given Public Gateway to the newest software version. This applies - * the latest bugfixes and features to your Public Gateway, but its service - * will be interrupted during the update. + * Upgrade a Public Gateway to the latest version. Upgrade a given Public + * Gateway to the newest software version. This applies the latest bugfixes + * and features to your Public Gateway, but its service will be interrupted + * during the update. * * @param request - The request {@link UpgradeGatewayRequest} * @returns A Promise of Gateway @@ -307,9 +310,10 @@ export class API extends ParentAPI { ) /** - * List the connections between Public Gateways and Private Networks (a - * connection = a GatewayNetwork). You can choose to filter by `gateway-id` to - * list all Private Networks attached to the specified Public Gateway, or by + * List Public Gateway connections to Private Networks. List the connections + * between Public Gateways and Private Networks (a connection = a + * GatewayNetwork). You can choose to filter by `gateway-id` to list all + * Private Networks attached to the specified Public Gateway, or by * `private_network_id` to list all Public Gateways attached to the specified * Private Network. Other query parameters are also available. The result is * an array of GatewayNetwork objects, each giving details of the connection @@ -326,11 +330,12 @@ export class API extends ParentAPI { ) /** - * Get details of a given connection between a Public Gateway and a Private - * Network (this connection = a GatewayNetwork), specified by its - * `gateway_network_id`. The response object contains details of the - * connection including the IDs of the Public Gateway and Private Network, the - * dates the connection was created/updated and its configuration settings. + * Get a Public Gateway connection to a Private Network. Get details of a + * given connection between a Public Gateway and a Private Network (this + * connection = a GatewayNetwork), specified by its `gateway_network_id`. The + * response object contains details of the connection including the IDs of the + * Public Gateway and Private Network, the dates the connection was + * created/updated and its configuration settings. * * @param request - The request {@link GetGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -373,9 +378,10 @@ export class API extends ParentAPI { ) /** - * Attach a specific Public Gateway to a specific Private Network (create a - * GatewayNetwork). You can configure parameters for the connection including - * DHCP settings, whether to enable masquerade (dynamic NAT), and more. + * Attach a Public Gateway to a Private Network. Attach a specific Public + * Gateway to a specific Private Network (create a GatewayNetwork). You can + * configure parameters for the connection including DHCP settings, whether to + * enable masquerade (dynamic NAT), and more. * * @param request - The request {@link CreateGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -397,10 +403,11 @@ export class API extends ParentAPI { ) /** - * Update the configuration parameters of a connection between a given Public - * Gateway and Private Network (the connection = a GatewayNetwork). Updatable - * parameters include DHCP settings and whether to enable traffic masquerade - * (dynamic NAT). + * Update a Public Gateway's connection to a Private Network. Update the + * configuration parameters of a connection between a given Public Gateway and + * Private Network (the connection = a GatewayNetwork). Updatable parameters + * include DHCP settings and whether to enable traffic masquerade (dynamic + * NAT). * * @param request - The request {@link UpdateGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -425,8 +432,9 @@ export class API extends ParentAPI { ) /** - * Detach a given Public Gateway from a given Private Network, i.e. delete a - * GatewayNetwork specified by a gateway_network_id. + * Detach a Public Gateway from a Private Network. Detach a given Public + * Gateway from a given Private Network, i.e. delete a GatewayNetwork + * specified by a gateway_network_id. * * @param request - The request {@link DeleteGatewayNetworkRequest} */ @@ -468,14 +476,14 @@ export class API extends ParentAPI { ) /** - * List DHCP configurations, optionally filtering by Organization, Project, - * Public Gateway IP address or more. The response is an array of DHCP - * configuration objects, each identified by a DHCP ID and containing - * configuration settings for the assignment of IP addresses to devices on a - * Private Network attached to a Public Gateway. Note that the response does - * not contain the IDs of any Private Network / Public Gateway the - * configuration is attached to. Use the `List Public Gateway connections to - * Private Networks` method for that purpose, filtering on DHCP ID. + * List DHCP configurations. List DHCP configurations, optionally filtering by + * Organization, Project, Public Gateway IP address or more. The response is + * an array of DHCP configuration objects, each identified by a DHCP ID and + * containing configuration settings for the assignment of IP addresses to + * devices on a Private Network attached to a Public Gateway. Note that the + * response does not contain the IDs of any Private Network / Public Gateway + * the configuration is attached to. Use the `List Public Gateway connections + * to Private Networks` method for that purpose, filtering on DHCP ID. * * @param request - The request {@link ListDHCPsRequest} * @returns A Promise of ListDHCPsResponse @@ -484,12 +492,13 @@ export class API extends ParentAPI { enrichForPagination('dhcps', this.pageOfListDHCPs, request) /** - * Get a DHCP configuration object, identified by its DHCP ID. The response - * object contains configuration settings for the assignment of IP addresses - * to devices on a Private Network attached to a Public Gateway. Note that the - * response does not contain the IDs of any Private Network / Public Gateway - * the configuration is attached to. Use the `List Public Gateway connections - * to Private Networks` method for that purpose, filtering on DHCP ID. + * Get a DHCP configuration. Get a DHCP configuration object, identified by + * its DHCP ID. The response object contains configuration settings for the + * assignment of IP addresses to devices on a Private Network attached to a + * Public Gateway. Note that the response does not contain the IDs of any + * Private Network / Public Gateway the configuration is attached to. Use the + * `List Public Gateway connections to Private Networks` method for that + * purpose, filtering on DHCP ID. * * @param request - The request {@link GetDHCPRequest} * @returns A Promise of DHCP @@ -507,13 +516,13 @@ export class API extends ParentAPI { ) /** - * Create a new DHCP configuration object, containing settings for the - * assignment of IP addresses to devices on a Private Network attached to a - * Public Gateway. The response object includes the ID of the DHCP - * configuration object. You can use this ID as part of a call to `Create a - * Public Gateway connection to a Private Network` or `Update a Public Gateway - * connection to a Private Network` to directly apply this DHCP - * configuration. + * Create a DHCP configuration. Create a new DHCP configuration object, + * containing settings for the assignment of IP addresses to devices on a + * Private Network attached to a Public Gateway. The response object includes + * the ID of the DHCP configuration object. You can use this ID as part of a + * call to `Create a Public Gateway connection to a Private Network` or + * `Update a Public Gateway connection to a Private Network` to directly apply + * this DHCP configuration. * * @param request - The request {@link CreateDHCPRequest} * @returns A Promise of DHCP @@ -535,7 +544,8 @@ export class API extends ParentAPI { ) /** - * Update a DHCP configuration object, identified by its DHCP ID. + * Update a DHCP configuration. Update a DHCP configuration object, identified + * by its DHCP ID. * * @param request - The request {@link UpdateDHCPRequest} * @returns A Promise of DHCP @@ -557,9 +567,9 @@ export class API extends ParentAPI { ) /** - * Delete a DHCP configuration object, identified by its DHCP ID. Note that - * you cannot delete a DHCP configuration object that is currently being used - * by a Gateway Network. + * Delete a DHCP configuration. Delete a DHCP configuration object, identified + * by its DHCP ID. Note that you cannot delete a DHCP configuration object + * that is currently being used by a Gateway Network. * * @param request - The request {@link DeleteDHCPRequest} */ @@ -600,9 +610,9 @@ export class API extends ParentAPI { ) /** - * List DHCP entries, whether dynamically assigned and/or statically reserved. - * DHCP entries can be filtered by the Gateway Network they are on, their MAC - * address, IP address, type or hostname. + * List DHCP entries. List DHCP entries, whether dynamically assigned and/or + * statically reserved. DHCP entries can be filtered by the Gateway Network + * they are on, their MAC address, IP address, type or hostname. * * @param request - The request {@link ListDHCPEntriesRequest} * @returns A Promise of ListDHCPEntriesResponse @@ -611,7 +621,7 @@ export class API extends ParentAPI { enrichForPagination('dhcpEntries', this.pageOfListDHCPEntries, request) /** - * Get a DHCP entry, specified by its DHCP entry ID. + * Get a DHCP entry. Get a DHCP entry, specified by its DHCP entry ID. * * @param request - The request {@link GetDHCPEntryRequest} * @returns A Promise of DHCPEntry @@ -632,10 +642,11 @@ export class API extends ParentAPI { ) /** - * Create a static DHCP reservation, specifying the Gateway Network for the - * reservation, the MAC address of the target device and the IP address to - * assign this device. The response is a DHCP entry object, confirming the ID - * and configuration details of the static DHCP reservation. + * Create a DHCP entry. Create a static DHCP reservation, specifying the + * Gateway Network for the reservation, the MAC address of the target device + * and the IP address to assign this device. The response is a DHCP entry + * object, confirming the ID and configuration details of the static DHCP + * reservation. * * @param request - The request {@link CreateDHCPEntryRequest} * @returns A Promise of DHCPEntry @@ -657,10 +668,11 @@ export class API extends ParentAPI { ) /** - * Update the IP address for a DHCP entry, specified by its DHCP entry ID. You - * can update an existing DHCP entry of any type (`reservation` (static), - * `lease` (dynamic) or `unknown`), but in manually updating the IP address - * the entry will necessarily be of type `reservation` after the update. + * Update a DHCP entry. Update the IP address for a DHCP entry, specified by + * its DHCP entry ID. You can update an existing DHCP entry of any type + * (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually + * updating the IP address the entry will necessarily be of type `reservation` + * after the update. * * @param request - The request {@link UpdateDHCPEntryRequest} * @returns A Promise of DHCPEntry @@ -685,10 +697,10 @@ export class API extends ParentAPI { ) /** - * Set the list of DHCP reservations attached to a Gateway Network. - * Reservations are identified by their MAC address, and will sync the current - * DHCP entry list to the given list, creating, updating or deleting DHCP - * entries accordingly. + * Set all DHCP reservations on a Gateway Network. Set the list of DHCP + * reservations attached to a Gateway Network. Reservations are identified by + * their MAC address, and will sync the current DHCP entry list to the given + * list, creating, updating or deleting DHCP entries accordingly. * * @param request - The request {@link SetDHCPEntriesRequest} * @returns A Promise of SetDHCPEntriesResponse @@ -710,9 +722,9 @@ export class API extends ParentAPI { ) /** - * Delete a static DHCP reservation, identified by its DHCP entry ID. Note - * that you cannot delete DHCP entries of type `lease`, these are deleted - * automatically when their time-to-live expires. + * Delete a DHCP entry. Delete a static DHCP reservation, identified by its + * DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, + * these are deleted automatically when their time-to-live expires. * * @param request - The request {@link DeleteDHCPEntryRequest} */ @@ -751,9 +763,9 @@ export class API extends ParentAPI { ) /** - * List PAT rules. You can filter by gateway ID to list all PAT rules for a - * particular gateway, or filter for PAT rules targeting a specific IP address - * or using a specific protocol. + * List PAT rules. List PAT rules. You can filter by gateway ID to list all + * PAT rules for a particular gateway, or filter for PAT rules targeting a + * specific IP address or using a specific protocol. * * @param request - The request {@link ListPATRulesRequest} * @returns A Promise of ListPATRulesResponse @@ -762,10 +774,10 @@ export class API extends ParentAPI { enrichForPagination('patRules', this.pageOfListPATRules, request) /** - * Get a PAT rule, specified by its PAT rule ID. The response object gives - * full details of the PAT rule, including the Public Gateway it belongs to - * and the configuration settings in terms of public / private ports, private - * IP and protocol. + * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response + * object gives full details of the PAT rule, including the Public Gateway it + * belongs to and the configuration settings in terms of public / private + * ports, private IP and protocol. * * @param request - The request {@link GetPATRuleRequest} * @returns A Promise of PATRule @@ -783,8 +795,9 @@ export class API extends ParentAPI { ) /** - * Create a new PAT rule on a specified Public Gateway, defining the protocol - * to use, public port to listen on, and private port / IP address to map to. + * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, + * defining the protocol to use, public port to listen on, and private port / + * IP address to map to. * * @param request - The request {@link CreatePATRuleRequest} * @returns A Promise of PATRule @@ -806,9 +819,9 @@ export class API extends ParentAPI { ) /** - * Update a PAT rule, specified by its PAT rule ID. Configuration settings - * including private/public port, private IP address and protocol can all be - * updated. + * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. + * Configuration settings including private/public port, private IP address + * and protocol can all be updated. * * @param request - The request {@link UpdatePATRuleRequest} * @returns A Promise of PATRule @@ -830,10 +843,10 @@ export class API extends ParentAPI { ) /** - * Set a definitive list of PAT rules attached to a Public Gateway. Each rule - * is identified by its public port and protocol. This will sync the current - * PAT rule list on the gateway with the new list, creating, updating or - * deleting PAT rules accordingly. + * Set all PAT rules. Set a definitive list of PAT rules attached to a Public + * Gateway. Each rule is identified by its public port and protocol. This will + * sync the current PAT rule list on the gateway with the new list, creating, + * updating or deleting PAT rules accordingly. * * @param request - The request {@link SetPATRulesRequest} * @returns A Promise of SetPATRulesResponse @@ -855,8 +868,8 @@ export class API extends ParentAPI { ) /** - * Delete a PAT rule, identified by its PAT rule ID. This action is - * irreversible. + * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This + * action is irreversible. * * @param request - The request {@link DeletePATRuleRequest} */ @@ -870,9 +883,9 @@ export class API extends ParentAPI { }) /** - * List the different Public Gateway commercial offer types available at - * Scaleway. The response is an array of objects describing the name and - * technical details of each available gateway type. + * List Public Gateway types. List the different Public Gateway commercial + * offer types available at Scaleway. The response is an array of objects + * describing the name and technical details of each available gateway type. * * @param request - The request {@link ListGatewayTypesRequest} * @returns A Promise of ListGatewayTypesResponse @@ -915,8 +928,8 @@ export class API extends ParentAPI { ) /** - * List Public Gateway flexible IP addresses. A number of filter options are - * available for limiting results in the response. + * List IPs. List Public Gateway flexible IP addresses. A number of filter + * options are available for limiting results in the response. * * @param request - The request {@link ListIPsRequest} * @returns A Promise of ListIPsResponse @@ -925,9 +938,9 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Get details of a Public Gateway flexible IP address, identified by its IP - * ID. The response object contains information including which (if any) - * Public Gateway using this IP address, the reverse and various other + * Get an IP. Get details of a Public Gateway flexible IP address, identified + * by its IP ID. The response object contains information including which (if + * any) Public Gateway using this IP address, the reverse and various other * metadata. * * @param request - The request {@link GetIPRequest} @@ -946,8 +959,8 @@ export class API extends ParentAPI { ) /** - * Create (reserve) a new flexible IP address that can be used for a Public - * Gateway in a specified Scaleway Project. + * Reserve an IP. Create (reserve) a new flexible IP address that can be used + * for a Public Gateway in a specified Scaleway Project. * * @param request - The request {@link CreateIPRequest} * @returns A Promise of IP @@ -969,8 +982,8 @@ export class API extends ParentAPI { ) /** - * Update details of an existing flexible IP address, including its tags, - * reverse and the Public Gateway it is assigned to. + * Update an IP. Update details of an existing flexible IP address, including + * its tags, reverse and the Public Gateway it is assigned to. * * @param request - The request {@link UpdateIPRequest} * @returns A Promise of IP @@ -992,8 +1005,8 @@ export class API extends ParentAPI { ) /** - * Delete a flexible IP address from your account. This action is - * irreversible. + * Delete an IP. Delete a flexible IP address from your account. This action + * is irreversible. * * @param request - The request {@link DeleteIPRequest} */ @@ -1007,9 +1020,9 @@ export class API extends ParentAPI { }) /** - * Refresh the SSH keys of a given Public Gateway, specified by its gateway - * ID. This adds any new SSH keys in the gateway's Scaleway Project to the - * gateway itself. + * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public + * Gateway, specified by its gateway ID. This adds any new SSH keys in the + * gateway's Scaleway Project to the gateway itself. * * @param request - The request {@link RefreshSSHKeysRequest} * @returns A Promise of Gateway diff --git a/packages/clients/src/api/vpcgw/v1/types.gen.ts b/packages/clients/src/api/vpcgw/v1/types.gen.ts index fbe2459f6..3ef62a126 100644 --- a/packages/clients/src/api/vpcgw/v1/types.gen.ts +++ b/packages/clients/src/api/vpcgw/v1/types.gen.ts @@ -363,8 +363,9 @@ export interface PATRule { /** Set dhcp entries request. entry. */ export interface SetDHCPEntriesRequestEntry { /** - * MAC address to give a static entry to. A matching entry will be upgraded to - * a reservation, and a matching reservation will be updated. + * MAC address to give a static entry to. MAC address to give a static entry + * to. A matching entry will be upgraded to a reservation, and a matching + * reservation will be updated. */ macAddress: string /** IP address to give to the device. */ @@ -380,8 +381,8 @@ export interface SetDHCPEntriesResponse { /** Set pat rules request. rule. */ export interface SetPATRulesRequestRule { /** - * Public port to listen on. Uniquely identifies the rule, and a matching rule - * will be updated with the new parameters. + * Public port to listen on. Public port to listen on. Uniquely identifies the + * rule, and a matching rule will be updated with the new parameters. */ publicPort: number /** Private IP to forward data to. */ diff --git a/packages/clients/src/api/webhosting/v1alpha1/api.gen.ts b/packages/clients/src/api/webhosting/v1alpha1/api.gen.ts index d3fe4fce6..2600546df 100644 --- a/packages/clients/src/api/webhosting/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/webhosting/v1alpha1/api.gen.ts @@ -42,7 +42,7 @@ export class API extends ParentAPI { public static readonly LOCALITIES: Region[] = ['fr-par'] /** - * Create a hosting + * Create a hosting. * * @param request - The request {@link CreateHostingRequest} * @returns A Promise of Hosting @@ -91,7 +91,7 @@ export class API extends ParentAPI { ) /** - * List all hostings + * List all hostings. * * @param request - The request {@link ListHostingsRequest} * @returns A Promise of ListHostingsResponse @@ -100,7 +100,7 @@ export class API extends ParentAPI { enrichForPagination('hostings', this.pageOfListHostings, request) /** - * Get the details of a Hosting with the given ID. + * Get a hosting. Get the details of a Hosting with the given ID. * * @param request - The request {@link GetHostingRequest} * @returns A Promise of Hosting @@ -138,7 +138,7 @@ export class API extends ParentAPI { ) /** - * Update a hosting + * Update a hosting. * * @param request - The request {@link UpdateHostingRequest} * @returns A Promise of Hosting @@ -160,7 +160,7 @@ export class API extends ParentAPI { ) /** - * Delete a hosting with the given ID. + * Delete a hosting. Delete a hosting with the given ID. * * @param request - The request {@link DeleteHostingRequest} * @returns A Promise of Hosting @@ -178,7 +178,7 @@ export class API extends ParentAPI { ) /** - * Restore a hosting with the given ID. + * Retore a hosting. Restore a hosting with the given ID. * * @param request - The request {@link RestoreHostingRequest} * @returns A Promise of Hosting @@ -201,7 +201,7 @@ export class API extends ParentAPI { ) /** - * Get the DNS records of a specified domain. + * Get the DNS records. Get the DNS records of a specified domain. * * @param request - The request {@link GetDomainDnsRecordsRequest} * @returns A Promise of DnsRecords @@ -219,7 +219,7 @@ export class API extends ParentAPI { ) /** - * List all offers + * List all offers. * * @param request - The request {@link ListOffersRequest} * @returns A Promise of ListOffersResponse