Skip to content

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

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

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ec6f4f
feat: update generated APIs
scaleway-bot May 12, 2025
49bed33
Merge branch 'master' into v1.6506.0
remyleone May 13, 2025
7896707
Merge branch 'master' into v1.6506.0
Laure-di May 13, 2025
ac8a59d
Merge branch 'master' into v1.6506.0
Laure-di May 14, 2025
a0db995
fix goimport
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
12 changes: 5 additions & 7 deletions internal/namespaces/file/v1alpha1/file_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,8 @@ func fileFilesystemGet() *core.Command {

func fileFilesystemList() *core.Command {
return &core.Command{
Short: `List all filesystems`,
Long: `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.`,
Short: `List all filesystems`,
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.`,
Namespace: "file",
Resource: "filesystem",
Verb: "list",
Expand Down Expand Up @@ -120,7 +119,7 @@ Use the order_by parameter to modify the sorting behavior.`,
},
{
Name: "name",
Short: `Filter the return filesystems by their names`,
Short: `Filter the returned filesystems by their names`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -161,8 +160,7 @@ func fileAttachmentList() *core.Command {
return &core.Command{
Short: `List filesystems attachments`,
Long: `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.`,
Namespace: "file",
Resource: "attachment",
Verb: "list",
Expand Down Expand Up @@ -229,7 +227,7 @@ This can be modified using the ` + "`" + `order_by` + "`" + ` field.`,
func fileFilesystemCreate() *core.Command {
return &core.Command{
Short: `Create a new filesystem`,
Long: `To create a new filesystem, you need to provide a name, a size, and a project ID.`,
Long: `To create a new filesystem, you must specify a name, a size, and a project ID.`,
Namespace: "file",
Resource: "filesystem",
Verb: "create",
Expand Down
2 changes: 1 addition & 1 deletion internal/namespaces/key_manager/v1alpha1/key_manager_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"reflect"

"github.com/scaleway/scaleway-cli/v2/core"
"github.com/scaleway/scaleway-sdk-go/api/key_manager/v1alpha1"
key_manager "github.com/scaleway/scaleway-sdk-go/api/key_manager/v1alpha1"
"github.com/scaleway/scaleway-sdk-go/scw"
)

Expand Down
Loading