From 91e9288f827ee62603b0e8010cbaf30b36515680 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Wed, 20 Nov 2024 14:03:24 +0000 Subject: [PATCH] feat: update generated APIs --- .../clients/src/api/instance/v1/api.gen.ts | 46 +++++++++++++------ .../clients/src/api/instance/v1/types.gen.ts | 21 +++++---- 2 files changed, 45 insertions(+), 22 deletions(-) diff --git a/packages/clients/src/api/instance/v1/api.gen.ts b/packages/clients/src/api/instance/v1/api.gen.ts index 4ed8bbf0c..cda8139f1 100644 --- a/packages/clients/src/api/instance/v1/api.gen.ts +++ b/packages/clients/src/api/instance/v1/api.gen.ts @@ -456,10 +456,17 @@ export class API extends ParentAPI { * for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new * network stack. * - * Keep in mind that `terminate` an Instance will result in the deletion of - * `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type - * will only be detached. If you want to preserve your volumes, you should - * detach them before the Instance deletion or `terminate` action. + * The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and + * `scratch` volumes types, `sbs_volume` volumes type will only be detached. + * If you want to preserve your volumes, you should detach them before the + * Instance deletion or `terminate` action. + * + * The `backup` action can be done with: No `volumes` key in the body: an + * image is created with snapshots of all the server volumes, except for the + * `scratch` volumes types. `volumes` key in the body with a dictionary as + * value, in this dictionary volumes UUID as keys and empty dictionaries as + * values : an image is created with the snapshots of the volumes in `volumes` + * key. `scratch` volumes types can't be shapshotted. * * @param request - The request {@link ServerActionRequest} * @returns A Promise of ServerActionResponse @@ -1529,13 +1536,22 @@ export class API extends ParentAPI { /** * Get a volume or snapshot's migration plan. Given a volume or snapshot, - * returns the migration plan for a call to the "Apply a migration plan" - * endpoint. This plan will include zero or one volume, and zero or more - * snapshots, which will need to be migrated together. This endpoint does not - * perform the actual migration itself, the "Apply a migration plan" endpoint - * must be used. The validation_key value returned by this endpoint must be - * provided to the call to the "Apply a migration plan" endpoint to confirm - * that all resources listed in the plan should be migrated. + * returns the migration plan but does not perform the actual migration. To + * perform the migration, you have to call the [Migrate a volume and/or + * snapshots to + * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) + * endpoint afterward. The endpoint returns the resources that should be + * migrated together: + * + * - The volume and any snapshots created from the volume, if the call was made + * to plan a volume migration. + * - The base volume of the snapshot (if the volume is not deleted) and its + * related snapshots, if the call was made to plan a snapshot migration. The + * endpoint also returns the validation_key, which must be provided to the + * [Migrate a volume and/or snapshots to + * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) + * endpoint to confirm that all resources listed in the plan should be + * migrated. * * @param request - The request {@link PlanBlockMigrationRequest} * @returns A Promise of MigrationPlan @@ -1555,9 +1571,11 @@ export class API extends ParentAPI { /** * Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be - * used, the call to this endpoint must be preceded by a call to the "Plan a - * migration" endpoint. To migrate all resources mentioned in the migration - * plan, the validation_key returned in the plan must be provided. + * used, the call to this endpoint must be preceded by a call to the [Get a + * volume or snapshot's migration + * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To + * migrate all resources mentioned in the migration plan, the validation_key + * returned in the plan must be provided. * * @param request - The request {@link ApplyBlockMigrationRequest} */ diff --git a/packages/clients/src/api/instance/v1/types.gen.ts b/packages/clients/src/api/instance/v1/types.gen.ts index 3c5398509..251f8daba 100644 --- a/packages/clients/src/api/instance/v1/types.gen.ts +++ b/packages/clients/src/api/instance/v1/types.gen.ts @@ -763,7 +763,8 @@ export type ApplyBlockMigrationRequest = { zone?: Zone /** * The volume to migrate, along with potentially other resources, according to - * the migration plan generated with a call to the "Plan a migration" + * the migration plan generated with a call to the [Get a volume or snapshot's + * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) * endpoint. * * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set. @@ -771,16 +772,18 @@ export type ApplyBlockMigrationRequest = { volumeId?: string /** * The snapshot to migrate, along with potentially other resources, according - * to the migration plan generated with a call to the "Plan a migration" - * endpoint. + * to the migration plan generated with a call to the [Get a volume or + * snapshot's migration + * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. * * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set. */ snapshotId?: string /** - * A value to be retrieved from a call to the "Plan a migration" endpoint, to - * confirm that the volume and/or snapshots specified in said plan should be - * migrated. + * A value to be retrieved from a call to the [Get a volume or snapshot's + * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) + * endpoint, to confirm that the volume and/or snapshots specified in said + * plan should be migrated. */ validationKey: string } @@ -1725,8 +1728,10 @@ export interface MigrationPlan { */ snapshots: Snapshot[] /** - * A value to be passed to the call to the "Apply a migration plan" endpoint, - * to confirm that the execution of the plan is being requested. + * A value to be passed to the call to the [Migrate a volume and/or snapshots + * to + * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) + * endpoint, to confirm that the execution of the plan is being requested. */ validationKey: string }