Skip to content

Commit 2b003ad

Browse files
docs(marketplace): adding marketplace v2 documentation (#3016)
Co-authored-by: Rémy Léone <[email protected]>
1 parent e9eef70 commit 2b003ad

14 files changed

+51
-51
lines changed

cmd/scw/testdata/test-all-usage-marketplace-category-get-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get marketplace resources.
3+
Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format).
44

55
USAGE:
66
scw marketplace category get [arg=value ...]

cmd/scw/testdata/test-all-usage-marketplace-category-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List marketplace resources.
3+
Get a list of all existing categories. The output can be paginated.
44

55
USAGE:
66
scw marketplace category list

cmd/scw/testdata/test-all-usage-marketplace-category-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ USAGE:
66
scw marketplace category <command>
77

88
AVAILABLE COMMANDS:
9-
get Get marketplace resources
10-
list List marketplace resources
9+
get Get a specific category
10+
list List existing image categories
1111

1212
FLAGS:
1313
-h, --help help for category

cmd/scw/testdata/test-all-usage-marketplace-image-get-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get a specific marketplace image.
3+
Get detailed information about a marketplace image, specified by its `image_id` (UUID format).
44

55
USAGE:
66
scw marketplace image get [arg=value ...]

cmd/scw/testdata/test-all-usage-marketplace-image-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List marketplace images.
3+
List all available images on the marketplace, their UUID, CPU architecture and description.
44

55
USAGE:
66
scw marketplace image list [arg=value ...]

cmd/scw/testdata/test-all-usage-marketplace-local-image-get-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get marketplace resources.
3+
Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its `local_image_id` (UUID format).
44

55
USAGE:
66
scw marketplace local-image get [arg=value ...]

cmd/scw/testdata/test-all-usage-marketplace-local-image-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List local images from a specific image or version.
3+
List information about local images in a specific Availability Zone, specified by its `image_id` (UUID format), `version_id` (UUID format) or `image_label`. Only one of these three parameters may be set.
44

55
USAGE:
66
scw marketplace local-image list [arg=value ...]

cmd/scw/testdata/test-all-usage-marketplace-local-image-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Marketplace Local Images management commands.
3+
Marketplace local images management commands.
44

55
USAGE:
66
scw marketplace local-image <command>
77

88
AVAILABLE COMMANDS:
9-
get Get marketplace resources
9+
get Get a specific local image by ID
1010
list List local images from a specific image or version
1111

1212
FLAGS:

cmd/scw/testdata/test-all-usage-marketplace-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ USAGE:
88
AVAILABLE COMMANDS:
99
category Marketplace category management commands
1010
image Marketplace images management commands
11-
local-image Marketplace Local Images management commands
11+
local-image Marketplace local images management commands
1212
version Marketplace version management commands
1313

1414
FLAGS:

cmd/scw/testdata/test-all-usage-marketplace-version-get-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get marketplace resources.
3+
Get information such as the name, creation date, last update and published date for an image version specified by its `version_id` (UUID format).
44

55
USAGE:
66
scw marketplace version get [arg=value ...]

0 commit comments

Comments
 (0)