Skip to content

Commit 7ccd52f

Browse files
duboolivierclaude
andcommitted
docs: regenerate CLI docs for block storage v2 and completion
Regenerate the docs that were out of date after the block storage v2 migration (--wait flags, updated --type values) and add the previously missing completion command docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 7658e92 commit 7ccd52f

6 files changed

Lines changed: 100 additions & 2 deletions

doc/ovhcloud_cloud_storage_block_backup_create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ ovhcloud cloud storage block backup create <volume_id> <backup_name> [flags]
1010

1111
```
1212
-h, --help help for create
13+
--wait Wait for the backup to be READY before exiting
1314
```
1415

1516
### Options inherited from parent commands

doc/ovhcloud_cloud_storage_block_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ovhcloud cloud storage block create <region> [flags]
2222
--replace Replace parameters file if it already exists
2323
--size int Volume size (in GB)
2424
--snapshot-id string Snapshot ID to create the volume from
25-
--type string Volume type (classic, classic-luks, classic-multiattach, high-speed, high-speed-gen2, high-speed-gen2-luks, high-speed-luks)
25+
--type string Volume type (CLASSIC, HIGH_SPEED, HIGH_SPEED_GEN2)
2626
--wait Wait for volume creation to be done before exiting
2727
```
2828

doc/ovhcloud_cloud_storage_block_edit.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ ovhcloud cloud storage block edit <volume_id> [flags]
1414
-h, --help help for edit
1515
--name string Volume name
1616
--size int Volume size (in GB, can only be increased)
17-
--type string Volume type (classic, classic-luks, classic-multiattach, high-speed, high-speed-gen2, high-speed-gen2-luks, high-speed-luks)
17+
--type string Volume type (CLASSIC, HIGH_SPEED, HIGH_SPEED_GEN2)
18+
--wait Wait for the volume to be READY before exiting
1819
```
1920

2021
### Options inherited from parent commands

doc/ovhcloud_cloud_storage_block_snapshot_create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ ovhcloud cloud storage block snapshot create <volume_id> [flags]
1212
--description string Snapshot description
1313
-h, --help help for create
1414
--name string Snapshot name
15+
--wait Wait for the snapshot to be READY before exiting
1516
```
1617

1718
### Options inherited from parent commands

doc/ovhcloud_completion.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
## ovhcloud completion
2+
3+
Generate shell completion scripts
4+
5+
### Synopsis
6+
7+
Generate shell completion scripts for ovhcloud CLI.
8+
9+
To load completions in your current shell session:
10+
11+
bash:
12+
source <(ovhcloud completion bash)
13+
14+
zsh:
15+
source <(ovhcloud completion zsh)
16+
17+
fish:
18+
ovhcloud completion fish | source
19+
20+
To make completions permanent, run:
21+
22+
ovhcloud completion install
23+
24+
25+
```
26+
ovhcloud completion [bash|zsh|fish|powershell] [flags]
27+
```
28+
29+
### Options
30+
31+
```
32+
-h, --help help for completion
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
-d, --debug Activate debug mode (will log all HTTP requests details)
39+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
40+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
41+
Examples:
42+
--output json
43+
--output yaml
44+
--output interactive
45+
--output 'id' (to extract a single field)
46+
--output 'nested.field.subfield' (to extract a nested field)
47+
--output '[id, "name"]' (to extract multiple fields as an array)
48+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
49+
--output 'name+","+type' (to extract and concatenate fields in a string)
50+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
51+
--profile string Use a specific profile from the configuration file
52+
```
53+
54+
### SEE ALSO
55+
56+
* [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services
57+
* [ovhcloud completion install](ovhcloud_completion_install.md) - Install shell completion permanently in your shell rc file
58+

doc/ovhcloud_completion_install.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## ovhcloud completion install
2+
3+
Install shell completion permanently in your shell rc file
4+
5+
```
6+
ovhcloud completion install [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for install
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
-d, --debug Activate debug mode (will log all HTTP requests details)
19+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
20+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
21+
Examples:
22+
--output json
23+
--output yaml
24+
--output interactive
25+
--output 'id' (to extract a single field)
26+
--output 'nested.field.subfield' (to extract a nested field)
27+
--output '[id, "name"]' (to extract multiple fields as an array)
28+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
29+
--output 'name+","+type' (to extract and concatenate fields in a string)
30+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
31+
--profile string Use a specific profile from the configuration file
32+
```
33+
34+
### SEE ALSO
35+
36+
* [ovhcloud completion](ovhcloud_completion.md) - Generate shell completion scripts
37+

0 commit comments

Comments
 (0)