Skip to content

docs(b‎aremetal): elastic metal servers #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 24, 2023
Merged

docs(b‎aremetal): elastic metal servers #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions scaleway-async/scaleway_async/baremetal/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ async def list_servers(
option_id: Optional[str] = None,
) -> ListServersResponse:
"""
List Elastic Metal servers for an organization.
List Elastic Metal servers for a specific organization.
List Elastic Metal servers for an Organization.
List Elastic Metal servers for a specific Organization.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Number of servers per page.
Expand Down Expand Up @@ -167,8 +167,8 @@ async def list_servers_all(
option_id: Optional[str] = None,
) -> List[Server]:
"""
List Elastic Metal servers for an organization.
List Elastic Metal servers for a specific organization.
List Elastic Metal servers for an Organization.
List Elastic Metal servers for a specific Organization.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Number of servers per page.
Expand Down Expand Up @@ -1157,12 +1157,12 @@ async def list_settings(
) -> ListSettingsResponse:
"""
List all settings.
Return all settings for a project ID.
Return all settings for a Project ID.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Set the maximum list size.
:param order_by: Sort order for items in the response.
:param project_id: ID of the project.
:param project_id: ID of the Project.
:return: :class:`ListSettingsResponse <ListSettingsResponse>`

Usage:
Expand Down Expand Up @@ -1198,12 +1198,12 @@ async def list_settings_all(
) -> List[Setting]:
"""
List all settings.
Return all settings for a project ID.
Return all settings for a Project ID.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Set the maximum list size.
:param order_by: Sort order for items in the response.
:param project_id: ID of the project.
:param project_id: ID of the Project.
:return: :class:`List[ListSettingsResponse] <List[ListSettingsResponse]>`

Usage:
Expand Down Expand Up @@ -1234,7 +1234,7 @@ async def update_setting(
) -> Setting:
"""
Update setting.
Update a setting for a project ID (enable or disable).
Update a setting for a Project ID (enable or disable).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param setting_id: ID of the setting.
:param enabled: Defines whether the setting is enabled.
Expand Down Expand Up @@ -1345,8 +1345,8 @@ async def get_os(
zone: Optional[Zone] = None,
) -> OS:
"""
Get an OS with an ID.
Return specific OS for the ID.
Get OS with an ID.
Return the specific OS for the ID.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param os_id: ID of the OS.
:return: :class:`OS <OS>`
Expand Down
4 changes: 2 additions & 2 deletions scaleway-async/scaleway_async/baremetal/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1037,7 +1037,7 @@ class Setting:

project_id: str
"""
ID of the project ID.
ID of the Project ID.
"""

enabled: bool
Expand Down Expand Up @@ -1553,7 +1553,7 @@ class ListSettingsRequest:

project_id: Optional[str]
"""
ID of the project.
ID of the Project.
"""


Expand Down
22 changes: 11 additions & 11 deletions scaleway/scaleway/baremetal/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ def list_servers(
option_id: Optional[str] = None,
) -> ListServersResponse:
"""
List Elastic Metal servers for an organization.
List Elastic Metal servers for a specific organization.
List Elastic Metal servers for an Organization.
List Elastic Metal servers for a specific Organization.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Number of servers per page.
Expand Down Expand Up @@ -167,8 +167,8 @@ def list_servers_all(
option_id: Optional[str] = None,
) -> List[Server]:
"""
List Elastic Metal servers for an organization.
List Elastic Metal servers for a specific organization.
List Elastic Metal servers for an Organization.
List Elastic Metal servers for a specific Organization.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Number of servers per page.
Expand Down Expand Up @@ -1157,12 +1157,12 @@ def list_settings(
) -> ListSettingsResponse:
"""
List all settings.
Return all settings for a project ID.
Return all settings for a Project ID.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Set the maximum list size.
:param order_by: Sort order for items in the response.
:param project_id: ID of the project.
:param project_id: ID of the Project.
:return: :class:`ListSettingsResponse <ListSettingsResponse>`

Usage:
Expand Down Expand Up @@ -1198,12 +1198,12 @@ def list_settings_all(
) -> List[Setting]:
"""
List all settings.
Return all settings for a project ID.
Return all settings for a Project ID.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param page: Page number.
:param page_size: Set the maximum list size.
:param order_by: Sort order for items in the response.
:param project_id: ID of the project.
:param project_id: ID of the Project.
:return: :class:`List[ListSettingsResponse] <List[ListSettingsResponse]>`

Usage:
Expand Down Expand Up @@ -1234,7 +1234,7 @@ def update_setting(
) -> Setting:
"""
Update setting.
Update a setting for a project ID (enable or disable).
Update a setting for a Project ID (enable or disable).
:param zone: Zone to target. If none is passed will use default zone from the config.
:param setting_id: ID of the setting.
:param enabled: Defines whether the setting is enabled.
Expand Down Expand Up @@ -1345,8 +1345,8 @@ def get_os(
zone: Optional[Zone] = None,
) -> OS:
"""
Get an OS with an ID.
Return specific OS for the ID.
Get OS with an ID.
Return the specific OS for the ID.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param os_id: ID of the OS.
:return: :class:`OS <OS>`
Expand Down
4 changes: 2 additions & 2 deletions scaleway/scaleway/baremetal/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1037,7 +1037,7 @@ class Setting:

project_id: str
"""
ID of the project ID.
ID of the Project ID.
"""

enabled: bool
Expand Down Expand Up @@ -1553,7 +1553,7 @@ class ListSettingsRequest:

project_id: Optional[str]
"""
ID of the project.
ID of the Project.
"""


Expand Down