From 628bb77d8f0e588e60dd1379831fc5fbb8ee6478 Mon Sep 17 00:00:00 2001 From: margaretjgu Date: Fri, 24 Jul 2026 14:29:57 -0400 Subject: [PATCH] fix: hide --input-file and --dry-run on no-input read-only commands --- docs/cli/schema.json | 3428 +++++++++++++++++++++++++++-------------- src/cloud/register.ts | 2 + src/es/register.ts | 1 + src/factory-core.ts | 5 + src/factory.ts | 11 +- src/kb/register.ts | 1 + test/factory.test.ts | 40 +- 7 files changed, 2316 insertions(+), 1172 deletions(-) diff --git a/docs/cli/schema.json b/docs/cli/schema.json index 33bcc0ae..4a82272b 100644 --- a/docs/cli/schema.json +++ b/docs/cli/schema.json @@ -4319,22 +4319,7 @@ "es" ], "name": "get-script-context", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get script contexts.", "intent": { "destructive": false, @@ -4349,22 +4334,7 @@ "es" ], "name": "get-script-languages", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get script languages.", "intent": { "destructive": false, @@ -4554,22 +4524,7 @@ "es" ], "name": "info", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get cluster info.", "intent": { "destructive": false, @@ -4584,22 +4539,7 @@ "es" ], "name": "ping", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Ping the cluster.", "intent": { "destructive": false, @@ -5821,22 +5761,7 @@ "cat" ], "name": "help", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get CAT help.", "intent": { "destructive": false, @@ -8847,22 +8772,7 @@ "cluster" ], "name": "remote-info", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get remote cluster information.", "intent": { "destructive": false, @@ -9053,22 +8963,7 @@ "cluster" ], "name": "stats", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get cluster statistics.", "intent": { "destructive": false, @@ -10652,22 +10547,7 @@ "dangling-indices" ], "name": "list-dangling-indices", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get the dangling indices.", "intent": { "destructive": false, @@ -11672,22 +11552,7 @@ "esql" ], "name": "list-queries", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get running ES|QL queries information.", "intent": { "destructive": false, @@ -12792,22 +12657,7 @@ "ilm" ], "name": "get-lifecycle", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get lifecycle policies.", "intent": { "destructive": false, @@ -12823,22 +12673,7 @@ "ilm" ], "name": "get-status", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get the ILM status.", "intent": { "destructive": false, @@ -15173,22 +15008,7 @@ "indices" ], "name": "get-data-lifecycle-stats", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get data stream lifecycle stats.", "intent": { "destructive": false, @@ -21313,22 +21133,7 @@ "ingest" ], "name": "geo-ip-stats", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get GeoIP statistics.", "intent": { "destructive": false, @@ -21474,22 +21279,7 @@ "ingest" ], "name": "processor-grok", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Run a grok processor.", "intent": { "destructive": false, @@ -21893,22 +21683,7 @@ "license" ], "name": "get-basic-status", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get the basic license status.", "intent": { "destructive": false, @@ -21924,22 +21699,7 @@ "license" ], "name": "get-trial-status", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get the trial status.", "intent": { "destructive": false, @@ -22291,22 +22051,7 @@ "migration" ], "name": "get-feature-upgrade-status", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get feature migration information.", "intent": { "destructive": false, @@ -24735,22 +24480,7 @@ "ml" ], "name": "info", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get machine learning information.", "intent": { "destructive": false, @@ -27614,22 +27344,7 @@ "project" ], "name": "get-many-routing", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get project routing expressions.", "intent": { "destructive": false, @@ -27683,22 +27398,7 @@ "project" ], "name": "tags", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get tags.", "intent": { "destructive": false, @@ -29277,22 +28977,7 @@ "security" ], "name": "authenticate", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Authenticate a user.", "intent": { "destructive": false, @@ -30428,22 +30113,7 @@ "security" ], "name": "enroll-kibana", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Enroll Kibana.", "intent": { "destructive": false, @@ -30459,22 +30129,7 @@ "security" ], "name": "enroll-node", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Enroll a node.", "intent": { "destructive": false, @@ -30577,22 +30232,7 @@ "security" ], "name": "get-builtin-privileges", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get builtin privileges.", "intent": { "destructive": false, @@ -30867,22 +30507,7 @@ "security" ], "name": "get-stats", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get security stats.", "intent": { "destructive": false, @@ -31014,22 +30639,7 @@ "security" ], "name": "get-user-privileges", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get user privileges.", "intent": { "destructive": false, @@ -33784,22 +33394,7 @@ "snapshot" ], "name": "get-repository", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get snapshot repository information.", "intent": { "destructive": false, @@ -34488,22 +34083,7 @@ "ssl" ], "name": "certificates", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get SSL certificates.", "intent": { "destructive": false, @@ -35742,7 +35322,59 @@ "transform" ], "name": "get-node-stats", + "parameters": [], + "summary": "Get node stats.", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "es", + "transform" + ], + "name": "get-transform", "parameters": [ + { + "role": "flag", + "name": "transform-id", + "type": "string", + "required": false, + "summary": "Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "repeatable": true + }, + { + "role": "flag", + "name": "allow-no-match", + "type": "boolean", + "required": false, + "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches." + }, + { + "role": "flag", + "name": "from", + "type": "number", + "required": false, + "summary": "Skips the specified number of transforms." + }, + { + "role": "flag", + "name": "size", + "type": "number", + "required": false, + "summary": "Specifies the maximum number of transforms to obtain." + }, + { + "role": "flag", + "name": "exclude-generated", + "type": "boolean", + "required": false, + "summary": "Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster." + }, { "role": "flag", "name": "input-file", @@ -35758,7 +35390,7 @@ "summary": "validate all inputs and exit without performing any action" } ], - "summary": "Get node stats.", + "summary": "Get transforms.", "intent": { "destructive": false, "idempotent": true, @@ -35772,80 +35404,13 @@ "es", "transform" ], - "name": "get-transform", + "name": "get-transform-stats", "parameters": [ { "role": "flag", "name": "transform-id", "type": "string", - "required": false, - "summary": "Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``.", - "repeatable": true - }, - { - "role": "flag", - "name": "allow-no-match", - "type": "boolean", - "required": false, - "summary": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches." - }, - { - "role": "flag", - "name": "from", - "type": "number", - "required": false, - "summary": "Skips the specified number of transforms." - }, - { - "role": "flag", - "name": "size", - "type": "number", - "required": false, - "summary": "Specifies the maximum number of transforms to obtain." - }, - { - "role": "flag", - "name": "exclude-generated", - "type": "boolean", - "required": false, - "summary": "Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster." - }, - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], - "summary": "Get transforms.", - "intent": { - "destructive": false, - "idempotent": true, - "scope": "global", - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "es", - "transform" - ], - "name": "get-transform-stats", - "parameters": [ - { - "role": "flag", - "name": "transform-id", - "type": "string", - "required": true, + "required": true, "summary": "Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``.", "repeatable": true }, @@ -37419,22 +36984,7 @@ "agent-builder" ], "name": "get-agent-builder-agents", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "List agents", "intent": { "destructive": false, @@ -38552,22 +38102,7 @@ "agent-builder" ], "name": "get-agent-builder-plugins", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "List plugins", "intent": { "destructive": false, @@ -38970,22 +38505,7 @@ "agent-builder" ], "name": "get-agent-builder-tools", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "List tools", "intent": { "destructive": false, @@ -40265,22 +39785,7 @@ "apm-agent-configuration" ], "name": "get-agent-configurations", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get a list of agent configurations", "intent": { "destructive": false, @@ -41211,22 +40716,7 @@ "connectors" ], "name": "get-actions-connectors", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get all connectors", "intent": { "destructive": false, @@ -41249,22 +40739,7 @@ "data-streams" ], "name": "get-fleet-data-streams", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get data streams", "intent": { "destructive": false, @@ -41342,22 +40817,7 @@ "data-views" ], "name": "get-all-data-views-default", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get all data views", "intent": { "destructive": false, @@ -41822,7 +41282,37 @@ "data-views" ], "name": "get-default-data-view-default", + "parameters": [], + "summary": "Get the default data view", + "intent": { + "destructive": false, + "idempotent": true, + "scope": "global", + "requiresAuth": true + } + }, + { + "path": [ + "stack", + "kb", + "data-views" + ], + "name": "set-default-datail-view-default", "parameters": [ + { + "role": "flag", + "name": "data-view-id", + "type": "string", + "required": true, + "summary": "The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view." + }, + { + "role": "flag", + "name": "force", + "type": "boolean", + "required": false, + "summary": "Update an existing default data view identifier." + }, { "role": "flag", "name": "input-file", @@ -41838,11 +41328,8 @@ "summary": "validate all inputs and exit without performing any action" } ], - "summary": "Get the default data view", + "summary": "Set the default data view", "intent": { - "destructive": false, - "idempotent": true, - "scope": "global", "requiresAuth": true } }, @@ -41852,21 +41339,49 @@ "kb", "data-views" ], - "name": "set-default-datail-view-default", + "name": "swap-data-views-default", "parameters": [ { "role": "flag", - "name": "data-view-id", + "name": "delete", + "type": "boolean", + "required": false, + "summary": "Deletes referenced saved object if all references are removed." + }, + { + "role": "flag", + "name": "for-id", + "type": "string", + "required": false, + "summary": "Limit the affected saved objects to one or more by identifier." + }, + { + "role": "flag", + "name": "for-type", + "type": "string", + "required": false, + "summary": "Limit the affected saved objects by type." + }, + { + "role": "flag", + "name": "from-id", "type": "string", "required": true, - "summary": "The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view." + "summary": "The saved object reference to change." }, { "role": "flag", - "name": "force", - "type": "boolean", + "name": "from-type", + "type": "string", "required": false, - "summary": "Update an existing default data view identifier." + "summary": "Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views." + }, + { + "role": "flag", + "name": "to-id", + "type": "string", + "required": true, + "summary": "New saved object reference value to replace the old value." }, { "role": "flag", @@ -41883,7 +41398,7 @@ "summary": "validate all inputs and exit without performing any action" } ], - "summary": "Set the default data view", + "summary": "Swap saved object references", "intent": { "requiresAuth": true } @@ -41894,77 +41409,7 @@ "kb", "data-views" ], - "name": "swap-data-views-default", - "parameters": [ - { - "role": "flag", - "name": "delete", - "type": "boolean", - "required": false, - "summary": "Deletes referenced saved object if all references are removed." - }, - { - "role": "flag", - "name": "for-id", - "type": "string", - "required": false, - "summary": "Limit the affected saved objects to one or more by identifier." - }, - { - "role": "flag", - "name": "for-type", - "type": "string", - "required": false, - "summary": "Limit the affected saved objects by type." - }, - { - "role": "flag", - "name": "from-id", - "type": "string", - "required": true, - "summary": "The saved object reference to change." - }, - { - "role": "flag", - "name": "from-type", - "type": "string", - "required": false, - "summary": "Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views." - }, - { - "role": "flag", - "name": "to-id", - "type": "string", - "required": true, - "summary": "New saved object reference value to replace the old value." - }, - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], - "summary": "Swap saved object references", - "intent": { - "requiresAuth": true - } - }, - { - "path": [ - "stack", - "kb", - "data-views" - ], - "name": "preview-swap-data-views-default", + "name": "preview-swap-data-views-default", "parameters": [ { "role": "flag", @@ -42754,22 +42199,7 @@ "elastic-agent-binary-download-sources" ], "name": "get-fleet-agent-download-sources", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get agent binary download sources", "intent": { "destructive": false, @@ -44656,22 +44086,7 @@ "elastic-agents" ], "name": "get-fleet-agents-available-versions", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get available agent versions", "intent": { "destructive": false, @@ -44874,22 +44289,7 @@ "elastic-agents" ], "name": "get-fleet-agents-setup", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get agent setup info", "intent": { "destructive": false, @@ -46501,22 +45901,7 @@ "elastic-package-manager-epm" ], "name": "get-fleet-epm-packages-limited", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get a limited package list", "intent": { "destructive": false, @@ -46595,22 +45980,7 @@ "elastic-package-manager-epm" ], "name": "get-fleet-epm-verification-key-id", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get a package signature verification key ID", "intent": { "destructive": false, @@ -47358,22 +46728,7 @@ "fleet-internals" ], "name": "get-fleet-settings", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get settings", "intent": { "destructive": false, @@ -47525,22 +46880,7 @@ "fleet-outputs" ], "name": "get-fleet-outputs", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get outputs", "intent": { "destructive": false, @@ -48156,22 +47496,7 @@ "fleet-proxies" ], "name": "get-fleet-proxies", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get proxies", "intent": { "destructive": false, @@ -48420,22 +47745,7 @@ "fleet-server-hosts" ], "name": "get-fleet-fleet-server-hosts", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get Fleet Server hosts", "intent": { "destructive": false, @@ -49173,22 +48483,7 @@ "misc" ], "name": "get-actions-connector-oauth-callback-script", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "intent": { "destructive": false, "idempotent": true, @@ -49203,22 +48498,7 @@ "misc" ], "name": "get-fleet-space-settings", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get space settings", "intent": { "destructive": false, @@ -49336,22 +48616,7 @@ "ml" ], "name": "ml-sync", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Sync saved objects in the default space", "intent": { "destructive": false, @@ -50534,22 +49799,7 @@ "security-ai-assistant-api" ], "name": "get-knowledge-base", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Read a KnowledgeBase", "intent": { "destructive": false, @@ -51840,22 +51090,7 @@ "security-detections-api" ], "name": "read-privileges", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Returns user privileges for the Kibana space", "intent": { "destructive": false, @@ -52510,22 +51745,7 @@ "security-detections-api" ], "name": "read-tags", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "List all detection rule tags", "intent": { "destructive": false, @@ -53807,22 +53027,7 @@ "security-endpoint-management-api" ], "name": "endpoint-get-actions-state", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get actions state", "intent": { "destructive": false, @@ -54587,22 +53792,7 @@ "security-entity-analytics-api" ], "name": "priv-mon-health", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Health check on Privilege Monitoring", "intent": { "destructive": false, @@ -54618,22 +53808,7 @@ "security-entity-analytics-api" ], "name": "priv-mon-privileges", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Run a privileges check on Privilege Monitoring", "intent": { "destructive": false, @@ -54884,22 +54059,7 @@ "security-entity-analytics-api" ], "name": "get-privileged-access-detection-package-status", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Gets the status of the privileged access detection package for the Entity Analytics privileged user monitoring experience", "intent": { "destructive": false, @@ -55082,22 +54242,7 @@ "security-entity-analytics-api" ], "name": "list-watchlists", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "List all watchlists", "intent": { "destructive": false, @@ -55267,22 +54412,7 @@ "security-entity-analytics-api" ], "name": "list-entity-engines", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "List the Entity Engines", "intent": { "destructive": false, @@ -57273,22 +56403,7 @@ "security-lists-api" ], "name": "read-list-index", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get status of value list data streams", "intent": { "destructive": false, @@ -57790,22 +56905,7 @@ "security-lists-api" ], "name": "read-list-privileges", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get value list privileges", "intent": { "destructive": false, @@ -60719,22 +59819,7 @@ "streams" ], "name": "get-streams", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get stream list", "intent": { "destructive": false, @@ -61919,22 +61004,7 @@ "task-manager" ], "name": "task-manager-health", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get the task manager health", "intent": { "destructive": false, @@ -62154,22 +61224,7 @@ "workflows" ], "name": "get-workflows-connectors", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get available connectors", "intent": { "destructive": false, @@ -62585,22 +61640,7 @@ "workflows" ], "name": "get-workflows-stats", - "parameters": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ], + "parameters": [], "summary": "Get workflow statistics", "intent": { "destructive": false, @@ -63184,7 +62224,22 @@ "trust" ], "name": "update-current-account", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Updates the current account", "intent": { "requiresAuth": true @@ -63196,7 +62251,22 @@ "trust" ], "name": "patch-current-account", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Updates the current account", "intent": { "requiresAuth": true @@ -63222,6 +62292,20 @@ "type": "string", "required": false, "summary": "Pagination cursor to get the next page of records" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get all API keys", @@ -63235,7 +62319,22 @@ "auth" ], "name": "create-api-key", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create API key", "intent": { "requiresAuth": true @@ -63247,7 +62346,22 @@ "auth" ], "name": "delete-api-keys", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Delete API keys", "intent": { "requiresAuth": true @@ -63266,6 +62380,20 @@ "type": "string", "required": true, "summary": "The API Key ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get API key", @@ -63286,6 +62414,20 @@ "type": "string", "required": true, "summary": "The API Key ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete API key", @@ -63327,6 +62469,20 @@ "type": "string", "required": false, "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get costs overview for the organization. Currently unavailable in self-hosted ECE.", @@ -63368,6 +62524,20 @@ "type": "string", "required": false, "summary": "The desired bucketing strategy for the charts. Defaults to `daily`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get charts for the organization. Currently unavailable in self-hosted ECE.", @@ -63402,6 +62572,20 @@ "type": "string", "required": false, "summary": "A datetime for the end of the desired range for which to fetch activity. Defaults to the current date." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get deployments costs for the organization. Currently unavailable in self-hosted ECE.", @@ -63450,6 +62634,20 @@ "type": "string", "required": false, "summary": "The desired bucketing strategy for the charts. Defaults to `daily`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get charts by deployment. Currently unavailable in self-hosted ECE.", @@ -63491,6 +62689,20 @@ "type": "string", "required": false, "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get itemized costs by deployments. Currently unavailable in self-hosted ECE.", @@ -63525,6 +62737,20 @@ "type": "string", "required": false, "summary": "A datetime for the end of the desired range for which to fetch costs. Defaults to the current date." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get itemized costs for the organization. Currently unavailable in self-hosted ECE.", @@ -63564,6 +62790,20 @@ "type": "string", "required": true, "summary": "Organization invitation token" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get organization invitation", @@ -63584,6 +62824,20 @@ "type": "string", "required": true, "summary": "Organization invitation token" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Accept an organization invitation", @@ -63604,6 +62858,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Fetch organization information", @@ -63624,6 +62892,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update organization", @@ -63644,6 +62926,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get domain claims", @@ -63664,6 +62960,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete domain claim", @@ -63684,6 +62994,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Generate verification code", @@ -63704,6 +63028,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Verify domain claim", @@ -63724,6 +63062,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get organization IdP", @@ -63744,6 +63096,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Setup organization IdP", @@ -63764,6 +63130,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Tear down organization IdP", @@ -63784,6 +63164,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get organization service provider SAML2 metadata.xml for configuring the identity provider", @@ -63804,6 +63198,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List organization invitations", @@ -63824,6 +63232,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create organization invitations", @@ -63851,6 +63273,20 @@ "type": "string", "required": true, "summary": "CSV list of Invitation tokens" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete organization invitations", @@ -63871,6 +63307,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List organization members", @@ -63905,6 +63355,20 @@ "type": "boolean", "required": false, "summary": "Whether or not to force the removal of Org memberships (effective only for Platform Admins)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete organization memberships", @@ -63925,6 +63389,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get role mappings", @@ -63945,6 +63423,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Updates role mappings", @@ -63965,6 +63457,20 @@ "type": "string", "required": true, "summary": "Identifier for the Organization" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete role mappings", @@ -63992,6 +63498,20 @@ "type": "string", "required": true, "summary": "Identifier for the user; include realm name and id if required" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add Role Assignments", @@ -64012,6 +63532,20 @@ "type": "string", "required": true, "summary": "Identifier for the user; include realm name and id if required" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Remove Role Assignments", @@ -64079,6 +63613,20 @@ "type": "string", "required": true, "summary": "Region of the deployment templates" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get deployment templates", @@ -64128,6 +63676,20 @@ "type": "string", "required": true, "summary": "Region of the deployment template" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get deployment template", @@ -64183,6 +63745,20 @@ "type": "string", "required": false, "summary": "An optional template id - if present, the referenced template will be used to fill in the resources field of the deployment creation request. If any resources are present in the request together with the template, the ones coming in the request will prevail and no merging with the template will be performed." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create Deployment", @@ -64204,6 +63780,20 @@ "type": "string", "required": false, "summary": "Comma separated list of attributes to include in response for deployments found. Useful for reducing response size when retrieving many deployments. Use of this parameter moves the result to the minimal_metadata section of the response." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Search Deployments", @@ -64225,6 +63815,20 @@ "type": "string", "required": true, "summary": "The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get eligible remote clusters", @@ -64344,6 +63948,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment", @@ -64393,6 +64011,20 @@ "type": "string", "required": false, "summary": "If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update Deployment", @@ -64421,6 +64053,20 @@ "type": "boolean", "required": false, "summary": "Whether or not to restore a snapshot for those resources that allow it." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Restores a shutdown Deployment", @@ -64456,6 +64102,20 @@ "type": "boolean", "required": false, "summary": "Whether or not to skip snapshots before shutting down the resources" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Shuts down Deployment", @@ -64533,6 +64193,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment APM Resource Info", @@ -64561,6 +64235,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reset the secret token for an APM resource.", @@ -64638,6 +64326,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment App Search Resource Info", @@ -64666,6 +64368,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set AppSearch read-only status", @@ -64694,6 +64410,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set AppSearch read-only status", @@ -64715,6 +64445,20 @@ "type": "string", "required": true, "summary": "Identifier for the Deployment." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get certificate authority", @@ -64820,6 +64564,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment Elasticsearch Resource Info", @@ -64855,6 +64613,20 @@ "type": "boolean", "required": false, "summary": "When `true`, will not enable CCR but returns warnings if any elements may lose availability during CCR enablement" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Migrate Elasticsearch and associated Kibana resources to enable CCR", @@ -64890,6 +64662,20 @@ "type": "boolean", "required": false, "summary": "When `true`, does not enable ILM but returns warnings if any applications may lose availability during ILM migration." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Migrate Elasticsearch resource to use ILM", @@ -64925,6 +64711,20 @@ "type": "boolean", "required": false, "summary": "When `true`, does not enable SLM but returns warnings if any applications may lose availability during SLM migration." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Migrate Elasticsearch resource to use SLM", @@ -64960,6 +64760,20 @@ "type": "boolean", "required": false, "summary": "If true, will not reset elastic user password and instead will return a status code signaling whether or not the current credentials are ready to use (eg from creation or the last call to _reset_password)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Reset 'elastic' user password", @@ -65023,6 +64837,20 @@ "type": "number", "required": false, "summary": "The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Restart Deployment Elasticsearch Resource", @@ -65065,6 +64893,20 @@ "type": "boolean", "required": false, "summary": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Shutdown Deployment Elasticsearch Resource", @@ -65093,6 +64935,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get eligible remote clusters", @@ -65121,6 +64977,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the items in the Elasticsearch resource keystore", @@ -65156,6 +65026,20 @@ "type": "boolean", "required": false, "summary": "When `true`, does nothing except return the entries' allowlist and reloadability statuses." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Add or remove items from the Elasticsearch resource keystore", @@ -65184,6 +65068,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get certificate based remote clusters", @@ -65212,6 +65110,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set certificate based remote clusters", @@ -65240,6 +65152,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List the attached snapshot repositories", @@ -65268,6 +65194,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a snapshot repository for Elasticsearch resource", @@ -65303,6 +65243,20 @@ "type": "string", "required": true, "summary": "The name of the snapshot repository to remove (e.g. _clone_abcd1234)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Remove the attached snapshot repository", @@ -65331,6 +65285,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Elasticsearch tiers", @@ -65359,6 +65327,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update Elasticsearch tiers", @@ -65436,6 +65418,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment Enterprise Search Resource Info", @@ -65513,6 +65509,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment Integrations Server Resource Info", @@ -65597,6 +65607,20 @@ "type": "boolean", "required": false, "summary": "If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment Kibana Resource Info", @@ -65632,6 +65656,20 @@ "type": "boolean", "required": false, "summary": "If true, will skip the instance metrics check for memory and disk usage calculations" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Build request to migrate deployment to a different template", @@ -65653,6 +65691,20 @@ "type": "string", "required": true, "summary": "Identifier for the Deployment" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the tags for a Deployment", @@ -65674,6 +65726,20 @@ "type": "string", "required": true, "summary": "Identifier for the Deployment" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Set the tags for a Deployment", @@ -65695,6 +65761,20 @@ "type": "string", "required": true, "summary": "Identifier for the Deployment" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Upgrade a Deployment to a new Elastic Stack version", @@ -65723,6 +65803,20 @@ "type": "string", "required": false, "summary": "If present, value is included in resource request to provide additional context (only supported for Kibana)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Deployment upgrade assistant status", @@ -65765,6 +65859,20 @@ "type": "boolean", "required": false, "summary": "Whether or not to restore a snapshot for those resources that allow it." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Restores a shutdown resource", @@ -65800,6 +65908,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start all instances", @@ -65835,6 +65957,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop all instances", @@ -65870,6 +66006,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start maintenance mode (all instances)", @@ -65905,6 +66055,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop maintenance mode (all instances)", @@ -65954,6 +66118,20 @@ "type": "boolean", "required": false, "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start instances", @@ -66003,6 +66181,20 @@ "type": "boolean", "required": false, "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop instances", @@ -66052,6 +66244,20 @@ "type": "boolean", "required": false, "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Start maintenance mode", @@ -66101,6 +66307,20 @@ "type": "boolean", "required": false, "summary": "If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Stop maintenance mode", @@ -66150,6 +66370,20 @@ "type": "boolean", "required": false, "summary": "When `true`, returns successfully, even when plans are missing. The default is `false`." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Cancel resource pending plan", @@ -66185,6 +66419,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the user settings of a Deployment resource", @@ -66220,6 +66468,20 @@ "type": "string", "required": true, "summary": "User-specified RefId for the Resource (or '_main' if there is only one)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update user settings for a deployment resource", @@ -66262,6 +66524,20 @@ "type": "boolean", "required": false, "summary": "If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Restart Deployment Stateless Resource", @@ -66311,6 +66587,20 @@ "type": "boolean", "required": false, "summary": "If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Shutdown Deployment Stateless Resource", @@ -66346,6 +66636,20 @@ "type": "string", "required": true, "summary": "Associated entity ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get associated rulesets", @@ -66374,6 +66678,20 @@ "type": "string", "required": false, "summary": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List traffic filter claimed link id", @@ -66388,7 +66706,22 @@ "traffic-filters" ], "name": "claim-traffic-filter-link-id", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Claim a link id", "intent": { "requiresAuth": true @@ -66401,7 +66734,22 @@ "traffic-filters" ], "name": "unclaim-traffic-filter-link-id", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Unclaims a link id", "intent": { "requiresAuth": true @@ -66435,6 +66783,20 @@ "type": "string", "required": false, "summary": "Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List traffic filter rulesets", @@ -66449,7 +66811,22 @@ "traffic-filters" ], "name": "create-traffic-filter-ruleset", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create a ruleset", "intent": { "requiresAuth": true @@ -66476,6 +66853,20 @@ "type": "boolean", "required": false, "summary": "Retrieves a list of resources that are associated to the specified ruleset." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Retrieves the ruleset by ID.", @@ -66497,6 +66888,20 @@ "type": "string", "required": true, "summary": "The mandatory ruleset ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Updates a ruleset", @@ -66525,6 +66930,20 @@ "type": "boolean", "required": false, "summary": "When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a ruleset", @@ -66546,6 +66965,20 @@ "type": "string", "required": true, "summary": "The mandatory ruleset ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get associated deployments", @@ -66567,6 +67000,20 @@ "type": "string", "required": true, "summary": "The mandatory ruleset ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create ruleset association", @@ -66602,6 +67049,20 @@ "type": "string", "required": true, "summary": "Associated entity ID" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete ruleset association", @@ -66636,7 +67097,22 @@ "extensions" ], "name": "create-extension", - "parameters": [], + "parameters": [ + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + } + ], "summary": "Create an extension", "intent": { "requiresAuth": true @@ -66663,6 +67139,20 @@ "type": "boolean", "required": false, "summary": "Include deployments referencing this extension. Up to only 10000 deployments will be included." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Extension", @@ -66684,6 +67174,20 @@ "type": "string", "required": true, "summary": "Id of an extension" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update Extension", @@ -66705,6 +67209,20 @@ "type": "string", "required": true, "summary": "Id of an extension" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Uploads the Extension", @@ -66726,6 +67244,20 @@ "type": "string", "required": true, "summary": "Id of an extension" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete Extension", @@ -66761,6 +67293,20 @@ "type": "boolean", "required": false, "summary": "Whether to show versions that are unusable by the authenticated user" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get stack versions", @@ -66835,6 +67381,20 @@ "type": "string", "required": false, "summary": "If specified, the result will be filtered to only those projects that have the specified tags and corresponding values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Elasticsearch projects", @@ -66865,6 +67425,20 @@ "required": true, "summary": "Unique human-readable identifier for a region in Elastic Cloud." }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + }, { "role": "flag", "name": "wait", @@ -66921,6 +67495,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an Elasticsearch project", @@ -66943,6 +67531,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an Elasticsearch project", @@ -66965,6 +67567,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an Elasticsearch project", @@ -66988,6 +67604,20 @@ "required": true, "summary": "The ID of the project" }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + }, { "role": "flag", "name": "save-as", @@ -67037,6 +67667,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resume Elasticsearch project", @@ -67059,6 +67703,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get roles for an Elasticsearch project", @@ -67081,6 +67739,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the status of an Elasticsearch project", @@ -67124,6 +67796,20 @@ "type": "string", "required": false, "summary": "If specified, the result will be filtered to only those projects that have the specified tags and corresponding values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Observability projects", @@ -67154,6 +67840,20 @@ "required": true, "summary": "Unique human-readable identifier for a region in Elastic Cloud." }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + }, { "role": "flag", "name": "wait", @@ -67210,6 +67910,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get an Observability project", @@ -67232,6 +67946,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete an Observability project", @@ -67254,6 +67982,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update an Observability project", @@ -67277,6 +68019,20 @@ "required": true, "summary": "The ID of the project" }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + }, { "role": "flag", "name": "save-as", @@ -67326,6 +68082,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resume Observability project", @@ -67348,6 +68118,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get roles for an Observability project", @@ -67370,6 +68154,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the status of an Observability project", @@ -67413,6 +68211,20 @@ "type": "string", "required": false, "summary": "If specified, the result will be filtered to only those projects that have the specified tags and corresponding values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Security projects", @@ -67443,6 +68255,20 @@ "required": true, "summary": "Unique human-readable identifier for a region in Elastic Cloud." }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + }, { "role": "flag", "name": "wait", @@ -67499,6 +68325,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a Security project", @@ -67521,6 +68361,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a Security project", @@ -67543,6 +68397,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Update a Security project", @@ -67566,6 +68434,20 @@ "required": true, "summary": "The ID of the project" }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" + }, { "role": "flag", "name": "save-as", @@ -67615,6 +68497,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Resume Security project", @@ -67637,6 +68533,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get roles for a Security project", @@ -67659,6 +68569,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get the status of a Security project", @@ -67732,6 +68656,20 @@ "type": "string", "required": false, "summary": "If specified, the result will be filtered to only those projects that have the specified tags and corresponding values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Elasticsearch project link candidates", @@ -67795,6 +68733,20 @@ "type": "string", "required": false, "summary": "If specified, the result will be filtered to only those projects that have the specified tags and corresponding values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Observability project link candidates", @@ -67858,6 +68810,20 @@ "type": "string", "required": false, "summary": "If specified, the result will be filtered to only those projects that have the specified tags and corresponding values." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Security project link candidates", @@ -67879,6 +68845,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Elasticsearch project delete status", @@ -67900,6 +68880,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Observability project delete status", @@ -67921,6 +68915,20 @@ "type": "string", "required": true, "summary": "The ID of the project" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get Security project delete status", @@ -67962,6 +68970,20 @@ "type": "string", "required": true, "summary": "ID of the region" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Get a region", @@ -67997,6 +69019,20 @@ "type": "string", "required": false, "summary": "If provided limits the traffic filters to that region only." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List traffic filters", @@ -68032,6 +69068,20 @@ "type": "string", "required": true, "summary": "The traffic filter can be attached only to projects in the specific region" + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Create a traffic filter", @@ -68060,6 +69110,20 @@ "type": "string", "required": false, "summary": "Filter metadata to a specific cloud service provider (aws, azure, gcp)." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "List PrivateLink region metadata", @@ -68081,6 +69145,20 @@ "type": "string", "required": true, "summary": "The traffic filter ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Retrieves the traffic filter by ID.", @@ -68102,6 +69180,20 @@ "type": "string", "required": true, "summary": "The traffic filter ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Delete a traffic filter", @@ -68123,6 +69215,20 @@ "type": "string", "required": true, "summary": "The traffic filter ID." + }, + { + "role": "flag", + "name": "input-file", + "type": "string", + "required": false, + "summary": "path to a JSON file to use as command input" + }, + { + "role": "dryRun", + "name": "dry-run", + "type": "boolean", + "required": false, + "summary": "validate all inputs and exit without performing any action" } ], "summary": "Updates a traffic filter", @@ -68138,23 +69244,7 @@ "summary": "Manage Elastic Serverless projects and resources" } ], - "summary": "Manage Elastic Cloud (hosted deployments and serverless projects)", - "options": [ - { - "role": "flag", - "name": "input-file", - "type": "string", - "required": false, - "summary": "path to a JSON file to use as command input" - }, - { - "role": "dryRun", - "name": "dry-run", - "type": "boolean", - "required": false, - "summary": "validate all inputs and exit without performing any action" - } - ] + "summary": "Manage Elastic Cloud (hosted deployments and serverless projects)" }, { "segment": "docs", diff --git a/src/cloud/register.ts b/src/cloud/register.ts index 54148ab4..12936819 100644 --- a/src/cloud/register.ts +++ b/src/cloud/register.ts @@ -165,6 +165,7 @@ function buildFlatLeaf (def: CloudApiDefinition): OpaqueCommandHandle { name: def.name, description: def.description, input: schema, + readOnly: def.method === 'GET', handler: createCloudHandler(def), }) } @@ -213,6 +214,7 @@ function buildServerlessTypeGroup ( name: shortName, description: def.description, input: schema, + readOnly: def.method === 'GET', handler, }) if (isCreateProjectCommand(def.name)) { diff --git a/src/es/register.ts b/src/es/register.ts index b50a976a..e95a9d12 100644 --- a/src/es/register.ts +++ b/src/es/register.ts @@ -77,6 +77,7 @@ function buildLeafHandle ( name: def.name, description: def.description, input: schema, + readOnly: def.method === 'GET' || def.method === 'HEAD', handler: async (parsed) => { const { createEsHandler } = await import('./handler.js') return createEsHandler(def, schemaArgs)(parsed) diff --git a/src/factory-core.ts b/src/factory-core.ts index 00dc935c..0232bbd2 100644 --- a/src/factory-core.ts +++ b/src/factory-core.ts @@ -73,6 +73,11 @@ export interface CommandConfig { input?: T formatOutput?: (result: JsonValue, parsed: ParsedResult>) => string intent?: CommandIntent + /** + * Marks a command as read-only (GET/HEAD). When the input schema is also + * empty, --input-file and --dry-run are hidden from help (#378). + */ + readOnly?: boolean } /** Configuration for a command group (namespace). */ diff --git a/src/factory.ts b/src/factory.ts index 399fe5ea..c1ae8fae 100644 --- a/src/factory.ts +++ b/src/factory.ts @@ -373,11 +373,18 @@ export function defineCommand (config: CommandConfig): O } } } - if (config.input instanceof getZ().ZodType) { + // Read-only (GET/HEAD) commands with an empty input schema (e.g. `es info`) + // take no input at all, so --input-file and --dry-run would be no-ops; hide + // them (#378). Write commands keep --input-file even with an empty schema + // because loose schemas pass the whole file through as the request body. + const inputIsEmptyObject = config.input instanceof getZ().ZodObject && + Object.keys(config.input.shape).length === 0 + const hideNoInputFlags = config.readOnly === true && inputIsEmptyObject + if (config.input instanceof getZ().ZodType && !hideNoInputFlags) { cmd.option('--input-file ', 'path to a JSON file to use as command input') } const schemaClaimsDryRun = schemaArgs.some((a) => a.cliFlag === 'dry-run') - if (!schemaClaimsDryRun) { + if (!schemaClaimsDryRun && !hideNoInputFlags) { cmd.option('--dry-run', 'validate all inputs and exit without performing any action') } diff --git a/src/kb/register.ts b/src/kb/register.ts index 83f01f91..c120783a 100644 --- a/src/kb/register.ts +++ b/src/kb/register.ts @@ -71,6 +71,7 @@ function buildLeafHandle (def: KbApiDefinition): OpaqueCommandHandle { name: def.name, description: def.description, input: schema, + readOnly: def.method === 'GET' || def.method === 'HEAD', handler: createKbHandler(def), ...(def.intent != null || inferIntentFromHttp(def.method) != null ? { intent: def.intent ?? inferIntentFromHttp(def.method)! } diff --git a/test/factory.test.ts b/test/factory.test.ts index 51bce0af..1762ccaf 100644 --- a/test/factory.test.ts +++ b/test/factory.test.ts @@ -1955,7 +1955,7 @@ describe('defineCommand', () => { }) describe('--dry-run', () => { - it('appears in help text for every command', () => { + it('appears in help text for commands without an input schema', () => { const cmd = defineCommand({ name: 'ping', description: 'Ping', @@ -1964,6 +1964,44 @@ describe('defineCommand', () => { assert.match(cmd.helpInformation(), /--dry-run/) }) + it('is hidden together with --input-file for read-only commands with an empty input schema (#378)', () => { + const cmd = defineCommand({ + name: 'info', + description: 'Get cluster info', + input: z.looseObject({}), + readOnly: true, + handler: () => ({}), + }) + const help = cmd.helpInformation() + assert.doesNotMatch(help, /--dry-run/) + assert.doesNotMatch(help, /--input-file/) + }) + + it('stays visible for read-only commands whose input schema has fields', () => { + const cmd = defineCommand({ + name: 'search', + description: 'Search', + input: z.object({ index: z.string() }), + readOnly: true, + handler: () => ({}), + }) + const help = cmd.helpInformation() + assert.match(help, /--dry-run/) + assert.match(help, /--input-file/) + }) + + it('stays visible for write commands with an empty input schema (body via --input-file)', () => { + const cmd = defineCommand({ + name: 'create', + description: 'Create a thing', + input: z.looseObject({}), + handler: () => ({}), + }) + const help = cmd.helpInformation() + assert.match(help, /--dry-run/) + assert.match(help, /--input-file/) + }) + it('outputs {"success":true} when --json and skips the handler', async () => { let handlerCalled = false const cmd = defineCommand({