docs(apple): reworked apple silicon api doc (#89)

Author: scaleway-bot

scaleway-async/scaleway_async/applesilicon/v1alpha1/api.py

@@ -44,7 +44,7 @@ class ApplesiliconV1Alpha1API(API):
     """
     Apple silicon.
 
-    Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation).
+    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 computers and much more.
 
@@ -63,7 +63,7 @@ async def list_server_types(
         zone: Optional[Zone] = None,
     ) -> ListServerTypesResponse:
         """
-        List all server types technical details.
+        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 zone: Zone to target. If none is passed will use default zone from the config.
         :return: :class:`ListServerTypesResponse <ListServerTypesResponse>`
 
@@ -121,7 +121,7 @@ async def create_server(
         project_id: Optional[str] = None,
     ) -> Server:
         """
-        Create a server.
+        Create a new server in the targeted zone, specifying its configuration including name and type.
         :param zone: Zone to target. If none is passed will use default zone from the config.
         :param name: Create a server with this given name.
         :param project_id: Create a server in the given project ID.
@@ -164,13 +164,13 @@ async def list_servers(
         page_size: Optional[int] = None,
     ) -> ListServersResponse:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
-        :param order_by: The sort order of the returned servers.
-        :param project_id: List only servers of this project ID.
-        :param organization_id: List only servers of this organization ID.
-        :param page: A positive integer to choose the page to return.
-        :param page_size: A positive integer lower or equal to 100 to select the number of items to return.
+        :param order_by: Sort order of the returned servers.
+        :param project_id: Only list servers of this project ID.
+        :param organization_id: Only list servers of this Organization ID.
+        :param page: Positive integer to choose the page to return.
+        :param page_size: Positive integer lower or equal to 100 to select the number of items to return.
         :return: :class:`ListServersResponse <ListServersResponse>`
 
         Usage:
@@ -208,13 +208,13 @@ async def list_servers_all(
         page_size: Optional[int] = None,
     ) -> List[Server]:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
-        :param order_by: The sort order of the returned servers.
-        :param project_id: List only servers of this project ID.
-        :param organization_id: List only servers of this organization ID.
-        :param page: A positive integer to choose the page to return.
-        :param page_size: A positive integer lower or equal to 100 to select the number of items to return.
+        :param order_by: Sort order of the returned servers.
+        :param project_id: Only list servers of this project ID.
+        :param organization_id: Only list servers of this Organization ID.
+        :param page: Positive integer to choose the page to return.
+        :param page_size: Positive integer lower or equal to 100 to select the number of items to return.
         :return: :class:`List[ListServersResponse] <List[ListServersResponse]>`
 
         Usage:
@@ -247,12 +247,12 @@ async def list_os(
         name: Optional[str] = None,
     ) -> ListOSResponse:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
-        :param page: A positive integer to choose the page to return.
-        :param page_size: A positive integer lower or equal to 100 to select the number of items to return.
-        :param server_type: List of compatible server type.
-        :param name: Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12").
+        :param page: Positive integer to choose the page to return.
+        :param page_size: Positive integer lower or equal to 100 to select the number of items to return.
+        :param server_type: List of compatible server types.
+        :param name: Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")).
         :return: :class:`ListOSResponse <ListOSResponse>`
 
         Usage:
@@ -287,12 +287,12 @@ async def list_os_all(
         name: Optional[str] = None,
     ) -> List[OS]:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
-        :param page: A positive integer to choose the page to return.
-        :param page_size: A positive integer lower or equal to 100 to select the number of items to return.
-        :param server_type: List of compatible server type.
-        :param name: Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12").
+        :param page: Positive integer to choose the page to return.
+        :param page_size: Positive integer lower or equal to 100 to select the number of items to return.
+        :param server_type: List of compatible server types.
+        :param name: Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")).
         :return: :class:`List[ListOSResponse] <List[ListOSResponse]>`
 
         Usage:
@@ -321,7 +321,7 @@ async def get_os(
         zone: Optional[Zone] = None,
     ) -> OS:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
         :param os_id: UUID of the OS you want to get.
         :return: :class:`OS <OS>`
@@ -350,7 +350,7 @@ async def get_server(
         zone: Optional[Zone] = None,
     ) -> Server:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
         :param server_id: UUID of the server you want to get.
         :return: :class:`Server <Server>`
@@ -415,7 +415,7 @@ async def update_server(
         zone: Optional[Zone] = None,
     ) -> Server:
         """
-        Update a server.
+        Update the parameters of an existing Apple silicon server, specified by its server ID.
         :param zone: Zone to target. If none is passed will use default zone from the config.
         :param server_id: UUID of the server you want to update.
         :param name: Updated name for your server.
@@ -456,7 +456,7 @@ async def delete_server(
         zone: Optional[Zone] = None,
     ) -> Optional[None]:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
         :param server_id: UUID of the server you want to delete.
 
@@ -484,7 +484,7 @@ async def reboot_server(
         zone: Optional[Zone] = None,
     ) -> Server:
         """
-        Reboot a server.
+        Reboot an existing Apple silicon server, specified by its server ID.
         :param zone: Zone to target. If none is passed will use default zone from the config.
         :param server_id: UUID of the server you want to reboot.
         :return: :class:`Server <Server>`
@@ -513,7 +513,7 @@ async def reinstall_server(
         zone: Optional[Zone] = None,
     ) -> Server:
         """
-        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 zone: Zone to target. If none is passed will use default zone from the config.
         :param server_id: UUID of the server you want to reinstall.
         :return: :class:`Server <Server>`

scaleway-async/scaleway_async/applesilicon/v1alpha1/types.py

@@ -54,7 +54,7 @@ class ListOSResponse:
 
     total_count: int
     """
-    Total number of os.
+    Total number of OS.
     """
 
     os: List[OS]
@@ -71,7 +71,7 @@ class ListServerTypesResponse:
 
     server_types: List[ServerType]
     """
-    The available server types.
+    Available server types.
     """
 
 
@@ -83,12 +83,12 @@ class ListServersResponse:
 
     total_count: int
     """
-    The total number of servers.
+    Total number of servers.
     """
 
     servers: List[Server]
     """
-    The paginated returned servers.
+    Paginated returned servers.
     """
 
 
@@ -100,17 +100,17 @@ class OS:
 
     id: str
     """
-    The OS unique ID.
+    Unique ID of the OS.
     """
 
     name: str
     """
-    The OS name.
+    OS name.
     """
 
     label: str
     """
-    The OS name as it should be displayed.
+    OS name as it should be displayed.
     """
 
     image_url: str
@@ -172,22 +172,22 @@ class Server:
 
     created_at: Optional[datetime]
     """
-    The date at which the server was created.
+    Date on which the server was created.
     """
 
     updated_at: Optional[datetime]
     """
-    The date at which the server was last updated.
+    Date on which the server was last updated.
     """
 
     deletable_at: Optional[datetime]
     """
-    The date at which the server was last deleted.
+    Date on which the server was last deleted.
     """
 
     zone: Zone
     """
-    The zone of the server.
+    Zone of the server.
     """
 
 
@@ -302,27 +302,27 @@ class ListServersRequest:
 
     order_by: Optional[ListServersRequestOrderBy]
     """
-    The sort order of the returned servers.
+    Sort order of the returned servers.
     """
 
     project_id: Optional[str]
     """
-    List only servers of this project ID.
+    Only list servers of this project ID.
     """
 
     organization_id: Optional[str]
     """
-    List only servers of this organization ID.
+    Only list servers of this Organization ID.
     """
 
     page: Optional[int]
     """
-    A positive integer to choose the page to return.
+    Positive integer to choose the page to return.
     """
 
     page_size: Optional[int]
     """
-    A positive integer lower or equal to 100 to select the number of items to return.
+    Positive integer lower or equal to 100 to select the number of items to return.
     """
 
 
@@ -335,22 +335,22 @@ class ListOSRequest:
 
     page: Optional[int]
     """
-    A positive integer to choose the page to return.
+    Positive integer to choose the page to return.
     """
 
     page_size: Optional[int]
     """
-    A positive integer lower or equal to 100 to select the number of items to return.
+    Positive integer lower or equal to 100 to select the number of items to return.
     """
 
     server_type: Optional[str]
     """
-    List of compatible server type.
+    List of compatible server types.
     """
 
     name: Optional[str]
     """
-    Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12").
+    Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")).
     """