Skip to content

Commit e1ab116

Browse files
scaleway-botremyleoneLaure-di
committed
docs(file): review File Storage API descriptions and documentation MTA-6002 (scaleway#4714)
Co-authored-by: Rémy Léone <rleone@scaleway.com> Co-authored-by: Laure-di <62625835+Laure-di@users.noreply.github.com> Co-authored-by: Laure-di <lmasson@scaleway.com>
1 parent ef98fbc commit e1ab116

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

internal/namespaces/file/v1alpha1/file_cli.go

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,8 @@ func fileFilesystemGet() *core.Command {
8989

9090
func fileFilesystemList() *core.Command {
9191
return &core.Command{
92-
Short: `List all filesystems`,
93-
Long: `Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
94-
Use the order_by parameter to modify the sorting behavior.`,
92+
Short: `List all filesystems`,
93+
Long: `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.`,
9594
Namespace: "file",
9695
Resource: "filesystem",
9796
Verb: "list",
@@ -120,7 +119,7 @@ Use the order_by parameter to modify the sorting behavior.`,
120119
},
121120
{
122121
Name: "name",
123-
Short: `Filter the return filesystems by their names`,
122+
Short: `Filter the returned filesystems by their names`,
124123
Required: false,
125124
Deprecated: false,
126125
Positional: false,
@@ -161,8 +160,7 @@ func fileAttachmentList() *core.Command {
161160
return &core.Command{
162161
Short: `List filesystems attachments`,
163162
Long: `List all existing attachments in a specified region.
164-
By default, the attachments listed are ordered by creation date in ascending order.
165-
This can be modified using the ` + "`" + `order_by` + "`" + ` field.`,
163+
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the ` + "`" + `order_by` + "`" + ` field.`,
166164
Namespace: "file",
167165
Resource: "attachment",
168166
Verb: "list",
@@ -229,7 +227,7 @@ This can be modified using the ` + "`" + `order_by` + "`" + ` field.`,
229227
func fileFilesystemCreate() *core.Command {
230228
return &core.Command{
231229
Short: `Create a new filesystem`,
232-
Long: `To create a new filesystem, you need to provide a name, a size, and a project ID.`,
230+
Long: `To create a new filesystem, you must specify a name, a size, and a project ID.`,
233231
Namespace: "file",
234232
Resource: "filesystem",
235233
Verb: "create",

internal/namespaces/key_manager/v1alpha1/key_manager_cli.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
"reflect"
99

1010
"github.com/scaleway/scaleway-cli/v2/core"
11-
"github.com/scaleway/scaleway-sdk-go/api/key_manager/v1alpha1"
11+
key_manager "github.com/scaleway/scaleway-sdk-go/api/key_manager/v1alpha1"
1212
"github.com/scaleway/scaleway-sdk-go/scw"
1313
)
1414

0 commit comments

Comments
 (0)