Merge branch 'main' into v1.5524.0

Author: jremy42

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

@@ -488,6 +488,9 @@ const unmarshalServerInstall = (data: unknown): ServerInstall => {
   return {
     hostname: data.hostname,
     osId: data.os_id,
+    partitioningSchema: data.partitioning_schema
+      ? unmarshalSchema(data.partitioning_schema)
+      : undefined,
     serviceUrl: data.service_url,
     serviceUser: data.service_user,
     sshKeyIds: data.ssh_key_ids,
@@ -759,12 +762,86 @@ export const marshalAddOptionServerRequest = (
   expires_at: request.expiresAt,
 })
 
+const marshalSchemaPartition = (
+  request: SchemaPartition,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  label: request.label,
+  number: request.number,
+  size: request.size,
+})
+
+const marshalSchemaPool = (
+  request: SchemaPool,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  devices: request.devices,
+  filesystem_options: request.filesystemOptions,
+  name: request.name,
+  options: request.options,
+  type: request.type,
+})
+
+const marshalSchemaDisk = (
+  request: SchemaDisk,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  device: request.device,
+  partitions: request.partitions.map(elt =>
+    marshalSchemaPartition(elt, defaults),
+  ),
+})
+
+const marshalSchemaFilesystem = (
+  request: SchemaFilesystem,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  device: request.device,
+  format: request.format,
+  mountpoint: request.mountpoint,
+})
+
+const marshalSchemaRAID = (
+  request: SchemaRAID,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  devices: request.devices,
+  level: request.level,
+  name: request.name,
+})
+
+const marshalSchemaZFS = (
+  request: SchemaZFS,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  pools: request.pools.map(elt => marshalSchemaPool(elt, defaults)),
+})
+
+export const marshalSchema = (
+  request: Schema,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  disks: request.disks.map(elt => marshalSchemaDisk(elt, defaults)),
+  filesystems: request.filesystems.map(elt =>
+    marshalSchemaFilesystem(elt, defaults),
+  ),
+  raids: request.raids.map(elt => marshalSchemaRAID(elt, defaults)),
+  zfs:
+    request.zfs !== undefined
+      ? marshalSchemaZFS(request.zfs, defaults)
+      : undefined,
+})
+
 const marshalCreateServerRequestInstall = (
   request: CreateServerRequestInstall,
   defaults: DefaultValues,
 ): Record<string, unknown> => ({
   hostname: request.hostname,
   os_id: request.osId,
+  partitioning_schema:
+    request.partitioningSchema !== undefined
+      ? marshalSchema(request.partitioningSchema, defaults)
+      : undefined,
   password: request.password,
   service_password: request.servicePassword,
   service_user: request.serviceUser,
@@ -805,6 +882,10 @@ export const marshalInstallServerRequest = (
 ): Record<string, unknown> => ({
   hostname: request.hostname,
   os_id: request.osId,
+  partitioning_schema:
+    request.partitioningSchema !== undefined
+      ? marshalSchema(request.partitioningSchema, defaults)
+      : undefined,
   password: request.password,
   service_password: request.servicePassword,
   service_user: request.serviceUser,

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

@@ -33,6 +33,8 @@ export type SchemaFilesystemFormat =
   | 'ext4'
   | 'swap'
   | 'zfs'
+  | 'xfs'
+
 
 export type SchemaPartitionLabel =
   | 'unknown_partition_label'
@@ -304,6 +306,8 @@ export interface ServerInstall {
   serviceUser: string
   /** Address of the installed service. */
   serviceUrl: string
+  /** Partitioning schema. */
+  partitioningSchema?: Schema
 }
 
 export interface ServerOption {
@@ -376,6 +380,8 @@ export interface CreateServerRequestInstall {
   serviceUser?: string
   /** Password used for the service to install. */
   servicePassword?: string
+  /** Partitioning schema. */
+  partitioningSchema?: Schema
 }
 
 export interface OS {
@@ -747,6 +753,8 @@ export type InstallServerRequest = {
   serviceUser?: string
   /** Password used for the service to install. */
   servicePassword?: string
+  /** Partitioning schema. */
+  partitioningSchema?: Schema
 }
 
 export type ListOSRequest = {

packages/clients/src/api/iam/v1alpha1/validation-rules.gen.ts

@@ -56,6 +56,9 @@ export const CreateSSHKeyRequest = {
 }
 
 export const CreateUserRequestMember = {
+  email: {
+    ignoreEmpty: true,
+  },
   password: {
     ignoreEmpty: true,
     maxLength: 72,

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

@@ -458,15 +458,14 @@ export class API extends ParentAPI {
    * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
    * keep the slot on the hypervisor. `reboot`: Stop the instance and restart
    * it. `backup`: Create an image with all the volumes of an Instance.
-   * `terminate`: Delete the Instance along with all attached volumes.
-   * `enable_routed_ip`: Migrate the Instance to the new network stack.
+   * `terminate`: Delete the Instance along with its attached volumes, except
+   * for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new
+   * network stack.
    *
-   * Keep in mind that terminating an Instance will result in the deletion of
-   * all attached volumes, including local and block storage. If you want to
-   * preserve your local volumes, you should use the `archive` action instead of
-   * `terminate`. Similarly, if you want to keep your block storage volumes, you
-   * must first detach them before issuing the `terminate` command. For more
-   * information, read the [Volumes](#path-volumes-list-volumes) documentation.
+   * 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.
    *
    * @param request - The request {@link ServerActionRequest}
    * @returns A Promise of ServerActionResponse

packages/clients/src/scw/__tests__/custom-marshalling.test.ts

@@ -4,12 +4,14 @@ import {
   marshalScwFile,
   marshalTimeSeries,
   marshalTimeSeriesPoint,
+  unmarshalDecimal,
   unmarshalMoney,
   unmarshalScwFile,
   unmarshalServiceInfo,
   unmarshalTimeSeries,
   unmarshalTimeSeriesPoint,
 } from '../custom-marshalling'
+import { Decimal } from '../custom-types'
 
 describe('unmarshalMoney', () => {
   it('returns the proper object', () => {
@@ -123,6 +125,29 @@ describe('unmarshalTimeSeries', () => {
   })
 })
 
+describe('unmarshalDecimal', () => {
+  it('returns the proper object', () => {
+    const decimal = unmarshalDecimal({
+      value: '0.01',
+    })
+    expect(decimal).toBeInstanceOf(Decimal)
+    expect(decimal?.toString()).toStrictEqual('0.01')
+  })
+
+  it('throws for invalid input', () => {
+    expect(unmarshalDecimal(null)).toBeNull()
+    expect(() => {
+      unmarshalDecimal({})
+    }).toThrow()
+    expect(() => {
+      unmarshalDecimal({ value: null })
+    }).toThrow()
+    expect(() => {
+      unmarshalDecimal({ value: 0.02 })
+    }).toThrow()
+  })
+})
+
 describe('marshalScwFile', () => {
   it('returns a the proper object', () =>
     expect(

packages/clients/src/scw/custom-marshalling.ts

@@ -115,13 +115,28 @@ export const unmarshalTimeSeries = (data: unknown) => {
  * @internal
  */
 export const unmarshalDecimal = (data: unknown) => {
-  if (!(typeof data === 'string')) {
+  if (!(typeof data === 'object')) {
     throw new TypeError(
-      `Unmarshalling the type 'Decimal' failed as data isn't a string.`,
+      `Unmarshalling the type 'Decimal' failed as data isn't an object.`,
+    )
+  }
+  if (data === null) {
+    return null
+  }
+
+  if (!('value' in data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Decimal' failed as data object does not have a 'value' key.`,
     )
   }
 
-  return new Decimal(data)
+  if (!(typeof data.value === 'string')) {
+    throw new TypeError(
+      `Unmarshalling the type 'Decimal' failed as 'value' is not a string.`,
+    )
+  }
+
+  return new Decimal(data.value)
 }
 
 /**
@@ -189,4 +204,6 @@ export const marshalTimeSeries = (
  *
  * @internal
  */
-export const marshalDecimal = (obj: Decimal): string => obj.toString()
+export const marshalDecimal = (obj: Decimal): { value: string } => ({
+  value: obj.toString(),
+})

packages/clients/src/scw/custom-types.ts

@@ -79,4 +79,6 @@ export class Decimal {
   }
 
   public toString = (): string => this.str
+
+  public marshal = (): object => ({ value: this.str })
 }