feat(baremetal): add GetDefaultPartitioningRequest (#665)

Author: scaleway-bot

scaleway-async/scaleway_async/baremetal/v1/__init__.py

@@ -8,6 +8,11 @@
 from .types import ListSettingsRequestOrderBy
 from .types import OfferStock
 from .types import OfferSubscriptionPeriod
+from .types import SchemaFilesystemFormat
+from .types import SchemaLogicalVolumeType
+from .types import SchemaPartitionLabel
+from .types import SchemaPoolType
+from .types import SchemaRAIDLevel
 from .types import ServerBootType
 from .types import ServerInstallStatus
 from .content import SERVER_INSTALL_TRANSIENT_STATUSES
@@ -18,11 +23,21 @@
 from .types import ServerStatus
 from .content import SERVER_TRANSIENT_STATUSES
 from .types import SettingType
+from .types import SchemaLogicalVolume
+from .types import SchemaPartition
+from .types import SchemaVolumeGroup
+from .types import SchemaPool
+from .types import SchemaDisk
+from .types import SchemaFilesystem
+from .types import SchemaLVM
+from .types import SchemaRAID
+from .types import SchemaZFS
 from .types import CertificationOption
 from .types import LicenseOption
 from .types import PrivateNetworkOption
 from .types import PublicBandwidthOption
 from .types import RemoteAccessOption
+from .types import Schema
 from .types import OSOSField
 from .types import CPU
 from .types import Disk
@@ -48,6 +63,7 @@
 from .types import DeleteOptionServerRequest
 from .types import DeleteServerRequest
 from .types import GetBMCAccessRequest
+from .types import GetDefaultPartitioningSchemaRequest
 from .types import GetOSRequest
 from .types import GetOfferRequest
 from .types import GetOptionRequest
@@ -81,6 +97,7 @@
 from .types import UpdateIPRequest
 from .types import UpdateServerRequest
 from .types import UpdateSettingRequest
+from .types import ValidatePartitioningSchemaRequest
 from .api import BaremetalV1API
 from .api import BaremetalV1PrivateNetworkAPI
 
@@ -93,6 +110,11 @@
     "ListSettingsRequestOrderBy",
     "OfferStock",
     "OfferSubscriptionPeriod",
+    "SchemaFilesystemFormat",
+    "SchemaLogicalVolumeType",
+    "SchemaPartitionLabel",
+    "SchemaPoolType",
+    "SchemaRAIDLevel",
     "ServerBootType",
     "ServerInstallStatus",
     "SERVER_INSTALL_TRANSIENT_STATUSES",
@@ -103,11 +125,21 @@
     "ServerStatus",
     "SERVER_TRANSIENT_STATUSES",
     "SettingType",
+    "SchemaLogicalVolume",
+    "SchemaPartition",
+    "SchemaVolumeGroup",
+    "SchemaPool",
+    "SchemaDisk",
+    "SchemaFilesystem",
+    "SchemaLVM",
+    "SchemaRAID",
+    "SchemaZFS",
     "CertificationOption",
     "LicenseOption",
     "PrivateNetworkOption",
     "PublicBandwidthOption",
     "RemoteAccessOption",
+    "Schema",
     "OSOSField",
     "CPU",
     "Disk",
@@ -133,6 +165,7 @@
     "DeleteOptionServerRequest",
     "DeleteServerRequest",
     "GetBMCAccessRequest",
+    "GetDefaultPartitioningSchemaRequest",
     "GetOSRequest",
     "GetOfferRequest",
     "GetOptionRequest",
@@ -166,6 +199,7 @@
     "UpdateIPRequest",
     "UpdateServerRequest",
     "UpdateSettingRequest",
+    "ValidatePartitioningSchemaRequest",
     "BaremetalV1API",
     "BaremetalV1PrivateNetworkAPI",
 ]

scaleway-async/scaleway_async/baremetal/v1/api.py

@@ -41,6 +41,7 @@
     PrivateNetworkApiAddServerPrivateNetworkRequest,
     PrivateNetworkApiSetServerPrivateNetworksRequest,
     RebootServerRequest,
+    Schema,
     Server,
     ServerEvent,
     ServerPrivateNetwork,
@@ -51,11 +52,13 @@
     UpdateIPRequest,
     UpdateServerRequest,
     UpdateSettingRequest,
+    ValidatePartitioningSchemaRequest,
 )
 from .content import (
     SERVER_TRANSIENT_STATUSES,
 )
 from .marshalling import (
+    unmarshal_Schema,
     unmarshal_IP,
     unmarshal_OS,
     unmarshal_Offer,
@@ -84,6 +87,7 @@
     marshal_UpdateIPRequest,
     marshal_UpdateServerRequest,
     marshal_UpdateSettingRequest,
+    marshal_ValidatePartitioningSchemaRequest,
 )
 
 
@@ -709,6 +713,87 @@ async def list_server_events_all(
             },
         )
 
+    async def get_default_partitioning_schema(
+        self,
+        *,
+        offer_id: str,
+        os_id: str,
+        zone: Optional[Zone] = None,
+    ) -> Schema:
+        """
+        Get default partitioning schema.
+        Get the default partitioning schema for the given offer ID and OS ID.
+        :param offer_id: ID of the offer.
+        :param os_id: ID of the OS.
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :return: :class:`Schema <Schema>`
+
+        Usage:
+        ::
+
+            result = await api.get_default_partitioning_schema(
+                offer_id="example",
+                os_id="example",
+            )
+        """
+
+        param_zone = validate_path_param("zone", zone or self.client.default_zone)
+
+        res = self._request(
+            "GET",
+            f"/baremetal/v1/zones/{param_zone}/partitioning-schemas/default",
+            params={
+                "offer_id": offer_id,
+                "os_id": os_id,
+            },
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_Schema(res.json())
+
+    async def validate_partitioning_schema(
+        self,
+        *,
+        offer_id: str,
+        os_id: str,
+        zone: Optional[Zone] = None,
+        partitioning_schema: Optional[Schema] = None,
+    ) -> None:
+        """
+        Validate client partitioning schema.
+        Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.
+        :param offer_id: Offer ID of the server.
+        :param os_id: OS ID.
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param partitioning_schema: Partitioning schema.
+
+        Usage:
+        ::
+
+            result = await api.validate_partitioning_schema(
+                offer_id="example",
+                os_id="example",
+            )
+        """
+
+        param_zone = validate_path_param("zone", zone or self.client.default_zone)
+
+        res = self._request(
+            "POST",
+            f"/baremetal/v1/zones/{param_zone}/partitioning-schemas/validate",
+            body=marshal_ValidatePartitioningSchemaRequest(
+                ValidatePartitioningSchemaRequest(
+                    offer_id=offer_id,
+                    os_id=os_id,
+                    zone=zone,
+                    partitioning_schema=partitioning_schema,
+                ),
+                self.client,
+            ),
+        )
+
+        self._throw_on_error(res)
+
     async def start_bmc_access(
         self,
         *,