Skip to content

Commit deae360

Browse files
scaleway-botremyleone
scaleway-bot
and
remyleone
authored
docs(sem): revamp (#2904)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 6a15d20 commit deae360

18 files changed

+197
-217
lines changed

‎cmd/scw/testdata/test-all-usage-secret-secret-create-usage.golden

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a Secret containing no versions.
3+
You must sepcify the `region` to create a secret.
44

55
USAGE:
66
scw secret secret create [arg=value ...]
77

88
EXAMPLES:
9-
Add a given Secret
10-
scw secret secret create project-id=<your-project-id> name="foobar" description="bar"
9+
Add a given secret
10+
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"
1111

1212
ARGS:
1313
[project-id] Project ID to use. If none is passed the default project ID will be used
14-
[name] Name of the Secret
15-
[tags.{index}] List of tags associated to this Secret
16-
[description] Description of the Secret
14+
[name] Name of the secret
15+
[tags.{index}] List of the secret's tags
16+
[description] Description of the secret
1717
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1818

1919
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-secret-delete-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a Secret.
3+
Delete a given secret specified by the `region` and `secret_id` parameters.
44

55
USAGE:
66
scw secret secret delete [arg=value ...]
77

88
EXAMPLES:
9-
Delete a given Secret
9+
Delete a given secret
1010
scw secret secret delete secret-id=11111111-1111-1111-1111-111111111111
1111

1212
ARGS:
13-
secret-id ID of the Secret
13+
secret-id ID of the secret
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1515

1616
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-secret-get-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-
Get metadata of a Secret.
3+
Retrieve the metadata of a secret specified by the `region` and the `secret_name` parameters.
44

55
USAGE:
66
scw secret secret get [arg=value ...]
77

88
ARGS:
9-
secret-id ID of the Secret
9+
secret-id ID of the secret
1010
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1111

1212
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-secret-list-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List Secrets.
3+
Retrieve the list of secrets created within an Organization and/or Project. You must specify either the `organization_id` or the `project_id` and the `region`.
44

55
USAGE:
66
scw secret secret list [arg=value ...]
77

88
ARGS:
9-
[project-id] ID of a project to filter on (optional)
10-
[name] Secret name to filter on (optional)
9+
[project-id] Filter by Project ID (optional)
10+
[name] Filter by secret name (optional)
1111
[tags.{index}] List of tags to filter on (optional)
1212
[order-by] (name_asc | name_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc)
13-
[organization-id] ID of an organization to filter on (optional)
13+
[organization-id] Filter by Organization ID (optional)
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
1515

1616
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-secret-update-usage.golden

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update metadata of a Secret.
3+
Edit a secret's metadata such as name, tag(s) and description. The secret to update is specified by the `secret_id` and `region` parameters.
44

55
USAGE:
66
scw secret secret update [arg=value ...]
77

88
ARGS:
9-
secret-id ID of the Secret
10-
[name] New name of the Secret (optional)
11-
[tags.{index}] New list of tags associated to this Secret (optional)
12-
[description] Description of the Secret
9+
secret-id ID of the secret
10+
[name] Secret's updated name (optional)
11+
[tags.{index}] Secret's updated list of tags (optional)
12+
[description] Description of the secret
1313
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1414

1515
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-secret-usage.golden

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Logical container made up of zero or more immutable versions, that hold the sensitive data.
3+
Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data.
44

55
USAGE:
66
scw secret secret <command>
77

88
AVAILABLE COMMANDS:
9-
create Create a Secret containing no versions
10-
delete Delete a Secret
11-
get Get metadata of a Secret
12-
list List Secrets
13-
update Update metadata of a Secret
9+
create Create a secret
10+
delete Delete a secret
11+
get Get metadata using the secret's name
12+
list List secrets
13+
update Update metadata of a secret
1414

1515
FLAGS:
1616
-h, --help help for secret

‎cmd/scw/testdata/test-all-usage-secret-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-
Secret API (beta).
3+
Secret Manager API documentation.
44

55
USAGE:
66
scw secret <command>

‎cmd/scw/testdata/test-all-usage-secret-version-access-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Access a SecretVersion, returning the sensitive data.
3+
Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters.
44

55
USAGE:
66
scw secret version access [arg=value ...]
77

88
ARGS:
9-
secret-id ID of the Secret
10-
revision Revision of the SecretVersion (may be a number or "latest")
9+
secret-id ID of the secret
10+
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1212

1313
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-version-create-usage.golden

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a SecretVersion.
3+
Create a version of a given secret specified by the `region` and `secret_id` parameters.
44

55
USAGE:
66
scw secret version create [arg=value ...]
77

8-
EXAMPLES:
9-
Add a given Secret Version
10-
scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>
11-
128
ARGS:
13-
secret-id ID of the Secret
9+
secret-id ID of the secret
1410
data Content of the secret version. Base64 is handled by the SDK (Support file loading with @/path/to/file)
15-
[description] Description of the SecretVersion
11+
[description] Description of the version
1612
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1713

1814
FLAGS:

‎cmd/scw/testdata/test-all-usage-secret-version-delete-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Destroy a SecretVersion, permanently destroying the sensitive data.
3+
Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone.
44

55
USAGE:
66
scw secret version delete [arg=value ...]
77

88
EXAMPLES:
9-
Delete a given SecretVersion
9+
Delete a given Secret Version
1010
scw secret version delete secret-id=11111111-1111-1111-1111-111111111111 revision=1
1111

1212
ARGS:
13-
secret-id ID of the Secret
14-
revision Revision of the SecretVersion (may be a number or "latest")
13+
secret-id ID of the secret
14+
revision Version number. The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be a number or "latest"
1515
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1616

1717
FLAGS:

0 commit comments

Comments
 (0)