Skip to content

docs(registry): components #3065

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
remyleone merged 2 commits into from
Apr 24, 2023
Merged

docs(registry): components #3065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e5e865
Fix
remyleone Apr 24, 2023
923daaa
FIx
remyleone Apr 24, 2023
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
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-image-delete-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-image-get-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-image-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-namespace-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-namespace-delete-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-namespace-get-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-namespace-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-tag-delete-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-tag-get-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-registry-tag-list-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
20 changes: 10 additions & 10 deletions docs/commands/registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).



Expand All @@ -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 |


Expand All @@ -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 |


Expand Down Expand Up @@ -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 |

Expand All @@ -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 |


Expand All @@ -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 |


Expand Down Expand Up @@ -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 |


Expand All @@ -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 |

Expand All @@ -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 |


Expand All @@ -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 |

Expand Down
20 changes: 10 additions & 10 deletions internal/namespaces/registry/v1/registry_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down