docs(vpc): revamp (#609)

Author: scaleway-bot

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

@@ -69,7 +69,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * List private networks.
+   * List Private Networks. List existing Private Networks in a specified
+   * Availability Zone. By default, the Private Networks 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 ListPrivateNetworksRequest}
    * @returns A Promise of ListPrivateNetworksResponse
@@ -82,7 +85,8 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Create a private network.
+   * Create a Private Network. Create a new Private Network. Once created, you
+   * can attach Scaleway resources in the same Availability Zone.
    *
    * @param request - The request {@link CreatePrivateNetworkRequest}
    * @returns A Promise of PrivateNetwork
@@ -106,7 +110,9 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Get a private network.
+   * Get a Private Network. Retrieve information about an existing Private
+   * Network, specified by its Private Network ID. Its full details are returned
+   * in the response object.
    *
    * @param request - The request {@link GetPrivateNetworkRequest}
    * @returns A Promise of PrivateNetwork
@@ -127,7 +133,8 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Update private network.
+   * Update Private Network. Update parameters (such as name or tags) of an
+   * existing Private Network, specified by its Private Network ID.
    *
    * @param request - The request {@link UpdatePrivateNetworkRequest}
    * @returns A Promise of PrivateNetwork
@@ -152,7 +159,8 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Delete a private network.
+   * Delete a Private Network. Delete an existing Private Network. Note that you
+   * must first detach all resources from the network, in order to delete it.
    *
    * @param request - The request {@link DeletePrivateNetworkRequest}
    */

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

@@ -15,85 +15,100 @@ export interface ListPrivateNetworksResponse {
 
 /** Private network. */
 export interface PrivateNetwork {
-  /** The private network ID. */
+  /** Private Network ID. */
   id: string
-  /** The private network name. */
+  /** Private Network name. */
   name: string
-  /** The private network organization. */
+  /** Scaleway Organization the Private Network belongs to. */
   organizationId: string
-  /** The private network project ID. */
+  /** Scaleway Project the Private Network belongs to. */
   projectId: string
-  /** The zone in which the private network is available. */
+  /** Availability Zone in which the Private Network is available. */
   zone: Zone
-  /** The private network tags. */
+  /** Tags of the Private Network. */
   tags: string[]
-  /** The private network creation date. */
+  /** Date the Private Network was created. */
   createdAt?: Date
-  /** The last private network modification date. */
+  /** Date the Private Network was last modified. */
   updatedAt?: Date
-  /** Private network subnets CIDR. */
+  /** Private Network subnets CIDR. */
   subnets: string[]
 }
 
 export type ListPrivateNetworksRequest = {
   /** Zone to target. If none is passed will use default zone from the config. */
   zone?: Zone
-  /** The sort order of the returned private networks. */
+  /** Sort order of the returned Private Networks. */
   orderBy?: ListPrivateNetworksRequestOrderBy
-  /** The page number for the returned private networks. */
+  /** Page number to return, from the paginated results. */
   page?: number
-  /** The maximum number of private networks per page. */
+  /** Maximum number of Private Networks to return per page. */
   pageSize?: number
-  /** Filter private networks with names containing this string. */
+  /**
+   * Name to filter for. Only Private Networks with names containing this string
+   * will be returned.
+   */
   name?: string
-  /** Filter private networks with one or more matching tags. */
+  /**
+   * Tags to filter for. Only Private Networks with one or more matching tags
+   * will be returned.
+   */
   tags?: string[]
-  /** The organization ID on which to filter the returned private networks. */
+  /**
+   * Organization ID to filter for. Only Private Networks belonging to this
+   * Organization will be returned.
+   */
   organizationId?: string
-  /** The project ID on which to filter the returned private networks. */
+  /**
+   * Project ID to filter for. Only Private Networks belonging to this Project
+   * will be returned.
+   */
   projectId?: string
-  /** The PrivateNetwork IDs on which to filter the returned private networks. */
+  /**
+   * Private Network IDs to filter for. Only Private Networks with one of these
+   * IDs will be returned.
+   */
   privateNetworkIds?: string[]
-  /** Include regional Private Networks. */
+  /** Defines whether to include regional Private Networks in the response. */
   includeRegional?: boolean
 }
 
 export type CreatePrivateNetworkRequest = {
   /** Zone to target. If none is passed will use default zone from the config. */
   zone?: Zone
-  /** The name of the private network. */
+  /** Name for the Private Network. */
   name?: string
-  /** The project ID of the private network. */
+  /** Scaleway Project in which to create the Private Network. */
   projectId?: string
-  /** The private networks tags. */
+  /** Tags for the Private Network. */
   tags?: string[]
-  /** Private network subnets CIDR. */
+  /** Private Network subnets CIDR. */
   subnets?: string[]
 }
 
 export type GetPrivateNetworkRequest = {
   /** Zone to target. If none is passed will use default zone from the config. */
   zone?: Zone
-  /** The private network id. */
+  /** Private Network ID. */
   privateNetworkId: string
 }
 
 export type UpdatePrivateNetworkRequest = {
   /** Zone to target. If none is passed will use default zone from the config. */
   zone?: Zone
-  /** The private network ID. */
+  /** Private Network ID. */
   privateNetworkId: string
-  /** The name of the private network. */
+  /** Name of the private network. */
   name?: string
-  /** The private networks tags. */
+  /** Tags for the Private Network. */
   tags?: string[]
-  /** @deprecated Private network subnets CIDR (deprecated). */
+  /** @deprecated Private Network subnets CIDR (deprecated). */
   subnets?: string[]
 }
 
 export type DeletePrivateNetworkRequest = {
   /** Zone to target. If none is passed will use default zone from the config. */
   zone?: Zone
-  /** The private network ID. */
+  /** Private Network ID. */
   privateNetworkId: string
 }