Skip to content

docs(file): review File Storage API descriptions and documentation MTA-6002 #981

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 2 commits into from
May 14, 2025
Merged

docs(file): review File Storage API descriptions and documentation MTA-6002 #981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e32753e
feat: update generated APIs
scaleway-bot May 12, 2025
19509f0
Merge branch 'main' into v1.6506.0
Laure-di May 14, 2025
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
18 changes: 7 additions & 11 deletions scaleway-async/scaleway_async/file/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,13 @@ async def list_file_systems(
) -> ListFileSystemsResponse:
"""
List all filesystems.
Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
Use the order_by parameter to modify the sorting behavior.
Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: Criteria to use when ordering the list.
:param project_id: Filter by project ID.
:param page: Page number (starting at 1).
:param page_size: Number of entries per page (default: 20, max: 100).
:param name: Filter the return filesystems by their names.
:param name: Filter the returned filesystems by their names.
:param tags: Filter by tags. Only filesystems with one or more matching tags will be returned.
:return: :class:`ListFileSystemsResponse <ListFileSystemsResponse>`

Expand Down Expand Up @@ -177,14 +176,13 @@ async def list_file_systems_all(
) -> List[FileSystem]:
"""
List all filesystems.
Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
Use the order_by parameter to modify the sorting behavior.
Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: Criteria to use when ordering the list.
:param project_id: Filter by project ID.
:param page: Page number (starting at 1).
:param page_size: Number of entries per page (default: 20, max: 100).
:param name: Filter the return filesystems by their names.
:param name: Filter the returned filesystems by their names.
:param tags: Filter by tags. Only filesystems with one or more matching tags will be returned.
:return: :class:`List[FileSystem] <List[FileSystem]>`

Expand Down Expand Up @@ -223,8 +221,7 @@ async def list_attachments(
"""
List filesystems attachments.
List all existing attachments in a specified region.
By default, the attachments listed are ordered by creation date in ascending order.
This can be modified using the `order_by` field.
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param filesystem_id: UUID of the File Storage volume.
:param resource_id: Filter by resource ID.
Expand Down Expand Up @@ -274,8 +271,7 @@ async def list_attachments_all(
"""
List filesystems attachments.
List all existing attachments in a specified region.
By default, the attachments listed are ordered by creation date in ascending order.
This can be modified using the `order_by` field.
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param filesystem_id: UUID of the File Storage volume.
:param resource_id: Filter by resource ID.
Expand Down Expand Up @@ -317,7 +313,7 @@ async def create_file_system(
) -> FileSystem:
"""
Create a new filesystem.
To create a new filesystem, you need to provide a name, a size, and a project ID.
To create a new filesystem, you must specify a name, a size, and a project ID.
:param name: Name of the filesystem.
:param size: Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
:param region: Region to target. If none is passed will use default region from the config.
Expand Down
2 changes: 1 addition & 1 deletion scaleway-async/scaleway_async/file/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ class ListFileSystemsRequest:

name: Optional[str]
"""
Filter the return filesystems by their names.
Filter the returned filesystems by their names.
"""

tags: Optional[List[str]]
Expand Down
18 changes: 7 additions & 11 deletions scaleway/scaleway/file/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,13 @@ def list_file_systems(
) -> ListFileSystemsResponse:
"""
List all filesystems.
Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
Use the order_by parameter to modify the sorting behavior.
Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: Criteria to use when ordering the list.
:param project_id: Filter by project ID.
:param page: Page number (starting at 1).
:param page_size: Number of entries per page (default: 20, max: 100).
:param name: Filter the return filesystems by their names.
:param name: Filter the returned filesystems by their names.
:param tags: Filter by tags. Only filesystems with one or more matching tags will be returned.
:return: :class:`ListFileSystemsResponse <ListFileSystemsResponse>`

Expand Down Expand Up @@ -175,14 +174,13 @@ def list_file_systems_all(
) -> List[FileSystem]:
"""
List all filesystems.
Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
Use the order_by parameter to modify the sorting behavior.
Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: Criteria to use when ordering the list.
:param project_id: Filter by project ID.
:param page: Page number (starting at 1).
:param page_size: Number of entries per page (default: 20, max: 100).
:param name: Filter the return filesystems by their names.
:param name: Filter the returned filesystems by their names.
:param tags: Filter by tags. Only filesystems with one or more matching tags will be returned.
:return: :class:`List[FileSystem] <List[FileSystem]>`

Expand Down Expand Up @@ -221,8 +219,7 @@ def list_attachments(
"""
List filesystems attachments.
List all existing attachments in a specified region.
By default, the attachments listed are ordered by creation date in ascending order.
This can be modified using the `order_by` field.
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param filesystem_id: UUID of the File Storage volume.
:param resource_id: Filter by resource ID.
Expand Down Expand Up @@ -272,8 +269,7 @@ def list_attachments_all(
"""
List filesystems attachments.
List all existing attachments in a specified region.
By default, the attachments listed are ordered by creation date in ascending order.
This can be modified using the `order_by` field.
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
:param region: Region to target. If none is passed will use default region from the config.
:param filesystem_id: UUID of the File Storage volume.
:param resource_id: Filter by resource ID.
Expand Down Expand Up @@ -315,7 +311,7 @@ def create_file_system(
) -> FileSystem:
"""
Create a new filesystem.
To create a new filesystem, you need to provide a name, a size, and a project ID.
To create a new filesystem, you must specify a name, a size, and a project ID.
:param name: Name of the filesystem.
:param size: Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
:param region: Region to target. If none is passed will use default region from the config.
Expand Down
2 changes: 1 addition & 1 deletion scaleway/scaleway/file/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ class ListFileSystemsRequest:

name: Optional[str]
"""
Filter the return filesystems by their names.
Filter the returned filesystems by their names.
"""

tags: Optional[List[str]]
Expand Down