Skip to content

Commit b0f9021

Browse files
authored
docs(file): review File Storage API descriptions and documentation MTA-6002 (scaleway#2553)
1 parent d650388 commit b0f9021

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

api/file/v1alpha1/file_sdk.go

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ type ListFileSystemsRequest struct {
334334
// PageSize: number of entries per page (default: 20, max: 100).
335335
PageSize *uint32 `json:"-"`
336336

337-
// Name: filter the return filesystems by their names.
337+
// Name: filter the returned filesystems by their names.
338338
Name *string `json:"-"`
339339

340340
// Tags: filter by tags. Only filesystems with one or more matching tags will be returned.
@@ -435,8 +435,7 @@ func (s *API) GetFileSystem(req *GetFileSystemRequest, opts ...scw.RequestOption
435435
return &resp, nil
436436
}
437437

438-
// ListFileSystems: Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
439-
// Use the order_by parameter to modify the sorting behavior.
438+
// ListFileSystems: 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.
440439
func (s *API) ListFileSystems(req *ListFileSystemsRequest, opts ...scw.RequestOption) (*ListFileSystemsResponse, error) {
441440
var err error
442441

@@ -478,8 +477,7 @@ func (s *API) ListFileSystems(req *ListFileSystemsRequest, opts ...scw.RequestOp
478477
}
479478

480479
// ListAttachments: List all existing attachments in a specified region.
481-
// By default, the attachments listed are ordered by creation date in ascending order.
482-
// This can be modified using the `order_by` field.
480+
// By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
483481
func (s *API) ListAttachments(req *ListAttachmentsRequest, opts ...scw.RequestOption) (*ListAttachmentsResponse, error) {
484482
var err error
485483

@@ -525,7 +523,7 @@ func (s *API) ListAttachments(req *ListAttachmentsRequest, opts ...scw.RequestOp
525523
return &resp, nil
526524
}
527525

528-
// CreateFileSystem: To create a new filesystem, you need to provide a name, a size, and a project ID.
526+
// CreateFileSystem: To create a new filesystem, you must specify a name, a size, and a project ID.
529527
func (s *API) CreateFileSystem(req *CreateFileSystemRequest, opts ...scw.RequestOption) (*FileSystem, error) {
530528
var err error
531529

0 commit comments

Comments
 (0)