Skip to content

Commit 594e38a

Browse files
authored
docs: update all products documentation (#86)
1 parent 9f77940 commit 594e38a

File tree

63 files changed

+5130
-5100
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+5130
-5100
lines changed

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

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ async def list_server_types(
6464
) -> ListServerTypesResponse:
6565
"""
6666
List all server types technical details.
67-
:param zone: Zone to target. If none is passed will use default zone from the config
67+
:param zone: Zone to target. If none is passed will use default zone from the config.
6868
:return: :class:`ListServerTypesResponse <ListServerTypesResponse>`
6969
7070
Usage:
@@ -91,8 +91,8 @@ async def get_server_type(
9191
) -> ServerType:
9292
"""
9393
Get a server technical details.
94-
:param zone: Zone to target. If none is passed will use default zone from the config
95-
:param server_type: Server type identifier
94+
:param zone: Zone to target. If none is passed will use default zone from the config.
95+
:param server_type: Server type identifier.
9696
:return: :class:`ServerType <ServerType>`
9797
9898
Usage:
@@ -122,10 +122,10 @@ async def create_server(
122122
) -> Server:
123123
"""
124124
Create a server.
125-
:param zone: Zone to target. If none is passed will use default zone from the config
126-
:param name: Create a server with this given name
127-
:param project_id: Create a server in the given project ID
128-
:param type_: Create a server of the given type
125+
:param zone: Zone to target. If none is passed will use default zone from the config.
126+
:param name: Create a server with this given name.
127+
:param project_id: Create a server in the given project ID.
128+
:param type_: Create a server of the given type.
129129
:return: :class:`Server <Server>`
130130
131131
Usage:
@@ -165,12 +165,12 @@ async def list_servers(
165165
) -> ListServersResponse:
166166
"""
167167
List all servers.
168-
:param zone: Zone to target. If none is passed will use default zone from the config
169-
:param order_by: The sort order of the returned servers
170-
:param project_id: List only servers of this project ID
171-
:param organization_id: List only servers of this organization ID
172-
:param page: A positive integer to choose the page to return
173-
:param page_size: A positive integer lower or equal to 100 to select the number of items to return
168+
:param zone: Zone to target. If none is passed will use default zone from the config.
169+
:param order_by: The sort order of the returned servers.
170+
:param project_id: List only servers of this project ID.
171+
:param organization_id: List only servers of this organization ID.
172+
:param page: A positive integer to choose the page to return.
173+
:param page_size: A positive integer lower or equal to 100 to select the number of items to return.
174174
:return: :class:`ListServersResponse <ListServersResponse>`
175175
176176
Usage:
@@ -209,12 +209,12 @@ async def list_servers_all(
209209
) -> List[Server]:
210210
"""
211211
List all servers.
212-
:param zone: Zone to target. If none is passed will use default zone from the config
213-
:param order_by: The sort order of the returned servers
214-
:param project_id: List only servers of this project ID
215-
:param organization_id: List only servers of this organization ID
216-
:param page: A positive integer to choose the page to return
217-
:param page_size: A positive integer lower or equal to 100 to select the number of items to return
212+
:param zone: Zone to target. If none is passed will use default zone from the config.
213+
:param order_by: The sort order of the returned servers.
214+
:param project_id: List only servers of this project ID.
215+
:param organization_id: List only servers of this organization ID.
216+
:param page: A positive integer to choose the page to return.
217+
:param page_size: A positive integer lower or equal to 100 to select the number of items to return.
218218
:return: :class:`List[ListServersResponse] <List[ListServersResponse]>`
219219
220220
Usage:
@@ -248,11 +248,11 @@ async def list_os(
248248
) -> ListOSResponse:
249249
"""
250250
List all Operating System (OS).
251-
:param zone: Zone to target. If none is passed will use default zone from the config
252-
:param page: A positive integer to choose the page to return
253-
:param page_size: A positive integer lower or equal to 100 to select the number of items to return
254-
:param server_type: List of compatible server type
255-
:param name: Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12")
251+
:param zone: Zone to target. If none is passed will use default zone from the config.
252+
:param page: A positive integer to choose the page to return.
253+
:param page_size: A positive integer lower or equal to 100 to select the number of items to return.
254+
:param server_type: List of compatible server type.
255+
:param name: Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12").
256256
:return: :class:`ListOSResponse <ListOSResponse>`
257257
258258
Usage:
@@ -288,11 +288,11 @@ async def list_os_all(
288288
) -> List[OS]:
289289
"""
290290
List all Operating System (OS).
291-
:param zone: Zone to target. If none is passed will use default zone from the config
292-
:param page: A positive integer to choose the page to return
293-
:param page_size: A positive integer lower or equal to 100 to select the number of items to return
294-
:param server_type: List of compatible server type
295-
:param name: Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12")
291+
:param zone: Zone to target. If none is passed will use default zone from the config.
292+
:param page: A positive integer to choose the page to return.
293+
:param page_size: A positive integer lower or equal to 100 to select the number of items to return.
294+
:param server_type: List of compatible server type.
295+
:param name: Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12").
296296
:return: :class:`List[ListOSResponse] <List[ListOSResponse]>`
297297
298298
Usage:
@@ -322,8 +322,8 @@ async def get_os(
322322
) -> OS:
323323
"""
324324
Get an Operating System (OS).
325-
:param zone: Zone to target. If none is passed will use default zone from the config
326-
:param os_id: UUID of the OS you want to get
325+
:param zone: Zone to target. If none is passed will use default zone from the config.
326+
:param os_id: UUID of the OS you want to get.
327327
:return: :class:`OS <OS>`
328328
329329
Usage:
@@ -351,8 +351,8 @@ async def get_server(
351351
) -> Server:
352352
"""
353353
Get a server.
354-
:param zone: Zone to target. If none is passed will use default zone from the config
355-
:param server_id: UUID of the server you want to get
354+
:param zone: Zone to target. If none is passed will use default zone from the config.
355+
:param server_id: UUID of the server you want to get.
356356
:return: :class:`Server <Server>`
357357
358358
Usage:
@@ -381,8 +381,8 @@ async def wait_for_server(
381381
) -> Server:
382382
"""
383383
Waits for :class:`Server <Server>` to be in a final state.
384-
:param zone: Zone to target. If none is passed will use default zone from the config
385-
:param server_id: UUID of the server you want to get
384+
:param zone: Zone to target. If none is passed will use default zone from the config.
385+
:param server_id: UUID of the server you want to get.
386386
:param options: The options for the waiter
387387
:return: :class:`Server <Server>`
388388
@@ -416,9 +416,9 @@ async def update_server(
416416
) -> Server:
417417
"""
418418
Update a server.
419-
:param zone: Zone to target. If none is passed will use default zone from the config
420-
:param server_id: UUID of the server you want to update
421-
:param name: Updated name for your server
419+
:param zone: Zone to target. If none is passed will use default zone from the config.
420+
:param server_id: UUID of the server you want to update.
421+
:param name: Updated name for your server.
422422
:return: :class:`Server <Server>`
423423
424424
Usage:
@@ -457,8 +457,8 @@ async def delete_server(
457457
) -> Optional[None]:
458458
"""
459459
Delete a server.
460-
:param zone: Zone to target. If none is passed will use default zone from the config
461-
:param server_id: UUID of the server you want to delete
460+
:param zone: Zone to target. If none is passed will use default zone from the config.
461+
:param server_id: UUID of the server you want to delete.
462462
463463
Usage:
464464
::
@@ -485,8 +485,8 @@ async def reboot_server(
485485
) -> Server:
486486
"""
487487
Reboot a server.
488-
:param zone: Zone to target. If none is passed will use default zone from the config
489-
:param server_id: UUID of the server you want to reboot
488+
:param zone: Zone to target. If none is passed will use default zone from the config.
489+
:param server_id: UUID of the server you want to reboot.
490490
:return: :class:`Server <Server>`
491491
492492
Usage:
@@ -514,8 +514,8 @@ async def reinstall_server(
514514
) -> Server:
515515
"""
516516
Reinstall a server.
517-
:param zone: Zone to target. If none is passed will use default zone from the config
518-
:param server_id: UUID of the server you want to reinstall
517+
:param zone: Zone to target. If none is passed will use default zone from the config.
518+
:param server_id: UUID of the server you want to reinstall.
519519
:return: :class:`Server <Server>`
520520
521521
Usage:

0 commit comments

Comments
 (0)