feat(ipfs): documents fields (#3392)

Co-authored-by: Rémy Léone <[email protected]>

Author: scaleway-bot

internal/namespaces/ipfs/v1alpha1/ipfs_cli.go

@@ -85,7 +85,8 @@ Should be the first command you made because every pin must be attached to a vol
 			core.ProjectIDArgSpec(),
 			{
 				Name:       "name",
-				Required:   false,
+				Short:      `Volume name`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
@@ -114,6 +115,7 @@ func ipfsVolumeGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
+				Short:      `Volume id`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -144,6 +146,7 @@ func ipfsVolumeList() *core.Command {
 			core.ProjectIDArgSpec(),
 			{
 				Name:       "order-by",
+				Short:      `Sort order of the returned Volume`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -182,19 +185,22 @@ func ipfsVolumeUpdate() *core.Command {
 		ArgsType: reflect.TypeOf(ipfs.UpdateVolumeRequest{}),
 		ArgSpecs: core.ArgSpecs{
 			{
-				Name:       "volume-id",
-				Required:   true,
+				Name:       "name",
+				Short:      `Volume name`,
+				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
-				Name:       "name",
-				Required:   false,
+				Name:       "volume-id",
+				Short:      `Volume id`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "tags.{index}",
+				Short:      `Tags for the Volume`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -224,6 +230,7 @@ func ipfsVolumeDelete() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
+				Short:      `Volume id`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -263,18 +270,21 @@ A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Required:   false,
+				Short:      `Volume Id on which you wish to pin your content`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "url",
-				Required:   false,
+				Short:      `Url whose content you wish to pin`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "name",
+				Short:      `Pin name`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -320,24 +330,28 @@ A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Required:   false,
+				Short:      `Volume Id on which you wish to pin your content`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "cid",
-				Required:   false,
+				Short:      `Cid whose content you wish to pin`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
-				Name:       "name",
+				Name:       "origins.{index}",
+				Short:      `Node containing the content you wish to pin`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
-				Name:       "origins.{index}",
+				Name:       "name",
+				Short:      `Pin name`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -379,12 +393,14 @@ func ipfsPinGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
+				Short:      `Volume id`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "pin-id",
+				Short:      `Pin id for which you wish to obtain information`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -414,32 +430,37 @@ func ipfsPinList() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Required:   false,
+				Short:      `Volume ID for which you wish to list the pins`,
+				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "project-id",
+				Short:      `Project id`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "order-by",
+				Short:      `Sort order of the returned Volume`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 				EnumValues: []string{"created_at_asc", "created_at_desc"},
 			},
 			{
 				Name:       "status",
+				Short:      `List pins by status`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 				EnumValues: []string{"unknown_status", "queued", "pinning", "failed", "pinned"},
 			},
 			{
 				Name:       "organization-id",
+				Short:      `Organization id`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -479,12 +500,14 @@ This content can therefore be removed and no longer provided on the IPFS network
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
+				Short:      `Volume id`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "pin-id",
+				Short:      `Pin id you wish to remove from the volume`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,