From 1c8c8c428cca53ce005789071267ba61f41602fe Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 3 Nov 2023 19:14:44 +0200 Subject: [PATCH] Auto-generated cli documentation update - 2023-11-03 19:12:00 (#1444) Update documentation Co-authored-by: JAORMX --- .../docs/ref/cli/commands/minder_rule_type.md | 2 + .../cli/commands/minder_rule_type_apply.md | 39 +++++++++++++++++++ .../cli/commands/minder_rule_type_create.md | 2 +- .../cli/commands/minder_rule_type_update.md | 39 +++++++++++++++++++ 4 files changed, 81 insertions(+), 1 deletion(-) create mode 100644 docs/docs/ref/cli/commands/minder_rule_type_apply.md create mode 100644 docs/docs/ref/cli/commands/minder_rule_type_update.md diff --git a/docs/docs/ref/cli/commands/minder_rule_type.md b/docs/docs/ref/cli/commands/minder_rule_type.md index ca469cc285..8256543bc5 100644 --- a/docs/docs/ref/cli/commands/minder_rule_type.md +++ b/docs/docs/ref/cli/commands/minder_rule_type.md @@ -35,8 +35,10 @@ minder rule_type [flags] ### SEE ALSO * [minder](minder.md) - Minder controls the hosted minder service +* [minder rule_type apply](minder_rule_type_apply.md) - Apply a rule type within a minder control plane * [minder rule_type create](minder_rule_type_create.md) - Create a rule type within a minder control plane * [minder rule_type delete](minder_rule_type_delete.md) - Delete a rule type * [minder rule_type get](minder_rule_type_get.md) - Get details for a rule type within a minder control plane * [minder rule_type list](minder_rule_type_list.md) - List rule types within a minder control plane +* [minder rule_type update](minder_rule_type_update.md) - Update a rule type within a minder control plane diff --git a/docs/docs/ref/cli/commands/minder_rule_type_apply.md b/docs/docs/ref/cli/commands/minder_rule_type_apply.md new file mode 100644 index 0000000000..d220924081 --- /dev/null +++ b/docs/docs/ref/cli/commands/minder_rule_type_apply.md @@ -0,0 +1,39 @@ +--- +title: minder rule type apply +--- +## minder rule_type apply + +Apply a rule type within a minder control plane + +### Synopsis + +The minder rule type apply subcommand lets you create or update rule types for a project +within a minder control plane. + +``` +minder rule_type apply [flags] +``` + +### Options + +``` + -f, --file stringArray Path to the YAML defining the rule type (or - for stdin). Can be specified multiple times. Can be a directory. + -h, --help help for apply +``` + +### Options inherited from parent commands + +``` + --config string Config file (default is $PWD/config.yaml) + --grpc-host string Server host (default "staging.stacklok.dev") + --grpc-insecure Allow establishing insecure connections + --grpc-port int Server port (default 443) + --identity-client string Identity server client ID (default "minder-cli") + --identity-realm string Identity server realm (default "stacklok") + --identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev") +``` + +### SEE ALSO + +* [minder rule_type](minder_rule_type.md) - Manage rule types within a minder control plane + diff --git a/docs/docs/ref/cli/commands/minder_rule_type_create.md b/docs/docs/ref/cli/commands/minder_rule_type_create.md index bdb570746c..36bf18dc77 100644 --- a/docs/docs/ref/cli/commands/minder_rule_type_create.md +++ b/docs/docs/ref/cli/commands/minder_rule_type_create.md @@ -7,7 +7,7 @@ Create a rule type within a minder control plane ### Synopsis -The minder rule type create subcommand lets you create new profiles for a project +The minder rule type create subcommand lets you create new rule types for a project within a minder control plane. ``` diff --git a/docs/docs/ref/cli/commands/minder_rule_type_update.md b/docs/docs/ref/cli/commands/minder_rule_type_update.md new file mode 100644 index 0000000000..beff4949a6 --- /dev/null +++ b/docs/docs/ref/cli/commands/minder_rule_type_update.md @@ -0,0 +1,39 @@ +--- +title: minder rule type update +--- +## minder rule_type update + +Update a rule type within a minder control plane + +### Synopsis + +The minder rule type update subcommand lets you update rule types for a project +within a minder control plane. + +``` +minder rule_type update [flags] +``` + +### Options + +``` + -f, --file stringArray Path to the YAML defining the rule type (or - for stdin). Can be specified multiple times. Can be a directory. + -h, --help help for update +``` + +### Options inherited from parent commands + +``` + --config string Config file (default is $PWD/config.yaml) + --grpc-host string Server host (default "staging.stacklok.dev") + --grpc-insecure Allow establishing insecure connections + --grpc-port int Server port (default 443) + --identity-client string Identity server client ID (default "minder-cli") + --identity-realm string Identity server realm (default "stacklok") + --identity-url string Identity server issuer URL (default "https://auth.staging.stacklok.dev") +``` + +### SEE ALSO + +* [minder rule_type](minder_rule_type.md) - Manage rule types within a minder control plane +