Skip to content

Commit 5460737

Browse files
authored
docs(b‎aremetal): elastic metal servers (#160)
1 parent b153ee9 commit 5460737

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ async def list_servers(
110110
option_id: Optional[str] = None,
111111
) -> ListServersResponse:
112112
"""
113-
List Elastic Metal servers for an organization.
114-
List Elastic Metal servers for a specific organization.
113+
List Elastic Metal servers for an Organization.
114+
List Elastic Metal servers for a specific Organization.
115115
:param zone: Zone to target. If none is passed will use default zone from the config.
116116
:param page: Page number.
117117
:param page_size: Number of servers per page.
@@ -167,8 +167,8 @@ async def list_servers_all(
167167
option_id: Optional[str] = None,
168168
) -> List[Server]:
169169
"""
170-
List Elastic Metal servers for an organization.
171-
List Elastic Metal servers for a specific organization.
170+
List Elastic Metal servers for an Organization.
171+
List Elastic Metal servers for a specific Organization.
172172
:param zone: Zone to target. If none is passed will use default zone from the config.
173173
:param page: Page number.
174174
:param page_size: Number of servers per page.
@@ -1157,12 +1157,12 @@ async def list_settings(
11571157
) -> ListSettingsResponse:
11581158
"""
11591159
List all settings.
1160-
Return all settings for a project ID.
1160+
Return all settings for a Project ID.
11611161
:param zone: Zone to target. If none is passed will use default zone from the config.
11621162
:param page: Page number.
11631163
:param page_size: Set the maximum list size.
11641164
:param order_by: Sort order for items in the response.
1165-
:param project_id: ID of the project.
1165+
:param project_id: ID of the Project.
11661166
:return: :class:`ListSettingsResponse <ListSettingsResponse>`
11671167
11681168
Usage:
@@ -1198,12 +1198,12 @@ async def list_settings_all(
11981198
) -> List[Setting]:
11991199
"""
12001200
List all settings.
1201-
Return all settings for a project ID.
1201+
Return all settings for a Project ID.
12021202
:param zone: Zone to target. If none is passed will use default zone from the config.
12031203
:param page: Page number.
12041204
:param page_size: Set the maximum list size.
12051205
:param order_by: Sort order for items in the response.
1206-
:param project_id: ID of the project.
1206+
:param project_id: ID of the Project.
12071207
:return: :class:`List[ListSettingsResponse] <List[ListSettingsResponse]>`
12081208
12091209
Usage:
@@ -1234,7 +1234,7 @@ async def update_setting(
12341234
) -> Setting:
12351235
"""
12361236
Update setting.
1237-
Update a setting for a project ID (enable or disable).
1237+
Update a setting for a Project ID (enable or disable).
12381238
:param zone: Zone to target. If none is passed will use default zone from the config.
12391239
:param setting_id: ID of the setting.
12401240
:param enabled: Defines whether the setting is enabled.
@@ -1345,8 +1345,8 @@ async def get_os(
13451345
zone: Optional[Zone] = None,
13461346
) -> OS:
13471347
"""
1348-
Get an OS with an ID.
1349-
Return specific OS for the ID.
1348+
Get OS with an ID.
1349+
Return the specific OS for the ID.
13501350
:param zone: Zone to target. If none is passed will use default zone from the config.
13511351
:param os_id: ID of the OS.
13521352
:return: :class:`OS <OS>`

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1037,7 +1037,7 @@ class Setting:
10371037

10381038
project_id: str
10391039
"""
1040-
ID of the project ID.
1040+
ID of the Project ID.
10411041
"""
10421042

10431043
enabled: bool
@@ -1553,7 +1553,7 @@ class ListSettingsRequest:
15531553

15541554
project_id: Optional[str]
15551555
"""
1556-
ID of the project.
1556+
ID of the Project.
15571557
"""
15581558

15591559

scaleway/scaleway/baremetal/v1/api.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ def list_servers(
110110
option_id: Optional[str] = None,
111111
) -> ListServersResponse:
112112
"""
113-
List Elastic Metal servers for an organization.
114-
List Elastic Metal servers for a specific organization.
113+
List Elastic Metal servers for an Organization.
114+
List Elastic Metal servers for a specific Organization.
115115
:param zone: Zone to target. If none is passed will use default zone from the config.
116116
:param page: Page number.
117117
:param page_size: Number of servers per page.
@@ -167,8 +167,8 @@ def list_servers_all(
167167
option_id: Optional[str] = None,
168168
) -> List[Server]:
169169
"""
170-
List Elastic Metal servers for an organization.
171-
List Elastic Metal servers for a specific organization.
170+
List Elastic Metal servers for an Organization.
171+
List Elastic Metal servers for a specific Organization.
172172
:param zone: Zone to target. If none is passed will use default zone from the config.
173173
:param page: Page number.
174174
:param page_size: Number of servers per page.
@@ -1157,12 +1157,12 @@ def list_settings(
11571157
) -> ListSettingsResponse:
11581158
"""
11591159
List all settings.
1160-
Return all settings for a project ID.
1160+
Return all settings for a Project ID.
11611161
:param zone: Zone to target. If none is passed will use default zone from the config.
11621162
:param page: Page number.
11631163
:param page_size: Set the maximum list size.
11641164
:param order_by: Sort order for items in the response.
1165-
:param project_id: ID of the project.
1165+
:param project_id: ID of the Project.
11661166
:return: :class:`ListSettingsResponse <ListSettingsResponse>`
11671167
11681168
Usage:
@@ -1198,12 +1198,12 @@ def list_settings_all(
11981198
) -> List[Setting]:
11991199
"""
12001200
List all settings.
1201-
Return all settings for a project ID.
1201+
Return all settings for a Project ID.
12021202
:param zone: Zone to target. If none is passed will use default zone from the config.
12031203
:param page: Page number.
12041204
:param page_size: Set the maximum list size.
12051205
:param order_by: Sort order for items in the response.
1206-
:param project_id: ID of the project.
1206+
:param project_id: ID of the Project.
12071207
:return: :class:`List[ListSettingsResponse] <List[ListSettingsResponse]>`
12081208
12091209
Usage:
@@ -1234,7 +1234,7 @@ def update_setting(
12341234
) -> Setting:
12351235
"""
12361236
Update setting.
1237-
Update a setting for a project ID (enable or disable).
1237+
Update a setting for a Project ID (enable or disable).
12381238
:param zone: Zone to target. If none is passed will use default zone from the config.
12391239
:param setting_id: ID of the setting.
12401240
:param enabled: Defines whether the setting is enabled.
@@ -1345,8 +1345,8 @@ def get_os(
13451345
zone: Optional[Zone] = None,
13461346
) -> OS:
13471347
"""
1348-
Get an OS with an ID.
1349-
Return specific OS for the ID.
1348+
Get OS with an ID.
1349+
Return the specific OS for the ID.
13501350
:param zone: Zone to target. If none is passed will use default zone from the config.
13511351
:param os_id: ID of the OS.
13521352
:return: :class:`OS <OS>`

scaleway/scaleway/baremetal/v1/types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1037,7 +1037,7 @@ class Setting:
10371037

10381038
project_id: str
10391039
"""
1040-
ID of the project ID.
1040+
ID of the Project ID.
10411041
"""
10421042

10431043
enabled: bool
@@ -1553,7 +1553,7 @@ class ListSettingsRequest:
15531553

15541554
project_id: Optional[str]
15551555
"""
1556-
ID of the project.
1556+
ID of the Project.
15571557
"""
15581558

15591559

0 commit comments

Comments
 (0)