docs(registry): components (#3065)

scaleway-bot · remyleone · web-flow · commit 9c6967a41cec · 2023-04-24T13:03:45.000Z
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-registry-image-delete-usage.golden b/cmd/scw/testdata/test-all-usage-registry-image-delete-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw registry image delete <image-id ...> [arg=value ...]
 
 ARGS:
-  image-id          The UUID of the image
+  image-id          UUID of the image
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-registry-image-get-usage.golden b/cmd/scw/testdata/test-all-usage-registry-image-get-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw registry image get <image-id ...> [arg=value ...]
 
 ARGS:
-  image-id          The UUID of the image
+  image-id          UUID of the image
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-registry-image-usage.golden b/cmd/scw/testdata/test-all-usage-registry-image-usage.golden
@@ -2,7 +2,7 @@
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
 An image represents a container image. A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. When running, it becomes one or multiple instances of that application.
 
-The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the [update image endpoit](https://developers.scaleway.com/en/products/registry/api/#patch-e73745).
+The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the [update image endpoit](#path-images-update-an-image).
 
 USAGE:
   scw registry image <command>
diff --git a/cmd/scw/testdata/test-all-usage-registry-namespace-create-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-create-usage.golden
@@ -9,7 +9,7 @@ ARGS:
   name=<generated>    Name of the namespace
   [description]       Description of the namespace
   [project-id]        Project ID to use. If none is passed the default project ID will be used
-  [is-public]         Whether or not namespace is public
+  [is-public]         Defines whether or not namespace is public
   [organization-id]   Organization ID to use. If none is passed the default organization ID will be used
   [region=fr-par]     Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
diff --git a/cmd/scw/testdata/test-all-usage-registry-namespace-delete-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-delete-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw registry namespace delete <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      The UUID of the namespace
+  namespace-id      UUID of the namespace
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-registry-namespace-get-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-get-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw registry namespace get <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      The UUID of the namespace
+  namespace-id      UUID of the namespace
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-registry-namespace-update-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-update-usage.golden
@@ -8,7 +8,7 @@ USAGE:
 ARGS:
   namespace-id      ID of the namespace to update
   [description]     Namespace description
-  [is-public]       Whether or not the namespace is public
+  [is-public]       Defines whether or not the namespace is public
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-registry-tag-delete-usage.golden b/cmd/scw/testdata/test-all-usage-registry-tag-delete-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw registry tag delete <tag-id ...> [arg=value ...]
 
 ARGS:
-  tag-id            The UUID of the tag
+  tag-id            UUID of the tag
   [force]           If two tags share the same digest the deletion will fail unless this parameter is set to true
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
diff --git a/cmd/scw/testdata/test-all-usage-registry-tag-get-usage.golden b/cmd/scw/testdata/test-all-usage-registry-tag-get-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw registry tag get <tag-id ...> [arg=value ...]
 
 ARGS:
-  tag-id            The UUID of the tag
+  tag-id            UUID of the tag
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-registry-tag-list-usage.golden b/cmd/scw/testdata/test-all-usage-registry-tag-list-usage.golden
@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   [order-by]        Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`. (created_at_asc | created_at_desc | name_asc | name_desc)
-  image-id          The UUID of the image
+  image-id          UUID of the image
   [name]            Filter by the tag name (exact match)
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
diff --git a/docs/commands/registry.md b/docs/commands/registry.md
@@ -26,7 +26,7 @@ Container Registry API.
 
 An image represents a container image. A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. When running, it becomes one or multiple instances of that application.
 
-The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the [update image endpoit](https://developers.scaleway.com/en/products/registry/api/#patch-e73745).
+The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the [update image endpoit](#path-images-update-an-image).
 
 
 
@@ -45,7 +45,7 @@ scw registry image delete <image-id ...> [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| image-id | Required | The UUID of the image |
+| image-id | Required | UUID of the image |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -65,7 +65,7 @@ scw registry image get <image-id ...> [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| image-id | Required | The UUID of the image |
+| image-id | Required | UUID of the image |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -222,7 +222,7 @@ scw registry namespace create [arg=value ...]
 | name | Required<br />Default: `<generated>` | Name of the namespace |
 | description |  | Description of the namespace |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
-| is-public |  | Whether or not namespace is public |
+| is-public |  | Defines whether or not namespace is public |
 | organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
@@ -243,7 +243,7 @@ scw registry namespace delete <namespace-id ...> [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| namespace-id | Required | The UUID of the namespace |
+| namespace-id | Required | UUID of the namespace |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -263,7 +263,7 @@ scw registry namespace get <namespace-id ...> [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| namespace-id | Required | The UUID of the namespace |
+| namespace-id | Required | UUID of the namespace |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -308,7 +308,7 @@ scw registry namespace update <namespace-id ...> [arg=value ...]
 |------|---|-------------|
 | namespace-id | Required | ID of the namespace to update |
 | description |  | Namespace description |
-| is-public |  | Whether or not the namespace is public |
+| is-public |  | Defines whether or not the namespace is public |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -334,7 +334,7 @@ scw registry tag delete <tag-id ...> [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| tag-id | Required | The UUID of the tag |
+| tag-id | Required | UUID of the tag |
 | force |  | If two tags share the same digest the deletion will fail unless this parameter is set to true |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
@@ -355,7 +355,7 @@ scw registry tag get <tag-id ...> [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| tag-id | Required | The UUID of the tag |
+| tag-id | Required | UUID of the tag |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -376,7 +376,7 @@ scw registry tag list [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`. |
-| image-id | Required | The UUID of the image |
+| image-id | Required | UUID of the image |
 | name |  | Filter by the tag name (exact match) |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
 
diff --git a/internal/namespaces/registry/v1/registry_cli.go b/internal/namespaces/registry/v1/registry_cli.go
@@ -64,7 +64,7 @@ func registryImage() *core.Command {
 		Short: `Image management commands`,
 		Long: `An image represents a container image. A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. When running, it becomes one or multiple instances of that application.
 
-The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the [update image endpoit](https://developers.scaleway.com/en/products/registry/api/#patch-e73745).
+The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the [update image endpoit](#path-images-update-an-image).
 `,
 		Namespace: "registry",
 		Resource:  "image",
@@ -198,7 +198,7 @@ func registryNamespaceGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "namespace-id",
-				Short:      `The UUID of the namespace`,
+				Short:      `UUID of the namespace`,
 				Required:   true,
 				Deprecated: false,
 				Positional: true,
@@ -244,7 +244,7 @@ func registryNamespaceCreate() *core.Command {
 			core.ProjectIDArgSpec(),
 			{
 				Name:       "is-public",
-				Short:      `Whether or not namespace is public`,
+				Short:      `Defines whether or not namespace is public`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -289,7 +289,7 @@ func registryNamespaceUpdate() *core.Command {
 			},
 			{
 				Name:       "is-public",
-				Short:      `Whether or not the namespace is public`,
+				Short:      `Defines whether or not the namespace is public`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -319,7 +319,7 @@ func registryNamespaceDelete() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "namespace-id",
-				Short:      `The UUID of the namespace`,
+				Short:      `UUID of the namespace`,
 				Required:   true,
 				Deprecated: false,
 				Positional: true,
@@ -449,7 +449,7 @@ func registryImageGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "image-id",
-				Short:      `The UUID of the image`,
+				Short:      `UUID of the image`,
 				Required:   true,
 				Deprecated: false,
 				Positional: true,
@@ -517,7 +517,7 @@ func registryImageDelete() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "image-id",
-				Short:      `The UUID of the image`,
+				Short:      `UUID of the image`,
 				Required:   true,
 				Deprecated: false,
 				Positional: true,
@@ -555,7 +555,7 @@ func registryTagList() *core.Command {
 			},
 			{
 				Name:       "image-id",
-				Short:      `The UUID of the image`,
+				Short:      `UUID of the image`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -601,7 +601,7 @@ func registryTagGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "tag-id",
-				Short:      `The UUID of the tag`,
+				Short:      `UUID of the tag`,
 				Required:   true,
 				Deprecated: false,
 				Positional: true,
@@ -631,7 +631,7 @@ func registryTagDelete() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "tag-id",
-				Short:      `The UUID of the tag`,
+				Short:      `UUID of the tag`,
 				Required:   true,
 				Deprecated: false,
 				Positional: true,
