Fix

remyleone · remyleone · commit f389bd9341b3 · 2023-04-17T15:52:42.000+02:00
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
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete the image associated with the given id.
+Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete.
 
 USAGE:
   scw registry image delete <image-id ...> [arg=value ...]
 
 ARGS:
-  image-id          The unique ID of the Image
+  image-id          The 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
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the image associated with the given id.
+Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response.
 
 USAGE:
   scw registry image get <image-id ...> [arg=value ...]
 
 ARGS:
-  image-id          The unique ID of the Image
+  image-id          The 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-list-usage.golden b/cmd/scw/testdata/test-all-usage-registry-image-list-usage.golden
@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all your images.
+List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `namespace_id` and `project_id` parameters.
 
 USAGE:
   scw registry image list [arg=value ...]
 
 ARGS:
-  [order-by]          Field by which to order the display of Images (created_at_asc | created_at_desc | name_asc | name_desc)
-  [namespace-id]      Filter by the Namespace ID
-  [name]              Filter by the Image name (exact match)
+  [order-by]          Criteria to use when ordering image 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)
+  [namespace-id]      Filter by the namespace ID
+  [name]              Filter by the image name (exact match)
   [project-id]        Filter by Project ID
   [organization-id]   Filter by Organization ID
   [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/cmd/scw/testdata/test-all-usage-registry-image-update-usage.golden b/cmd/scw/testdata/test-all-usage-registry-image-update-usage.golden
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update the image associated with the given id.
+Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter.
 
 USAGE:
   scw registry image update <image-id ...> [arg=value ...]
 
 ARGS:
-  image-id          Image ID to update
-  [visibility]      A `public` image is pullable from internet without authentication, opposed to a `private` image. `inherit` will use the namespace `is_public` parameter (visibility_unknown | inherit | public | private)
+  image-id          ID of the image to update
+  [visibility]      Set to `public` to allow the image to be pulled without authentication. Else, set to  `private`. Set to `inherit` to keep the same visibility configuration as the namespace (visibility_unknown | inherit | public | private)
   [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
@@ -1,18 +1,17 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-An image represents a container image.
+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 (everyone can pull it), private (only your organization can pull it) or inherit from the namespace visibility (default)
-It can be changed with an update on the image via the registry API.
+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).
 
 USAGE:
   scw registry image <command>
 
 AVAILABLE COMMANDS:
   delete      Delete an image
-  get         Get a image
-  list        List all your images
-  update      Update an existing image
+  get         Get an image
+  list        List images
+  update      Update an image
 
 FLAGS:
   -h, --help   help for image
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
@@ -1,15 +1,15 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a new namespace.
+Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the `project_id` and `is_public` in the request payload.
 
 USAGE:
   scw registry namespace create [arg=value ...]
 
 ARGS:
-  name=<generated>    Define a namespace name
-  [description]       Define a description
+  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]         Define the default visibility policy
+  [is-public]         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
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete the namespace associated with the given id.
+Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete.
 
 USAGE:
   scw registry namespace delete <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      The unique ID of the Namespace
+  namespace-id      The 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
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the namespace associated with the given id.
+Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response.
 
 USAGE:
   scw registry namespace get <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      The unique ID of the Namespace
+  namespace-id      The 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-list-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-list-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all your namespaces.
+List all namespaces in a specified region. By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `instance_id` and `project_id` parameters.
 
 USAGE:
   scw registry namespace list [arg=value ...]
 
 ARGS:
-  [order-by]          Field by which to order the display of Images (created_at_asc | created_at_desc | description_asc | description_desc | name_asc | name_desc)
+  [order-by]          Criteria to use when ordering namespace 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 | description_asc | description_desc | name_asc | name_desc)
   [project-id]        Filter by Project ID
   [name]              Filter by the namespace name (exact match)
   [organization-id]   Filter by Organization ID
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
@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update the namespace associated with the given id.
+Update the parameters of a given namespace, specified by its `namespace_id` and `region`. You can update the `description` and `is_public` parameters.
 
 USAGE:
   scw registry namespace update <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      Namespace ID to update
-  [description]     Define a description
-  [is-public]       Define the default visibility policy
+  namespace-id      ID of the namespace to update
+  [description]     Namespace description
+  [is-public]       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-namespace-usage.golden b/cmd/scw/testdata/test-all-usage-registry-namespace-usage.golden
@@ -1,25 +1,20 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-A namespace is for images what a folder is for files
+A namespace is a collection of container images, each bearing the unique identifier of that namespace. A namespace can be either public or private, by default.
 
-To use our services, the first step is to create a namespace.
+Each namespace must have a globally unique name within its region. This means no namespaces in the same region can bear the same name.
 
-A namespace is for images what a folder is for files. Every push or pull must mention the namespace :
-```docker pull rg.nl-ams.scw.cloud/<namespace_name>/<image_name>:<tag_name>```
-
-Note that a namespace name is unique on a region. Thus, if another client already has created "test", you can't have it as a namespace
-
-A namespace can be either public or private (default), which determines who can pull images.
+You can use namespace privacy policies to specify whether everyone has the right to pull an image from a namespace or not. When an image is in a public namespace, anyone is able to pull it. You can set your namespace to private if you want to restrict access.
 
 USAGE:
   scw registry namespace <command>
 
 AVAILABLE COMMANDS:
-  create      Create a new namespace
-  delete      Delete an existing namespace
+  create      Create a namespace
+  delete      Delete a namespace
   get         Get a namespace
-  list        List all your namespaces
-  update      Update an existing namespace
+  list        List namespaces
+  update      Update a namespace
 
 FLAGS:
   -h, --help   help for namespace
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
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete the tag associated with the given id.
+Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete.
 
 USAGE:
   scw registry tag delete <tag-id ...> [arg=value ...]
 
 ARGS:
-  tag-id            The unique ID of the tag
+  tag-id            The 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
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the tag associated with the given id.
+Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response.
 
 USAGE:
   scw registry tag get <tag-id ...> [arg=value ...]
 
 ARGS:
-  tag-id            The unique ID of the Tag
+  tag-id            The 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
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all your tags.
+List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
 
 USAGE:
   scw registry tag list [arg=value ...]
 
 ARGS:
-  [order-by]        Field by which to order the display of Images (created_at_asc | created_at_desc | name_asc | name_desc)
-  image-id          The unique ID of the image
+  [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
   [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/cmd/scw/testdata/test-all-usage-registry-tag-usage.golden b/cmd/scw/testdata/test-all-usage-registry-tag-usage.golden
@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-A tag represents a container tag of an image.
+Tags allow you to organize your container images. This gives you the possibility of sorting and filtering your images in any organizational pattern of your choice, which in turn helps you arrange, control and monitor your cloud resources. You can assign as many tags as you want to each image.
 
 USAGE:
   scw registry tag <command>
 
 AVAILABLE COMMANDS:
   delete      Delete a tag
   get         Get a tag
-  list        List all your tags
+  list        List tags
 
 FLAGS:
   -h, --help   help for tag
diff --git a/cmd/scw/testdata/test-all-usage-registry-usage.golden b/cmd/scw/testdata/test-all-usage-registry-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Registry API.
+Container Registry API.
 
 USAGE:
   scw registry <command>
diff --git a/docs/commands/registry.md b/docs/commands/registry.md
diff --git a/internal/namespaces/registry/v1/registry_cli.go b/internal/namespaces/registry/v1/registry_cli.go
