Skip to content

Commit 17f6d56

Browse files
committed
[build] Regenerate apidocs
1 parent e908044 commit 17f6d56

30 files changed

+88
-196
lines changed

coconut/doc/coconut.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ For more information on the available commands, see the individual documentation
3232
* [coconut task](coconut_task.md) - manage active tasks
3333
* [coconut template](coconut_template.md) - query available workflow templates in configuration repositories
3434

35-
###### Auto generated by spf13/cobra on 17-Aug-2023
35+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ coconut about [flags]
3131

3232
* [coconut](coconut.md) - O² Control and Configuration Utility
3333

34-
###### Auto generated by spf13/cobra on 17-Aug-2023
34+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_configuration.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ configuration store.
2828

2929
* [coconut](coconut.md) - O² Control and Configuration Utility
3030
* [coconut configuration dump](coconut_configuration_dump.md) - dump configuration subtree
31-
* [coconut configuration history](coconut_configuration_history.md) - List all existing entries with timestamps of a specified component in Consul
3231
* [coconut configuration import](coconut_configuration_import.md) - Import a configuration file for the specified component and entry
3332
* [coconut configuration list](coconut_configuration_list.md) - List all existing O² components in Consul
3433
* [coconut configuration show](coconut_configuration_show.md) - Show configuration for the component and entry specified
3534

36-
###### Auto generated by spf13/cobra on 17-Aug-2023
35+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_configuration_dump.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ coconut configuration dump [key] [flags]
3636

3737
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
3838

39-
###### Auto generated by spf13/cobra on 17-Aug-2023
39+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_configuration_import.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Import a configuration file for the specified component and entry
55
### Synopsis
66

77
The configuration import command generates a timestamp and saves
8-
the configuration file to Consul under the <component>/<entry>/<timestamp> path.
8+
the configuration file to Consul under the <component>/<entry> path.
99
Supported configuration file types are JSON, YAML, TOML and INI,
1010
and their file extensions are recognized automatically.
1111

@@ -21,7 +21,7 @@ coconut conf import <component>/<run type>/<machine role>/<entry> <file_path>
2121
coconut conf import <component> <entry> <file_path> --new-component
2222
coconut conf import <component>/<run type>/<machine role>/<entry> <file_path> --format=json
2323
coconut conf import <component> <entry> <file_path>.json
24-
coconut conf import <component> <entry> <file_path>
24+
coconut conf import <component> <entry> <file_path>
2525
coconut conf import <component> <entry> <file_path> --new-component
2626
2727
```
@@ -51,4 +51,4 @@ coconut conf import <component> <entry> <file_path> --new-component
5151

5252
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
5353

54-
###### Auto generated by spf13/cobra on 17-Aug-2023
54+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_configuration_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ coconut conf list <component> -t
4242

4343
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
4444

45-
###### Auto generated by spf13/cobra on 17-Aug-2023
45+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_configuration_show.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Show configuration for the component and entry specified
66

77
The configuration show command returns the most recent
88
configuration revision for the specified component and entry.
9+
It can also return a specific revision, requested with the --timestamp/-t flag
910

1011
```
1112
coconut configuration show <component> <entry> [flags]
@@ -17,7 +18,9 @@ coconut configuration show <component> <entry> [flags]
1718
coconut conf show <component> <entry>
1819
coconut conf show <component> <entry> -t <timestamp>
1920
coconut conf show <component>/<run type>/<machine role>/<entry>
20-
coconut conf show <component> <entry> -r <run type> -l <machine role>'
21+
coconut conf show <component>/<run type>/<machine role>/<entry> -t <timestamp>
22+
coconut conf show <component>/<run type>/<machine role>/<entry>@<timestamp>
23+
coconut conf show <component> <entry> -r <run type> -l <machine role> -t <timestamp>'
2124
coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"}'
2225
```
2326

@@ -29,6 +32,7 @@ coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"
2932
-l, --role string request configuration for this O² machine role
3033
-r, --runtype string request configuration for this run type (e.g. PHYSICS, TECHNICAL, etc.)
3134
-s, --simulate simulate runtime template processing on the configuration payload
35+
-t, --timestamp string request configuration for this timestamp
3236
```
3337

3438
### Options inherited from parent commands
@@ -46,4 +50,4 @@ coconut conf show <component> <entry> -s -e '{"key1": "value1", "key2": "value2"
4650

4751
* [coconut configuration](coconut_configuration.md) - view or modify O² configuration
4852

49-
###### Auto generated by spf13/cobra on 17-Aug-2023
53+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ For more information on the behavior of coconut environments, see the subcommand
5353
* [coconut environment list](coconut_environment_list.md) - list environments
5454
* [coconut environment show](coconut_environment_show.md) - show environment information
5555

56-
###### Auto generated by spf13/cobra on 17-Aug-2023
56+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_environment_control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ coconut environment control [environment id] [flags]
4141

4242
* [coconut environment](coconut_environment.md) - create, destroy and manage AliECS environments
4343

44-
###### Auto generated by spf13/cobra on 17-Aug-2023
44+
###### Auto generated by spf13/cobra on 27-Nov-2024

coconut/doc/coconut_environment_create.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ coconut environment create [flags]
3030
### Options
3131

3232
```
33+
-y, --asynchronous use asynchronous mode for environment creation
3334
-a, --auto create an autorun environment
3435
-c, --configuration string high-level configuration payload to be loaded for the new environment
3536
-e, --extra-vars key1=val1,key2=val2 values passed using key=value CSV or JSON syntax, interpreted as strings key1=val1,key2=val2 or `{"key1": "value1", "key2": "value2"}`
@@ -53,4 +54,4 @@ coconut environment create [flags]
5354

5455
* [coconut environment](coconut_environment.md) - create, destroy and manage AliECS environments
5556

56-
###### Auto generated by spf13/cobra on 17-Aug-2023
57+
###### Auto generated by spf13/cobra on 27-Nov-2024

0 commit comments

Comments
 (0)