From 58ff788779048f9043ba737d30f368044a4fd449 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Mon, 13 Jul 2026 19:53:34 +0200 Subject: [PATCH 1/3] Migrate cli-schema generation onto the published @cli-schema/* packages Retires this repo's local cli-schema.ts implementation in favor of @cli-schema/spec, @cli-schema/zod, and @cli-schema/commander (extracted from this exact codebase, published at github.com/cli-schema/cli-schema-js). - factory.ts: the _commandConfig non-enumerable attach point is replaced with @cli-schema/commander's attachInput/attachIntent (the sole prior reader, cli-schema.ts, is the only thing that changes here -- runtime option/argument registration and request handling are untouched). - lib/schema-args.ts: thin wrapper re-exporting @cli-schema/zod's generic extractor, adding back Elastic's found_in/sort-pairs enrichment and reserved flag list via the package's enrich/reserved hooks. - cli-schema.ts: shrinks from ~600 lines to the ENVIRONMENT constant plus a handler that calls the package's buildCliSchema, passing classifyRole (to keep --dry-run as the only name-based role, matching prior emission), enrichSchemaArg, and postProcessInputParameter (for the body-routed CSV separator) -- all the local types/JSON-Schema helpers/walkers/hoisting logic the package now does are deleted. - cli-schema-intent.ts: deleted; es/register.ts and kb/register.ts now import inferIntentFromHttp from @cli-schema/spec (byte-for-byte identical behavior). This surfaced and fixed a real bug in @cli-schema/commander 0.1.0 (shipped as 0.1.1): every ES/KB command's Zod-schema-derived flags are registered as real but *inaccurate* Commander options here (always optional, no Commander-visible default, since actual required/default/enum enforcement happens via Zod after merging flags with --input-file/stdin input) -- the package's old "skip if a real option already covers this flag" rule silently discarded that richer schema detail for nearly every parameter in this CLI. Fixed upstream via a mergeParameter hook (schema wins on richness, Commander wins on role/shortName/hidden) rather than picking one source over the other. docs/cli/schema.json is regenerated, not byte-identical (root key order and empty-array omission now follow the spec's canonical shape), but every parameter's content is preserved exactly: 6915 parameters before and after, identical counts for separator (50), repeatable (391), number (358), and enum (61) fields, and the full document validates against @cli-schema/spec's own meta-schema validator. The only 7 real diffs are ES's own native "dry_run" query/body fields (e.g. cluster reroute, ILM migrate-to-data-tiers) gaining role: "dryRun" instead of "flag" -- previously only the framework-injected --dry-run flag got that classification; the merge fix applies the same role-by-name heuristic uniformly regardless of which side registered the flag. Added a regression test asserting the body-routed/query-routed separator distinction survives end-to-end through the new wiring. Regenerated NOTICE.txt for the three new bundled dependencies. --- NOTICE.txt | 773 +++++++++++ docs/cli/schema.json | 2624 ++++++++++++++++++-------------------- package-lock.json | 98 +- package.json | 6 + src/cli-schema-intent.ts | 29 - src/cli-schema.ts | 541 +------- src/es/register.ts | 2 +- src/factory.ts | 12 +- src/kb/register.ts | 2 +- src/lib/schema-args.ts | 275 +--- test/cli-schema.test.ts | 51 + 11 files changed, 2266 insertions(+), 2147 deletions(-) delete mode 100644 src/cli-schema-intent.ts diff --git a/NOTICE.txt b/NOTICE.txt index 02d7767b..d75711ff 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -8,6 +8,620 @@ This product includes software developed by Elastic Third-party software notices and licenses ======================================================================== +------------------------------------------------------------------------ +@cli-schema/commander@0.1.1 +License: MIT +Repository: https://github.com/cli-schema/cli-schema-js +------------------------------------------------------------------------ + +# @cli-schema/commander + +Generates a [CLI Schema](https://github.com/cli-schema/cli-schema) document from a live +[Commander](https://github.com/tj/commander.js) command tree — dynamically. There's no +registration list to keep in sync: point it at your `program` and it walks the real commands, +options, and positionals you already built. + +Part of the [`cli-schema-js`](https://github.com/cli-schema/cli-schema-js) monorepo. + +## Quickstart + +```sh +npm install @cli-schema/commander commander +``` + +```ts +import { Command } from 'commander' +import { buildCliSchema } from '@cli-schema/commander' + +const program = new Command('mytool') +program.command('search').description('Search an index').argument('') + +const schema = buildCliSchema(program, { name: 'mytool', version: '1.0.0' }) +console.log(JSON.stringify(schema, null, 2)) +``` + +That's a valid CLI Schema document already — `name`, `version`, and `commands` are discovered +automatically. Everything below is about enriching it. + +## Purpose + +Commander already knows your command tree — names, descriptions, options, positionals, aliases. +What it *doesn't* know is the extra layer CLI Schema adds on top for agent/tooling consumption: +side-effect intent (is this destructive? does it need confirmation?), richer parameter typing +than Commander's own model (enums, array element types, range constraints), and structured +metadata like tags or deprecation notices. + +`@cli-schema/commander` bridges that gap. It reads everything Commander already exposes +dynamically, and gives you two ways — a fluent one and a functional one — to attach the parts +Commander has no concept of. + +## Features + +- **Dynamic discovery, not registration** — `buildCliSchema(root, options)` walks `root.commands` + recursively. Options and positionals come straight from Commander's own `cmd.options` / + `cmd.registeredArguments`. There's nothing to forget to register. +- **Two equivalent ways to attach `.intent()` / `.input()` / `.cliMeta()`:** + - **Fluent**, via an opt-in `Command.prototype` augmentation: + ```ts + import '@cli-schema/commander/augment' + ``` + - **Functional**, with no prototype patching at all: + ```ts + import { attachIntent, attachInput, attachCliMeta } from '@cli-schema/commander' + ``` + `buildCliSchema` reads either form identically — pick whichever fits your codebase, or mix + them. +- **Zod input schemas become extra parameters automatically.** Attach a schema with `.input()` / + `attachInput()`; `buildCliSchema` derives parameters for it via + [`@cli-schema/zod`](https://www.npmjs.com/package/@cli-schema/zod) (types, enums, array element + types, validation constraints). When a schema field's flag name already matches a real + Commander option, the two are **reconciled**, not one discarding the other — see + [Reconciling Commander and schema detail](#reconciling-commander-and-schema-detail). +- **Flag-role heuristics, overridable.** `--dry-run` is classified `role: "dryRun"` and + `--yes`/`--force`/`--confirm`/`--no-input`/`--non-interactive` as `role: "confirmationSkip"` by + default (spec §6.1) — pass `classifyRole` to change the rule. +- **Automatic option hoisting.** Flags common to every command in a namespace are promoted to + that namespace's `options`; flags common across *every* namespace and root command are promoted + further to the document's `globalOptions`. You don't repeat `--json` on every single command in + the emitted document just because every command in your CLI happens to support it. +- **Reconciling Commander and schema detail is a hook, not a fixed rule.** `mergeParameter` + (default: schema wins on richness, Commander wins on `role`/`shortName`/`hidden`), + `enrichSchemaArg`, and `postProcessInputParameter` let you tune or fully override how the two + sources combine for a given flag — see + [Reconciling Commander and schema detail](#reconciling-commander-and-schema-detail). +- **Hidden commands respected.** Commands registered with Commander's own + `{ hidden: true }` (via `.command()`/`.addCommand()`) are excluded from the document. +- **`registerZodOptions`** — an opt-in convenience for quick CLIs: derives and registers basic + Commander options directly from a Zod schema, so you don't hand-write `.option()` calls at all. +- **Spec-conformant, lenient output.** Empty `commands`/`namespaces`/`globalOptions` are omitted + rather than emitted as empty arrays, matching the specification's lenient root object. + +## Usage + +### Attaching intent (fluent) + +```ts +import '@cli-schema/commander/augment' +import { Command } from 'commander' + +const del = new Command('delete') + .description('Delete a document') + .argument('') + .intent({ destructive: true, idempotent: true, scope: 'global', requiresConfirmation: true }) +``` + +### Attaching intent (functional — no prototype patching) + +```ts +import { Command } from 'commander' +import { attachIntent } from '@cli-schema/commander' + +const del = new Command('delete').description('Delete a document').argument('') +attachIntent(del, { destructive: true, idempotent: true, scope: 'global', requiresConfirmation: true }) +``` + +### Deriving parameters from a Zod input schema + +```ts +import { z } from 'zod' +import { Command } from 'commander' +import '@cli-schema/commander/augment' +import { buildCliSchema } from '@cli-schema/commander' + +const search = new Command('search') + .description('Search an index') + .input(z.object({ + q: z.string().describe('Query string'), + size: z.number().default(10).describe('Number of results'), + })) + +const program = new Command('mytool').addCommand(search) +const schema = buildCliSchema(program, { name: 'mytool', version: '1.0.0' }) +// schema.commands[0].parameters includes `q` and `size`, with types/descriptions/defaults +// derived straight from the Zod schema — even though neither was ever registered as a real +// Commander `.option()`. +``` + +If you *do* want real, working `--q`/`--size` flags, register them yourself with `.option()`, or +use `registerZodOptions` for the simple case: + +```ts +import { registerZodOptions } from '@cli-schema/commander' + +registerZodOptions(search, z.object({ q: z.string(), size: z.number().default(10) })) +// search now has real --q and --size options. +``` + +### Reconciling Commander and schema detail + +If a schema field's flag name matches a real Commander option, `buildCliSchema` doesn't have to +choose one source and throw the other away — it **merges** them, by default preferring the +schema's richer detail (`type`, `required`, `defaultValue`, `enumValues`, `elementType`, +`validations`, `repeatable`, `summary`) while keeping `role`, `shortName`, and `hidden` from the +real Commander `Option`, since a Zod schema has no concept of any of those. + +Why this needs to be a decision at all, rather than always trusting Commander: some CLIs register +every option on Commander as merely *optional*, with no default, and enforce `required`/defaults/ +enum membership/ranges purely through the Zod schema at parse time — often because a value can +arrive through more than one channel (a flag, a JSON file, stdin), and Commander can only ever +validate the flag form. In that shape, Commander's own `Option` is an inaccurate, impoverished +view of the real contract; the schema is the source of truth for everything except the raw +flag/alias/hidden surface. Other CLIs pass accurate `required`/defaults to Commander directly and +only reach for a schema to layer JSON-Schema detail (enums, ranges) on top — there, the existing +option's `required`/`default` might be just as trustworthy as the schema's. + +Because which side is authoritative depends on how your CLI is built, this is exposed as a hook — +`mergeParameter` — rather than a fixed rule or a `merge`/`replace` toggle: + +```ts +buildCliSchema(program, { + name: 'mytool', + version: '1.0.0', + // Trust Commander over the schema when both describe the same flag: + mergeParameter: (commanderParam, schemaParam) => commanderParam ?? schemaParam, +}) +``` + +The default behaves as if you'd written +`mergeParameter: (commanderParam, schemaParam) => commanderParam == null ? schemaParam : { ...schemaParam, role: commanderParam.role, shortName: commanderParam.shortName, hidden: commanderParam.hidden }`. + +Two more hooks round this out: +- `enrichSchemaArg?: (field, base) => Record` — threaded to `@cli-schema/zod`'s + own `extractSchemaArgs` `enrich` option, for attaching your own metadata (e.g. HTTP-transport + routing) to a schema arg before it becomes a parameter. +- `postProcessInputParameter?: (param, arg) => Parameter` — runs after `mergeParameter`, so you + can add fields this package has no business knowing about — e.g. a `separator` that only + applies to array-accepting fields your framework routes into a JSON body: + ```ts + buildCliSchema(program, { + name: 'mytool', + version: '1.0.0', + enrichSchemaArg: (field) => ({ foundIn: field.meta()?.found_in }), + postProcessInputParameter: (param, arg) => + arg.acceptsArrayForm && (arg as { foundIn?: string }).foundIn === 'body' + ? { ...param, separator: ',' } + : param, + }) + ``` + +### Extra metadata (`notes`, `tags`, `output`, ...) + +Anything the spec's [Command Object](https://github.com/cli-schema/cli-schema/blob/main/spec/v1/README.md#7-command-object) +defines that Commander has no concept of — `notes`, `usage`, `examples`, `tags`, `deprecated`, +`output`, `streaming`, `longRunning` — goes through `.cliMeta()` / `attachCliMeta()`: + +```ts +del.cliMeta({ + tags: ['dangerous'], + deprecated: { message: 'Use `purge` instead', since: '2.0.0' }, +}) +``` + +### Building the full document + +```ts +import { buildCliSchema } from '@cli-schema/commander' + +const schema = buildCliSchema(program, { + name: 'mytool', + version: '1.4.2', + description: 'An example CLI', + environment: { + variables: [{ name: 'MYTOOL_TOKEN', required: false, description: 'API token' }], + configFiles: [{ path: '~/.mytoolrc.yml', required: false }], + }, + reservedMetaCommands: ['__schema'], + // Namespaces/commands NOT in this set default to intent.requiresAuth: true, unless a command + // explicitly sets its own requiresAuth via .intent()/attachIntent(). + noContextNames: new Set(['config', 'help']), +}) +``` + +### Wiring up spec discovery (`__schema`) + +The spec recommends implementations respond to a single `__schema` argument by printing the +document to stdout (spec §4.1). A minimal wiring: + +```ts +program + .command('__schema', { hidden: true }) + .description('Emit the CLI structure as JSON') + .action(() => { + console.log(JSON.stringify(buildCliSchema(program, { name: 'mytool', version: '1.4.2' }), null, 2)) + }) +``` + +Registering it as `hidden` keeps it out of your own `--help` output while still being +discoverable by anything that knows to run `mytool __schema`. + +### Custom role classification + +```ts +buildCliSchema(program, { + name: 'mytool', + version: '1.0.0', + classifyRole: (longName) => (longName === 'nuke' ? 'confirmationSkip' : 'flag'), +}) +``` + +## Related packages + +- [`@cli-schema/spec`](https://www.npmjs.com/package/@cli-schema/spec) — the `CliSchema`/`Intent`/`Parameter` types this package produces, plus a validator to check the result +- [`@cli-schema/zod`](https://www.npmjs.com/package/@cli-schema/zod) — the Zod-schema introspection this package uses for `.input()`-derived parameters + +## License + +MIT + + +------------------------------------------------------------------------ +@cli-schema/spec@0.1.1 +License: MIT +Repository: https://github.com/cli-schema/cli-schema-js +------------------------------------------------------------------------ + +# @cli-schema/spec + +TypeScript types, the vendored meta-schema, and a validator for the +[CLI Schema specification](https://github.com/cli-schema/cli-schema) v1 — the open standard for +describing command-line interfaces in a language-agnostic, machine-readable way. + +This is the only package in the [`cli-schema-js`](https://github.com/cli-schema/cli-schema-js) +monorepo with no CLI-framework dependency. It defines the *shape* of a CLI Schema document; +[`@cli-schema/commander`](https://www.npmjs.com/package/@cli-schema/commander) is what actually +produces one from a real CLI. + +## Quickstart + +```sh +npm install @cli-schema/spec +``` + +```ts +import { validate, SCHEMA_VERSION, type CliSchema } from '@cli-schema/spec' + +const doc: CliSchema = { + schemaVersion: SCHEMA_VERSION, + name: 'mytool', + version: '1.0.0', +} + +const result = validate(doc) +if (!result.valid) throw new Error(JSON.stringify(result.errors, null, 2)) +``` + +That's the minimum: a document only needs `schemaVersion`, `name`, and `version` to be valid — +everything else (commands, parameters, environment, intent, ...) is optional enrichment. + +## Purpose + +CLI help text is written for humans, completion scripts are hand-authored per shell, and AI +agents guess flags. CLI Schema fixes this by defining one JSON document format that describes a +program's commands, parameters, intent, auth requirements, environment dependencies, and output +capabilities — so agents, IDEs, shell-completion generators, and docs tooling can all read the +same document instead of re-deriving it. + +`@cli-schema/spec` is the compile-time and runtime contract for that format: the types you build +a document against, and the validator you check it with before trusting it. + +## Features + +- **Full v1 type coverage** — every object in the spec has a corresponding TypeScript interface: + `CliSchema` (root), `Command`, `Namespace`, `Parameter`, `Constraint`, `Intent`, `Output`, + `Environment`, `EnvVar`, `ConfigFile`, `DefaultHandler`, `Shortcut`, `Deprecation`. +- **The normative meta-schema, vendored** — `schema/cli-schema.meta-schema.json` from the spec + repo, re-exported at `@cli-schema/spec/meta-schema.json` for tools that want the raw JSON + Schema directly (e.g. to validate in a non-JS pipeline, or feed to a codegen tool). +- **A ready-to-use validator** — `validate()` / `assertValid()`, backed by + [ajv](https://ajv.js.org)'s 2020-12 dialect support. No need to wire up ajv yourself. +- **`inferIntentFromHttp`** — a small pure helper for CLIs that wrap HTTP APIs: derives a + reasonable {@link Intent} from an HTTP verb (`GET`/`HEAD` → safe & idempotent, `PUT` → + idempotent, `DELETE` → destructive & idempotent, `POST`/`PATCH` → unset, since their semantics + are endpoint-specific). +- **Vendor extensions typed** — every object that permits `x-` prefixed fields (spec §14) is + typed to accept them (`[extension: \`x-${string}\`]: unknown`), so `x-my-tool: {...}` type-checks + without `as any`. + +## Usage + +### Building a document by hand + +The types double as documentation of the format — reach for the [spec +itself](https://github.com/cli-schema/cli-schema/blob/main/spec/v1/README.md) for full field +semantics, but a well-populated document looks like: + +```ts +import type { CliSchema } from '@cli-schema/spec' + +const doc: CliSchema = { + schemaVersion: 1, + name: 'gh', + version: '2.45.0', + description: 'GitHub CLI — bring GitHub to your terminal', + requiresAuth: true, + authCommands: ['auth login', 'auth logout'], + reservedMetaCommands: ['__schema'], + commands: [ + { + name: 'status', + summary: 'Print information about relevant issues, pull requests, and notifications', + intent: { destructive: false, idempotent: true, requiresAuth: true }, + }, + ], + namespaces: [ + { + segment: 'repo', + commands: [ + { + name: 'delete', + path: ['repo'], + parameters: [ + { role: 'positional', name: 'repository', type: 'string', required: true }, + { role: 'confirmationSkip', name: 'yes', type: 'boolean', required: false }, + ], + intent: { destructive: true, idempotent: true, scope: 'global', requiresConfirmation: true }, + }, + ], + }, + ], +} +``` + +In practice you'll usually generate this from a live CLI rather than write it by hand — see +[`@cli-schema/commander`](https://www.npmjs.com/package/@cli-schema/commander). + +### Validating an untrusted document + +Per spec §15, consumers should treat schema documents as untrusted input: + +```ts +import { validate, assertValid } from '@cli-schema/spec' + +const { valid, errors } = validate(untrustedDoc) +// errors is an ajv ErrorObject[] — empty when valid + +assertValid(untrustedDoc) // throws with a formatted message if invalid +``` + +### Reading the raw meta-schema + +```ts +import metaSchema from '@cli-schema/spec/meta-schema.json' with { type: 'json' } +``` + +Useful if you want to validate documents with your own ajv instance, a different validator +entirely, or a non-JS tool. + +### Deriving intent from an HTTP verb + +```ts +import { inferIntentFromHttp } from '@cli-schema/spec' + +inferIntentFromHttp('DELETE') // { destructive: true, idempotent: true, scope: 'global' } +inferIntentFromHttp('POST') // undefined — annotate explicitly, semantics vary per endpoint +``` + +## Related packages + +- [`@cli-schema/zod`](https://www.npmjs.com/package/@cli-schema/zod) — derive `Parameter`s from Zod schemas +- [`@cli-schema/commander`](https://www.npmjs.com/package/@cli-schema/commander) — generate a full `CliSchema` from a live Commander tree + +## License + +MIT + + +------------------------------------------------------------------------ +@cli-schema/zod@0.1.1 +License: MIT +Repository: https://github.com/cli-schema/cli-schema-js +------------------------------------------------------------------------ + +# @cli-schema/zod + +Derives [CLI Schema](https://github.com/cli-schema/cli-schema) parameter definitions from +[Zod](https://zod.dev) schemas — types, requiredness, defaults, descriptions, and JSON-Schema +validation constraints, all read directly off the schema you already wrote for validation. + +Part of the [`cli-schema-js`](https://github.com/cli-schema/cli-schema-js) monorepo. Framework- +agnostic: it doesn't know about Commander, yargs, or any other CLI library — it only knows Zod +in, structured parameter data out. [`@cli-schema/commander`](https://www.npmjs.com/package/@cli-schema/commander) +builds on top of it. + +## Quickstart + +```sh +npm install @cli-schema/zod zod +``` + +```ts +import { z } from 'zod' +import { extractSchemaArgs } from '@cli-schema/zod' + +const SearchInput = z.object({ + index: z.string().describe('Index to search'), + size: z.number().default(10).describe('Number of results'), +}) + +extractSchemaArgs(SearchInput) +// [ +// { schemaKey: 'index', cliFlag: 'index', type: 'string', required: true, description: 'Index to search' }, +// { schemaKey: 'size', cliFlag: 'size', type: 'number', required: false, description: 'Number of results', defaultValue: 10 }, +// ] +``` + +That's the core of it: one Zod object schema in, one CLI parameter definition per top-level key +out. + +## Purpose + +If your CLI already validates its input with Zod, that schema *is* a complete, precise +description of every flag the command accepts — type, requiredness, default, description, +enum/range/length constraints. Re-describing all of that by hand for help text, documentation, or +a CLI Schema document is duplicated, drifting work. `@cli-schema/zod` reads it back out. + +It deliberately knows nothing about any particular CLI's own conventions (routing metadata, +custom parsing hints, reserved flag names) — those vary per project, so they're exposed as +extension points (`enrich`, a `reserved` list) rather than baked in. + +## Features + +- **`extractSchemaArgs`** — the main entry point. Walks a `z.object()`'s top-level shape and + returns one `SchemaArgDefinition` per key: + - **Type inference** across `string`, `number`, `integer` (zod's `z.int()`), `boolean`, + `object`, `array`, `enum` — including through `.optional()`, `.default()`, `z.lazy()`, + `z.union()` (first member wins), `z.record()`/`z.any()`/`z.unknown()` (→ `object`). + - **Kebab-case flag names** derived from the schema key (`toKebabCase`) — handles + `snake_case`, `camelCase`, and strips leading underscores (`_source` → `source`). + - **Requiredness and defaults** — a field is required only if it's neither optional nor + defaulted; `defaultValue` is read straight off `.default(...)`. + - **Descriptions** from `.describe()` / `.meta({ description })`. + - **`acceptsArrayForm`** detection for the `union(T, array(T))` pattern — a common way to let a + field accept either a single value or a collection while keeping the type inference on the + scalar branch for CLI ergonomics. + - **An `enrich` hook** so your own framework can attach extra fields (routing metadata, parse + hints, anything) without this package needing to know what they mean. +- **`validateSchemaArgs`** — fail-fast collision detection: throws if two schema keys would + produce the same CLI flag, or if a flag collides with your CLI's reserved names. +- **`buildFlagKeyMap`** — a bidirectional `cliFlag` ↔ `schemaKey` map, for merging parsed CLI + flags back into the shape your Zod schema expects. +- **JSON-Schema-derived enrichment** (`zodToJsonSchema`, `extractEnumValues`, + `extractElementType`, `extractValidations`) — for the detail `extractSchemaArgs` alone can't + carry (enum values, array element types, range/length/regex/email/url constraints), reusing + Zod's own `toJSONSchema()` rather than re-implementing schema introspection. +- **`readMetaField` / `walkWrapperChain`** — the low-level primitives the above are built on, + exported for CLIs that need their own custom extraction (e.g. a `found_in` routing tag, or a + named-shape check like "is this schema tagged `Sort` anywhere in its wrapper chain"). + +## Usage + +### Basic extraction + +```ts +import { z } from 'zod' +import { extractSchemaArgs } from '@cli-schema/zod' + +const args = extractSchemaArgs(z.object({ + numShards: z.number().min(1).max(100), + level: z.enum(['low', 'medium', 'high']).default('medium'), + tags: z.array(z.string()).optional(), +})) + +args.map((a) => a.cliFlag) // ['num-shards', 'level', 'tags'] +``` + +### Attaching framework-specific extras with `enrich` + +Say your CLI routes some fields to an HTTP path/query/body via `.meta({ found_in: '...' })`. +Rather than this package hardcoding that convention, thread it through `enrich`: + +```ts +import { z } from 'zod' +import { extractSchemaArgs, type SchemaArgDefinition } from '@cli-schema/zod' + +interface MyExtras { + foundIn?: 'path' | 'query' | 'body' +} + +const schema = z.object({ + index: z.string().meta({ found_in: 'path' }), + q: z.string().optional().meta({ found_in: 'query' }), +}) + +const args: Array = extractSchemaArgs(schema, { + enrich: (field, base) => { + const foundIn = (field.meta() as Record | undefined)?.['found_in'] + return foundIn != null ? { foundIn } : {} + }, +}) +``` + +### Validating for flag collisions + +```ts +import { validateSchemaArgs } from '@cli-schema/zod' + +// throws: "help" collides with a name your CLI already uses for --help +validateSchemaArgs(extractSchemaArgs(z.object({ help: z.string() })), ['help', 'json', 'config-file']) +``` + +`reserved` defaults to `['help']` if omitted, since nearly every CLI framework reserves +`--help`. + +### Round-tripping flags back to schema keys + +```ts +import { buildFlagKeyMap } from '@cli-schema/zod' + +const map = buildFlagKeyMap(args) +map.toSchemaKey.get('num-shards') // 'numShards' +map.toCliFlag.get('numShards') // 'num-shards' +``` + +### Enum values, array element types, and validation constraints + +`extractSchemaArgs` alone doesn't carry enum values or range/length constraints — those need the +full JSON Schema, which is a separate (and more expensive) step best done once per command: + +```ts +import { z } from 'zod' +import { extractSchemaArgs, zodToJsonSchema, extractEnumValues, extractElementType, extractValidations } from '@cli-schema/zod' + +const schema = z.object({ + level: z.enum(['low', 'medium', 'high']), + size: z.number().min(1).max(100), +}) + +const root = zodToJsonSchema(schema) +const properties = root.properties as Record> + +for (const arg of extractSchemaArgs(schema)) { + const node = properties[arg.schemaKey] + console.log(arg.cliFlag, { + enumValues: extractEnumValues(node, root), + elementType: extractElementType(node, root), // only meaningful when arg.type === 'array' + validations: extractValidations(node, root), // e.g. [{ kind: 'range', min: '1', max: '100' }] + }) +} +``` + +`extractValidations` covers the constraint kinds directly derivable from JSON Schema keywords — +`range` (`minimum`/`maximum`), `length` (`minLength`/`maxLength`), `regex` (`pattern`), `email` +and `url` (`format`). Kinds that need domain knowledge beyond what JSON Schema expresses +(`timeSpanRange`, `count`, `allowed`, `denied`, `uriScheme`, `fileExtensions`, `existing`, +`nonExisting`, `rejectSymbolicLinks` — see the [spec](https://github.com/cli-schema/cli-schema/blob/main/spec/v1/README.md#62-constraints)) +aren't inferred automatically; attach them via the `enrich` hook if your schema encodes them. + +## Related packages + +- [`@cli-schema/spec`](https://www.npmjs.com/package/@cli-schema/spec) — the `Constraint`/`Parameter` types this package's JSON-Schema helpers produce +- [`@cli-schema/commander`](https://www.npmjs.com/package/@cli-schema/commander) — wires this package's output into a full `CliSchema` document from a live Commander tree + +## License + +MIT + + ------------------------------------------------------------------------ @colors/colors@1.5.0 License: MIT @@ -89,6 +703,36 @@ The above copyright notice and this permission notice shall be included in all c THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +------------------------------------------------------------------------ +ajv@8.20.0 +License: MIT +Repository: https://github.com/ajv-validator/ajv +Publisher: Evgeny Poberezkin +------------------------------------------------------------------------ + +The MIT License (MIT) + +Copyright (c) 2015-2021 Evgeny Poberezkin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + ------------------------------------------------------------------------ ansi-escapes@7.3.0 License: MIT @@ -532,6 +1176,75 @@ The above copyright notice and this permission notice shall be included in all c THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +------------------------------------------------------------------------ +fast-deep-equal@3.1.3 +License: MIT +Repository: https://github.com/epoberezkin/fast-deep-equal +Publisher: Evgeny Poberezkin +------------------------------------------------------------------------ + +MIT License + +Copyright (c) 2017 Evgeny Poberezkin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + +------------------------------------------------------------------------ +fast-uri@3.1.3 +License: BSD-3-Clause +Repository: https://github.com/fastify/fast-uri +Publisher: Vincent Le Goff (https://github.com/zekth) +------------------------------------------------------------------------ + +Copyright (c) 2011-2021, Gary Court until https://github.com/garycourt/uri-js/commit/a1acf730b4bba3f1097c9f52e7d9d3aba8cdcaae +Copyright (c) 2021-present The Fastify team +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * The names of any contributors may not be used to endorse or promote + products derived from this software without specific prior written + permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + * * * + +The complete list of contributors can be found at: +- https://github.com/garycourt/uri-js/graphs/contributors + + ------------------------------------------------------------------------ get-caller-file@2.0.5 License: ISC @@ -621,6 +1334,36 @@ The above copyright notice and this permission notice shall be included in all c THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +------------------------------------------------------------------------ +json-schema-traverse@1.0.0 +License: MIT +Repository: https://github.com/epoberezkin/json-schema-traverse +Publisher: Evgeny Poberezkin +------------------------------------------------------------------------ + +MIT License + +Copyright (c) 2017 Evgeny Poberezkin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + ------------------------------------------------------------------------ marked-terminal@7.3.0 License: MIT @@ -911,6 +1654,36 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +------------------------------------------------------------------------ +require-from-string@2.0.2 +License: MIT +Repository: https://github.com/floatdrop/require-from-string +Publisher: Vsevolod Strukchinsky (github.com/floatdrop) +------------------------------------------------------------------------ + +The MIT License (MIT) + +Copyright (c) Vsevolod Strukchinsky (github.com/floatdrop) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + ------------------------------------------------------------------------ skin-tone@2.0.0 License: MIT diff --git a/docs/cli/schema.json b/docs/cli/schema.json index 7dc09cb1..b8894974 100644 --- a/docs/cli/schema.json +++ b/docs/cli/schema.json @@ -2,18 +2,7 @@ "schemaVersion": 1, "name": "elastic", "version": "0.2.0", - "reservedMetaCommands": [ - "cli-schema" - ], - "globalOptions": [ - { - "role": "flag", - "name": "json", - "type": "boolean", - "required": false, - "summary": "output as JSON" - } - ], + "description": "Interface with the Elastic Stack and Elastic Cloud from the command line.", "environment": { "variables": [ { @@ -55,9 +44,20 @@ } ] }, + "reservedMetaCommands": [ + "cli-schema" + ], + "globalOptions": [ + { + "role": "flag", + "name": "json", + "type": "boolean", + "required": false, + "summary": "output as JSON" + } + ], "commands": [ { - "path": [], "name": "version", "parameters": [ { @@ -77,17 +77,16 @@ "namespaces": [ { "segment": "stack", - "commands": [], "namespaces": [ { "segment": "es", "commands": [ { + "name": "bulk", "path": [ "stack", "es" ], - "name": "bulk", "parameters": [ { "role": "flag", @@ -211,11 +210,11 @@ } }, { + "name": "create", "path": [ "stack", "es" ], - "name": "create", "parameters": [ { "role": "flag", @@ -332,11 +331,11 @@ } }, { + "name": "delete", "path": [ "stack", "es" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -433,11 +432,11 @@ } }, { + "name": "delete-by-query", "path": [ "stack", "es" ], - "name": "delete-by-query", "parameters": [ { "role": "flag", @@ -689,11 +688,11 @@ } }, { + "name": "exists", "path": [ "stack", "es" ], - "name": "exists", "parameters": [ { "role": "flag", @@ -808,11 +807,11 @@ } }, { + "name": "exists-source", "path": [ "stack", "es" ], - "name": "exists-source", "parameters": [ { "role": "flag", @@ -919,11 +918,11 @@ } }, { + "name": "get", "path": [ "stack", "es" ], - "name": "get", "parameters": [ { "role": "flag", @@ -1045,11 +1044,11 @@ } }, { + "name": "get-source", "path": [ "stack", "es" ], - "name": "get-source", "parameters": [ { "role": "flag", @@ -1156,11 +1155,11 @@ } }, { + "name": "index", "path": [ "stack", "es" ], - "name": "index", "parameters": [ { "role": "flag", @@ -1298,11 +1297,11 @@ } }, { + "name": "mget", "path": [ "stack", "es" ], - "name": "mget", "parameters": [ { "role": "flag", @@ -1412,11 +1411,11 @@ } }, { + "name": "reindex", "path": [ "stack", "es" ], - "name": "reindex", "parameters": [ { "role": "flag", @@ -1530,11 +1529,11 @@ } }, { + "name": "update", "path": [ "stack", "es" ], - "name": "update", "parameters": [ { "role": "flag", @@ -1709,11 +1708,11 @@ } }, { + "name": "update-by-query", "path": [ "stack", "es" ], - "name": "update-by-query", "parameters": [ { "role": "flag", @@ -1984,11 +1983,11 @@ } }, { + "name": "clear-scroll", "path": [ "stack", "es" ], - "name": "clear-scroll", "parameters": [ { "role": "flag", @@ -2023,11 +2022,11 @@ } }, { + "name": "close-point-in-time", "path": [ "stack", "es" ], - "name": "close-point-in-time", "parameters": [ { "role": "flag", @@ -2060,11 +2059,11 @@ } }, { + "name": "msearch", "path": [ "stack", "es" ], - "name": "msearch", "parameters": [ { "role": "flag", @@ -2197,11 +2196,11 @@ } }, { + "name": "msearch-template", "path": [ "stack", "es" ], - "name": "msearch-template", "parameters": [ { "role": "flag", @@ -2276,11 +2275,11 @@ } }, { + "name": "open-point-in-time", "path": [ "stack", "es" ], - "name": "open-point-in-time", "parameters": [ { "role": "flag", @@ -2369,11 +2368,11 @@ } }, { + "name": "render-search-template", "path": [ "stack", "es" ], - "name": "render-search-template", "parameters": [ { "role": "flag", @@ -2426,11 +2425,11 @@ } }, { + "name": "scroll", "path": [ "stack", "es" ], - "name": "scroll", "parameters": [ { "role": "flag", @@ -2477,11 +2476,11 @@ } }, { + "name": "search", "path": [ "stack", "es" ], - "name": "search", "parameters": [ { "role": "flag", @@ -2977,11 +2976,11 @@ } }, { + "name": "search-mvt", "path": [ "stack", "es" ], - "name": "search-mvt", "parameters": [ { "role": "flag", @@ -3142,11 +3141,11 @@ } }, { + "name": "search-shards", "path": [ "stack", "es" ], - "name": "search-shards", "parameters": [ { "role": "flag", @@ -3231,11 +3230,11 @@ } }, { + "name": "search-template", "path": [ "stack", "es" ], - "name": "search-template", "parameters": [ { "role": "flag", @@ -3383,11 +3382,11 @@ } }, { + "name": "count", "path": [ "stack", "es" ], - "name": "count", "parameters": [ { "role": "flag", @@ -3525,11 +3524,11 @@ } }, { + "name": "explain", "path": [ "stack", "es" ], - "name": "explain", "parameters": [ { "role": "flag", @@ -3665,11 +3664,11 @@ } }, { + "name": "field-caps", "path": [ "stack", "es" ], - "name": "field-caps", "parameters": [ { "role": "flag", @@ -3777,11 +3776,11 @@ } }, { + "name": "mtermvectors", "path": [ "stack", "es" ], - "name": "mtermvectors", "parameters": [ { "role": "flag", @@ -3907,11 +3906,11 @@ } }, { + "name": "rank-eval", "path": [ "stack", "es" ], - "name": "rank-eval", "parameters": [ { "role": "flag", @@ -3988,11 +3987,11 @@ } }, { + "name": "terms-enum", "path": [ "stack", "es" ], - "name": "terms-enum", "parameters": [ { "role": "flag", @@ -4075,11 +4074,11 @@ } }, { + "name": "termvectors", "path": [ "stack", "es" ], - "name": "termvectors", "parameters": [ { "role": "flag", @@ -4219,11 +4218,11 @@ } }, { + "name": "delete-script", "path": [ "stack", "es" ], - "name": "delete-script", "parameters": [ { "role": "flag", @@ -4270,11 +4269,11 @@ } }, { + "name": "get-script", "path": [ "stack", "es" ], - "name": "get-script", "parameters": [ { "role": "flag", @@ -4314,11 +4313,11 @@ } }, { + "name": "get-script-context", "path": [ "stack", "es" ], - "name": "get-script-context", "parameters": [ { "role": "flag", @@ -4344,11 +4343,11 @@ } }, { + "name": "get-script-languages", "path": [ "stack", "es" ], - "name": "get-script-languages", "parameters": [ { "role": "flag", @@ -4374,11 +4373,11 @@ } }, { + "name": "put-script", "path": [ "stack", "es" ], - "name": "put-script", "parameters": [ { "role": "flag", @@ -4439,11 +4438,11 @@ } }, { + "name": "scripts-painless-execute", "path": [ "stack", "es" ], - "name": "scripts-painless-execute", "parameters": [ { "role": "flag", @@ -4490,11 +4489,11 @@ } }, { + "name": "health-report", "path": [ "stack", "es" ], - "name": "health-report", "parameters": [ { "role": "flag", @@ -4549,11 +4548,11 @@ } }, { + "name": "info", "path": [ "stack", "es" ], - "name": "info", "parameters": [ { "role": "flag", @@ -4579,11 +4578,11 @@ } }, { + "name": "ping", "path": [ "stack", "es" ], - "name": "ping", "parameters": [ { "role": "flag", @@ -4609,11 +4608,11 @@ } }, { + "name": "delete-by-query-rethrottle", "path": [ "stack", "es" ], - "name": "delete-by-query-rethrottle", "parameters": [ { "role": "flag", @@ -4650,11 +4649,11 @@ } }, { + "name": "reindex-rethrottle", "path": [ "stack", "es" ], - "name": "reindex-rethrottle", "parameters": [ { "role": "flag", @@ -4691,11 +4690,11 @@ } }, { + "name": "update-by-query-rethrottle", "path": [ "stack", "es" ], - "name": "update-by-query-rethrottle", "parameters": [ { "role": "flag", @@ -4732,11 +4731,11 @@ } }, { + "name": "helpers", "path": [ "stack", "es" ], - "name": "helpers", "parameters": [], "summary": "High-level helper commands for common Elasticsearch workflows", "intent": { @@ -4749,12 +4748,12 @@ "segment": "async-search", "commands": [ { + "name": "delete", "path": [ "stack", "es", "async-search" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -4787,12 +4786,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "async-search" ], - "name": "get", "parameters": [ { "role": "flag", @@ -4853,12 +4852,12 @@ } }, { + "name": "status", "path": [ "stack", "es", "async-search" ], - "name": "status", "parameters": [ { "role": "flag", @@ -4898,12 +4897,12 @@ } }, { + "name": "submit", "path": [ "stack", "es", "async-search" ], - "name": "submit", "parameters": [ { "role": "flag", @@ -5371,19 +5370,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch async-search API commands" }, { "segment": "cat", "commands": [ { + "name": "aliases", "path": [ "stack", "es", "cat" ], - "name": "aliases", "parameters": [ { "role": "flag", @@ -5448,12 +5446,12 @@ } }, { + "name": "allocation", "path": [ "stack", "es", "cat" ], - "name": "allocation", "parameters": [ { "role": "flag", @@ -5517,12 +5515,12 @@ } }, { + "name": "circuit-breaker", "path": [ "stack", "es", "cat" ], - "name": "circuit-breaker", "parameters": [ { "role": "flag", @@ -5586,12 +5584,12 @@ } }, { + "name": "component-templates", "path": [ "stack", "es", "cat" ], - "name": "component-templates", "parameters": [ { "role": "flag", @@ -5654,12 +5652,12 @@ } }, { + "name": "count", "path": [ "stack", "es", "cat" ], - "name": "count", "parameters": [ { "role": "flag", @@ -5706,12 +5704,12 @@ } }, { + "name": "fielddata", "path": [ "stack", "es", "cat" ], - "name": "fielddata", "parameters": [ { "role": "flag", @@ -5761,12 +5759,12 @@ } }, { + "name": "health", "path": [ "stack", "es", "cat" ], - "name": "health", "parameters": [ { "role": "flag", @@ -5815,12 +5813,12 @@ } }, { + "name": "help", "path": [ "stack", "es", "cat" ], - "name": "help", "parameters": [ { "role": "flag", @@ -5846,12 +5844,12 @@ } }, { + "name": "indices", "path": [ "stack", "es", "cat" ], - "name": "indices", "parameters": [ { "role": "flag", @@ -5937,12 +5935,12 @@ } }, { + "name": "master", "path": [ "stack", "es", "cat" ], - "name": "master", "parameters": [ { "role": "flag", @@ -5998,12 +5996,12 @@ } }, { + "name": "ml-data-frame-analytics", "path": [ "stack", "es", "cat" ], - "name": "ml-data-frame-analytics", "parameters": [ { "role": "flag", @@ -6059,12 +6057,12 @@ } }, { + "name": "ml-datafeeds", "path": [ "stack", "es", "cat" ], - "name": "ml-datafeeds", "parameters": [ { "role": "flag", @@ -6120,12 +6118,12 @@ } }, { + "name": "ml-jobs", "path": [ "stack", "es", "cat" ], - "name": "ml-jobs", "parameters": [ { "role": "flag", @@ -6181,12 +6179,12 @@ } }, { + "name": "ml-trained-models", "path": [ "stack", "es", "cat" ], - "name": "ml-trained-models", "parameters": [ { "role": "flag", @@ -6256,12 +6254,12 @@ } }, { + "name": "nodeattrs", "path": [ "stack", "es", "cat" ], - "name": "nodeattrs", "parameters": [ { "role": "flag", @@ -6317,12 +6315,12 @@ } }, { + "name": "nodes", "path": [ "stack", "es", "cat" ], - "name": "nodes", "parameters": [ { "role": "flag", @@ -6385,12 +6383,12 @@ } }, { + "name": "pending-tasks", "path": [ "stack", "es", "cat" ], - "name": "pending-tasks", "parameters": [ { "role": "flag", @@ -6446,12 +6444,12 @@ } }, { + "name": "plugins", "path": [ "stack", "es", "cat" ], - "name": "plugins", "parameters": [ { "role": "flag", @@ -6514,12 +6512,12 @@ } }, { + "name": "recovery", "path": [ "stack", "es", "cat" ], - "name": "recovery", "parameters": [ { "role": "flag", @@ -6583,12 +6581,12 @@ } }, { + "name": "repositories", "path": [ "stack", "es", "cat" ], - "name": "repositories", "parameters": [ { "role": "flag", @@ -6644,12 +6642,12 @@ } }, { + "name": "segments", "path": [ "stack", "es", "cat" ], - "name": "segments", "parameters": [ { "role": "flag", @@ -6749,12 +6747,12 @@ } }, { + "name": "shards", "path": [ "stack", "es", "cat" ], - "name": "shards", "parameters": [ { "role": "flag", @@ -6811,12 +6809,12 @@ } }, { + "name": "snapshots", "path": [ "stack", "es", "cat" ], - "name": "snapshots", "parameters": [ { "role": "flag", @@ -6880,12 +6878,12 @@ } }, { + "name": "tasks", "path": [ "stack", "es", "cat" ], - "name": "tasks", "parameters": [ { "role": "flag", @@ -6969,12 +6967,12 @@ } }, { + "name": "templates", "path": [ "stack", "es", "cat" ], - "name": "templates", "parameters": [ { "role": "flag", @@ -7037,12 +7035,12 @@ } }, { + "name": "thread-pool", "path": [ "stack", "es", "cat" ], - "name": "thread-pool", "parameters": [ { "role": "flag", @@ -7106,12 +7104,12 @@ } }, { + "name": "transforms", "path": [ "stack", "es", "cat" ], - "name": "transforms", "parameters": [ { "role": "flag", @@ -7181,19 +7179,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch cat API commands" }, { "segment": "ccr", "commands": [ { + "name": "delete-auto-follow-pattern", "path": [ "stack", "es", "ccr" ], - "name": "delete-auto-follow-pattern", "parameters": [ { "role": "flag", @@ -7233,12 +7230,12 @@ } }, { + "name": "follow", "path": [ "stack", "es", "ccr" ], - "name": "follow", "parameters": [ { "role": "flag", @@ -7383,12 +7380,12 @@ } }, { + "name": "follow-info", "path": [ "stack", "es", "ccr" ], - "name": "follow-info", "parameters": [ { "role": "flag", @@ -7429,12 +7426,12 @@ } }, { + "name": "follow-stats", "path": [ "stack", "es", "ccr" ], - "name": "follow-stats", "parameters": [ { "role": "flag", @@ -7475,12 +7472,12 @@ } }, { + "name": "forget-follower", "path": [ "stack", "es", "ccr" ], - "name": "forget-follower", "parameters": [ { "role": "flag", @@ -7541,12 +7538,12 @@ } }, { + "name": "get-auto-follow-pattern", "path": [ "stack", "es", "ccr" ], - "name": "get-auto-follow-pattern", "parameters": [ { "role": "flag", @@ -7586,12 +7583,12 @@ } }, { + "name": "pause-auto-follow-pattern", "path": [ "stack", "es", "ccr" ], - "name": "pause-auto-follow-pattern", "parameters": [ { "role": "flag", @@ -7628,12 +7625,12 @@ } }, { + "name": "pause-follow", "path": [ "stack", "es", "ccr" ], - "name": "pause-follow", "parameters": [ { "role": "flag", @@ -7670,12 +7667,12 @@ } }, { + "name": "put-auto-follow-pattern", "path": [ "stack", "es", "ccr" ], - "name": "put-auto-follow-pattern", "parameters": [ { "role": "flag", @@ -7820,12 +7817,12 @@ } }, { + "name": "resume-auto-follow-pattern", "path": [ "stack", "es", "ccr" ], - "name": "resume-auto-follow-pattern", "parameters": [ { "role": "flag", @@ -7862,12 +7859,12 @@ } }, { + "name": "resume-follow", "path": [ "stack", "es", "ccr" ], - "name": "resume-follow", "parameters": [ { "role": "flag", @@ -7964,12 +7961,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "ccr" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -8009,12 +8006,12 @@ } }, { + "name": "unfollow", "path": [ "stack", "es", "ccr" ], - "name": "unfollow", "parameters": [ { "role": "flag", @@ -8051,19 +8048,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch ccr API commands" }, { "segment": "cluster", "commands": [ { + "name": "allocation-explain", "path": [ "stack", "es", "cluster" ], - "name": "allocation-explain", "parameters": [ { "role": "flag", @@ -8138,12 +8134,12 @@ } }, { + "name": "delete-component-template", "path": [ "stack", "es", "cluster" ], - "name": "delete-component-template", "parameters": [ { "role": "flag", @@ -8191,12 +8187,12 @@ } }, { + "name": "delete-voting-config-exclusions", "path": [ "stack", "es", "cluster" ], - "name": "delete-voting-config-exclusions", "parameters": [ { "role": "flag", @@ -8236,12 +8232,12 @@ } }, { + "name": "exists-component-template", "path": [ "stack", "es", "cluster" ], - "name": "exists-component-template", "parameters": [ { "role": "flag", @@ -8289,12 +8285,12 @@ } }, { + "name": "get-component-template", "path": [ "stack", "es", "cluster" ], - "name": "get-component-template", "parameters": [ { "role": "flag", @@ -8363,12 +8359,12 @@ } }, { + "name": "get-settings", "path": [ "stack", "es", "cluster" ], - "name": "get-settings", "parameters": [ { "role": "flag", @@ -8422,12 +8418,12 @@ } }, { + "name": "health", "path": [ "stack", "es", "cluster" ], - "name": "health", "parameters": [ { "role": "flag", @@ -8539,12 +8535,12 @@ } }, { + "name": "info", "path": [ "stack", "es", "cluster" ], - "name": "info", "parameters": [ { "role": "flag", @@ -8585,12 +8581,12 @@ } }, { + "name": "pending-tasks", "path": [ "stack", "es", "cluster" ], - "name": "pending-tasks", "parameters": [ { "role": "flag", @@ -8630,12 +8626,12 @@ } }, { + "name": "post-voting-config-exclusions", "path": [ "stack", "es", "cluster" ], - "name": "post-voting-config-exclusions", "parameters": [ { "role": "flag", @@ -8688,12 +8684,12 @@ } }, { + "name": "put-component-template", "path": [ "stack", "es", "cluster" ], - "name": "put-component-template", "parameters": [ { "role": "flag", @@ -8775,12 +8771,12 @@ } }, { + "name": "put-settings", "path": [ "stack", "es", "cluster" ], - "name": "put-settings", "parameters": [ { "role": "flag", @@ -8841,12 +8837,12 @@ } }, { + "name": "remote-info", "path": [ "stack", "es", "cluster" ], - "name": "remote-info", "parameters": [ { "role": "flag", @@ -8872,15 +8868,15 @@ } }, { + "name": "reroute", "path": [ "stack", "es", "cluster" ], - "name": "reroute", "parameters": [ { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -8943,12 +8939,12 @@ } }, { + "name": "state", "path": [ "stack", "es", "cluster" ], - "name": "state", "parameters": [ { "role": "flag", @@ -9047,12 +9043,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "cluster" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -9078,19 +9074,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch cluster API commands" }, { "segment": "connector", "commands": [ { + "name": "check-in", "path": [ "stack", "es", "connector" ], - "name": "check-in", "parameters": [ { "role": "flag", @@ -9123,12 +9118,12 @@ } }, { + "name": "delete", "path": [ "stack", "es", "connector" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -9175,12 +9170,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "connector" ], - "name": "get", "parameters": [ { "role": "flag", @@ -9220,12 +9215,12 @@ } }, { + "name": "list", "path": [ "stack", "es", "connector" ], - "name": "list", "parameters": [ { "role": "flag", @@ -9303,12 +9298,12 @@ } }, { + "name": "post", "path": [ "stack", "es", "connector" ], - "name": "post", "parameters": [ { "role": "flag", @@ -9367,12 +9362,12 @@ } }, { + "name": "put", "path": [ "stack", "es", "connector" ], - "name": "put", "parameters": [ { "role": "flag", @@ -9441,12 +9436,12 @@ } }, { + "name": "sync-job-cancel", "path": [ "stack", "es", "connector" ], - "name": "sync-job-cancel", "parameters": [ { "role": "flag", @@ -9479,12 +9474,12 @@ } }, { + "name": "sync-job-check-in", "path": [ "stack", "es", "connector" ], - "name": "sync-job-check-in", "parameters": [ { "role": "flag", @@ -9517,12 +9512,12 @@ } }, { + "name": "sync-job-claim", "path": [ "stack", "es", "connector" ], - "name": "sync-job-claim", "parameters": [ { "role": "flag", @@ -9569,12 +9564,12 @@ } }, { + "name": "sync-job-delete", "path": [ "stack", "es", "connector" ], - "name": "sync-job-delete", "parameters": [ { "role": "flag", @@ -9607,12 +9602,12 @@ } }, { + "name": "sync-job-error", "path": [ "stack", "es", "connector" ], - "name": "sync-job-error", "parameters": [ { "role": "flag", @@ -9652,12 +9647,12 @@ } }, { + "name": "sync-job-get", "path": [ "stack", "es", "connector" ], - "name": "sync-job-get", "parameters": [ { "role": "flag", @@ -9690,12 +9685,12 @@ } }, { + "name": "sync-job-list", "path": [ "stack", "es", "connector" ], - "name": "sync-job-list", "parameters": [ { "role": "flag", @@ -9757,12 +9752,12 @@ } }, { + "name": "sync-job-post", "path": [ "stack", "es", "connector" ], - "name": "sync-job-post", "parameters": [ { "role": "flag", @@ -9804,12 +9799,12 @@ } }, { + "name": "sync-job-update-stats", "path": [ "stack", "es", "connector" ], - "name": "sync-job-update-stats", "parameters": [ { "role": "flag", @@ -9884,12 +9879,12 @@ } }, { + "name": "update-active-filtering", "path": [ "stack", "es", "connector" ], - "name": "update-active-filtering", "parameters": [ { "role": "flag", @@ -9922,12 +9917,12 @@ } }, { + "name": "update-api-key-id", "path": [ "stack", "es", "connector" ], - "name": "update-api-key-id", "parameters": [ { "role": "flag", @@ -9972,12 +9967,12 @@ } }, { + "name": "update-configuration", "path": [ "stack", "es", "connector" ], - "name": "update-configuration", "parameters": [ { "role": "flag", @@ -10022,12 +10017,12 @@ } }, { + "name": "update-error", "path": [ "stack", "es", "connector" ], - "name": "update-error", "parameters": [ { "role": "flag", @@ -10066,12 +10061,12 @@ } }, { + "name": "update-features", "path": [ "stack", "es", "connector" ], - "name": "update-features", "parameters": [ { "role": "flag", @@ -10110,12 +10105,12 @@ } }, { + "name": "update-filtering", "path": [ "stack", "es", "connector" ], - "name": "update-filtering", "parameters": [ { "role": "flag", @@ -10166,12 +10161,12 @@ } }, { + "name": "update-filtering-validation", "path": [ "stack", "es", "connector" ], - "name": "update-filtering-validation", "parameters": [ { "role": "flag", @@ -10210,12 +10205,12 @@ } }, { + "name": "update-index-name", "path": [ "stack", "es", "connector" ], - "name": "update-index-name", "parameters": [ { "role": "flag", @@ -10254,12 +10249,12 @@ } }, { + "name": "update-name", "path": [ "stack", "es", "connector" ], - "name": "update-name", "parameters": [ { "role": "flag", @@ -10304,12 +10299,12 @@ } }, { + "name": "update-native", "path": [ "stack", "es", "connector" ], - "name": "update-native", "parameters": [ { "role": "flag", @@ -10348,12 +10343,12 @@ } }, { + "name": "update-pipeline", "path": [ "stack", "es", "connector" ], - "name": "update-pipeline", "parameters": [ { "role": "flag", @@ -10392,12 +10387,12 @@ } }, { + "name": "update-scheduling", "path": [ "stack", "es", "connector" ], - "name": "update-scheduling", "parameters": [ { "role": "flag", @@ -10436,12 +10431,12 @@ } }, { + "name": "update-service-type", "path": [ "stack", "es", "connector" ], - "name": "update-service-type", "parameters": [ { "role": "flag", @@ -10480,12 +10475,12 @@ } }, { + "name": "update-status", "path": [ "stack", "es", "connector" ], - "name": "update-status", "parameters": [ { "role": "flag", @@ -10524,19 +10519,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch connector API commands" }, { "segment": "dangling-indices", "commands": [ { + "name": "delete-dangling-index", "path": [ "stack", "es", "dangling-indices" ], - "name": "delete-dangling-index", "parameters": [ { "role": "flag", @@ -10590,12 +10584,12 @@ } }, { + "name": "import-dangling-index", "path": [ "stack", "es", "dangling-indices" ], - "name": "import-dangling-index", "parameters": [ { "role": "flag", @@ -10646,12 +10640,12 @@ } }, { + "name": "list-dangling-indices", "path": [ "stack", "es", "dangling-indices" ], - "name": "list-dangling-indices", "parameters": [ { "role": "flag", @@ -10677,19 +10671,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch dangling-indices API commands" }, { "segment": "enrich", "commands": [ { + "name": "delete-policy", "path": [ "stack", "es", "enrich" ], - "name": "delete-policy", "parameters": [ { "role": "flag", @@ -10729,12 +10722,12 @@ } }, { + "name": "execute-policy", "path": [ "stack", "es", "enrich" ], - "name": "execute-policy", "parameters": [ { "role": "flag", @@ -10781,12 +10774,12 @@ } }, { + "name": "get-policy", "path": [ "stack", "es", "enrich" ], - "name": "get-policy", "parameters": [ { "role": "flag", @@ -10827,12 +10820,12 @@ } }, { + "name": "put-policy", "path": [ "stack", "es", "enrich" ], - "name": "put-policy", "parameters": [ { "role": "flag", @@ -10893,12 +10886,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "enrich" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -10931,19 +10924,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch enrich API commands" }, { "segment": "eql", "commands": [ { + "name": "delete", "path": [ "stack", "es", "eql" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -10976,12 +10968,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "eql" ], - "name": "get", "parameters": [ { "role": "flag", @@ -11028,12 +11020,12 @@ } }, { + "name": "get-status", "path": [ "stack", "es", "eql" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -11066,12 +11058,12 @@ } }, { + "name": "search", "path": [ "stack", "es", "eql" ], - "name": "search", "parameters": [ { "role": "flag", @@ -11251,19 +11243,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch eql API commands" }, { "segment": "esql", "commands": [ { + "name": "async-query", "path": [ "stack", "es", "esql" ], - "name": "async-query", "parameters": [ { "role": "flag", @@ -11405,12 +11396,12 @@ } }, { + "name": "async-query-delete", "path": [ "stack", "es", "esql" ], - "name": "async-query-delete", "parameters": [ { "role": "flag", @@ -11443,12 +11434,12 @@ } }, { + "name": "async-query-get", "path": [ "stack", "es", "esql" ], - "name": "async-query-get", "parameters": [ { "role": "flag", @@ -11509,12 +11500,12 @@ } }, { + "name": "async-query-stop", "path": [ "stack", "es", "esql" ], - "name": "async-query-stop", "parameters": [ { "role": "flag", @@ -11551,12 +11542,12 @@ } }, { + "name": "delete-view", "path": [ "stack", "es", "esql" ], - "name": "delete-view", "parameters": [ { "role": "flag", @@ -11590,12 +11581,12 @@ } }, { + "name": "get-query", "path": [ "stack", "es", "esql" ], - "name": "get-query", "parameters": [ { "role": "flag", @@ -11628,12 +11619,12 @@ } }, { + "name": "get-view", "path": [ "stack", "es", "esql" ], - "name": "get-view", "parameters": [ { "role": "flag", @@ -11666,12 +11657,12 @@ } }, { + "name": "list-queries", "path": [ "stack", "es", "esql" ], - "name": "list-queries", "parameters": [ { "role": "flag", @@ -11697,12 +11688,12 @@ } }, { + "name": "put-view", "path": [ "stack", "es", "esql" ], - "name": "put-view", "parameters": [ { "role": "flag", @@ -11742,12 +11733,12 @@ } }, { + "name": "query", "path": [ "stack", "es", "esql" ], - "name": "query", "parameters": [ { "role": "flag", @@ -11868,19 +11859,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch esql API commands" }, { "segment": "features", "commands": [ { + "name": "get-features", "path": [ "stack", "es", "features" ], - "name": "get-features", "parameters": [ { "role": "flag", @@ -11913,12 +11903,12 @@ } }, { + "name": "reset-features", "path": [ "stack", "es", "features" ], - "name": "reset-features", "parameters": [ { "role": "flag", @@ -11948,19 +11938,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch features API commands" }, { "segment": "fleet", "commands": [ { + "name": "global-checkpoints", "path": [ "stack", "es", "fleet" ], - "name": "global-checkpoints", "parameters": [ { "role": "flag", @@ -12021,12 +12010,12 @@ } }, { + "name": "msearch", "path": [ "stack", "es", "fleet" ], - "name": "msearch", "parameters": [ { "role": "flag", @@ -12157,12 +12146,12 @@ } }, { + "name": "search", "path": [ "stack", "es", "fleet" ], - "name": "search", "parameters": [ { "role": "flag", @@ -12600,19 +12589,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch fleet API commands" }, { "segment": "graph", "commands": [ { + "name": "explore", "path": [ "stack", "es", "graph" ], - "name": "explore", "parameters": [ { "role": "flag", @@ -12689,19 +12677,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch graph API commands" }, { "segment": "ilm", "commands": [ { + "name": "delete-lifecycle", "path": [ "stack", "es", "ilm" ], - "name": "delete-lifecycle", "parameters": [ { "role": "flag", @@ -12727,12 +12714,12 @@ } }, { + "name": "explain-lifecycle", "path": [ "stack", "es", "ilm" ], - "name": "explain-lifecycle", "parameters": [ { "role": "flag", @@ -12786,12 +12773,12 @@ } }, { + "name": "get-lifecycle", "path": [ "stack", "es", "ilm" ], - "name": "get-lifecycle", "parameters": [ { "role": "flag", @@ -12817,12 +12804,12 @@ } }, { + "name": "get-status", "path": [ "stack", "es", "ilm" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -12848,15 +12835,15 @@ } }, { + "name": "migrate-to-data-tiers", "path": [ "stack", "es", "ilm" ], - "name": "migrate-to-data-tiers", "parameters": [ { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -12895,12 +12882,12 @@ } }, { + "name": "move-to-step", "path": [ "stack", "es", "ilm" ], - "name": "move-to-step", "parameters": [ { "role": "flag", @@ -12944,12 +12931,12 @@ } }, { + "name": "put-lifecycle", "path": [ "stack", "es", "ilm" ], - "name": "put-lifecycle", "parameters": [ { "role": "flag", @@ -12975,12 +12962,12 @@ } }, { + "name": "remove-policy", "path": [ "stack", "es", "ilm" ], - "name": "remove-policy", "parameters": [ { "role": "flag", @@ -13010,12 +12997,12 @@ } }, { + "name": "retry", "path": [ "stack", "es", "ilm" ], - "name": "retry", "parameters": [ { "role": "flag", @@ -13045,12 +13032,12 @@ } }, { + "name": "start", "path": [ "stack", "es", "ilm" ], - "name": "start", "parameters": [ { "role": "flag", @@ -13087,12 +13074,12 @@ } }, { + "name": "stop", "path": [ "stack", "es", "ilm" ], - "name": "stop", "parameters": [ { "role": "flag", @@ -13129,19 +13116,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch ilm API commands" }, { "segment": "indices", "commands": [ { + "name": "add-block", "path": [ "stack", "es", "indices" ], - "name": "add-block", "parameters": [ { "role": "flag", @@ -13224,12 +13210,12 @@ } }, { + "name": "analyze", "path": [ "stack", "es", "indices" ], - "name": "analyze", "parameters": [ { "role": "flag", @@ -13327,12 +13313,12 @@ } }, { + "name": "cancel-migrate-reindex", "path": [ "stack", "es", "indices" ], - "name": "cancel-migrate-reindex", "parameters": [ { "role": "flag", @@ -13363,12 +13349,12 @@ } }, { + "name": "clear-cache", "path": [ "stack", "es", "indices" ], - "name": "clear-cache", "parameters": [ { "role": "flag", @@ -13450,12 +13436,12 @@ } }, { + "name": "clone", "path": [ "stack", "es", "indices" ], - "name": "clone", "parameters": [ { "role": "flag", @@ -13530,12 +13516,12 @@ } }, { + "name": "close", "path": [ "stack", "es", "indices" ], - "name": "close", "parameters": [ { "role": "flag", @@ -13609,12 +13595,12 @@ } }, { + "name": "create", "path": [ "stack", "es", "indices" ], - "name": "create", "parameters": [ { "role": "flag", @@ -13689,12 +13675,12 @@ } }, { + "name": "create-data-stream", "path": [ "stack", "es", "indices" ], - "name": "create-data-stream", "parameters": [ { "role": "flag", @@ -13741,12 +13727,12 @@ } }, { + "name": "create-from", "path": [ "stack", "es", "indices" ], - "name": "create-from", "parameters": [ { "role": "flag", @@ -13792,12 +13778,12 @@ } }, { + "name": "data-streams-stats", "path": [ "stack", "es", "indices" ], - "name": "data-streams-stats", "parameters": [ { "role": "flag", @@ -13839,12 +13825,12 @@ } }, { + "name": "delete", "path": [ "stack", "es", "indices" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -13914,12 +13900,12 @@ } }, { + "name": "delete-alias", "path": [ "stack", "es", "indices" ], - "name": "delete-alias", "parameters": [ { "role": "flag", @@ -13975,12 +13961,12 @@ } }, { + "name": "delete-data-lifecycle", "path": [ "stack", "es", "indices" ], - "name": "delete-data-lifecycle", "parameters": [ { "role": "flag", @@ -14036,12 +14022,12 @@ } }, { + "name": "delete-data-stream", "path": [ "stack", "es", "indices" ], - "name": "delete-data-stream", "parameters": [ { "role": "flag", @@ -14090,12 +14076,12 @@ } }, { + "name": "delete-data-stream-options", "path": [ "stack", "es", "indices" ], - "name": "delete-data-stream-options", "parameters": [ { "role": "flag", @@ -14151,12 +14137,12 @@ } }, { + "name": "delete-index-template", "path": [ "stack", "es", "indices" ], - "name": "delete-index-template", "parameters": [ { "role": "flag", @@ -14204,12 +14190,12 @@ } }, { + "name": "delete-template", "path": [ "stack", "es", "indices" ], - "name": "delete-template", "parameters": [ { "role": "flag", @@ -14256,12 +14242,12 @@ } }, { + "name": "disk-usage", "path": [ "stack", "es", "indices" ], - "name": "disk-usage", "parameters": [ { "role": "flag", @@ -14328,12 +14314,12 @@ } }, { + "name": "downsample", "path": [ "stack", "es", "indices" ], - "name": "downsample", "parameters": [ { "role": "flag", @@ -14376,12 +14362,12 @@ } }, { + "name": "exists", "path": [ "stack", "es", "indices" ], - "name": "exists", "parameters": [ { "role": "flag", @@ -14458,12 +14444,12 @@ } }, { + "name": "exists-alias", "path": [ "stack", "es", "indices" ], - "name": "exists-alias", "parameters": [ { "role": "flag", @@ -14534,12 +14520,12 @@ } }, { + "name": "exists-index-template", "path": [ "stack", "es", "indices" ], - "name": "exists-index-template", "parameters": [ { "role": "flag", @@ -14593,12 +14579,12 @@ } }, { + "name": "exists-template", "path": [ "stack", "es", "indices" ], - "name": "exists-template", "parameters": [ { "role": "flag", @@ -14653,12 +14639,12 @@ } }, { + "name": "explain-data-lifecycle", "path": [ "stack", "es", "indices" ], - "name": "explain-data-lifecycle", "parameters": [ { "role": "flag", @@ -14706,12 +14692,12 @@ } }, { + "name": "field-usage-stats", "path": [ "stack", "es", "indices" ], - "name": "field-usage-stats", "parameters": [ { "role": "flag", @@ -14775,12 +14761,12 @@ } }, { + "name": "flush", "path": [ "stack", "es", "indices" ], - "name": "flush", "parameters": [ { "role": "flag", @@ -14847,12 +14833,12 @@ } }, { + "name": "forcemerge", "path": [ "stack", "es", "indices" ], - "name": "forcemerge", "parameters": [ { "role": "flag", @@ -14933,12 +14919,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "indices" ], - "name": "get", "parameters": [ { "role": "flag", @@ -15030,12 +15016,12 @@ } }, { + "name": "get-alias", "path": [ "stack", "es", "indices" ], - "name": "get-alias", "parameters": [ { "role": "flag", @@ -15106,12 +15092,12 @@ } }, { + "name": "get-data-lifecycle", "path": [ "stack", "es", "indices" ], - "name": "get-data-lifecycle", "parameters": [ { "role": "flag", @@ -15167,12 +15153,12 @@ } }, { + "name": "get-data-lifecycle-stats", "path": [ "stack", "es", "indices" ], - "name": "get-data-lifecycle-stats", "parameters": [ { "role": "flag", @@ -15198,12 +15184,12 @@ } }, { + "name": "get-data-stream", "path": [ "stack", "es", "indices" ], - "name": "get-data-stream", "parameters": [ { "role": "flag", @@ -15266,12 +15252,12 @@ } }, { + "name": "get-data-stream-mappings", "path": [ "stack", "es", "indices" ], - "name": "get-data-stream-mappings", "parameters": [ { "role": "flag", @@ -15312,12 +15298,12 @@ } }, { + "name": "get-data-stream-options", "path": [ "stack", "es", "indices" ], - "name": "get-data-stream-options", "parameters": [ { "role": "flag", @@ -15366,12 +15352,12 @@ } }, { + "name": "get-data-stream-settings", "path": [ "stack", "es", "indices" ], - "name": "get-data-stream-settings", "parameters": [ { "role": "flag", @@ -15412,12 +15398,12 @@ } }, { + "name": "get-field-mapping", "path": [ "stack", "es", "indices" ], - "name": "get-field-mapping", "parameters": [ { "role": "flag", @@ -15488,12 +15474,12 @@ } }, { + "name": "get-index-template", "path": [ "stack", "es", "indices" ], - "name": "get-index-template", "parameters": [ { "role": "flag", @@ -15554,12 +15540,12 @@ } }, { + "name": "get-mapping", "path": [ "stack", "es", "indices" ], - "name": "get-mapping", "parameters": [ { "role": "flag", @@ -15629,12 +15615,12 @@ } }, { + "name": "get-migrate-reindex-status", "path": [ "stack", "es", "indices" ], - "name": "get-migrate-reindex-status", "parameters": [ { "role": "flag", @@ -15668,12 +15654,12 @@ } }, { + "name": "get-settings", "path": [ "stack", "es", "indices" ], - "name": "get-settings", "parameters": [ { "role": "flag", @@ -15765,12 +15751,12 @@ } }, { + "name": "get-template", "path": [ "stack", "es", "indices" ], - "name": "get-template", "parameters": [ { "role": "flag", @@ -15825,12 +15811,12 @@ } }, { + "name": "migrate-reindex", "path": [ "stack", "es", "indices" ], - "name": "migrate-reindex", "parameters": [ { "role": "flag", @@ -15859,12 +15845,12 @@ } }, { + "name": "migrate-to-data-stream", "path": [ "stack", "es", "indices" ], - "name": "migrate-to-data-stream", "parameters": [ { "role": "flag", @@ -15908,12 +15894,12 @@ } }, { + "name": "modify-data-stream", "path": [ "stack", "es", "indices" ], - "name": "modify-data-stream", "parameters": [ { "role": "flag", @@ -15943,12 +15929,12 @@ } }, { + "name": "open", "path": [ "stack", "es", "indices" ], - "name": "open", "parameters": [ { "role": "flag", @@ -16022,12 +16008,12 @@ } }, { + "name": "promote-data-stream", "path": [ "stack", "es", "indices" ], - "name": "promote-data-stream", "parameters": [ { "role": "flag", @@ -16064,12 +16050,12 @@ } }, { + "name": "put-alias", "path": [ "stack", "es", "indices" ], - "name": "put-alias", "parameters": [ { "role": "flag", @@ -16159,12 +16145,12 @@ } }, { + "name": "put-data-lifecycle", "path": [ "stack", "es", "indices" ], - "name": "put-data-lifecycle", "parameters": [ { "role": "flag", @@ -16248,12 +16234,12 @@ } }, { + "name": "put-data-stream-mappings", "path": [ "stack", "es", "indices" ], - "name": "put-data-stream-mappings", "parameters": [ { "role": "flag", @@ -16264,7 +16250,7 @@ "repeatable": true }, { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -16307,12 +16293,12 @@ } }, { + "name": "put-data-stream-options", "path": [ "stack", "es", "indices" ], - "name": "put-data-stream-options", "parameters": [ { "role": "flag", @@ -16375,12 +16361,12 @@ } }, { + "name": "put-data-stream-settings", "path": [ "stack", "es", "indices" ], - "name": "put-data-stream-settings", "parameters": [ { "role": "flag", @@ -16391,7 +16377,7 @@ "repeatable": true }, { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -16434,12 +16420,12 @@ } }, { + "name": "put-index-template", "path": [ "stack", "es", "indices" ], - "name": "put-index-template", "parameters": [ { "role": "flag", @@ -16565,12 +16551,12 @@ } }, { + "name": "put-mapping", "path": [ "stack", "es", "indices" ], - "name": "put-mapping", "parameters": [ { "role": "flag", @@ -16724,12 +16710,12 @@ } }, { + "name": "put-settings", "path": [ "stack", "es", "indices" ], - "name": "put-settings", "parameters": [ { "role": "flag", @@ -16826,12 +16812,12 @@ } }, { + "name": "put-template", "path": [ "stack", "es", "indices" ], - "name": "put-template", "parameters": [ { "role": "flag", @@ -16929,12 +16915,12 @@ } }, { + "name": "recovery", "path": [ "stack", "es", "indices" ], - "name": "recovery", "parameters": [ { "role": "flag", @@ -17004,12 +16990,12 @@ } }, { + "name": "refresh", "path": [ "stack", "es", "indices" ], - "name": "refresh", "parameters": [ { "role": "flag", @@ -17062,12 +17048,12 @@ } }, { + "name": "reload-search-analyzers", "path": [ "stack", "es", "indices" ], - "name": "reload-search-analyzers", "parameters": [ { "role": "flag", @@ -17130,12 +17116,12 @@ } }, { + "name": "remove-block", "path": [ "stack", "es", "indices" ], - "name": "remove-block", "parameters": [ { "role": "flag", @@ -17218,12 +17204,12 @@ } }, { + "name": "resolve-cluster", "path": [ "stack", "es", "indices" ], - "name": "resolve-cluster", "parameters": [ { "role": "flag", @@ -17293,12 +17279,12 @@ } }, { + "name": "resolve-index", "path": [ "stack", "es", "indices" ], - "name": "resolve-index", "parameters": [ { "role": "flag", @@ -17362,12 +17348,12 @@ } }, { + "name": "rollover", "path": [ "stack", "es", "indices" ], - "name": "rollover", "parameters": [ { "role": "flag", @@ -17384,7 +17370,7 @@ "summary": "Name of the index to create. Supports date math. Data streams do not support this parameter." }, { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -17460,12 +17446,12 @@ } }, { + "name": "segments", "path": [ "stack", "es", "indices" ], - "name": "segments", "parameters": [ { "role": "flag", @@ -17521,12 +17507,12 @@ } }, { + "name": "shard-stores", "path": [ "stack", "es", "indices" ], - "name": "shard-stores", "parameters": [ { "role": "flag", @@ -17590,12 +17576,12 @@ } }, { + "name": "shrink", "path": [ "stack", "es", "indices" ], - "name": "shrink", "parameters": [ { "role": "flag", @@ -17670,12 +17656,12 @@ } }, { + "name": "simulate-index-template", "path": [ "stack", "es", "indices" ], - "name": "simulate-index-template", "parameters": [ { "role": "flag", @@ -17739,12 +17725,12 @@ } }, { + "name": "simulate-template", "path": [ "stack", "es", "indices" ], - "name": "simulate-template", "parameters": [ { "role": "flag", @@ -17874,12 +17860,12 @@ } }, { + "name": "split", "path": [ "stack", "es", "indices" ], - "name": "split", "parameters": [ { "role": "flag", @@ -17954,12 +17940,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "indices" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -18069,12 +18055,12 @@ } }, { + "name": "update-aliases", "path": [ "stack", "es", "indices" ], - "name": "update-aliases", "parameters": [ { "role": "flag", @@ -18118,12 +18104,12 @@ } }, { + "name": "validate-query", "path": [ "stack", "es", "indices" ], - "name": "validate-query", "parameters": [ { "role": "flag", @@ -18249,19 +18235,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch indices API commands" }, { "segment": "inference", "commands": [ { + "name": "chat-completion-unified", "path": [ "stack", "es", "inference" ], - "name": "chat-completion-unified", "parameters": [ { "role": "flag", @@ -18304,12 +18289,12 @@ } }, { + "name": "completion", "path": [ "stack", "es", "inference" ], - "name": "completion", "parameters": [ { "role": "flag", @@ -18362,12 +18347,12 @@ } }, { + "name": "delete", "path": [ "stack", "es", "inference" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -18384,7 +18369,7 @@ "summary": "The inference identifier." }, { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -18414,12 +18399,12 @@ } }, { + "name": "embedding", "path": [ "stack", "es", "inference" ], - "name": "embedding", "parameters": [ { "role": "flag", @@ -18462,12 +18447,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "inference" ], - "name": "get", "parameters": [ { "role": "flag", @@ -18507,12 +18492,12 @@ } }, { + "name": "inference", "path": [ "stack", "es", "inference" ], - "name": "inference", "parameters": [ { "role": "flag", @@ -18586,12 +18571,12 @@ } }, { + "name": "put", "path": [ "stack", "es", "inference" ], - "name": "put", "parameters": [ { "role": "flag", @@ -18644,12 +18629,12 @@ } }, { + "name": "put-ai21", "path": [ "stack", "es", "inference" ], - "name": "put-ai21", "parameters": [ { "role": "flag", @@ -18717,12 +18702,12 @@ } }, { + "name": "put-alibabacloud", "path": [ "stack", "es", "inference" ], - "name": "put-alibabacloud", "parameters": [ { "role": "flag", @@ -18806,12 +18791,12 @@ } }, { + "name": "put-amazonbedrock", "path": [ "stack", "es", "inference" ], - "name": "put-amazonbedrock", "parameters": [ { "role": "flag", @@ -18894,12 +18879,12 @@ } }, { + "name": "put-amazonsagemaker", "path": [ "stack", "es", "inference" ], - "name": "put-amazonsagemaker", "parameters": [ { "role": "flag", @@ -18984,12 +18969,12 @@ } }, { + "name": "put-anthropic", "path": [ "stack", "es", "inference" ], - "name": "put-anthropic", "parameters": [ { "role": "flag", @@ -19063,12 +19048,12 @@ } }, { + "name": "put-azureaistudio", "path": [ "stack", "es", "inference" ], - "name": "put-azureaistudio", "parameters": [ { "role": "flag", @@ -19151,12 +19136,12 @@ } }, { + "name": "put-azureopenai", "path": [ "stack", "es", "inference" ], - "name": "put-azureopenai", "parameters": [ { "role": "flag", @@ -19239,12 +19224,12 @@ } }, { + "name": "put-cohere", "path": [ "stack", "es", "inference" ], - "name": "put-cohere", "parameters": [ { "role": "flag", @@ -19327,12 +19312,12 @@ } }, { + "name": "put-contextualai", "path": [ "stack", "es", "inference" ], - "name": "put-contextualai", "parameters": [ { "role": "flag", @@ -19406,12 +19391,12 @@ } }, { + "name": "put-custom", "path": [ "stack", "es", "inference" ], - "name": "put-custom", "parameters": [ { "role": "flag", @@ -19488,12 +19473,12 @@ } }, { + "name": "put-deepseek", "path": [ "stack", "es", "inference" ], - "name": "put-deepseek", "parameters": [ { "role": "flag", @@ -19561,12 +19546,12 @@ } }, { + "name": "put-elasticsearch", "path": [ "stack", "es", "inference" ], - "name": "put-elasticsearch", "parameters": [ { "role": "flag", @@ -19649,12 +19634,12 @@ } }, { + "name": "put-elser", "path": [ "stack", "es", "inference" ], - "name": "put-elser", "parameters": [ { "role": "flag", @@ -19728,12 +19713,12 @@ } }, { + "name": "put-fireworksai", "path": [ "stack", "es", "inference" ], - "name": "put-fireworksai", "parameters": [ { "role": "flag", @@ -19816,12 +19801,12 @@ } }, { + "name": "put-googleaistudio", "path": [ "stack", "es", "inference" ], - "name": "put-googleaistudio", "parameters": [ { "role": "flag", @@ -19896,12 +19881,12 @@ } }, { + "name": "put-googlevertexai", "path": [ "stack", "es", "inference" ], - "name": "put-googlevertexai", "parameters": [ { "role": "flag", @@ -19985,12 +19970,12 @@ } }, { + "name": "put-groq", "path": [ "stack", "es", "inference" ], - "name": "put-groq", "parameters": [ { "role": "flag", @@ -20057,12 +20042,12 @@ } }, { + "name": "put-hugging-face", "path": [ "stack", "es", "inference" ], - "name": "put-hugging-face", "parameters": [ { "role": "flag", @@ -20146,12 +20131,12 @@ } }, { + "name": "put-jinaai", "path": [ "stack", "es", "inference" ], - "name": "put-jinaai", "parameters": [ { "role": "flag", @@ -20234,12 +20219,12 @@ } }, { + "name": "put-llama", "path": [ "stack", "es", "inference" ], - "name": "put-llama", "parameters": [ { "role": "flag", @@ -20315,12 +20300,12 @@ } }, { + "name": "put-mistral", "path": [ "stack", "es", "inference" ], - "name": "put-mistral", "parameters": [ { "role": "flag", @@ -20396,12 +20381,12 @@ } }, { + "name": "put-nvidia", "path": [ "stack", "es", "inference" ], - "name": "put-nvidia", "parameters": [ { "role": "flag", @@ -20485,12 +20470,12 @@ } }, { + "name": "put-openai", "path": [ "stack", "es", "inference" ], - "name": "put-openai", "parameters": [ { "role": "flag", @@ -20574,12 +20559,12 @@ } }, { + "name": "put-openshift-ai", "path": [ "stack", "es", "inference" ], - "name": "put-openshift-ai", "parameters": [ { "role": "flag", @@ -20663,12 +20648,12 @@ } }, { + "name": "put-voyageai", "path": [ "stack", "es", "inference" ], - "name": "put-voyageai", "parameters": [ { "role": "flag", @@ -20750,12 +20735,12 @@ } }, { + "name": "put-watsonx", "path": [ "stack", "es", "inference" ], - "name": "put-watsonx", "parameters": [ { "role": "flag", @@ -20832,12 +20817,12 @@ } }, { + "name": "rerank", "path": [ "stack", "es", "inference" ], - "name": "rerank", "parameters": [ { "role": "flag", @@ -20910,12 +20895,12 @@ } }, { + "name": "sparse-embedding", "path": [ "stack", "es", "inference" ], - "name": "sparse-embedding", "parameters": [ { "role": "flag", @@ -20968,12 +20953,12 @@ } }, { + "name": "stream-completion", "path": [ "stack", "es", "inference" ], - "name": "stream-completion", "parameters": [ { "role": "flag", @@ -21026,12 +21011,12 @@ } }, { + "name": "text-embedding", "path": [ "stack", "es", "inference" ], - "name": "text-embedding", "parameters": [ { "role": "flag", @@ -21091,12 +21076,12 @@ } }, { + "name": "update", "path": [ "stack", "es", "inference" ], - "name": "update", "parameters": [ { "role": "flag", @@ -21142,19 +21127,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch inference API commands" }, { "segment": "ingest", "commands": [ { + "name": "delete-geoip-database", "path": [ "stack", "es", "ingest" ], - "name": "delete-geoip-database", "parameters": [ { "role": "flag", @@ -21202,12 +21186,12 @@ } }, { + "name": "delete-ip-location-database", "path": [ "stack", "es", "ingest" ], - "name": "delete-ip-location-database", "parameters": [ { "role": "flag", @@ -21255,12 +21239,12 @@ } }, { + "name": "delete-pipeline", "path": [ "stack", "es", "ingest" ], - "name": "delete-pipeline", "parameters": [ { "role": "flag", @@ -21307,12 +21291,12 @@ } }, { + "name": "geo-ip-stats", "path": [ "stack", "es", "ingest" ], - "name": "geo-ip-stats", "parameters": [ { "role": "flag", @@ -21338,12 +21322,12 @@ } }, { + "name": "get-geoip-database", "path": [ "stack", "es", "ingest" ], - "name": "get-geoip-database", "parameters": [ { "role": "flag", @@ -21377,12 +21361,12 @@ } }, { + "name": "get-ip-location-database", "path": [ "stack", "es", "ingest" ], - "name": "get-ip-location-database", "parameters": [ { "role": "flag", @@ -21416,12 +21400,12 @@ } }, { + "name": "get-pipeline", "path": [ "stack", "es", "ingest" ], - "name": "get-pipeline", "parameters": [ { "role": "flag", @@ -21468,12 +21452,12 @@ } }, { + "name": "processor-grok", "path": [ "stack", "es", "ingest" ], - "name": "processor-grok", "parameters": [ { "role": "flag", @@ -21499,12 +21483,12 @@ } }, { + "name": "put-geoip-database", "path": [ "stack", "es", "ingest" ], - "name": "put-geoip-database", "parameters": [ { "role": "flag", @@ -21565,12 +21549,12 @@ } }, { + "name": "put-ip-location-database", "path": [ "stack", "es", "ingest" ], - "name": "put-ip-location-database", "parameters": [ { "role": "flag", @@ -21623,12 +21607,12 @@ } }, { + "name": "put-pipeline", "path": [ "stack", "es", "ingest" ], - "name": "put-pipeline", "parameters": [ { "role": "flag", @@ -21731,12 +21715,12 @@ } }, { + "name": "simulate", "path": [ "stack", "es", "ingest" ], - "name": "simulate", "parameters": [ { "role": "flag", @@ -21790,19 +21774,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch ingest API commands" }, { "segment": "license", "commands": [ { + "name": "delete", "path": [ "stack", "es", "license" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -21842,12 +21825,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "license" ], - "name": "get", "parameters": [ { "role": "flag", @@ -21887,12 +21870,12 @@ } }, { + "name": "get-basic-status", "path": [ "stack", "es", "license" ], - "name": "get-basic-status", "parameters": [ { "role": "flag", @@ -21918,12 +21901,12 @@ } }, { + "name": "get-trial-status", "path": [ "stack", "es", "license" ], - "name": "get-trial-status", "parameters": [ { "role": "flag", @@ -21949,12 +21932,12 @@ } }, { + "name": "post", "path": [ "stack", "es", "license" ], - "name": "post", "parameters": [ { "role": "flag", @@ -22014,12 +21997,12 @@ } }, { + "name": "post-start-basic", "path": [ "stack", "es", "license" ], - "name": "post-start-basic", "parameters": [ { "role": "flag", @@ -22063,12 +22046,12 @@ } }, { + "name": "post-start-trial", "path": [ "stack", "es", "license" ], - "name": "post-start-trial", "parameters": [ { "role": "flag", @@ -22112,19 +22095,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch license API commands" }, { "segment": "logstash", "commands": [ { + "name": "delete-pipeline", "path": [ "stack", "es", "logstash" ], - "name": "delete-pipeline", "parameters": [ { "role": "flag", @@ -22157,12 +22139,12 @@ } }, { + "name": "get-pipeline", "path": [ "stack", "es", "logstash" ], - "name": "get-pipeline", "parameters": [ { "role": "flag", @@ -22196,12 +22178,12 @@ } }, { + "name": "put-pipeline", "path": [ "stack", "es", "logstash" ], - "name": "put-pipeline", "parameters": [ { "role": "flag", @@ -22240,19 +22222,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch logstash API commands" }, { "segment": "migration", "commands": [ { + "name": "deprecations", "path": [ "stack", "es", "migration" ], - "name": "deprecations", "parameters": [ { "role": "flag", @@ -22285,12 +22266,12 @@ } }, { + "name": "get-feature-upgrade-status", "path": [ "stack", "es", "migration" ], - "name": "get-feature-upgrade-status", "parameters": [ { "role": "flag", @@ -22316,12 +22297,12 @@ } }, { + "name": "post-feature-upgrade", "path": [ "stack", "es", "migration" ], - "name": "post-feature-upgrade", "parameters": [ { "role": "flag", @@ -22344,19 +22325,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch migration API commands" }, { "segment": "ml", "commands": [ { + "name": "clear-trained-model-deployment-cache", "path": [ "stack", "es", "ml" ], - "name": "clear-trained-model-deployment-cache", "parameters": [ { "role": "flag", @@ -22386,12 +22366,12 @@ } }, { + "name": "close-job", "path": [ "stack", "es", "ml" ], - "name": "close-job", "parameters": [ { "role": "flag", @@ -22442,12 +22422,12 @@ } }, { + "name": "delete-calendar", "path": [ "stack", "es", "ml" ], - "name": "delete-calendar", "parameters": [ { "role": "flag", @@ -22480,12 +22460,12 @@ } }, { + "name": "delete-calendar-event", "path": [ "stack", "es", "ml" ], - "name": "delete-calendar-event", "parameters": [ { "role": "flag", @@ -22525,12 +22505,12 @@ } }, { + "name": "delete-calendar-job", "path": [ "stack", "es", "ml" ], - "name": "delete-calendar-job", "parameters": [ { "role": "flag", @@ -22571,12 +22551,12 @@ } }, { + "name": "delete-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "delete-data-frame-analytics", "parameters": [ { "role": "flag", @@ -22623,12 +22603,12 @@ } }, { + "name": "delete-datafeed", "path": [ "stack", "es", "ml" ], - "name": "delete-datafeed", "parameters": [ { "role": "flag", @@ -22668,12 +22648,12 @@ } }, { + "name": "delete-expired-data", "path": [ "stack", "es", "ml" ], - "name": "delete-expired-data", "parameters": [ { "role": "flag", @@ -22720,12 +22700,12 @@ } }, { + "name": "delete-filter", "path": [ "stack", "es", "ml" ], - "name": "delete-filter", "parameters": [ { "role": "flag", @@ -22758,12 +22738,12 @@ } }, { + "name": "delete-forecast", "path": [ "stack", "es", "ml" ], - "name": "delete-forecast", "parameters": [ { "role": "flag", @@ -22817,12 +22797,12 @@ } }, { + "name": "delete-job", "path": [ "stack", "es", "ml" ], - "name": "delete-job", "parameters": [ { "role": "flag", @@ -22876,12 +22856,12 @@ } }, { + "name": "delete-model-snapshot", "path": [ "stack", "es", "ml" ], - "name": "delete-model-snapshot", "parameters": [ { "role": "flag", @@ -22921,12 +22901,12 @@ } }, { + "name": "delete-trained-model", "path": [ "stack", "es", "ml" ], - "name": "delete-trained-model", "parameters": [ { "role": "flag", @@ -22973,12 +22953,12 @@ } }, { + "name": "delete-trained-model-alias", "path": [ "stack", "es", "ml" ], - "name": "delete-trained-model-alias", "parameters": [ { "role": "flag", @@ -23018,12 +22998,12 @@ } }, { + "name": "estimate-model-memory", "path": [ "stack", "es", "ml" ], - "name": "estimate-model-memory", "parameters": [ { "role": "flag", @@ -23067,12 +23047,12 @@ } }, { + "name": "evaluate-data-frame", "path": [ "stack", "es", "ml" ], - "name": "evaluate-data-frame", "parameters": [ { "role": "flag", @@ -23116,12 +23096,12 @@ } }, { + "name": "explain-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "explain-data-frame-analytics", "parameters": [ { "role": "flag", @@ -23212,12 +23192,12 @@ } }, { + "name": "flush-job", "path": [ "stack", "es", "ml" ], - "name": "flush-job", "parameters": [ { "role": "flag", @@ -23282,12 +23262,12 @@ } }, { + "name": "forecast", "path": [ "stack", "es", "ml" ], - "name": "forecast", "parameters": [ { "role": "flag", @@ -23338,12 +23318,12 @@ } }, { + "name": "get-buckets", "path": [ "stack", "es", "ml" ], - "name": "get-buckets", "parameters": [ { "role": "flag", @@ -23452,12 +23432,12 @@ } }, { + "name": "get-calendar-events", "path": [ "stack", "es", "ml" ], - "name": "get-calendar-events", "parameters": [ { "role": "flag", @@ -23525,12 +23505,12 @@ } }, { + "name": "get-calendars", "path": [ "stack", "es", "ml" ], - "name": "get-calendars", "parameters": [ { "role": "flag", @@ -23584,12 +23564,12 @@ } }, { + "name": "get-categories", "path": [ "stack", "es", "ml" ], - "name": "get-categories", "parameters": [ { "role": "flag", @@ -23657,12 +23637,12 @@ } }, { + "name": "get-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "get-data-frame-analytics", "parameters": [ { "role": "flag", @@ -23723,12 +23703,12 @@ } }, { + "name": "get-data-frame-analytics-stats", "path": [ "stack", "es", "ml" ], - "name": "get-data-frame-analytics-stats", "parameters": [ { "role": "flag", @@ -23789,12 +23769,12 @@ } }, { + "name": "get-datafeed-stats", "path": [ "stack", "es", "ml" ], - "name": "get-datafeed-stats", "parameters": [ { "role": "flag", @@ -23835,12 +23815,12 @@ } }, { + "name": "get-datafeeds", "path": [ "stack", "es", "ml" ], - "name": "get-datafeeds", "parameters": [ { "role": "flag", @@ -23888,12 +23868,12 @@ } }, { + "name": "get-filters", "path": [ "stack", "es", "ml" ], - "name": "get-filters", "parameters": [ { "role": "flag", @@ -23941,12 +23921,12 @@ } }, { + "name": "get-influencers", "path": [ "stack", "es", "ml" ], - "name": "get-influencers", "parameters": [ { "role": "flag", @@ -24042,12 +24022,12 @@ } }, { + "name": "get-job-stats", "path": [ "stack", "es", "ml" ], - "name": "get-job-stats", "parameters": [ { "role": "flag", @@ -24087,12 +24067,12 @@ } }, { + "name": "get-jobs", "path": [ "stack", "es", "ml" ], - "name": "get-jobs", "parameters": [ { "role": "flag", @@ -24140,12 +24120,12 @@ } }, { + "name": "get-memory-stats", "path": [ "stack", "es", "ml" ], - "name": "get-memory-stats", "parameters": [ { "role": "flag", @@ -24192,12 +24172,12 @@ } }, { + "name": "get-model-snapshot-upgrade-stats", "path": [ "stack", "es", "ml" ], - "name": "get-model-snapshot-upgrade-stats", "parameters": [ { "role": "flag", @@ -24244,12 +24224,12 @@ } }, { + "name": "get-model-snapshots", "path": [ "stack", "es", "ml" ], - "name": "get-model-snapshots", "parameters": [ { "role": "flag", @@ -24337,12 +24317,12 @@ } }, { + "name": "get-overall-buckets", "path": [ "stack", "es", "ml" ], - "name": "get-overall-buckets", "parameters": [ { "role": "flag", @@ -24424,12 +24404,12 @@ } }, { + "name": "get-records", "path": [ "stack", "es", "ml" ], - "name": "get-records", "parameters": [ { "role": "flag", @@ -24524,12 +24504,12 @@ } }, { + "name": "get-trained-models", "path": [ "stack", "es", "ml" ], - "name": "get-trained-models", "parameters": [ { "role": "flag", @@ -24613,12 +24593,12 @@ } }, { + "name": "get-trained-models-stats", "path": [ "stack", "es", "ml" ], - "name": "get-trained-models-stats", "parameters": [ { "role": "flag", @@ -24673,12 +24653,12 @@ } }, { + "name": "infer-trained-model", "path": [ "stack", "es", "ml" ], - "name": "infer-trained-model", "parameters": [ { "role": "flag", @@ -24729,12 +24709,12 @@ } }, { + "name": "info", "path": [ "stack", "es", "ml" ], - "name": "info", "parameters": [ { "role": "flag", @@ -24760,12 +24740,12 @@ } }, { + "name": "open-job", "path": [ "stack", "es", "ml" ], - "name": "open-job", "parameters": [ { "role": "flag", @@ -24802,12 +24782,12 @@ } }, { + "name": "post-calendar-events", "path": [ "stack", "es", "ml" ], - "name": "post-calendar-events", "parameters": [ { "role": "flag", @@ -24844,12 +24824,12 @@ } }, { + "name": "post-data", "path": [ "stack", "es", "ml" ], - "name": "post-data", "parameters": [ { "role": "flag", @@ -24899,12 +24879,12 @@ } }, { + "name": "preview-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "preview-data-frame-analytics", "parameters": [ { "role": "flag", @@ -24944,12 +24924,12 @@ } }, { + "name": "preview-datafeed", "path": [ "stack", "es", "ml" ], - "name": "preview-datafeed", "parameters": [ { "role": "flag", @@ -25010,12 +24990,12 @@ } }, { + "name": "put-calendar", "path": [ "stack", "es", "ml" ], - "name": "put-calendar", "parameters": [ { "role": "flag", @@ -25062,12 +25042,12 @@ } }, { + "name": "put-calendar-job", "path": [ "stack", "es", "ml" ], - "name": "put-calendar-job", "parameters": [ { "role": "flag", @@ -25108,12 +25088,12 @@ } }, { + "name": "put-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "put-data-frame-analytics", "parameters": [ { "role": "flag", @@ -25222,12 +25202,12 @@ } }, { + "name": "put-datafeed", "path": [ "stack", "es", "ml" ], - "name": "put-datafeed", "parameters": [ { "role": "flag", @@ -25403,12 +25383,12 @@ } }, { + "name": "put-filter", "path": [ "stack", "es", "ml" ], - "name": "put-filter", "parameters": [ { "role": "flag", @@ -25455,12 +25435,12 @@ } }, { + "name": "put-job", "path": [ "stack", "es", "ml" ], - "name": "put-job", "parameters": [ { "role": "flag", @@ -25627,12 +25607,12 @@ } }, { + "name": "put-trained-model", "path": [ "stack", "es", "ml" ], - "name": "put-trained-model", "parameters": [ { "role": "flag", @@ -25756,12 +25736,12 @@ } }, { + "name": "put-trained-model-alias", "path": [ "stack", "es", "ml" ], - "name": "put-trained-model-alias", "parameters": [ { "role": "flag", @@ -25808,12 +25788,12 @@ } }, { + "name": "put-trained-model-definition-part", "path": [ "stack", "es", "ml" ], - "name": "put-trained-model-definition-part", "parameters": [ { "role": "flag", @@ -25874,12 +25854,12 @@ } }, { + "name": "put-trained-model-vocabulary", "path": [ "stack", "es", "ml" ], - "name": "put-trained-model-vocabulary", "parameters": [ { "role": "flag", @@ -25934,12 +25914,12 @@ } }, { + "name": "reset-job", "path": [ "stack", "es", "ml" ], - "name": "reset-job", "parameters": [ { "role": "flag", @@ -25983,12 +25963,12 @@ } }, { + "name": "revert-model-snapshot", "path": [ "stack", "es", "ml" ], - "name": "revert-model-snapshot", "parameters": [ { "role": "flag", @@ -26032,12 +26012,12 @@ } }, { + "name": "set-upgrade-mode", "path": [ "stack", "es", "ml" ], - "name": "set-upgrade-mode", "parameters": [ { "role": "flag", @@ -26074,12 +26054,12 @@ } }, { + "name": "start-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "start-data-frame-analytics", "parameters": [ { "role": "flag", @@ -26116,12 +26096,12 @@ } }, { + "name": "start-datafeed", "path": [ "stack", "es", "ml" ], - "name": "start-datafeed", "parameters": [ { "role": "flag", @@ -26172,12 +26152,12 @@ } }, { + "name": "start-trained-model-deployment", "path": [ "stack", "es", "ml" ], - "name": "start-trained-model-deployment", "parameters": [ { "role": "flag", @@ -26263,12 +26243,12 @@ } }, { + "name": "stop-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "stop-data-frame-analytics", "parameters": [ { "role": "flag", @@ -26319,12 +26299,12 @@ } }, { + "name": "stop-datafeed", "path": [ "stack", "es", "ml" ], - "name": "stop-datafeed", "parameters": [ { "role": "flag", @@ -26382,12 +26362,12 @@ } }, { + "name": "stop-trained-model-deployment", "path": [ "stack", "es", "ml" ], - "name": "stop-trained-model-deployment", "parameters": [ { "role": "flag", @@ -26438,12 +26418,12 @@ } }, { + "name": "update-data-frame-analytics", "path": [ "stack", "es", "ml" ], - "name": "update-data-frame-analytics", "parameters": [ { "role": "flag", @@ -26501,12 +26481,12 @@ } }, { + "name": "update-datafeed", "path": [ "stack", "es", "ml" ], - "name": "update-datafeed", "parameters": [ { "role": "flag", @@ -26663,12 +26643,12 @@ } }, { + "name": "update-filter", "path": [ "stack", "es", "ml" ], - "name": "update-filter", "parameters": [ { "role": "flag", @@ -26719,12 +26699,12 @@ } }, { + "name": "update-job", "path": [ "stack", "es", "ml" ], - "name": "update-job", "parameters": [ { "role": "flag", @@ -26855,12 +26835,12 @@ } }, { + "name": "update-model-snapshot", "path": [ "stack", "es", "ml" ], - "name": "update-model-snapshot", "parameters": [ { "role": "flag", @@ -26911,12 +26891,12 @@ } }, { + "name": "update-trained-model-deployment", "path": [ "stack", "es", "ml" ], - "name": "update-trained-model-deployment", "parameters": [ { "role": "flag", @@ -26960,12 +26940,12 @@ } }, { + "name": "upgrade-job-snapshot", "path": [ "stack", "es", "ml" ], - "name": "upgrade-job-snapshot", "parameters": [ { "role": "flag", @@ -27016,19 +26996,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch ml API commands" }, { "segment": "nodes", "commands": [ { + "name": "clear-repositories-metering-archive", "path": [ "stack", "es", "nodes" ], - "name": "clear-repositories-metering-archive", "parameters": [ { "role": "flag", @@ -27069,12 +27048,12 @@ } }, { + "name": "get-repositories-metering-info", "path": [ "stack", "es", "nodes" ], - "name": "get-repositories-metering-info", "parameters": [ { "role": "flag", @@ -27108,12 +27087,12 @@ } }, { + "name": "hot-threads", "path": [ "stack", "es", "nodes" ], - "name": "hot-threads", "parameters": [ { "role": "flag", @@ -27196,12 +27175,12 @@ } }, { + "name": "info", "path": [ "stack", "es", "nodes" ], - "name": "info", "parameters": [ { "role": "flag", @@ -27257,12 +27236,12 @@ } }, { + "name": "reload-secure-settings", "path": [ "stack", "es", "nodes" ], - "name": "reload-secure-settings", "parameters": [ { "role": "flag", @@ -27307,12 +27286,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "nodes" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -27428,12 +27407,12 @@ } }, { + "name": "usage", "path": [ "stack", "es", "nodes" ], - "name": "usage", "parameters": [ { "role": "flag", @@ -27482,19 +27461,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch nodes API commands" }, { "segment": "project", "commands": [ { + "name": "create-many-routing", "path": [ "stack", "es", "project" ], - "name": "create-many-routing", "parameters": [ { "role": "flag", @@ -27526,12 +27504,12 @@ } }, { + "name": "create-routing", "path": [ "stack", "es", "project" ], - "name": "create-routing", "parameters": [ { "role": "flag", @@ -27570,12 +27548,12 @@ } }, { + "name": "delete-routing", "path": [ "stack", "es", "project" ], - "name": "delete-routing", "parameters": [ { "role": "flag", @@ -27608,12 +27586,12 @@ } }, { + "name": "get-many-routing", "path": [ "stack", "es", "project" ], - "name": "get-many-routing", "parameters": [ { "role": "flag", @@ -27639,12 +27617,12 @@ } }, { + "name": "get-routing", "path": [ "stack", "es", "project" ], - "name": "get-routing", "parameters": [ { "role": "flag", @@ -27677,12 +27655,12 @@ } }, { + "name": "tags", "path": [ "stack", "es", "project" ], - "name": "tags", "parameters": [ { "role": "flag", @@ -27708,19 +27686,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch project API commands" }, { "segment": "query-rules", "commands": [ { + "name": "delete-rule", "path": [ "stack", "es", "query-rules" ], - "name": "delete-rule", "parameters": [ { "role": "flag", @@ -27760,12 +27737,12 @@ } }, { + "name": "delete-ruleset", "path": [ "stack", "es", "query-rules" ], - "name": "delete-ruleset", "parameters": [ { "role": "flag", @@ -27798,12 +27775,12 @@ } }, { + "name": "get-rule", "path": [ "stack", "es", "query-rules" ], - "name": "get-rule", "parameters": [ { "role": "flag", @@ -27843,12 +27820,12 @@ } }, { + "name": "get-ruleset", "path": [ "stack", "es", "query-rules" ], - "name": "get-ruleset", "parameters": [ { "role": "flag", @@ -27881,12 +27858,12 @@ } }, { + "name": "list-rulesets", "path": [ "stack", "es", "query-rules" ], - "name": "list-rulesets", "parameters": [ { "role": "flag", @@ -27926,12 +27903,12 @@ } }, { + "name": "put-rule", "path": [ "stack", "es", "query-rules" ], - "name": "put-rule", "parameters": [ { "role": "flag", @@ -28004,12 +27981,12 @@ } }, { + "name": "put-ruleset", "path": [ "stack", "es", "query-rules" ], - "name": "put-ruleset", "parameters": [ { "role": "flag", @@ -28050,12 +28027,12 @@ } }, { + "name": "test", "path": [ "stack", "es", "query-rules" ], - "name": "test", "parameters": [ { "role": "flag", @@ -28092,19 +28069,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch query-rules API commands" }, { "segment": "rollup", "commands": [ { + "name": "delete-job", "path": [ "stack", "es", "rollup" ], - "name": "delete-job", "parameters": [ { "role": "flag", @@ -28137,12 +28113,12 @@ } }, { + "name": "get-jobs", "path": [ "stack", "es", "rollup" ], - "name": "get-jobs", "parameters": [ { "role": "flag", @@ -28175,12 +28151,12 @@ } }, { + "name": "get-rollup-caps", "path": [ "stack", "es", "rollup" ], - "name": "get-rollup-caps", "parameters": [ { "role": "flag", @@ -28213,12 +28189,12 @@ } }, { + "name": "get-rollup-index-caps", "path": [ "stack", "es", "rollup" ], - "name": "get-rollup-index-caps", "parameters": [ { "role": "flag", @@ -28252,12 +28228,12 @@ } }, { + "name": "put-job", "path": [ "stack", "es", "rollup" ], - "name": "put-job", "parameters": [ { "role": "flag", @@ -28345,12 +28321,12 @@ } }, { + "name": "rollup-search", "path": [ "stack", "es", "rollup" ], - "name": "rollup-search", "parameters": [ { "role": "flag", @@ -28426,12 +28402,12 @@ } }, { + "name": "start-job", "path": [ "stack", "es", "rollup" ], - "name": "start-job", "parameters": [ { "role": "flag", @@ -28461,12 +28437,12 @@ } }, { + "name": "stop-job", "path": [ "stack", "es", "rollup" ], - "name": "stop-job", "parameters": [ { "role": "flag", @@ -28510,19 +28486,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch rollup API commands" }, { "segment": "search-application", "commands": [ { + "name": "delete", "path": [ "stack", "es", "search-application" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -28555,12 +28530,12 @@ } }, { + "name": "delete-behavioral-analytics", "path": [ "stack", "es", "search-application" ], - "name": "delete-behavioral-analytics", "parameters": [ { "role": "flag", @@ -28593,12 +28568,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "search-application" ], - "name": "get", "parameters": [ { "role": "flag", @@ -28631,12 +28606,12 @@ } }, { + "name": "get-behavioral-analytics", "path": [ "stack", "es", "search-application" ], - "name": "get-behavioral-analytics", "parameters": [ { "role": "flag", @@ -28669,12 +28644,12 @@ } }, { + "name": "list", "path": [ "stack", "es", "search-application" ], - "name": "list", "parameters": [ { "role": "flag", @@ -28721,12 +28696,12 @@ } }, { + "name": "post-behavioral-analytics-event", "path": [ "stack", "es", "search-application" ], - "name": "post-behavioral-analytics-event", "parameters": [ { "role": "flag", @@ -28781,12 +28756,12 @@ } }, { + "name": "put", "path": [ "stack", "es", "search-application" ], - "name": "put", "parameters": [ { "role": "flag", @@ -28832,12 +28807,12 @@ } }, { + "name": "put-behavioral-analytics", "path": [ "stack", "es", "search-application" ], - "name": "put-behavioral-analytics", "parameters": [ { "role": "flag", @@ -28870,12 +28845,12 @@ } }, { + "name": "render-query", "path": [ "stack", "es", "search-application" ], - "name": "render-query", "parameters": [ { "role": "flag", @@ -28911,12 +28886,12 @@ } }, { + "name": "search", "path": [ "stack", "es", "search-application" ], - "name": "search", "parameters": [ { "role": "flag", @@ -28963,19 +28938,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch search-application API commands" }, { "segment": "searchable-snapshots", "commands": [ { + "name": "cache-stats", "path": [ "stack", "es", "searchable-snapshots" ], - "name": "cache-stats", "parameters": [ { "role": "flag", @@ -29009,12 +28983,12 @@ } }, { + "name": "clear-cache", "path": [ "stack", "es", "searchable-snapshots" ], - "name": "clear-cache", "parameters": [ { "role": "flag", @@ -29067,12 +29041,12 @@ } }, { + "name": "mount", "path": [ "stack", "es", "searchable-snapshots" ], - "name": "mount", "parameters": [ { "role": "flag", @@ -29158,12 +29132,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "searchable-snapshots" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -29204,19 +29178,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch searchable-snapshots API commands" }, { "segment": "security", "commands": [ { + "name": "activate-user-profile", "path": [ "stack", "es", "security" ], - "name": "activate-user-profile", "parameters": [ { "role": "flag", @@ -29271,12 +29244,12 @@ } }, { + "name": "authenticate", "path": [ "stack", "es", "security" ], - "name": "authenticate", "parameters": [ { "role": "flag", @@ -29302,12 +29275,12 @@ } }, { + "name": "bulk-delete-role", "path": [ "stack", "es", "security" ], - "name": "bulk-delete-role", "parameters": [ { "role": "flag", @@ -29348,12 +29321,12 @@ } }, { + "name": "bulk-put-role", "path": [ "stack", "es", "security" ], - "name": "bulk-put-role", "parameters": [ { "role": "flag", @@ -29390,12 +29363,12 @@ } }, { + "name": "bulk-update-api-keys", "path": [ "stack", "es", "security" ], - "name": "bulk-update-api-keys", "parameters": [ { "role": "flag", @@ -29448,12 +29421,12 @@ } }, { + "name": "change-password", "path": [ "stack", "es", "security" ], - "name": "change-password", "parameters": [ { "role": "flag", @@ -29507,12 +29480,12 @@ } }, { + "name": "clear-api-key-cache", "path": [ "stack", "es", "security" ], - "name": "clear-api-key-cache", "parameters": [ { "role": "flag", @@ -29543,12 +29516,12 @@ } }, { + "name": "clear-cached-privileges", "path": [ "stack", "es", "security" ], - "name": "clear-cached-privileges", "parameters": [ { "role": "flag", @@ -29579,12 +29552,12 @@ } }, { + "name": "clear-cached-realms", "path": [ "stack", "es", "security" ], - "name": "clear-cached-realms", "parameters": [ { "role": "flag", @@ -29622,12 +29595,12 @@ } }, { + "name": "clear-cached-roles", "path": [ "stack", "es", "security" ], - "name": "clear-cached-roles", "parameters": [ { "role": "flag", @@ -29658,12 +29631,12 @@ } }, { + "name": "clear-cached-service-tokens", "path": [ "stack", "es", "security" ], - "name": "clear-cached-service-tokens", "parameters": [ { "role": "flag", @@ -29708,12 +29681,12 @@ } }, { + "name": "clone-api-key", "path": [ "stack", "es", "security" ], - "name": "clone-api-key", "parameters": [ { "role": "flag", @@ -29771,12 +29744,12 @@ } }, { + "name": "create-api-key", "path": [ "stack", "es", "security" ], - "name": "create-api-key", "parameters": [ { "role": "flag", @@ -29837,12 +29810,12 @@ } }, { + "name": "create-cross-cluster-api-key", "path": [ "stack", "es", "security" ], - "name": "create-cross-cluster-api-key", "parameters": [ { "role": "flag", @@ -29900,12 +29873,12 @@ } }, { + "name": "create-service-token", "path": [ "stack", "es", "security" ], - "name": "create-service-token", "parameters": [ { "role": "flag", @@ -29959,12 +29932,12 @@ } }, { + "name": "delegate-pki", "path": [ "stack", "es", "security" ], - "name": "delegate-pki", "parameters": [ { "role": "flag", @@ -29995,12 +29968,12 @@ } }, { + "name": "delete-privileges", "path": [ "stack", "es", "security" ], - "name": "delete-privileges", "parameters": [ { "role": "flag", @@ -30048,12 +30021,12 @@ } }, { + "name": "delete-role", "path": [ "stack", "es", "security" ], - "name": "delete-role", "parameters": [ { "role": "flag", @@ -30093,12 +30066,12 @@ } }, { + "name": "delete-role-mapping", "path": [ "stack", "es", "security" ], - "name": "delete-role-mapping", "parameters": [ { "role": "flag", @@ -30138,12 +30111,12 @@ } }, { + "name": "delete-service-token", "path": [ "stack", "es", "security" ], - "name": "delete-service-token", "parameters": [ { "role": "flag", @@ -30197,12 +30170,12 @@ } }, { + "name": "delete-user", "path": [ "stack", "es", "security" ], - "name": "delete-user", "parameters": [ { "role": "flag", @@ -30242,12 +30215,12 @@ } }, { + "name": "disable-user", "path": [ "stack", "es", "security" ], - "name": "disable-user", "parameters": [ { "role": "flag", @@ -30287,12 +30260,12 @@ } }, { + "name": "disable-user-profile", "path": [ "stack", "es", "security" ], - "name": "disable-user-profile", "parameters": [ { "role": "flag", @@ -30332,12 +30305,12 @@ } }, { + "name": "enable-user", "path": [ "stack", "es", "security" ], - "name": "enable-user", "parameters": [ { "role": "flag", @@ -30377,12 +30350,12 @@ } }, { + "name": "enable-user-profile", "path": [ "stack", "es", "security" ], - "name": "enable-user-profile", "parameters": [ { "role": "flag", @@ -30422,12 +30395,12 @@ } }, { + "name": "enroll-kibana", "path": [ "stack", "es", "security" ], - "name": "enroll-kibana", "parameters": [ { "role": "flag", @@ -30453,12 +30426,12 @@ } }, { + "name": "enroll-node", "path": [ "stack", "es", "security" ], - "name": "enroll-node", "parameters": [ { "role": "flag", @@ -30484,12 +30457,12 @@ } }, { + "name": "get-api-key", "path": [ "stack", "es", "security" ], - "name": "get-api-key", "parameters": [ { "role": "flag", @@ -30571,12 +30544,12 @@ } }, { + "name": "get-builtin-privileges", "path": [ "stack", "es", "security" ], - "name": "get-builtin-privileges", "parameters": [ { "role": "flag", @@ -30602,12 +30575,12 @@ } }, { + "name": "get-privileges", "path": [ "stack", "es", "security" ], - "name": "get-privileges", "parameters": [ { "role": "flag", @@ -30648,12 +30621,12 @@ } }, { + "name": "get-role", "path": [ "stack", "es", "security" ], - "name": "get-role", "parameters": [ { "role": "flag", @@ -30694,12 +30667,12 @@ } }, { + "name": "get-role-mapping", "path": [ "stack", "es", "security" ], - "name": "get-role-mapping", "parameters": [ { "role": "flag", @@ -30733,12 +30706,12 @@ } }, { + "name": "get-service-accounts", "path": [ "stack", "es", "security" ], - "name": "get-service-accounts", "parameters": [ { "role": "flag", @@ -30778,12 +30751,12 @@ } }, { + "name": "get-service-credentials", "path": [ "stack", "es", "security" ], - "name": "get-service-credentials", "parameters": [ { "role": "flag", @@ -30823,12 +30796,12 @@ } }, { + "name": "get-settings", "path": [ "stack", "es", "security" ], - "name": "get-settings", "parameters": [ { "role": "flag", @@ -30861,12 +30834,12 @@ } }, { + "name": "get-stats", "path": [ "stack", "es", "security" ], - "name": "get-stats", "parameters": [ { "role": "flag", @@ -30892,12 +30865,12 @@ } }, { + "name": "get-token", "path": [ "stack", "es", "security" ], - "name": "get-token", "parameters": [ { "role": "flag", @@ -30962,12 +30935,12 @@ } }, { + "name": "get-user", "path": [ "stack", "es", "security" ], - "name": "get-user", "parameters": [ { "role": "flag", @@ -31008,12 +30981,12 @@ } }, { + "name": "get-user-privileges", "path": [ "stack", "es", "security" ], - "name": "get-user-privileges", "parameters": [ { "role": "flag", @@ -31039,12 +31012,12 @@ } }, { + "name": "get-user-profile", "path": [ "stack", "es", "security" ], - "name": "get-user-profile", "parameters": [ { "role": "flag", @@ -31086,12 +31059,12 @@ } }, { + "name": "grant-api-key", "path": [ "stack", "es", "security" ], - "name": "grant-api-key", "parameters": [ { "role": "flag", @@ -31167,12 +31140,12 @@ } }, { + "name": "has-privileges", "path": [ "stack", "es", "security" ], - "name": "has-privileges", "parameters": [ { "role": "flag", @@ -31224,12 +31197,12 @@ } }, { + "name": "has-privileges-user-profile", "path": [ "stack", "es", "security" ], - "name": "has-privileges-user-profile", "parameters": [ { "role": "flag", @@ -31270,12 +31243,12 @@ } }, { + "name": "invalidate-api-key", "path": [ "stack", "es", "security" ], - "name": "invalidate-api-key", "parameters": [ { "role": "flag", @@ -31342,12 +31315,12 @@ } }, { + "name": "invalidate-token", "path": [ "stack", "es", "security" ], - "name": "invalidate-token", "parameters": [ { "role": "flag", @@ -31401,12 +31374,12 @@ } }, { + "name": "oidc-authenticate", "path": [ "stack", "es", "security" ], - "name": "oidc-authenticate", "parameters": [ { "role": "flag", @@ -31457,12 +31430,12 @@ } }, { + "name": "oidc-logout", "path": [ "stack", "es", "security" ], - "name": "oidc-logout", "parameters": [ { "role": "flag", @@ -31499,12 +31472,12 @@ } }, { + "name": "oidc-prepare-authentication", "path": [ "stack", "es", "security" ], - "name": "oidc-prepare-authentication", "parameters": [ { "role": "flag", @@ -31562,12 +31535,12 @@ } }, { + "name": "put-privileges", "path": [ "stack", "es", "security" ], - "name": "put-privileges", "parameters": [ { "role": "flag", @@ -31606,12 +31579,12 @@ } }, { + "name": "put-role", "path": [ "stack", "es", "security" ], - "name": "put-role", "parameters": [ { "role": "flag", @@ -31700,12 +31673,12 @@ } }, { + "name": "put-role-mapping", "path": [ "stack", "es", "security" ], - "name": "put-role-mapping", "parameters": [ { "role": "flag", @@ -31786,12 +31759,12 @@ } }, { + "name": "put-user", "path": [ "stack", "es", "security" ], - "name": "put-user", "parameters": [ { "role": "flag", @@ -31880,12 +31853,12 @@ } }, { + "name": "query-api-keys", "path": [ "stack", "es", "security" ], - "name": "query-api-keys", "parameters": [ { "role": "flag", @@ -31983,12 +31956,12 @@ } }, { + "name": "query-role", "path": [ "stack", "es", "security" ], - "name": "query-role", "parameters": [ { "role": "flag", @@ -32051,12 +32024,12 @@ } }, { + "name": "query-user", "path": [ "stack", "es", "security" ], - "name": "query-user", "parameters": [ { "role": "flag", @@ -32126,12 +32099,12 @@ } }, { + "name": "saml-authenticate", "path": [ "stack", "es", "security" ], - "name": "saml-authenticate", "parameters": [ { "role": "flag", @@ -32177,12 +32150,12 @@ } }, { + "name": "saml-complete-logout", "path": [ "stack", "es", "security" ], - "name": "saml-complete-logout", "parameters": [ { "role": "flag", @@ -32235,12 +32208,12 @@ } }, { + "name": "saml-invalidate", "path": [ "stack", "es", "security" ], - "name": "saml-invalidate", "parameters": [ { "role": "flag", @@ -32284,12 +32257,12 @@ } }, { + "name": "saml-logout", "path": [ "stack", "es", "security" ], - "name": "saml-logout", "parameters": [ { "role": "flag", @@ -32326,12 +32299,12 @@ } }, { + "name": "saml-prepare-authentication", "path": [ "stack", "es", "security" ], - "name": "saml-prepare-authentication", "parameters": [ { "role": "flag", @@ -32375,12 +32348,12 @@ } }, { + "name": "saml-service-provider-metadata", "path": [ "stack", "es", "security" ], - "name": "saml-service-provider-metadata", "parameters": [ { "role": "flag", @@ -32413,12 +32386,12 @@ } }, { + "name": "suggest-user-profiles", "path": [ "stack", "es", "security" ], - "name": "suggest-user-profiles", "parameters": [ { "role": "flag", @@ -32474,12 +32447,12 @@ } }, { + "name": "update-api-key", "path": [ "stack", "es", "security" ], - "name": "update-api-key", "parameters": [ { "role": "flag", @@ -32533,12 +32506,12 @@ } }, { + "name": "update-cross-cluster-api-key", "path": [ "stack", "es", "security" ], - "name": "update-cross-cluster-api-key", "parameters": [ { "role": "flag", @@ -32599,12 +32572,12 @@ } }, { + "name": "update-settings", "path": [ "stack", "es", "security" ], - "name": "update-settings", "parameters": [ { "role": "flag", @@ -32665,12 +32638,12 @@ } }, { + "name": "update-user-profile-data", "path": [ "stack", "es", "security" ], - "name": "update-user-profile-data", "parameters": [ { "role": "flag", @@ -32738,19 +32711,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch security API commands" }, { "segment": "simulate", "commands": [ { + "name": "ingest", "path": [ "stack", "es", "simulate" ], - "name": "ingest", "parameters": [ { "role": "flag", @@ -32831,19 +32803,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch simulate API commands" }, { "segment": "slm", "commands": [ { + "name": "delete-lifecycle", "path": [ "stack", "es", "slm" ], - "name": "delete-lifecycle", "parameters": [ { "role": "flag", @@ -32890,12 +32861,12 @@ } }, { + "name": "execute-lifecycle", "path": [ "stack", "es", "slm" ], - "name": "execute-lifecycle", "parameters": [ { "role": "flag", @@ -32942,12 +32913,12 @@ } }, { + "name": "execute-retention", "path": [ "stack", "es", "slm" ], - "name": "execute-retention", "parameters": [ { "role": "flag", @@ -32984,12 +32955,12 @@ } }, { + "name": "get-lifecycle", "path": [ "stack", "es", "slm" ], - "name": "get-lifecycle", "parameters": [ { "role": "flag", @@ -33037,12 +33008,12 @@ } }, { + "name": "get-stats", "path": [ "stack", "es", "slm" ], - "name": "get-stats", "parameters": [ { "role": "flag", @@ -33082,12 +33053,12 @@ } }, { + "name": "get-status", "path": [ "stack", "es", "slm" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -33127,12 +33098,12 @@ } }, { + "name": "put-lifecycle", "path": [ "stack", "es", "slm" ], - "name": "put-lifecycle", "parameters": [ { "role": "flag", @@ -33214,12 +33185,12 @@ } }, { + "name": "start", "path": [ "stack", "es", "slm" ], - "name": "start", "parameters": [ { "role": "flag", @@ -33256,12 +33227,12 @@ } }, { + "name": "stop", "path": [ "stack", "es", "slm" ], - "name": "stop", "parameters": [ { "role": "flag", @@ -33298,19 +33269,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch slm API commands" }, { "segment": "snapshot", "commands": [ { + "name": "cleanup-repository", "path": [ "stack", "es", "snapshot" ], - "name": "cleanup-repository", "parameters": [ { "role": "flag", @@ -33333,12 +33303,12 @@ } }, { + "name": "clone", "path": [ "stack", "es", "snapshot" ], - "name": "clone", "parameters": [ { "role": "flag", @@ -33399,12 +33369,12 @@ } }, { + "name": "create", "path": [ "stack", "es", "snapshot" ], - "name": "create", "parameters": [ { "role": "flag", @@ -33511,12 +33481,12 @@ } }, { + "name": "create-repository", "path": [ "stack", "es", "snapshot" ], - "name": "create-repository", "parameters": [ { "role": "flag", @@ -33542,12 +33512,12 @@ } }, { + "name": "delete", "path": [ "stack", "es", "snapshot" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -33602,12 +33572,12 @@ } }, { + "name": "delete-repository", "path": [ "stack", "es", "snapshot" ], - "name": "delete-repository", "parameters": [ { "role": "flag", @@ -33633,12 +33603,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "snapshot" ], - "name": "get", "parameters": [ { "role": "flag", @@ -33778,12 +33748,12 @@ } }, { + "name": "get-repository", "path": [ "stack", "es", "snapshot" ], - "name": "get-repository", "parameters": [ { "role": "flag", @@ -33809,12 +33779,12 @@ } }, { + "name": "repository-analyze", "path": [ "stack", "es", "snapshot" ], - "name": "repository-analyze", "parameters": [ { "role": "flag", @@ -33837,12 +33807,12 @@ } }, { + "name": "repository-verify-integrity", "path": [ "stack", "es", "snapshot" ], - "name": "repository-verify-integrity", "parameters": [ { "role": "flag", @@ -33865,12 +33835,12 @@ } }, { + "name": "restore", "path": [ "stack", "es", "snapshot" ], - "name": "restore", "parameters": [ { "role": "flag", @@ -33993,12 +33963,12 @@ } }, { + "name": "status", "path": [ "stack", "es", "snapshot" ], - "name": "status", "parameters": [ { "role": "flag", @@ -34053,12 +34023,12 @@ } }, { + "name": "verify-repository", "path": [ "stack", "es", "snapshot" ], - "name": "verify-repository", "parameters": [ { "role": "flag", @@ -34081,19 +34051,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch snapshot API commands" }, { "segment": "sql", "commands": [ { + "name": "clear-cursor", "path": [ "stack", "es", "sql" ], - "name": "clear-cursor", "parameters": [ { "role": "flag", @@ -34123,12 +34092,12 @@ } }, { + "name": "delete-async", "path": [ "stack", "es", "sql" ], - "name": "delete-async", "parameters": [ { "role": "flag", @@ -34161,12 +34130,12 @@ } }, { + "name": "get-async", "path": [ "stack", "es", "sql" ], - "name": "get-async", "parameters": [ { "role": "flag", @@ -34227,12 +34196,12 @@ } }, { + "name": "get-async-status", "path": [ "stack", "es", "sql" ], - "name": "get-async-status", "parameters": [ { "role": "flag", @@ -34265,12 +34234,12 @@ } }, { + "name": "query", "path": [ "stack", "es", "sql" ], - "name": "query", "parameters": [ { "role": "flag", @@ -34419,12 +34388,12 @@ } }, { + "name": "translate", "path": [ "stack", "es", "sql" ], - "name": "translate", "parameters": [ { "role": "flag", @@ -34475,19 +34444,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch sql API commands" }, { "segment": "ssl", "commands": [ { + "name": "certificates", "path": [ "stack", "es", "ssl" ], - "name": "certificates", "parameters": [ { "role": "flag", @@ -34513,19 +34481,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch ssl API commands" }, { "segment": "streams", "commands": [ { + "name": "logs-disable", "path": [ "stack", "es", "streams" ], - "name": "logs-disable", "parameters": [ { "role": "flag", @@ -34574,12 +34541,12 @@ } }, { + "name": "logs-enable", "path": [ "stack", "es", "streams" ], - "name": "logs-enable", "parameters": [ { "role": "flag", @@ -34628,12 +34595,12 @@ } }, { + "name": "status", "path": [ "stack", "es", "streams" ], - "name": "status", "parameters": [ { "role": "flag", @@ -34666,19 +34633,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch streams API commands" }, { "segment": "synonyms", "commands": [ { + "name": "delete-synonym", "path": [ "stack", "es", "synonyms" ], - "name": "delete-synonym", "parameters": [ { "role": "flag", @@ -34711,12 +34677,12 @@ } }, { + "name": "delete-synonym-rule", "path": [ "stack", "es", "synonyms" ], - "name": "delete-synonym-rule", "parameters": [ { "role": "flag", @@ -34756,12 +34722,12 @@ } }, { + "name": "get-synonym", "path": [ "stack", "es", "synonyms" ], - "name": "get-synonym", "parameters": [ { "role": "flag", @@ -34808,12 +34774,12 @@ } }, { + "name": "get-synonym-rule", "path": [ "stack", "es", "synonyms" ], - "name": "get-synonym-rule", "parameters": [ { "role": "flag", @@ -34853,12 +34819,12 @@ } }, { + "name": "get-synonyms-sets", "path": [ "stack", "es", "synonyms" ], - "name": "get-synonyms-sets", "parameters": [ { "role": "flag", @@ -34898,12 +34864,12 @@ } }, { + "name": "put-synonym", "path": [ "stack", "es", "synonyms" ], - "name": "put-synonym", "parameters": [ { "role": "flag", @@ -34945,12 +34911,12 @@ } }, { + "name": "put-synonym-rule", "path": [ "stack", "es", "synonyms" ], - "name": "put-synonym-rule", "parameters": [ { "role": "flag", @@ -34997,19 +34963,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch synonyms API commands" }, { "segment": "tasks", "commands": [ { + "name": "cancel", "path": [ "stack", "es", "tasks" ], - "name": "cancel", "parameters": [ { "role": "flag", @@ -35068,12 +35033,12 @@ } }, { + "name": "get", "path": [ "stack", "es", "tasks" ], - "name": "get", "parameters": [ { "role": "flag", @@ -35120,12 +35085,12 @@ } }, { + "name": "list", "path": [ "stack", "es", "tasks" ], - "name": "list", "parameters": [ { "role": "flag", @@ -35202,19 +35167,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch tasks API commands" }, { "segment": "text-structure", "commands": [ { + "name": "find-field-structure", "path": [ "stack", "es", "text-structure" ], - "name": "find-field-structure", "parameters": [ { "role": "flag", @@ -35346,12 +35310,12 @@ } }, { + "name": "find-message-structure", "path": [ "stack", "es", "text-structure" ], - "name": "find-message-structure", "parameters": [ { "role": "flag", @@ -35470,12 +35434,12 @@ } }, { + "name": "find-structure", "path": [ "stack", "es", "text-structure" ], - "name": "find-structure", "parameters": [ { "role": "flag", @@ -35617,12 +35581,12 @@ } }, { + "name": "test-grok-pattern", "path": [ "stack", "es", "text-structure" ], - "name": "test-grok-pattern", "parameters": [ { "role": "flag", @@ -35670,19 +35634,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch text-structure API commands" }, { "segment": "transform", "commands": [ { + "name": "delete-transform", "path": [ "stack", "es", "transform" ], - "name": "delete-transform", "parameters": [ { "role": "flag", @@ -35736,12 +35699,12 @@ } }, { + "name": "get-node-stats", "path": [ "stack", "es", "transform" ], - "name": "get-node-stats", "parameters": [ { "role": "flag", @@ -35767,12 +35730,12 @@ } }, { + "name": "get-transform", "path": [ "stack", "es", "transform" ], - "name": "get-transform", "parameters": [ { "role": "flag", @@ -35834,12 +35797,12 @@ } }, { + "name": "get-transform-stats", "path": [ "stack", "es", "transform" ], - "name": "get-transform-stats", "parameters": [ { "role": "flag", @@ -35901,12 +35864,12 @@ } }, { + "name": "preview-transform", "path": [ "stack", "es", "transform" ], - "name": "preview-transform", "parameters": [ { "role": "flag", @@ -36009,12 +35972,12 @@ } }, { + "name": "put-transform", "path": [ "stack", "es", "transform" ], - "name": "put-transform", "parameters": [ { "role": "flag", @@ -36131,12 +36094,12 @@ } }, { + "name": "reset-transform", "path": [ "stack", "es", "transform" ], - "name": "reset-transform", "parameters": [ { "role": "flag", @@ -36180,12 +36143,12 @@ } }, { + "name": "schedule-now-transform", "path": [ "stack", "es", "transform" ], - "name": "schedule-now-transform", "parameters": [ { "role": "flag", @@ -36229,12 +36192,12 @@ } }, { + "name": "set-upgrade-mode", "path": [ "stack", "es", "transform" ], - "name": "set-upgrade-mode", "parameters": [ { "role": "flag", @@ -36271,12 +36234,12 @@ } }, { + "name": "start-transform", "path": [ "stack", "es", "transform" ], - "name": "start-transform", "parameters": [ { "role": "flag", @@ -36320,12 +36283,12 @@ } }, { + "name": "stop-transform", "path": [ "stack", "es", "transform" ], - "name": "stop-transform", "parameters": [ { "role": "flag", @@ -36390,12 +36353,12 @@ } }, { + "name": "update-transform", "path": [ "stack", "es", "transform" ], - "name": "update-transform", "parameters": [ { "role": "flag", @@ -36495,15 +36458,15 @@ } }, { + "name": "upgrade-transforms", "path": [ "stack", "es", "transform" ], - "name": "upgrade-transforms", "parameters": [ { - "role": "flag", + "role": "dryRun", "name": "dry-run", "type": "boolean", "required": false, @@ -36530,19 +36493,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch transform API commands" }, { "segment": "watcher", "commands": [ { + "name": "ack-watch", "path": [ "stack", "es", "watcher" ], - "name": "ack-watch", "parameters": [ { "role": "flag", @@ -36583,12 +36545,12 @@ } }, { + "name": "activate-watch", "path": [ "stack", "es", "watcher" ], - "name": "activate-watch", "parameters": [ { "role": "flag", @@ -36621,12 +36583,12 @@ } }, { + "name": "deactivate-watch", "path": [ "stack", "es", "watcher" ], - "name": "deactivate-watch", "parameters": [ { "role": "flag", @@ -36659,12 +36621,12 @@ } }, { + "name": "delete-watch", "path": [ "stack", "es", "watcher" ], - "name": "delete-watch", "parameters": [ { "role": "flag", @@ -36697,12 +36659,12 @@ } }, { + "name": "execute-watch", "path": [ "stack", "es", "watcher" ], - "name": "execute-watch", "parameters": [ { "role": "flag", @@ -36790,12 +36752,12 @@ } }, { + "name": "get-settings", "path": [ "stack", "es", "watcher" ], - "name": "get-settings", "parameters": [ { "role": "flag", @@ -36828,12 +36790,12 @@ } }, { + "name": "get-watch", "path": [ "stack", "es", "watcher" ], - "name": "get-watch", "parameters": [ { "role": "flag", @@ -36866,12 +36828,12 @@ } }, { + "name": "put-watch", "path": [ "stack", "es", "watcher" ], - "name": "put-watch", "parameters": [ { "role": "flag", @@ -36988,12 +36950,12 @@ } }, { + "name": "query-watches", "path": [ "stack", "es", "watcher" ], - "name": "query-watches", "parameters": [ { "role": "flag", @@ -37056,12 +37018,12 @@ } }, { + "name": "start", "path": [ "stack", "es", "watcher" ], - "name": "start", "parameters": [ { "role": "flag", @@ -37091,12 +37053,12 @@ } }, { + "name": "stats", "path": [ "stack", "es", "watcher" ], - "name": "stats", "parameters": [ { "role": "flag", @@ -37137,12 +37099,12 @@ } }, { + "name": "stop", "path": [ "stack", "es", "watcher" ], - "name": "stop", "parameters": [ { "role": "flag", @@ -37172,12 +37134,12 @@ } }, { + "name": "update-settings", "path": [ "stack", "es", "watcher" ], - "name": "update-settings", "parameters": [ { "role": "flag", @@ -37229,19 +37191,18 @@ } } ], - "namespaces": [], "summary": "Elasticsearch watcher API commands" }, { "segment": "xpack", "commands": [ { + "name": "info", "path": [ "stack", "es", "xpack" ], - "name": "info", "parameters": [ { "role": "flag", @@ -37288,12 +37249,12 @@ } }, { + "name": "usage", "path": [ "stack", "es", "xpack" ], - "name": "usage", "parameters": [ { "role": "flag", @@ -37326,7 +37287,6 @@ } } ], - "namespaces": [], "summary": "Elasticsearch xpack API commands" } ], @@ -37334,18 +37294,17 @@ }, { "segment": "kb", - "commands": [], "namespaces": [ { "segment": "agent-builder", "commands": [ { + "name": "post-agent-builder-a2a-agentid", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-a2a-agentid", "parameters": [ { "role": "flag", @@ -37375,12 +37334,12 @@ } }, { + "name": "get-agent-builder-a2a-agentid-json", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-a2a-agentid-json", "parameters": [ { "role": "flag", @@ -37413,12 +37372,12 @@ } }, { + "name": "get-agent-builder-agents", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-agents", "parameters": [ { "role": "flag", @@ -37444,12 +37403,12 @@ } }, { + "name": "post-agent-builder-agents", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-agents", "parameters": [ { "role": "flag", @@ -37528,12 +37487,12 @@ } }, { + "name": "post-agent-builder-agents-agent-id-consumption", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-agents-agent-id-consumption", "parameters": [ { "role": "flag", @@ -37612,12 +37571,12 @@ } }, { + "name": "delete-agent-builder-agents-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "delete-agent-builder-agents-id", "parameters": [ { "role": "flag", @@ -37650,12 +37609,12 @@ } }, { + "name": "get-agent-builder-agents-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-agents-id", "parameters": [ { "role": "flag", @@ -37688,12 +37647,12 @@ } }, { + "name": "put-agent-builder-agents-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "put-agent-builder-agents-id", "parameters": [ { "role": "flag", @@ -37775,12 +37734,12 @@ } }, { + "name": "get-agent-builder-conversations", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-conversations", "parameters": [ { "role": "flag", @@ -37813,12 +37772,12 @@ } }, { + "name": "delete-agent-builder-conversations-conversation-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "delete-agent-builder-conversations-conversation-id", "parameters": [ { "role": "flag", @@ -37851,12 +37810,12 @@ } }, { + "name": "get-agent-builder-conversations-conversation-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-conversations-conversation-id", "parameters": [ { "role": "flag", @@ -37889,12 +37848,12 @@ } }, { + "name": "get-agent-builder-conversations-conversation-id-attachments", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-conversations-conversation-id-attachments", "parameters": [ { "role": "flag", @@ -37934,12 +37893,12 @@ } }, { + "name": "post-agent-builder-conversations-conversation-id-attachments", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-conversations-conversation-id-attachments", "parameters": [ { "role": "flag", @@ -38010,12 +37969,12 @@ } }, { + "name": "delete-agent-builder-conversations-conversation-id-attachments-attachment-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "delete-agent-builder-conversations-conversation-id-attachments-attachment-id", "parameters": [ { "role": "flag", @@ -38062,12 +38021,12 @@ } }, { + "name": "patch-agent-builder-conversations-conversation-id-attachments-attachment-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "patch-agent-builder-conversations-conversation-id-attachments-attachment-id", "parameters": [ { "role": "flag", @@ -38111,12 +38070,12 @@ } }, { + "name": "put-agent-builder-conversations-conversation-id-attachments-attachment-id", "path": [ "stack", "kb", "agent-builder" ], - "name": "put-agent-builder-conversations-conversation-id-attachments-attachment-id", "parameters": [ { "role": "flag", @@ -38169,12 +38128,12 @@ } }, { + "name": "post-agent-builder-conversations-conversation-id-attachments-attachment-id-restore", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-conversations-conversation-id-attachments-attachment-id-restore", "parameters": [ { "role": "flag", @@ -38211,12 +38170,12 @@ } }, { + "name": "put-agent-builder-conversations-conversation-id-attachments-attachment-id-origin", "path": [ "stack", "kb", "agent-builder" ], - "name": "put-agent-builder-conversations-conversation-id-attachments-attachment-id-origin", "parameters": [ { "role": "flag", @@ -38263,12 +38222,12 @@ } }, { + "name": "get-agent-builder-conversations-conversation-id-attachments-stale", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-conversations-conversation-id-attachments-stale", "parameters": [ { "role": "flag", @@ -38301,12 +38260,12 @@ } }, { + "name": "post-agent-builder-converse", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-converse", "parameters": [ { "role": "flag", @@ -38406,12 +38365,12 @@ } }, { + "name": "post-agent-builder-converse-async", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-converse-async", "parameters": [ { "role": "flag", @@ -38511,12 +38470,12 @@ } }, { + "name": "post-agent-builder-mcp", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-mcp", "parameters": [ { "role": "flag", @@ -38546,12 +38505,12 @@ } }, { + "name": "get-agent-builder-plugins", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-plugins", "parameters": [ { "role": "flag", @@ -38577,12 +38536,12 @@ } }, { + "name": "delete-agent-builder-plugins-pluginid", "path": [ "stack", "kb", "agent-builder" ], - "name": "delete-agent-builder-plugins-pluginid", "parameters": [ { "role": "flag", @@ -38622,12 +38581,12 @@ } }, { + "name": "get-agent-builder-plugins-pluginid", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-plugins-pluginid", "parameters": [ { "role": "flag", @@ -38660,12 +38619,12 @@ } }, { + "name": "post-agent-builder-plugins-install", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-plugins-install", "parameters": [ { "role": "flag", @@ -38702,12 +38661,12 @@ } }, { + "name": "get-agent-builder-skills", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-skills", "parameters": [ { "role": "flag", @@ -38740,12 +38699,12 @@ } }, { + "name": "post-agent-builder-skills", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-skills", "parameters": [ { "role": "flag", @@ -38809,12 +38768,12 @@ } }, { + "name": "delete-agent-builder-skills-skillid", "path": [ "stack", "kb", "agent-builder" ], - "name": "delete-agent-builder-skills-skillid", "parameters": [ { "role": "flag", @@ -38854,12 +38813,12 @@ } }, { + "name": "get-agent-builder-skills-skillid", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-skills-skillid", "parameters": [ { "role": "flag", @@ -38892,12 +38851,12 @@ } }, { + "name": "put-agent-builder-skills-skillid", "path": [ "stack", "kb", "agent-builder" ], - "name": "put-agent-builder-skills-skillid", "parameters": [ { "role": "flag", @@ -38964,12 +38923,12 @@ } }, { + "name": "get-agent-builder-tools", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-tools", "parameters": [ { "role": "flag", @@ -38995,12 +38954,12 @@ } }, { + "name": "post-agent-builder-tools", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-tools", "parameters": [ { "role": "flag", @@ -39058,12 +39017,12 @@ } }, { + "name": "post-agent-builder-tools-execute", "path": [ "stack", "kb", "agent-builder" ], - "name": "post-agent-builder-tools-execute", "parameters": [ { "role": "flag", @@ -39107,12 +39066,12 @@ } }, { + "name": "delete-agent-builder-tools-toolid", "path": [ "stack", "kb", "agent-builder" ], - "name": "delete-agent-builder-tools-toolid", "parameters": [ { "role": "flag", @@ -39152,12 +39111,12 @@ } }, { + "name": "get-agent-builder-tools-toolid", "path": [ "stack", "kb", "agent-builder" ], - "name": "get-agent-builder-tools-toolid", "parameters": [ { "role": "flag", @@ -39190,12 +39149,12 @@ } }, { + "name": "put-agent-builder-tools-toolid", "path": [ "stack", "kb", "agent-builder" ], - "name": "put-agent-builder-tools-toolid", "parameters": [ { "role": "flag", @@ -39249,19 +39208,18 @@ } } ], - "namespaces": [], "summary": "Kibana agent-builder API commands" }, { "segment": "alerting", "commands": [ { + "name": "delete-alerting-rule-id", "path": [ "stack", "kb", "alerting" ], - "name": "delete-alerting-rule-id", "parameters": [ { "role": "flag", @@ -39294,12 +39252,12 @@ } }, { + "name": "get-alerting-rule-id", "path": [ "stack", "kb", "alerting" ], - "name": "get-alerting-rule-id", "parameters": [ { "role": "flag", @@ -39332,12 +39290,12 @@ } }, { + "name": "post-alerting-rule-id", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id", "parameters": [ { "role": "flag", @@ -39456,12 +39414,12 @@ } }, { + "name": "put-alerting-rule-id", "path": [ "stack", "kb", "alerting" ], - "name": "put-alerting-rule-id", "parameters": [ { "role": "flag", @@ -39560,12 +39518,12 @@ } }, { + "name": "post-alerting-rule-id-disable", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id-disable", "parameters": [ { "role": "flag", @@ -39602,12 +39560,12 @@ } }, { + "name": "post-alerting-rule-id-enable", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id-enable", "parameters": [ { "role": "flag", @@ -39637,12 +39595,12 @@ } }, { + "name": "post-alerting-rule-id-mute-all", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id-mute-all", "parameters": [ { "role": "flag", @@ -39672,12 +39630,12 @@ } }, { + "name": "post-alerting-rule-id-unmute-all", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id-unmute-all", "parameters": [ { "role": "flag", @@ -39707,12 +39665,12 @@ } }, { + "name": "post-alerting-rule-id-update-api-key", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id-update-api-key", "parameters": [ { "role": "flag", @@ -39742,12 +39700,12 @@ } }, { + "name": "post-alerting-rule-id-snooze-schedule", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-id-snooze-schedule", "parameters": [ { "role": "flag", @@ -39783,12 +39741,12 @@ } }, { + "name": "post-alerting-rule-rule-id-alert-alert-id-mute", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-rule-id-alert-alert-id-mute", "parameters": [ { "role": "flag", @@ -39832,12 +39790,12 @@ } }, { + "name": "post-alerting-rule-rule-id-alert-alert-id-unmute", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rule-rule-id-alert-alert-id-unmute", "parameters": [ { "role": "flag", @@ -39874,12 +39832,12 @@ } }, { + "name": "delete-alerting-rule-ruleid-snooze-schedule-scheduleid", "path": [ "stack", "kb", "alerting" ], - "name": "delete-alerting-rule-ruleid-snooze-schedule-scheduleid", "parameters": [ { "role": "flag", @@ -39919,12 +39877,12 @@ } }, { + "name": "get-alerting-rules-find", "path": [ "stack", "kb", "alerting" ], - "name": "get-alerting-rules-find", "parameters": [ { "role": "flag", @@ -40026,12 +39984,12 @@ } }, { + "name": "post-alerting-rules-backfill-find", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rules-backfill-find", "parameters": [ { "role": "flag", @@ -40110,12 +40068,12 @@ } }, { + "name": "post-alerting-rules-backfill-schedule", "path": [ "stack", "kb", "alerting" ], - "name": "post-alerting-rules-backfill-schedule", "parameters": [ { "role": "flag", @@ -40138,12 +40096,12 @@ } }, { + "name": "delete-alerting-rules-backfill-id", "path": [ "stack", "kb", "alerting" ], - "name": "delete-alerting-rules-backfill-id", "parameters": [ { "role": "flag", @@ -40176,12 +40134,12 @@ } }, { + "name": "get-alerting-rules-backfill-id", "path": [ "stack", "kb", "alerting" ], - "name": "get-alerting-rules-backfill-id", "parameters": [ { "role": "flag", @@ -40214,19 +40172,18 @@ } } ], - "namespaces": [], "summary": "Kibana alerting API commands" }, { "segment": "apm-agent-configuration", "commands": [ { + "name": "delete-agent-configuration", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "delete-agent-configuration", "parameters": [ { "role": "flag", @@ -40259,12 +40216,12 @@ } }, { + "name": "get-agent-configurations", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "get-agent-configurations", "parameters": [ { "role": "flag", @@ -40290,12 +40247,12 @@ } }, { + "name": "create-update-agent-configuration", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "create-update-agent-configuration", "parameters": [ { "role": "flag", @@ -40349,12 +40306,12 @@ } }, { + "name": "get-agent-name-for-service", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "get-agent-name-for-service", "parameters": [ { "role": "flag", @@ -40387,12 +40344,12 @@ } }, { + "name": "get-environments-for-service", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "get-environments-for-service", "parameters": [ { "role": "flag", @@ -40425,12 +40382,12 @@ } }, { + "name": "search-single-configuration", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "search-single-configuration", "parameters": [ { "role": "flag", @@ -40474,12 +40431,12 @@ } }, { + "name": "get-single-agent-configuration", "path": [ "stack", "kb", "apm-agent-configuration" ], - "name": "get-single-agent-configuration", "parameters": [ { "role": "flag", @@ -40519,19 +40476,18 @@ } } ], - "namespaces": [], "summary": "Kibana apm-agent-configuration API commands" }, { "segment": "apm-agent-keys", "commands": [ { + "name": "create-agent-key", "path": [ "stack", "kb", "apm-agent-keys" ], - "name": "create-agent-key", "parameters": [ { "role": "flag", @@ -40568,19 +40524,18 @@ } } ], - "namespaces": [], "summary": "Kibana apm-agent-keys API commands" }, { "segment": "apm-annotations", "commands": [ { + "name": "create-annotation", "path": [ "stack", "kb", "apm-annotations" ], - "name": "create-annotation", "parameters": [ { "role": "flag", @@ -40638,12 +40593,12 @@ } }, { + "name": "get-annotation", "path": [ "stack", "kb", "apm-annotations" ], - "name": "get-annotation", "parameters": [ { "role": "flag", @@ -40697,19 +40652,18 @@ } } ], - "namespaces": [], "summary": "Kibana apm-annotations API commands" }, { "segment": "apm-server-schema", "commands": [ { + "name": "save-apm-server-schema", "path": [ "stack", "kb", "apm-server-schema" ], - "name": "save-apm-server-schema", "parameters": [ { "role": "flag", @@ -40739,19 +40693,18 @@ } } ], - "namespaces": [], "summary": "Kibana apm-server-schema API commands" }, { "segment": "apm-sourcemaps", "commands": [ { + "name": "get-source-maps", "path": [ "stack", "kb", "apm-sourcemaps" ], - "name": "get-source-maps", "parameters": [ { "role": "flag", @@ -40791,12 +40744,12 @@ } }, { + "name": "upload-source-map", "path": [ "stack", "kb", "apm-sourcemaps" ], - "name": "upload-source-map", "parameters": [ { "role": "flag", @@ -40819,12 +40772,12 @@ } }, { + "name": "delete-source-map", "path": [ "stack", "kb", "apm-sourcemaps" ], - "name": "delete-source-map", "parameters": [ { "role": "flag", @@ -40857,19 +40810,18 @@ } } ], - "namespaces": [], "summary": "Kibana apm-sourcemaps API commands" }, { "segment": "connectors", "commands": [ { + "name": "get-actions-connector-types", "path": [ "stack", "kb", "connectors" ], - "name": "get-actions-connector-types", "parameters": [ { "role": "flag", @@ -40902,12 +40854,12 @@ } }, { + "name": "get-actions-connector-oauth-callback", "path": [ "stack", "kb", "connectors" ], - "name": "get-actions-connector-oauth-callback", "parameters": [ { "role": "flag", @@ -40968,12 +40920,12 @@ } }, { + "name": "delete-actions-connector-id", "path": [ "stack", "kb", "connectors" ], - "name": "delete-actions-connector-id", "parameters": [ { "role": "flag", @@ -41006,12 +40958,12 @@ } }, { + "name": "get-actions-connector-id", "path": [ "stack", "kb", "connectors" ], - "name": "get-actions-connector-id", "parameters": [ { "role": "flag", @@ -41044,12 +40996,12 @@ } }, { + "name": "post-actions-connector-id", "path": [ "stack", "kb", "connectors" ], - "name": "post-actions-connector-id", "parameters": [ { "role": "flag", @@ -41106,12 +41058,12 @@ } }, { + "name": "put-actions-connector-id", "path": [ "stack", "kb", "connectors" ], - "name": "put-actions-connector-id", "parameters": [ { "role": "flag", @@ -41164,12 +41116,12 @@ } }, { + "name": "post-actions-connector-id-execute", "path": [ "stack", "kb", "connectors" ], - "name": "post-actions-connector-id-execute", "parameters": [ { "role": "flag", @@ -41205,12 +41157,12 @@ } }, { + "name": "get-actions-connectors", "path": [ "stack", "kb", "connectors" ], - "name": "get-actions-connectors", "parameters": [ { "role": "flag", @@ -41236,19 +41188,18 @@ } } ], - "namespaces": [], "summary": "Kibana connectors API commands" }, { "segment": "data-streams", "commands": [ { + "name": "get-fleet-data-streams", "path": [ "stack", "kb", "data-streams" ], - "name": "get-fleet-data-streams", "parameters": [ { "role": "flag", @@ -41274,12 +41225,12 @@ } }, { + "name": "get-fleet-epm-data-streams", "path": [ "stack", "kb", "data-streams" ], - "name": "get-fleet-epm-data-streams", "parameters": [ { "role": "flag", @@ -41329,19 +41280,18 @@ } } ], - "namespaces": [], "summary": "Kibana data-streams API commands" }, { "segment": "data-views", "commands": [ { + "name": "get-all-data-views-default", "path": [ "stack", "kb", "data-views" ], - "name": "get-all-data-views-default", "parameters": [ { "role": "flag", @@ -41367,12 +41317,12 @@ } }, { + "name": "create-data-view-defaultw", "path": [ "stack", "kb", "data-views" ], - "name": "create-data-view-defaultw", "parameters": [ { "role": "flag", @@ -41409,12 +41359,12 @@ } }, { + "name": "delete-data-view-default", "path": [ "stack", "kb", "data-views" ], - "name": "delete-data-view-default", "parameters": [ { "role": "flag", @@ -41447,12 +41397,12 @@ } }, { + "name": "get-data-view-default", "path": [ "stack", "kb", "data-views" ], - "name": "get-data-view-default", "parameters": [ { "role": "flag", @@ -41485,12 +41435,12 @@ } }, { + "name": "update-data-view-default", "path": [ "stack", "kb", "data-views" ], - "name": "update-data-view-default", "parameters": [ { "role": "flag", @@ -41534,12 +41484,12 @@ } }, { + "name": "update-fields-metadata-default", "path": [ "stack", "kb", "data-views" ], - "name": "update-fields-metadata-default", "parameters": [ { "role": "flag", @@ -41576,12 +41526,12 @@ } }, { + "name": "create-runtime-field-default", "path": [ "stack", "kb", "data-views" ], - "name": "create-runtime-field-default", "parameters": [ { "role": "flag", @@ -41625,12 +41575,12 @@ } }, { + "name": "create-update-runtime-field-default", "path": [ "stack", "kb", "data-views" ], - "name": "create-update-runtime-field-default", "parameters": [ { "role": "flag", @@ -41677,12 +41627,12 @@ } }, { + "name": "delete-runtime-field-default", "path": [ "stack", "kb", "data-views" ], - "name": "delete-runtime-field-default", "parameters": [ { "role": "flag", @@ -41722,12 +41672,12 @@ } }, { + "name": "get-runtime-field-default", "path": [ "stack", "kb", "data-views" ], - "name": "get-runtime-field-default", "parameters": [ { "role": "flag", @@ -41767,12 +41717,12 @@ } }, { + "name": "update-runtime-field-default", "path": [ "stack", "kb", "data-views" ], - "name": "update-runtime-field-default", "parameters": [ { "role": "flag", @@ -41816,12 +41766,12 @@ } }, { + "name": "get-default-data-view-default", "path": [ "stack", "kb", "data-views" ], - "name": "get-default-data-view-default", "parameters": [ { "role": "flag", @@ -41847,12 +41797,12 @@ } }, { + "name": "set-default-datail-view-default", "path": [ "stack", "kb", "data-views" ], - "name": "set-default-datail-view-default", "parameters": [ { "role": "flag", @@ -41889,12 +41839,12 @@ } }, { + "name": "swap-data-views-default", "path": [ "stack", "kb", "data-views" ], - "name": "swap-data-views-default", "parameters": [ { "role": "flag", @@ -41959,12 +41909,12 @@ } }, { + "name": "preview-swap-data-views-default", "path": [ "stack", "kb", "data-views" ], - "name": "preview-swap-data-views-default", "parameters": [ { "role": "flag", @@ -42029,19 +41979,18 @@ } } ], - "namespaces": [], "summary": "Kibana data-views API commands" }, { "segment": "elastic-agent-actions", "commands": [ { + "name": "post-fleet-agents-agentid-actions", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-agentid-actions", "parameters": [ { "role": "flag", @@ -42077,12 +42026,12 @@ } }, { + "name": "post-fleet-agents-agentid-reassign", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-agentid-reassign", "parameters": [ { "role": "flag", @@ -42118,12 +42067,12 @@ } }, { + "name": "post-fleet-agents-agentid-request-diagnostics", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-agentid-request-diagnostics", "parameters": [ { "role": "flag", @@ -42159,12 +42108,12 @@ } }, { + "name": "post-fleet-agents-agentid-rollback", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-agentid-rollback", "parameters": [ { "role": "flag", @@ -42194,12 +42143,12 @@ } }, { + "name": "post-fleet-agents-agentid-unenroll", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-agentid-unenroll", "parameters": [ { "role": "flag", @@ -42241,12 +42190,12 @@ } }, { + "name": "post-fleet-agents-agentid-upgrade", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-agentid-upgrade", "parameters": [ { "role": "flag", @@ -42300,12 +42249,12 @@ } }, { + "name": "get-fleet-agents-action-status", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "get-fleet-agents-action-status", "parameters": [ { "role": "flag", @@ -42361,12 +42310,12 @@ } }, { + "name": "post-fleet-agents-actions-actionid-cancel", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-actions-actionid-cancel", "parameters": [ { "role": "flag", @@ -42396,12 +42345,12 @@ } }, { + "name": "post-fleet-agents-bulk-reassign", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-bulk-reassign", "parameters": [ { "role": "flag", @@ -42448,12 +42397,12 @@ } }, { + "name": "post-fleet-agents-bulk-request-diagnostics", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-bulk-request-diagnostics", "parameters": [ { "role": "flag", @@ -42494,12 +42443,12 @@ } }, { + "name": "post-fleet-agents-bulk-rollback", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-bulk-rollback", "parameters": [ { "role": "flag", @@ -42540,12 +42489,12 @@ } }, { + "name": "post-fleet-agents-bulk-unenroll", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-bulk-unenroll", "parameters": [ { "role": "flag", @@ -42601,12 +42550,12 @@ } }, { + "name": "post-fleet-agents-bulk-update-agent-tags", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-bulk-update-agent-tags", "parameters": [ { "role": "flag", @@ -42659,12 +42608,12 @@ } }, { + "name": "post-fleet-agents-bulk-upgrade", "path": [ "stack", "kb", "elastic-agent-actions" ], - "name": "post-fleet-agents-bulk-upgrade", "parameters": [ { "role": "flag", @@ -42741,19 +42690,18 @@ } } ], - "namespaces": [], "summary": "Kibana elastic-agent-actions API commands" }, { "segment": "elastic-agent-binary-download-sources", "commands": [ { + "name": "get-fleet-agent-download-sources", "path": [ "stack", "kb", "elastic-agent-binary-download-sources" ], - "name": "get-fleet-agent-download-sources", "parameters": [ { "role": "flag", @@ -42779,12 +42727,12 @@ } }, { + "name": "post-fleet-agent-download-sources", "path": [ "stack", "kb", "elastic-agent-binary-download-sources" ], - "name": "post-fleet-agent-download-sources", "parameters": [ { "role": "flag", @@ -42856,12 +42804,12 @@ } }, { + "name": "delete-fleet-agent-download-sources-sourceid", "path": [ "stack", "kb", "elastic-agent-binary-download-sources" ], - "name": "delete-fleet-agent-download-sources-sourceid", "parameters": [ { "role": "flag", @@ -42894,12 +42842,12 @@ } }, { + "name": "get-fleet-agent-download-sources-sourceid", "path": [ "stack", "kb", "elastic-agent-binary-download-sources" ], - "name": "get-fleet-agent-download-sources-sourceid", "parameters": [ { "role": "flag", @@ -42932,12 +42880,12 @@ } }, { + "name": "put-fleet-agent-download-sources-sourceid", "path": [ "stack", "kb", "elastic-agent-binary-download-sources" ], - "name": "put-fleet-agent-download-sources-sourceid", "parameters": [ { "role": "flag", @@ -43019,19 +42967,18 @@ } } ], - "namespaces": [], "summary": "Kibana elastic-agent-binary-download-sources API commands" }, { "segment": "elastic-agent-policies", "commands": [ { + "name": "get-fleet-agent-policies", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-agent-policies", "parameters": [ { "role": "flag", @@ -43120,12 +43067,12 @@ } }, { + "name": "post-fleet-agent-policies", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "post-fleet-agent-policies", "parameters": [ { "role": "flag", @@ -43345,12 +43292,12 @@ } }, { + "name": "post-fleet-agent-policies-bulk-get", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "post-fleet-agent-policies-bulk-get", "parameters": [ { "role": "flag", @@ -43399,12 +43346,12 @@ } }, { + "name": "get-fleet-agent-policies-agentpolicyid", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-agent-policies-agentpolicyid", "parameters": [ { "role": "flag", @@ -43443,12 +43390,12 @@ } }, { + "name": "put-fleet-agent-policies-agentpolicyid", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "put-fleet-agent-policies-agentpolicyid", "parameters": [ { "role": "flag", @@ -43684,12 +43631,12 @@ } }, { + "name": "get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status", "parameters": [ { "role": "flag", @@ -43722,12 +43669,12 @@ } }, { + "name": "post-fleet-agent-policies-agentpolicyid-copy", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "post-fleet-agent-policies-agentpolicyid-copy", "parameters": [ { "role": "flag", @@ -43775,12 +43722,12 @@ } }, { + "name": "get-fleet-agent-policies-agentpolicyid-download", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-agent-policies-agentpolicyid-download", "parameters": [ { "role": "flag", @@ -43841,12 +43788,12 @@ } }, { + "name": "get-fleet-agent-policies-agentpolicyid-full", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-agent-policies-agentpolicyid-full", "parameters": [ { "role": "flag", @@ -43907,12 +43854,12 @@ } }, { + "name": "get-fleet-agent-policies-agentpolicyid-outputs", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-agent-policies-agentpolicyid-outputs", "parameters": [ { "role": "flag", @@ -43945,12 +43892,12 @@ } }, { + "name": "post-fleet-agent-policies-delete", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "post-fleet-agent-policies-delete", "parameters": [ { "role": "flag", @@ -43986,12 +43933,12 @@ } }, { + "name": "post-fleet-agent-policies-outputs", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "post-fleet-agent-policies-outputs", "parameters": [ { "role": "flag", @@ -44021,12 +43968,12 @@ } }, { + "name": "get-fleet-kubernetes", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-kubernetes", "parameters": [ { "role": "flag", @@ -44070,12 +44017,12 @@ } }, { + "name": "get-fleet-kubernetes-download", "path": [ "stack", "kb", "elastic-agent-policies" ], - "name": "get-fleet-kubernetes-download", "parameters": [ { "role": "flag", @@ -44119,19 +44066,18 @@ } } ], - "namespaces": [], "summary": "Kibana elastic-agent-policies API commands" }, { "segment": "elastic-agent-status", "commands": [ { + "name": "get-fleet-agent-status", "path": [ "stack", "kb", "elastic-agent-status" ], - "name": "get-fleet-agent-status", "parameters": [ { "role": "flag", @@ -44175,19 +44121,18 @@ } } ], - "namespaces": [], "summary": "Kibana elastic-agent-status API commands" }, { "segment": "elastic-agents", "commands": [ { + "name": "get-fleet-agent-status-data", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agent-status-data", "parameters": [ { "role": "flag", @@ -44237,12 +44182,12 @@ } }, { + "name": "get-fleet-agents", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents", "parameters": [ { "role": "flag", @@ -44352,12 +44297,12 @@ } }, { + "name": "post-fleet-agents", "path": [ "stack", "kb", "elastic-agents" ], - "name": "post-fleet-agents", "parameters": [ { "role": "flag", @@ -44386,12 +44331,12 @@ } }, { + "name": "delete-fleet-agents-agentid", "path": [ "stack", "kb", "elastic-agents" ], - "name": "delete-fleet-agents-agentid", "parameters": [ { "role": "flag", @@ -44424,12 +44369,12 @@ } }, { + "name": "get-fleet-agents-agentid", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents-agentid", "parameters": [ { "role": "flag", @@ -44468,12 +44413,12 @@ } }, { + "name": "put-fleet-agents-agentid", "path": [ "stack", "kb", "elastic-agents" ], - "name": "put-fleet-agents-agentid", "parameters": [ { "role": "flag", @@ -44518,12 +44463,12 @@ } }, { + "name": "post-fleet-agents-agentid-migrate", "path": [ "stack", "kb", "elastic-agents" ], - "name": "post-fleet-agents-agentid-migrate", "parameters": [ { "role": "flag", @@ -44571,12 +44516,12 @@ } }, { + "name": "post-fleet-agents-agentid-privilege-level-change", "path": [ "stack", "kb", "elastic-agents" ], - "name": "post-fleet-agents-agentid-privilege-level-change", "parameters": [ { "role": "flag", @@ -44612,12 +44557,12 @@ } }, { + "name": "get-fleet-agents-agentid-uploads", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents-agentid-uploads", "parameters": [ { "role": "flag", @@ -44650,12 +44595,12 @@ } }, { + "name": "get-fleet-agents-available-versions", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents-available-versions", "parameters": [ { "role": "flag", @@ -44681,12 +44626,12 @@ } }, { + "name": "post-fleet-agents-bulk-migrate", "path": [ "stack", "kb", "elastic-agents" ], - "name": "post-fleet-agents-bulk-migrate", "parameters": [ { "role": "flag", @@ -44739,12 +44684,12 @@ } }, { + "name": "post-fleet-agents-bulk-privilege-level-change", "path": [ "stack", "kb", "elastic-agents" ], - "name": "post-fleet-agents-bulk-privilege-level-change", "parameters": [ { "role": "flag", @@ -44785,12 +44730,12 @@ } }, { + "name": "delete-fleet-agents-files-fileid", "path": [ "stack", "kb", "elastic-agents" ], - "name": "delete-fleet-agents-files-fileid", "parameters": [ { "role": "flag", @@ -44823,12 +44768,12 @@ } }, { + "name": "get-fleet-agents-files-fileid-filename", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents-files-fileid-filename", "parameters": [ { "role": "flag", @@ -44868,12 +44813,12 @@ } }, { + "name": "get-fleet-agents-setup", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents-setup", "parameters": [ { "role": "flag", @@ -44899,12 +44844,12 @@ } }, { + "name": "post-fleet-agents-setup", "path": [ "stack", "kb", "elastic-agents" ], - "name": "post-fleet-agents-setup", "parameters": [ { "role": "flag", @@ -44927,12 +44872,12 @@ } }, { + "name": "get-fleet-agents-tags", "path": [ "stack", "kb", "elastic-agents" ], - "name": "get-fleet-agents-tags", "parameters": [ { "role": "flag", @@ -44970,19 +44915,18 @@ } } ], - "namespaces": [], "summary": "Kibana elastic-agents API commands" }, { "segment": "elastic-package-manager-epm", "commands": [ { + "name": "post-fleet-epm-bulk-assets", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-bulk-assets", "parameters": [ { "role": "flag", @@ -45011,12 +44955,12 @@ } }, { + "name": "get-fleet-epm-categories", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-categories", "parameters": [ { "role": "flag", @@ -45054,12 +44998,12 @@ } }, { + "name": "post-fleet-epm-custom-integrations", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-custom-integrations", "parameters": [ { "role": "flag", @@ -45100,12 +45044,12 @@ } }, { + "name": "put-fleet-epm-custom-integrations-pkgname", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "put-fleet-epm-custom-integrations-pkgname", "parameters": [ { "role": "flag", @@ -45150,12 +45094,12 @@ } }, { + "name": "get-fleet-epm-packages", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages", "parameters": [ { "role": "flag", @@ -45205,12 +45149,12 @@ } }, { + "name": "post-fleet-epm-packages", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages", "parameters": [ { "role": "flag", @@ -45245,12 +45189,12 @@ } }, { + "name": "post-fleet-epm-packages-bulk", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-bulk", "parameters": [ { "role": "flag", @@ -45291,12 +45235,12 @@ } }, { + "name": "post-fleet-epm-packages-bulk-rollback", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-bulk-rollback", "parameters": [ { "role": "flag", @@ -45325,12 +45269,12 @@ } }, { + "name": "get-fleet-epm-packages-bulk-rollback-taskid", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-bulk-rollback-taskid", "parameters": [ { "role": "flag", @@ -45363,12 +45307,12 @@ } }, { + "name": "post-fleet-epm-packages-bulk-uninstall", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-bulk-uninstall", "parameters": [ { "role": "flag", @@ -45403,12 +45347,12 @@ } }, { + "name": "get-fleet-epm-packages-bulk-uninstall-taskid", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-bulk-uninstall-taskid", "parameters": [ { "role": "flag", @@ -45441,12 +45385,12 @@ } }, { + "name": "post-fleet-epm-packages-bulk-upgrade", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-bulk-upgrade", "parameters": [ { "role": "flag", @@ -45493,12 +45437,12 @@ } }, { + "name": "get-fleet-epm-packages-bulk-upgrade-taskid", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-bulk-upgrade-taskid", "parameters": [ { "role": "flag", @@ -45531,12 +45475,12 @@ } }, { + "name": "delete-fleet-epm-packages-pkgname", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "delete-fleet-epm-packages-pkgname", "parameters": [ { "role": "flag", @@ -45575,12 +45519,12 @@ } }, { + "name": "get-fleet-epm-packages-pkgname", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-pkgname", "parameters": [ { "role": "flag", @@ -45637,12 +45581,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname", "parameters": [ { "role": "flag", @@ -45709,12 +45653,12 @@ } }, { + "name": "put-fleet-epm-packages-pkgname", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "put-fleet-epm-packages-pkgname", "parameters": [ { "role": "flag", @@ -45753,12 +45697,12 @@ } }, { + "name": "delete-fleet-epm-packages-pkgname-pkgversion", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "delete-fleet-epm-packages-pkgname-pkgversion", "parameters": [ { "role": "flag", @@ -45804,12 +45748,12 @@ } }, { + "name": "get-fleet-epm-packages-pkgname-pkgversion", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-pkgname-pkgversion", "parameters": [ { "role": "flag", @@ -45873,12 +45817,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname-pkgversion", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname-pkgversion", "parameters": [ { "role": "flag", @@ -45952,12 +45896,12 @@ } }, { + "name": "put-fleet-epm-packages-pkgname-pkgversion", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "put-fleet-epm-packages-pkgname-pkgversion", "parameters": [ { "role": "flag", @@ -46003,12 +45947,12 @@ } }, { + "name": "get-fleet-epm-packages-pkgname-pkgversion-filepath", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-pkgname-pkgversion-filepath", "parameters": [ { "role": "flag", @@ -46055,12 +45999,12 @@ } }, { + "name": "delete-fleet-epm-packages-pkgname-pkgversion-datastream-assets", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "delete-fleet-epm-packages-pkgname-pkgversion-datastream-assets", "parameters": [ { "role": "flag", @@ -46106,12 +46050,12 @@ } }, { + "name": "delete-fleet-epm-packages-pkgname-pkgversion-kibana-assets", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "delete-fleet-epm-packages-pkgname-pkgversion-kibana-assets", "parameters": [ { "role": "flag", @@ -46151,12 +46095,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname-pkgversion-kibana-assets", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname-pkgversion-kibana-assets", "parameters": [ { "role": "flag", @@ -46206,12 +46150,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname-pkgversion-rule-assets", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname-pkgversion-rule-assets", "parameters": [ { "role": "flag", @@ -46254,12 +46198,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname-pkgversion-transforms-authorize", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname-pkgversion-transforms-authorize", "parameters": [ { "role": "flag", @@ -46308,12 +46252,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname-review-upgrade", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname-review-upgrade", "parameters": [ { "role": "flag", @@ -46355,12 +46299,12 @@ } }, { + "name": "post-fleet-epm-packages-pkgname-rollback", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "post-fleet-epm-packages-pkgname-rollback", "parameters": [ { "role": "flag", @@ -46390,12 +46334,12 @@ } }, { + "name": "get-fleet-epm-packages-pkgname-stats", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-pkgname-stats", "parameters": [ { "role": "flag", @@ -46428,12 +46372,12 @@ } }, { + "name": "get-fleet-epm-packages-installed", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-installed", "parameters": [ { "role": "flag", @@ -46495,12 +46439,12 @@ } }, { + "name": "get-fleet-epm-packages-limited", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-packages-limited", "parameters": [ { "role": "flag", @@ -46526,12 +46470,12 @@ } }, { + "name": "get-fleet-epm-templates-pkgname-pkgversion-inputs", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-templates-pkgname-pkgversion-inputs", "parameters": [ { "role": "flag", @@ -46589,12 +46533,12 @@ } }, { + "name": "get-fleet-epm-verification-key-id", "path": [ "stack", "kb", "elastic-package-manager-epm" ], - "name": "get-fleet-epm-verification-key-id", "parameters": [ { "role": "flag", @@ -46620,19 +46564,18 @@ } } ], - "namespaces": [], "summary": "Kibana elastic-package-manager-epm API commands" }, { "segment": "fleet-agentless-policies", "commands": [ { + "name": "post-fleet-agentless-policies", "path": [ "stack", "kb", "fleet-agentless-policies" ], - "name": "post-fleet-agentless-policies", "parameters": [ { "role": "flag", @@ -46744,12 +46687,12 @@ } }, { + "name": "delete-fleet-agentless-policies-policyid", "path": [ "stack", "kb", "fleet-agentless-policies" ], - "name": "delete-fleet-agentless-policies-policyid", "parameters": [ { "role": "flag", @@ -46789,19 +46732,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-agentless-policies API commands" }, { "segment": "fleet-cloud-connectors", "commands": [ { + "name": "get-fleet-cloud-connectors", "path": [ "stack", "kb", "fleet-cloud-connectors" ], - "name": "get-fleet-cloud-connectors", "parameters": [ { "role": "flag", @@ -46848,12 +46790,12 @@ } }, { + "name": "post-fleet-cloud-connectors", "path": [ "stack", "kb", "fleet-cloud-connectors" ], - "name": "post-fleet-cloud-connectors", "parameters": [ { "role": "flag", @@ -46903,12 +46845,12 @@ } }, { + "name": "delete-fleet-cloud-connectors-cloudconnectorid", "path": [ "stack", "kb", "fleet-cloud-connectors" ], - "name": "delete-fleet-cloud-connectors-cloudconnectorid", "parameters": [ { "role": "flag", @@ -46948,12 +46890,12 @@ } }, { + "name": "get-fleet-cloud-connectors-cloudconnectorid", "path": [ "stack", "kb", "fleet-cloud-connectors" ], - "name": "get-fleet-cloud-connectors-cloudconnectorid", "parameters": [ { "role": "flag", @@ -46986,12 +46928,12 @@ } }, { + "name": "put-fleet-cloud-connectors-cloudconnectorid", "path": [ "stack", "kb", "fleet-cloud-connectors" ], - "name": "put-fleet-cloud-connectors-cloudconnectorid", "parameters": [ { "role": "flag", @@ -47044,12 +46986,12 @@ } }, { + "name": "get-fleet-cloud-connectors-cloudconnectorid-usage", "path": [ "stack", "kb", "fleet-cloud-connectors" ], - "name": "get-fleet-cloud-connectors-cloudconnectorid-usage", "parameters": [ { "role": "flag", @@ -47096,19 +47038,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-cloud-connectors API commands" }, { "segment": "fleet-enrollment-api-keys", "commands": [ { + "name": "get-fleet-enrollment-api-keys", "path": [ "stack", "kb", "fleet-enrollment-api-keys" ], - "name": "get-fleet-enrollment-api-keys", "parameters": [ { "role": "flag", @@ -47152,12 +47093,12 @@ } }, { + "name": "post-fleet-enrollment-api-keys", "path": [ "stack", "kb", "fleet-enrollment-api-keys" ], - "name": "post-fleet-enrollment-api-keys", "parameters": [ { "role": "flag", @@ -47198,12 +47139,12 @@ } }, { + "name": "delete-fleet-enrollment-api-keys-keyid", "path": [ "stack", "kb", "fleet-enrollment-api-keys" ], - "name": "delete-fleet-enrollment-api-keys-keyid", "parameters": [ { "role": "flag", @@ -47236,12 +47177,12 @@ } }, { + "name": "get-fleet-enrollment-api-keys-keyid", "path": [ "stack", "kb", "fleet-enrollment-api-keys" ], - "name": "get-fleet-enrollment-api-keys-keyid", "parameters": [ { "role": "flag", @@ -47274,19 +47215,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-enrollment-api-keys API commands" }, { "segment": "fleet-internals", "commands": [ { + "name": "get-fleet-check-permissions", "path": [ "stack", "kb", "fleet-internals" ], - "name": "get-fleet-check-permissions", "parameters": [ { "role": "flag", @@ -47318,12 +47258,12 @@ } }, { + "name": "post-fleet-health-check", "path": [ "stack", "kb", "fleet-internals" ], - "name": "post-fleet-health-check", "parameters": [ { "role": "flag", @@ -47352,12 +47292,12 @@ } }, { + "name": "get-fleet-settings", "path": [ "stack", "kb", "fleet-internals" ], - "name": "get-fleet-settings", "parameters": [ { "role": "flag", @@ -47383,12 +47323,12 @@ } }, { + "name": "put-fleet-settings", "path": [ "stack", "kb", "fleet-internals" ], - "name": "put-fleet-settings", "parameters": [ { "role": "flag", @@ -47456,12 +47396,12 @@ } }, { + "name": "post-fleet-setup", "path": [ "stack", "kb", "fleet-internals" ], - "name": "post-fleet-setup", "parameters": [ { "role": "flag", @@ -47484,19 +47424,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-internals API commands" }, { "segment": "fleet-outputs", "commands": [ { + "name": "post-fleet-logstash-api-keys", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "post-fleet-logstash-api-keys", "parameters": [ { "role": "flag", @@ -47519,12 +47458,12 @@ } }, { + "name": "get-fleet-outputs", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "get-fleet-outputs", "parameters": [ { "role": "flag", @@ -47550,12 +47489,12 @@ } }, { + "name": "post-fleet-outputs", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "post-fleet-outputs", "parameters": [ { "role": "flag", @@ -47578,12 +47517,12 @@ } }, { + "name": "delete-fleet-outputs-outputid", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "delete-fleet-outputs-outputid", "parameters": [ { "role": "flag", @@ -47616,12 +47555,12 @@ } }, { + "name": "get-fleet-outputs-outputid", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "get-fleet-outputs-outputid", "parameters": [ { "role": "flag", @@ -47654,12 +47593,12 @@ } }, { + "name": "put-fleet-outputs-outputid", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "put-fleet-outputs-outputid", "parameters": [ { "role": "flag", @@ -47692,12 +47631,12 @@ } }, { + "name": "get-fleet-outputs-outputid-health", "path": [ "stack", "kb", "fleet-outputs" ], - "name": "get-fleet-outputs-outputid-health", "parameters": [ { "role": "flag", @@ -47730,19 +47669,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-outputs API commands" }, { "segment": "fleet-package-policies", "commands": [ { + "name": "get-fleet-package-policies", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "get-fleet-package-policies", "parameters": [ { "role": "flag", @@ -47816,12 +47754,12 @@ } }, { + "name": "post-fleet-package-policies", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "post-fleet-package-policies", "parameters": [ { "role": "flag", @@ -47850,12 +47788,12 @@ } }, { + "name": "post-fleet-package-policies-bulk-get", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "post-fleet-package-policies-bulk-get", "parameters": [ { "role": "flag", @@ -47897,12 +47835,12 @@ } }, { + "name": "delete-fleet-package-policies-packagepolicyid", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "delete-fleet-package-policies-packagepolicyid", "parameters": [ { "role": "flag", @@ -47941,12 +47879,12 @@ } }, { + "name": "get-fleet-package-policies-packagepolicyid", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "get-fleet-package-policies-packagepolicyid", "parameters": [ { "role": "flag", @@ -47985,12 +47923,12 @@ } }, { + "name": "put-fleet-package-policies-packagepolicyid", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "put-fleet-package-policies-packagepolicyid", "parameters": [ { "role": "flag", @@ -48029,12 +47967,12 @@ } }, { + "name": "post-fleet-package-policies-delete", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "post-fleet-package-policies-delete", "parameters": [ { "role": "flag", @@ -48069,12 +48007,12 @@ } }, { + "name": "post-fleet-package-policies-upgrade", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "post-fleet-package-policies-upgrade", "parameters": [ { "role": "flag", @@ -48103,12 +48041,12 @@ } }, { + "name": "post-fleet-package-policies-upgrade-dryrun", "path": [ "stack", "kb", "fleet-package-policies" ], - "name": "post-fleet-package-policies-upgrade-dryrun", "parameters": [ { "role": "flag", @@ -48143,19 +48081,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-package-policies API commands" }, { "segment": "fleet-proxies", "commands": [ { + "name": "get-fleet-proxies", "path": [ "stack", "kb", "fleet-proxies" ], - "name": "get-fleet-proxies", "parameters": [ { "role": "flag", @@ -48181,12 +48118,12 @@ } }, { + "name": "post-fleet-proxies", "path": [ "stack", "kb", "fleet-proxies" ], - "name": "post-fleet-proxies", "parameters": [ { "role": "flag", @@ -48257,12 +48194,12 @@ } }, { + "name": "delete-fleet-proxies-itemid", "path": [ "stack", "kb", "fleet-proxies" ], - "name": "delete-fleet-proxies-itemid", "parameters": [ { "role": "flag", @@ -48295,12 +48232,12 @@ } }, { + "name": "get-fleet-proxies-itemid", "path": [ "stack", "kb", "fleet-proxies" ], - "name": "get-fleet-proxies-itemid", "parameters": [ { "role": "flag", @@ -48333,12 +48270,12 @@ } }, { + "name": "put-fleet-proxies-itemid", "path": [ "stack", "kb", "fleet-proxies" ], - "name": "put-fleet-proxies-itemid", "parameters": [ { "role": "flag", @@ -48407,19 +48344,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-proxies API commands" }, { "segment": "fleet-server-hosts", "commands": [ { + "name": "get-fleet-fleet-server-hosts", "path": [ "stack", "kb", "fleet-server-hosts" ], - "name": "get-fleet-fleet-server-hosts", "parameters": [ { "role": "flag", @@ -48445,12 +48381,12 @@ } }, { + "name": "post-fleet-fleet-server-hosts", "path": [ "stack", "kb", "fleet-server-hosts" ], - "name": "post-fleet-fleet-server-hosts", "parameters": [ { "role": "flag", @@ -48527,12 +48463,12 @@ } }, { + "name": "delete-fleet-fleet-server-hosts-itemid", "path": [ "stack", "kb", "fleet-server-hosts" ], - "name": "delete-fleet-fleet-server-hosts-itemid", "parameters": [ { "role": "flag", @@ -48565,12 +48501,12 @@ } }, { + "name": "get-fleet-fleet-server-hosts-itemid", "path": [ "stack", "kb", "fleet-server-hosts" ], - "name": "get-fleet-fleet-server-hosts-itemid", "parameters": [ { "role": "flag", @@ -48603,12 +48539,12 @@ } }, { + "name": "put-fleet-fleet-server-hosts-itemid", "path": [ "stack", "kb", "fleet-server-hosts" ], - "name": "put-fleet-fleet-server-hosts-itemid", "parameters": [ { "role": "flag", @@ -48683,19 +48619,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-server-hosts API commands" }, { "segment": "fleet-uninstall-tokens", "commands": [ { + "name": "get-fleet-uninstall-tokens", "path": [ "stack", "kb", "fleet-uninstall-tokens" ], - "name": "get-fleet-uninstall-tokens", "parameters": [ { "role": "flag", @@ -48747,12 +48682,12 @@ } }, { + "name": "get-fleet-uninstall-tokens-uninstalltokenid", "path": [ "stack", "kb", "fleet-uninstall-tokens" ], - "name": "get-fleet-uninstall-tokens-uninstalltokenid", "parameters": [ { "role": "flag", @@ -48785,19 +48720,18 @@ } } ], - "namespaces": [], "summary": "Kibana fleet-uninstall-tokens API commands" }, { "segment": "maintenance-window", "commands": [ { + "name": "post-maintenance-window", "path": [ "stack", "kb", "maintenance-window" ], - "name": "post-maintenance-window", "parameters": [ { "role": "flag", @@ -48846,12 +48780,12 @@ } }, { + "name": "get-maintenance-window-find", "path": [ "stack", "kb", "maintenance-window" ], - "name": "get-maintenance-window-find", "parameters": [ { "role": "flag", @@ -48912,12 +48846,12 @@ } }, { + "name": "delete-maintenance-window-id", "path": [ "stack", "kb", "maintenance-window" ], - "name": "delete-maintenance-window-id", "parameters": [ { "role": "flag", @@ -48950,12 +48884,12 @@ } }, { + "name": "get-maintenance-window-id", "path": [ "stack", "kb", "maintenance-window" ], - "name": "get-maintenance-window-id", "parameters": [ { "role": "flag", @@ -48988,12 +48922,12 @@ } }, { + "name": "patch-maintenance-window-id", "path": [ "stack", "kb", "maintenance-window" ], - "name": "patch-maintenance-window-id", "parameters": [ { "role": "flag", @@ -49049,12 +48983,12 @@ } }, { + "name": "post-maintenance-window-id-archive", "path": [ "stack", "kb", "maintenance-window" ], - "name": "post-maintenance-window-id-archive", "parameters": [ { "role": "flag", @@ -49084,12 +49018,12 @@ } }, { + "name": "post-maintenance-window-id-unarchive", "path": [ "stack", "kb", "maintenance-window" ], - "name": "post-maintenance-window-id-unarchive", "parameters": [ { "role": "flag", @@ -49119,19 +49053,18 @@ } } ], - "namespaces": [], "summary": "Kibana maintenance-window API commands" }, { "segment": "message-signing-service", "commands": [ { + "name": "post-fleet-message-signing-service-rotate-key-pair", "path": [ "stack", "kb", "message-signing-service" ], - "name": "post-fleet-message-signing-service-rotate-key-pair", "parameters": [ { "role": "flag", @@ -49160,19 +49093,18 @@ } } ], - "namespaces": [], "summary": "Kibana message-signing-service API commands" }, { "segment": "misc", "commands": [ { + "name": "get-actions-connector-oauth-callback-script", "path": [ "stack", "kb", "misc" ], - "name": "get-actions-connector-oauth-callback-script", "parameters": [ { "role": "flag", @@ -49197,12 +49129,12 @@ } }, { + "name": "get-fleet-space-settings", "path": [ "stack", "kb", "misc" ], - "name": "get-fleet-space-settings", "parameters": [ { "role": "flag", @@ -49228,12 +49160,12 @@ } }, { + "name": "put-fleet-space-settings", "path": [ "stack", "kb", "misc" ], - "name": "put-fleet-space-settings", "parameters": [ { "role": "flag", @@ -49265,12 +49197,12 @@ } }, { + "name": "post-security-role-query", "path": [ "stack", "kb", "misc" ], - "name": "post-security-role-query", "parameters": [ { "role": "flag", @@ -49323,19 +49255,18 @@ } } ], - "namespaces": [], "summary": "Kibana misc API commands" }, { "segment": "ml", "commands": [ { + "name": "ml-sync", "path": [ "stack", "kb", "ml" ], - "name": "ml-sync", "parameters": [ { "role": "flag", @@ -49361,12 +49292,12 @@ } }, { + "name": "ml-update-jobs-spaces", "path": [ "stack", "kb", "ml" ], - "name": "ml-update-jobs-spaces", "parameters": [ { "role": "flag", @@ -49389,12 +49320,12 @@ } }, { + "name": "ml-update-trained-models-spaces", "path": [ "stack", "kb", "ml" ], - "name": "ml-update-trained-models-spaces", "parameters": [ { "role": "flag", @@ -49417,19 +49348,18 @@ } } ], - "namespaces": [], "summary": "Kibana ml API commands" }, { "segment": "observabilityaiassistant", "commands": [ { + "name": "observability-ai-assistant-chat-complete", "path": [ "stack", "kb", "observabilityaiassistant" ], - "name": "observability-ai-assistant-chat-complete", "parameters": [ { "role": "flag", @@ -49507,19 +49437,18 @@ } } ], - "namespaces": [], "summary": "Kibana observabilityaiassistant API commands" }, { "segment": "roles", "commands": [ { + "name": "get-security-role", "path": [ "stack", "kb", "roles" ], - "name": "get-security-role", "parameters": [ { "role": "flag", @@ -49552,12 +49481,12 @@ } }, { + "name": "delete-security-role-name", "path": [ "stack", "kb", "roles" ], - "name": "delete-security-role-name", "parameters": [ { "role": "flag", @@ -49590,12 +49519,12 @@ } }, { + "name": "get-security-role-name", "path": [ "stack", "kb", "roles" ], - "name": "get-security-role-name", "parameters": [ { "role": "flag", @@ -49635,12 +49564,12 @@ } }, { + "name": "put-security-role-name", "path": [ "stack", "kb", "roles" ], - "name": "put-security-role-name", "parameters": [ { "role": "flag", @@ -49705,12 +49634,12 @@ } }, { + "name": "post-security-roles", "path": [ "stack", "kb", "roles" ], - "name": "post-security-roles", "parameters": [ { "role": "flag", @@ -49739,19 +49668,18 @@ } } ], - "namespaces": [], "summary": "Kibana roles API commands" }, { "segment": "saved-objects", "commands": [ { + "name": "post-saved-objects-export", "path": [ "stack", "kb", "saved-objects" ], - "name": "post-saved-objects-export", "parameters": [ { "role": "flag", @@ -49815,12 +49743,12 @@ } }, { + "name": "post-saved-objects-import", "path": [ "stack", "kb", "saved-objects" ], - "name": "post-saved-objects-import", "parameters": [ { "role": "flag", @@ -49871,12 +49799,12 @@ } }, { + "name": "post-saved-objects-resolve-import-errors", "path": [ "stack", "kb", "saved-objects" ], - "name": "post-saved-objects-resolve-import-errors", "parameters": [ { "role": "flag", @@ -49925,19 +49853,18 @@ } } ], - "namespaces": [], "summary": "Kibana saved-objects API commands" }, { "segment": "security-ai-assistant-api", "commands": [ { + "name": "perform-anonymization-fields-bulk-action", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "perform-anonymization-fields-bulk-action", "parameters": [ { "role": "flag", @@ -49981,12 +49908,12 @@ } }, { + "name": "find-anonymization-fields", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "find-anonymization-fields", "parameters": [ { "role": "flag", @@ -50061,12 +49988,12 @@ } }, { + "name": "chat-complete", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "chat-complete", "parameters": [ { "role": "flag", @@ -50166,12 +50093,12 @@ } }, { + "name": "delete-all-conversations", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "delete-all-conversations", "parameters": [ { "role": "flag", @@ -50204,12 +50131,12 @@ } }, { + "name": "create-conversation", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "create-conversation", "parameters": [ { "role": "flag", @@ -50280,12 +50207,12 @@ } }, { + "name": "find-conversations", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "find-conversations", "parameters": [ { "role": "flag", @@ -50360,12 +50287,12 @@ } }, { + "name": "delete-conversation", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "delete-conversation", "parameters": [ { "role": "flag", @@ -50398,12 +50325,12 @@ } }, { + "name": "read-conversation", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "read-conversation", "parameters": [ { "role": "flag", @@ -50436,12 +50363,12 @@ } }, { + "name": "update-conversation", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "update-conversation", "parameters": [ { "role": "flag", @@ -50528,12 +50455,12 @@ } }, { + "name": "get-knowledge-base", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "get-knowledge-base", "parameters": [ { "role": "flag", @@ -50559,12 +50486,12 @@ } }, { + "name": "post-knowledge-base", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "post-knowledge-base", "parameters": [ { "role": "flag", @@ -50601,12 +50528,12 @@ } }, { + "name": "read-knowledge-base", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "read-knowledge-base", "parameters": [ { "role": "flag", @@ -50639,12 +50566,12 @@ } }, { + "name": "create-knowledge-base", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "create-knowledge-base", "parameters": [ { "role": "flag", @@ -50688,12 +50615,12 @@ } }, { + "name": "create-knowledge-base-entry", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "create-knowledge-base-entry", "parameters": [ { "role": "flag", @@ -50716,12 +50643,12 @@ } }, { + "name": "perform-knowledge-base-entry-bulk-action", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "perform-knowledge-base-entry-bulk-action", "parameters": [ { "role": "flag", @@ -50764,12 +50691,12 @@ } }, { + "name": "find-knowledge-base-entries", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "find-knowledge-base-entries", "parameters": [ { "role": "flag", @@ -50837,12 +50764,12 @@ } }, { + "name": "delete-knowledge-base-entry", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "delete-knowledge-base-entry", "parameters": [ { "role": "flag", @@ -50875,12 +50802,12 @@ } }, { + "name": "read-knowledge-base-entry", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "read-knowledge-base-entry", "parameters": [ { "role": "flag", @@ -50913,12 +50840,12 @@ } }, { + "name": "update-knowledge-base-entry", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "update-knowledge-base-entry", "parameters": [ { "role": "flag", @@ -50951,12 +50878,12 @@ } }, { + "name": "perform-prompts-bulk-action", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "perform-prompts-bulk-action", "parameters": [ { "role": "flag", @@ -51000,12 +50927,12 @@ } }, { + "name": "find-prompts", "path": [ "stack", "kb", "security-ai-assistant-api" ], - "name": "find-prompts", "parameters": [ { "role": "flag", @@ -51073,19 +51000,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-ai-assistant-api API commands" }, { "segment": "security-attack-discovery-api", "commands": [ { + "name": "post-attack-discovery-bulk", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "post-attack-discovery-bulk", "parameters": [ { "role": "flag", @@ -51115,12 +51041,12 @@ } }, { + "name": "attack-discovery-find", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "attack-discovery-find", "parameters": [ { "role": "flag", @@ -51258,12 +51184,12 @@ } }, { + "name": "post-attack-discovery-generate", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "post-attack-discovery-generate", "parameters": [ { "role": "flag", @@ -51356,12 +51282,12 @@ } }, { + "name": "get-attack-discovery-generations", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "get-attack-discovery-generations", "parameters": [ { "role": "flag", @@ -51408,12 +51334,12 @@ } }, { + "name": "get-attack-discovery-generation", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "get-attack-discovery-generation", "parameters": [ { "role": "flag", @@ -51460,12 +51386,12 @@ } }, { + "name": "post-attack-discovery-generations-dismiss", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "post-attack-discovery-generations-dismiss", "parameters": [ { "role": "flag", @@ -51495,12 +51421,12 @@ } }, { + "name": "create-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "create-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51557,12 +51483,12 @@ } }, { + "name": "find-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "find-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51616,12 +51542,12 @@ } }, { + "name": "delete-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "delete-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51654,12 +51580,12 @@ } }, { + "name": "get-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "get-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51692,12 +51618,12 @@ } }, { + "name": "update-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "update-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51757,12 +51683,12 @@ } }, { + "name": "disable-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "disable-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51792,12 +51718,12 @@ } }, { + "name": "enable-attack-discovery-schedules", "path": [ "stack", "kb", "security-attack-discovery-api" ], - "name": "enable-attack-discovery-schedules", "parameters": [ { "role": "flag", @@ -51827,19 +51753,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-attack-discovery-api API commands" }, { "segment": "security-detections-api", "commands": [ { + "name": "read-privileges", "path": [ "stack", "kb", "security-detections-api" ], - "name": "read-privileges", "parameters": [ { "role": "flag", @@ -51865,12 +51790,12 @@ } }, { + "name": "delete-rule", "path": [ "stack", "kb", "security-detections-api" ], - "name": "delete-rule", "parameters": [ { "role": "flag", @@ -51910,12 +51835,12 @@ } }, { + "name": "read-rule", "path": [ "stack", "kb", "security-detections-api" ], - "name": "read-rule", "parameters": [ { "role": "flag", @@ -51955,12 +51880,12 @@ } }, { + "name": "patch-rule", "path": [ "stack", "kb", "security-detections-api" ], - "name": "patch-rule", "parameters": [ { "role": "flag", @@ -51983,12 +51908,12 @@ } }, { + "name": "create-rule", "path": [ "stack", "kb", "security-detections-api" ], - "name": "create-rule", "parameters": [ { "role": "flag", @@ -52011,12 +51936,12 @@ } }, { + "name": "update-rule", "path": [ "stack", "kb", "security-detections-api" ], - "name": "update-rule", "parameters": [ { "role": "flag", @@ -52042,12 +51967,12 @@ } }, { + "name": "perform-rules-bulk-action", "path": [ "stack", "kb", "security-detections-api" ], - "name": "perform-rules-bulk-action", "parameters": [ { "role": "flag", @@ -52077,12 +52002,12 @@ } }, { + "name": "export-rules", "path": [ "stack", "kb", "security-detections-api" ], - "name": "export-rules", "parameters": [ { "role": "flag", @@ -52126,12 +52051,12 @@ } }, { + "name": "find-rules", "path": [ "stack", "kb", "security-detections-api" ], - "name": "find-rules", "parameters": [ { "role": "flag", @@ -52226,12 +52151,12 @@ } }, { + "name": "import-rules", "path": [ "stack", "kb", "security-detections-api" ], - "name": "import-rules", "parameters": [ { "role": "flag", @@ -52282,12 +52207,12 @@ } }, { + "name": "rule-preview", "path": [ "stack", "kb", "security-detections-api" ], - "name": "rule-preview", "parameters": [ { "role": "flag", @@ -52317,12 +52242,12 @@ } }, { + "name": "set-alert-assignees", "path": [ "stack", "kb", "security-detections-api" ], - "name": "set-alert-assignees", "parameters": [ { "role": "flag", @@ -52358,12 +52283,12 @@ } }, { + "name": "search-alerts", "path": [ "stack", "kb", "security-detections-api" ], - "name": "search-alerts", "parameters": [ { "role": "flag", @@ -52434,12 +52359,12 @@ } }, { + "name": "set-alerts-status", "path": [ "stack", "kb", "security-detections-api" ], - "name": "set-alerts-status", "parameters": [ { "role": "flag", @@ -52462,12 +52387,12 @@ } }, { + "name": "set-alert-tags", "path": [ "stack", "kb", "security-detections-api" ], - "name": "set-alert-tags", "parameters": [ { "role": "flag", @@ -52504,12 +52429,12 @@ } }, { + "name": "read-tags", "path": [ "stack", "kb", "security-detections-api" ], - "name": "read-tags", "parameters": [ { "role": "flag", @@ -52535,19 +52460,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-detections-api API commands" }, { "segment": "security-endpoint-exceptions-api", "commands": [ { + "name": "create-endpoint-list", "path": [ "stack", "kb", "security-endpoint-exceptions-api" ], - "name": "create-endpoint-list", "parameters": [ { "role": "flag", @@ -52570,12 +52494,12 @@ } }, { + "name": "delete-endpoint-list-item", "path": [ "stack", "kb", "security-endpoint-exceptions-api" ], - "name": "delete-endpoint-list-item", "parameters": [ { "role": "flag", @@ -52615,12 +52539,12 @@ } }, { + "name": "read-endpoint-list-item", "path": [ "stack", "kb", "security-endpoint-exceptions-api" ], - "name": "read-endpoint-list-item", "parameters": [ { "role": "flag", @@ -52660,12 +52584,12 @@ } }, { + "name": "create-endpoint-list-item", "path": [ "stack", "kb", "security-endpoint-exceptions-api" ], - "name": "create-endpoint-list-item", "parameters": [ { "role": "flag", @@ -52746,12 +52670,12 @@ } }, { + "name": "update-endpoint-list-item", "path": [ "stack", "kb", "security-endpoint-exceptions-api" ], - "name": "update-endpoint-list-item", "parameters": [ { "role": "flag", @@ -52848,12 +52772,12 @@ } }, { + "name": "find-endpoint-list-items", "path": [ "stack", "kb", "security-endpoint-exceptions-api" ], - "name": "find-endpoint-list-items", "parameters": [ { "role": "flag", @@ -52914,19 +52838,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-endpoint-exceptions-api API commands" }, { "segment": "security-endpoint-management-api", "commands": [ { + "name": "endpoint-get-actions-list", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-get-actions-list", "parameters": [ { "role": "flag", @@ -53012,12 +52935,12 @@ } }, { + "name": "endpoint-get-actions-status", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-get-actions-status", "parameters": [ { "role": "flag", @@ -53049,12 +52972,12 @@ } }, { + "name": "endpoint-get-actions-details", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-get-actions-details", "parameters": [ { "role": "flag", @@ -53087,12 +53010,12 @@ } }, { + "name": "endpoint-file-info", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-file-info", "parameters": [ { "role": "flag", @@ -53132,12 +53055,12 @@ } }, { + "name": "endpoint-file-download", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-file-download", "parameters": [ { "role": "flag", @@ -53177,12 +53100,12 @@ } }, { + "name": "cancel-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "cancel-action", "parameters": [ { "role": "flag", @@ -53246,12 +53169,12 @@ } }, { + "name": "endpoint-execute-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-execute-action", "parameters": [ { "role": "flag", @@ -53315,12 +53238,12 @@ } }, { + "name": "endpoint-get-file-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-get-file-action", "parameters": [ { "role": "flag", @@ -53384,12 +53307,12 @@ } }, { + "name": "endpoint-isolate-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-isolate-action", "parameters": [ { "role": "flag", @@ -53454,12 +53377,12 @@ } }, { + "name": "endpoint-kill-process-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-kill-process-action", "parameters": [ { "role": "flag", @@ -53523,12 +53446,12 @@ } }, { + "name": "endpoint-generate-memory-dump", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-generate-memory-dump", "parameters": [ { "role": "flag", @@ -53592,12 +53515,12 @@ } }, { + "name": "endpoint-get-processes-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-get-processes-action", "parameters": [ { "role": "flag", @@ -53662,12 +53585,12 @@ } }, { + "name": "run-script-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "run-script-action", "parameters": [ { "role": "flag", @@ -53732,12 +53655,12 @@ } }, { + "name": "endpoint-scan-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-scan-action", "parameters": [ { "role": "flag", @@ -53801,12 +53724,12 @@ } }, { + "name": "endpoint-get-actions-state", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-get-actions-state", "parameters": [ { "role": "flag", @@ -53832,12 +53755,12 @@ } }, { + "name": "endpoint-suspend-process-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-suspend-process-action", "parameters": [ { "role": "flag", @@ -53901,12 +53824,12 @@ } }, { + "name": "endpoint-unisolate-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-unisolate-action", "parameters": [ { "role": "flag", @@ -53971,12 +53894,12 @@ } }, { + "name": "endpoint-upload-action", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "endpoint-upload-action", "parameters": [ { "role": "flag", @@ -53999,12 +53922,12 @@ } }, { + "name": "get-endpoint-metadata-list", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "get-endpoint-metadata-list", "parameters": [ { "role": "flag", @@ -54066,12 +53989,12 @@ } }, { + "name": "get-endpoint-metadata", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "get-endpoint-metadata", "parameters": [ { "role": "flag", @@ -54104,12 +54027,12 @@ } }, { + "name": "get-policy-response", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "get-policy-response", "parameters": [ { "role": "flag", @@ -54141,12 +54064,12 @@ } }, { + "name": "get-protection-updates-note", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "get-protection-updates-note", "parameters": [ { "role": "flag", @@ -54179,12 +54102,12 @@ } }, { + "name": "create-update-protection-updates-note", "path": [ "stack", "kb", "security-endpoint-management-api" ], - "name": "create-update-protection-updates-note", "parameters": [ { "role": "flag", @@ -54220,19 +54143,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-endpoint-management-api API commands" }, { "segment": "security-entity-analytics-api", "commands": [ { + "name": "delete-asset-criticality-record", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "delete-asset-criticality-record", "parameters": [ { "role": "flag", @@ -54279,12 +54201,12 @@ } }, { + "name": "get-asset-criticality-record", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "get-asset-criticality-record", "parameters": [ { "role": "flag", @@ -54324,12 +54246,12 @@ } }, { + "name": "create-asset-criticality-record", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "create-asset-criticality-record", "parameters": [ { "role": "flag", @@ -54359,12 +54281,12 @@ } }, { + "name": "bulk-upsert-asset-criticality-records", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "bulk-upsert-asset-criticality-records", "parameters": [ { "role": "flag", @@ -54393,12 +54315,12 @@ } }, { + "name": "find-asset-criticality-records", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "find-asset-criticality-records", "parameters": [ { "role": "flag", @@ -54459,12 +54381,12 @@ } }, { + "name": "delete-monitoring-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "delete-monitoring-engine", "parameters": [ { "role": "flag", @@ -54497,12 +54419,12 @@ } }, { + "name": "disable-monitoring-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "disable-monitoring-engine", "parameters": [ { "role": "flag", @@ -54525,12 +54447,12 @@ } }, { + "name": "init-monitoring-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "init-monitoring-engine", "parameters": [ { "role": "flag", @@ -54553,12 +54475,12 @@ } }, { + "name": "schedule-monitoring-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "schedule-monitoring-engine", "parameters": [ { "role": "flag", @@ -54581,12 +54503,12 @@ } }, { + "name": "priv-mon-health", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "priv-mon-health", "parameters": [ { "role": "flag", @@ -54612,12 +54534,12 @@ } }, { + "name": "priv-mon-privileges", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "priv-mon-privileges", "parameters": [ { "role": "flag", @@ -54643,12 +54565,12 @@ } }, { + "name": "create-priv-mon-user", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "create-priv-mon-user", "parameters": [ { "role": "flag", @@ -54684,12 +54606,12 @@ } }, { + "name": "privmon-bulk-upload-users-c-s-v", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "privmon-bulk-upload-users-c-s-v", "parameters": [ { "role": "flag", @@ -54712,12 +54634,12 @@ } }, { + "name": "delete-priv-mon-user", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "delete-priv-mon-user", "parameters": [ { "role": "flag", @@ -54750,12 +54672,12 @@ } }, { + "name": "update-priv-mon-user", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "update-priv-mon-user", "parameters": [ { "role": "flag", @@ -54812,12 +54734,12 @@ } }, { + "name": "list-priv-mon-users", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "list-priv-mon-users", "parameters": [ { "role": "flag", @@ -54850,12 +54772,12 @@ } }, { + "name": "install-privileged-access-detection-package", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "install-privileged-access-detection-package", "parameters": [ { "role": "flag", @@ -54878,12 +54800,12 @@ } }, { + "name": "get-privileged-access-detection-package-status", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "get-privileged-access-detection-package-status", "parameters": [ { "role": "flag", @@ -54909,12 +54831,12 @@ } }, { + "name": "create-watchlist", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "create-watchlist", "parameters": [ { "role": "flag", @@ -54972,12 +54894,12 @@ } }, { + "name": "get-watchlist", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "get-watchlist", "parameters": [ { "role": "flag", @@ -55010,12 +54932,12 @@ } }, { + "name": "update-watchlist", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "update-watchlist", "parameters": [ { "role": "flag", @@ -55076,12 +54998,12 @@ } }, { + "name": "list-watchlists", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "list-watchlists", "parameters": [ { "role": "flag", @@ -55107,12 +55029,12 @@ } }, { + "name": "init-entity-store", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "init-entity-store", "parameters": [ { "role": "flag", @@ -55216,12 +55138,12 @@ } }, { + "name": "delete-entity-engines", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "delete-entity-engines", "parameters": [ { "role": "flag", @@ -55261,12 +55183,12 @@ } }, { + "name": "list-entity-engines", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "list-entity-engines", "parameters": [ { "role": "flag", @@ -55292,12 +55214,12 @@ } }, { + "name": "delete-entity-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "delete-entity-engine", "parameters": [ { "role": "flag", @@ -55344,12 +55266,12 @@ } }, { + "name": "get-entity-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "get-entity-engine", "parameters": [ { "role": "flag", @@ -55382,12 +55304,12 @@ } }, { + "name": "init-entity-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "init-entity-engine", "parameters": [ { "role": "flag", @@ -55492,12 +55414,12 @@ } }, { + "name": "start-entity-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "start-entity-engine", "parameters": [ { "role": "flag", @@ -55527,12 +55449,12 @@ } }, { + "name": "stop-entity-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "stop-entity-engine", "parameters": [ { "role": "flag", @@ -55562,12 +55484,12 @@ } }, { + "name": "apply-entity-engine-dataview-indices", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "apply-entity-engine-dataview-indices", "parameters": [ { "role": "flag", @@ -55590,12 +55512,12 @@ } }, { + "name": "delete-single-entity", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "delete-single-entity", "parameters": [ { "role": "flag", @@ -55635,12 +55557,12 @@ } }, { + "name": "upsert-entity", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "upsert-entity", "parameters": [ { "role": "flag", @@ -55679,12 +55601,12 @@ } }, { + "name": "upsert-entities-bulk", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "upsert-entities-bulk", "parameters": [ { "role": "flag", @@ -55722,12 +55644,12 @@ } }, { + "name": "list-entities", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "list-entities", "parameters": [ { "role": "flag", @@ -55790,12 +55712,12 @@ } }, { + "name": "get-entity-store-status", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "get-entity-store-status", "parameters": [ { "role": "flag", @@ -55828,12 +55750,12 @@ } }, { + "name": "clean-up-risk-engine", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "clean-up-risk-engine", "parameters": [ { "role": "flag", @@ -55859,12 +55781,12 @@ } }, { + "name": "configure-risk-engine-saved-object", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "configure-risk-engine-saved-object", "parameters": [ { "role": "flag", @@ -55917,12 +55839,12 @@ } }, { + "name": "schedule-risk-engine-now", "path": [ "stack", "kb", "security-entity-analytics-api" ], - "name": "schedule-risk-engine-now", "parameters": [ { "role": "flag", @@ -55945,19 +55867,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-entity-analytics-api API commands" }, { "segment": "security-exceptions-api", "commands": [ { + "name": "create-rule-exception-list-items", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "create-rule-exception-list-items", "parameters": [ { "role": "flag", @@ -55993,12 +55914,12 @@ } }, { + "name": "delete-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "delete-exception-list", "parameters": [ { "role": "flag", @@ -56044,12 +55965,12 @@ } }, { + "name": "read-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "read-exception-list", "parameters": [ { "role": "flag", @@ -56095,12 +56016,12 @@ } }, { + "name": "create-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "create-exception-list", "parameters": [ { "role": "flag", @@ -56186,12 +56107,12 @@ } }, { + "name": "update-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "update-exception-list", "parameters": [ { "role": "flag", @@ -56294,12 +56215,12 @@ } }, { + "name": "duplicate-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "duplicate-exception-list", "parameters": [ { "role": "flag", @@ -56341,12 +56262,12 @@ } }, { + "name": "export-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "export-exception-list", "parameters": [ { "role": "flag", @@ -56394,12 +56315,12 @@ } }, { + "name": "find-exception-lists", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "find-exception-lists", "parameters": [ { "role": "flag", @@ -56467,12 +56388,12 @@ } }, { + "name": "import-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "import-exception-list", "parameters": [ { "role": "flag", @@ -56509,12 +56430,12 @@ } }, { + "name": "delete-exception-list-item", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "delete-exception-list-item", "parameters": [ { "role": "flag", @@ -56560,12 +56481,12 @@ } }, { + "name": "read-exception-list-item", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "read-exception-list-item", "parameters": [ { "role": "flag", @@ -56611,12 +56532,12 @@ } }, { + "name": "create-exception-list-item", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "create-exception-list-item", "parameters": [ { "role": "flag", @@ -56639,12 +56560,12 @@ } }, { + "name": "update-exception-list-item", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "update-exception-list-item", "parameters": [ { "role": "flag", @@ -56670,12 +56591,12 @@ } }, { + "name": "find-exception-list-items", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "find-exception-list-items", "parameters": [ { "role": "flag", @@ -56756,12 +56677,12 @@ } }, { + "name": "read-exception-list-summary", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "read-exception-list-summary", "parameters": [ { "role": "flag", @@ -56814,12 +56735,12 @@ } }, { + "name": "create-shared-exception-list", "path": [ "stack", "kb", "security-exceptions-api" ], - "name": "create-shared-exception-list", "parameters": [ { "role": "flag", @@ -56856,19 +56777,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-exceptions-api API commands" }, { "segment": "security-lists-api", "commands": [ { + "name": "delete-list", "path": [ "stack", "kb", "security-lists-api" ], - "name": "delete-list", "parameters": [ { "role": "flag", @@ -56914,12 +56834,12 @@ } }, { + "name": "read-list", "path": [ "stack", "kb", "security-lists-api" ], - "name": "read-list", "parameters": [ { "role": "flag", @@ -56951,12 +56871,12 @@ } }, { + "name": "patch-list", "path": [ "stack", "kb", "security-lists-api" ], - "name": "patch-list", "parameters": [ { "role": "flag", @@ -57021,12 +56941,12 @@ } }, { + "name": "create-list", "path": [ "stack", "kb", "security-lists-api" ], - "name": "create-list", "parameters": [ { "role": "flag", @@ -57090,12 +57010,12 @@ } }, { + "name": "update-list", "path": [ "stack", "kb", "security-lists-api" ], - "name": "update-list", "parameters": [ { "role": "flag", @@ -57163,12 +57083,12 @@ } }, { + "name": "find-lists", "path": [ "stack", "kb", "security-lists-api" ], - "name": "find-lists", "parameters": [ { "role": "flag", @@ -57236,12 +57156,12 @@ } }, { + "name": "delete-list-index", "path": [ "stack", "kb", "security-lists-api" ], - "name": "delete-list-index", "parameters": [ { "role": "flag", @@ -57267,12 +57187,12 @@ } }, { + "name": "read-list-index", "path": [ "stack", "kb", "security-lists-api" ], - "name": "read-list-index", "parameters": [ { "role": "flag", @@ -57298,12 +57218,12 @@ } }, { + "name": "create-list-index", "path": [ "stack", "kb", "security-lists-api" ], - "name": "create-list-index", "parameters": [ { "role": "flag", @@ -57326,12 +57246,12 @@ } }, { + "name": "delete-list-item", "path": [ "stack", "kb", "security-lists-api" ], - "name": "delete-list-item", "parameters": [ { "role": "flag", @@ -57385,12 +57305,12 @@ } }, { + "name": "read-list-item", "path": [ "stack", "kb", "security-lists-api" ], - "name": "read-list-item", "parameters": [ { "role": "flag", @@ -57437,12 +57357,12 @@ } }, { + "name": "patch-list-item", "path": [ "stack", "kb", "security-lists-api" ], - "name": "patch-list-item", "parameters": [ { "role": "flag", @@ -57500,12 +57420,12 @@ } }, { + "name": "create-list-item", "path": [ "stack", "kb", "security-lists-api" ], - "name": "create-list-item", "parameters": [ { "role": "flag", @@ -57563,12 +57483,12 @@ } }, { + "name": "update-list-item", "path": [ "stack", "kb", "security-lists-api" ], - "name": "update-list-item", "parameters": [ { "role": "flag", @@ -57622,12 +57542,12 @@ } }, { + "name": "export-list-items", "path": [ "stack", "kb", "security-lists-api" ], - "name": "export-list-items", "parameters": [ { "role": "flag", @@ -57657,12 +57577,12 @@ } }, { + "name": "find-list-items", "path": [ "stack", "kb", "security-lists-api" ], - "name": "find-list-items", "parameters": [ { "role": "flag", @@ -57735,12 +57655,12 @@ } }, { + "name": "import-list-items", "path": [ "stack", "kb", "security-lists-api" ], - "name": "import-list-items", "parameters": [ { "role": "flag", @@ -57784,12 +57704,12 @@ } }, { + "name": "read-list-privileges", "path": [ "stack", "kb", "security-lists-api" ], - "name": "read-list-privileges", "parameters": [ { "role": "flag", @@ -57815,19 +57735,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-lists-api API commands" }, { "segment": "security-osquery-api", "commands": [ { + "name": "osquery-find-live-queries", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-find-live-queries", "parameters": [ { "role": "flag", @@ -57883,12 +57802,12 @@ } }, { + "name": "osquery-create-live-query", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-create-live-query", "parameters": [ { "role": "flag", @@ -58002,12 +57921,12 @@ } }, { + "name": "osquery-get-live-query-details", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-get-live-query-details", "parameters": [ { "role": "flag", @@ -58040,12 +57959,12 @@ } }, { + "name": "osquery-get-live-query-results", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-get-live-query-results", "parameters": [ { "role": "flag", @@ -58115,12 +58034,12 @@ } }, { + "name": "osquery-find-packs", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-find-packs", "parameters": [ { "role": "flag", @@ -58170,12 +58089,12 @@ } }, { + "name": "osquery-create-packs", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-create-packs", "parameters": [ { "role": "flag", @@ -58240,12 +58159,12 @@ } }, { + "name": "osquery-delete-packs", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-delete-packs", "parameters": [ { "role": "flag", @@ -58278,12 +58197,12 @@ } }, { + "name": "osquery-get-packs-details", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-get-packs-details", "parameters": [ { "role": "flag", @@ -58316,12 +58235,12 @@ } }, { + "name": "osquery-update-packs", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-update-packs", "parameters": [ { "role": "flag", @@ -58396,12 +58315,12 @@ } }, { + "name": "osquery-find-saved-queries", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-find-saved-queries", "parameters": [ { "role": "flag", @@ -58451,12 +58370,12 @@ } }, { + "name": "osquery-create-saved-query", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-create-saved-query", "parameters": [ { "role": "flag", @@ -58542,12 +58461,12 @@ } }, { + "name": "osquery-delete-saved-query", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-delete-saved-query", "parameters": [ { "role": "flag", @@ -58580,12 +58499,12 @@ } }, { + "name": "osquery-get-saved-query-details", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-get-saved-query-details", "parameters": [ { "role": "flag", @@ -58618,12 +58537,12 @@ } }, { + "name": "osquery-update-saved-query", "path": [ "stack", "kb", "security-osquery-api" ], - "name": "osquery-update-saved-query", "parameters": [ { "role": "flag", @@ -58719,19 +58638,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-osquery-api API commands" }, { "segment": "security-timeline-api", "commands": [ { + "name": "delete-note", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "delete-note", "parameters": [ { "role": "flag", @@ -58757,12 +58675,12 @@ } }, { + "name": "get-notes", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "get-notes", "parameters": [ { "role": "flag", @@ -58848,12 +58766,12 @@ } }, { + "name": "persist-note-route", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "persist-note-route", "parameters": [ { "role": "flag", @@ -58896,12 +58814,12 @@ } }, { + "name": "persist-pinned-event-route", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "persist-pinned-event-route", "parameters": [ { "role": "flag", @@ -58945,12 +58863,12 @@ } }, { + "name": "delete-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "delete-timelines", "parameters": [ { "role": "flag", @@ -58990,12 +58908,12 @@ } }, { + "name": "get-timeline", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "get-timeline", "parameters": [ { "role": "flag", @@ -59035,12 +58953,12 @@ } }, { + "name": "patch-timeline", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "patch-timeline", "parameters": [ { "role": "flag", @@ -59083,12 +59001,12 @@ } }, { + "name": "create-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "create-timelines", "parameters": [ { "role": "flag", @@ -59158,12 +59076,12 @@ } }, { + "name": "copy-timeline", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "copy-timeline", "parameters": [ { "role": "flag", @@ -59201,12 +59119,12 @@ } }, { + "name": "get-draft-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "get-draft-timelines", "parameters": [ { "role": "flag", @@ -59238,12 +59156,12 @@ } }, { + "name": "clean-draft-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "clean-draft-timelines", "parameters": [ { "role": "flag", @@ -59273,12 +59191,12 @@ } }, { + "name": "export-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "export-timelines", "parameters": [ { "role": "flag", @@ -59314,12 +59232,12 @@ } }, { + "name": "persist-favorite-route", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "persist-favorite-route", "parameters": [ { "role": "flag", @@ -59367,12 +59285,12 @@ } }, { + "name": "import-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "import-timelines", "parameters": [ { "role": "flag", @@ -59408,12 +59326,12 @@ } }, { + "name": "install-prepacked-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "install-prepacked-timelines", "parameters": [ { "role": "flag", @@ -59454,12 +59372,12 @@ } }, { + "name": "resolve-timeline", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "resolve-timeline", "parameters": [ { "role": "flag", @@ -59499,12 +59417,12 @@ } }, { + "name": "get-timelines", "path": [ "stack", "kb", "security-timeline-api" ], - "name": "get-timelines", "parameters": [ { "role": "flag", @@ -59583,19 +59501,18 @@ } } ], - "namespaces": [], "summary": "Kibana security-timeline-api API commands" }, { "segment": "slo", "commands": [ { + "name": "find-slos-op", "path": [ "stack", "kb", "slo" ], - "name": "find-slos-op", "parameters": [ { "role": "flag", @@ -59684,12 +59601,12 @@ } }, { + "name": "create-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "create-slo-op", "parameters": [ { "role": "flag", @@ -59795,12 +59712,12 @@ } }, { + "name": "bulk-delete-op", "path": [ "stack", "kb", "slo" ], - "name": "bulk-delete-op", "parameters": [ { "role": "flag", @@ -59837,12 +59754,12 @@ } }, { + "name": "bulk-delete-status-op", "path": [ "stack", "kb", "slo" ], - "name": "bulk-delete-status-op", "parameters": [ { "role": "flag", @@ -59882,12 +59799,12 @@ } }, { + "name": "delete-rollup-data-op", "path": [ "stack", "kb", "slo" ], - "name": "delete-rollup-data-op", "parameters": [ { "role": "flag", @@ -59931,12 +59848,12 @@ } }, { + "name": "delete-slo-instances-op", "path": [ "stack", "kb", "slo" ], - "name": "delete-slo-instances-op", "parameters": [ { "role": "flag", @@ -59973,12 +59890,12 @@ } }, { + "name": "delete-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "delete-slo-op", "parameters": [ { "role": "flag", @@ -60018,12 +59935,12 @@ } }, { + "name": "get-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "get-slo-op", "parameters": [ { "role": "flag", @@ -60070,12 +59987,12 @@ } }, { + "name": "update-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "update-slo-op", "parameters": [ { "role": "flag", @@ -60184,12 +60101,12 @@ } }, { + "name": "reset-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "reset-slo-op", "parameters": [ { "role": "flag", @@ -60226,12 +60143,12 @@ } }, { + "name": "disable-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "disable-slo-op", "parameters": [ { "role": "flag", @@ -60268,12 +60185,12 @@ } }, { + "name": "enable-slo-op", "path": [ "stack", "kb", "slo" ], - "name": "enable-slo-op", "parameters": [ { "role": "flag", @@ -60310,12 +60227,12 @@ } }, { + "name": "get-definitions-op", "path": [ "stack", "kb", "slo" ], - "name": "get-definitions-op", "parameters": [ { "role": "flag", @@ -60390,19 +60307,18 @@ } } ], - "namespaces": [], "summary": "Kibana slo API commands" }, { "segment": "spaces", "commands": [ { + "name": "get-spaces-space", "path": [ "stack", "kb", "spaces" ], - "name": "get-spaces-space", "parameters": [ { "role": "flag", @@ -60442,12 +60358,12 @@ } }, { + "name": "post-spaces-space", "path": [ "stack", "kb", "spaces" ], - "name": "post-spaces-space", "parameters": [ { "role": "flag", @@ -60531,12 +60447,12 @@ } }, { + "name": "delete-spaces-space-id", "path": [ "stack", "kb", "spaces" ], - "name": "delete-spaces-space-id", "parameters": [ { "role": "flag", @@ -60569,12 +60485,12 @@ } }, { + "name": "get-spaces-space-id", "path": [ "stack", "kb", "spaces" ], - "name": "get-spaces-space-id", "parameters": [ { "role": "flag", @@ -60607,12 +60523,12 @@ } }, { + "name": "put-spaces-space-id", "path": [ "stack", "kb", "spaces" ], - "name": "put-spaces-space-id", "parameters": [ { "role": "flag", @@ -60706,19 +60622,18 @@ } } ], - "namespaces": [], "summary": "Kibana spaces API commands" }, { "segment": "streams", "commands": [ { + "name": "get-streams", "path": [ "stack", "kb", "streams" ], - "name": "get-streams", "parameters": [ { "role": "flag", @@ -60744,12 +60659,12 @@ } }, { + "name": "post-streams-disable", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-disable", "parameters": [ { "role": "flag", @@ -60772,12 +60687,12 @@ } }, { + "name": "post-streams-enable", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-enable", "parameters": [ { "role": "flag", @@ -60800,12 +60715,12 @@ } }, { + "name": "post-streams-resync", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-resync", "parameters": [ { "role": "flag", @@ -60828,12 +60743,12 @@ } }, { + "name": "delete-streams-name", "path": [ "stack", "kb", "streams" ], - "name": "delete-streams-name", "parameters": [ { "role": "flag", @@ -60866,12 +60781,12 @@ } }, { + "name": "get-streams-name", "path": [ "stack", "kb", "streams" ], - "name": "get-streams-name", "parameters": [ { "role": "flag", @@ -60904,12 +60819,12 @@ } }, { + "name": "put-streams-name", "path": [ "stack", "kb", "streams" ], - "name": "put-streams-name", "parameters": [ { "role": "flag", @@ -60942,12 +60857,12 @@ } }, { + "name": "post-streams-name-fork", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-name-fork", "parameters": [ { "role": "flag", @@ -60996,12 +60911,12 @@ } }, { + "name": "get-streams-name-ingest", "path": [ "stack", "kb", "streams" ], - "name": "get-streams-name-ingest", "parameters": [ { "role": "flag", @@ -61034,12 +60949,12 @@ } }, { + "name": "put-streams-name-ingest", "path": [ "stack", "kb", "streams" ], - "name": "put-streams-name-ingest", "parameters": [ { "role": "flag", @@ -61078,12 +60993,12 @@ } }, { + "name": "get-streams-name-query", "path": [ "stack", "kb", "streams" ], - "name": "get-streams-name-query", "parameters": [ { "role": "flag", @@ -61116,12 +61031,12 @@ } }, { + "name": "put-streams-name-query", "path": [ "stack", "kb", "streams" ], - "name": "put-streams-name-query", "parameters": [ { "role": "flag", @@ -61166,12 +61081,12 @@ } }, { + "name": "post-streams-name-content-export", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-name-content-export", "parameters": [ { "role": "flag", @@ -61225,12 +61140,12 @@ } }, { + "name": "post-streams-name-content-import", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-name-content-import", "parameters": [ { "role": "flag", @@ -61260,12 +61175,12 @@ } }, { + "name": "get-streams-name-queries", "path": [ "stack", "kb", "streams" ], - "name": "get-streams-name-queries", "parameters": [ { "role": "flag", @@ -61298,12 +61213,12 @@ } }, { + "name": "post-streams-name-queries-bulk", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-name-queries-bulk", "parameters": [ { "role": "flag", @@ -61339,12 +61254,12 @@ } }, { + "name": "delete-streams-name-queries-queryid", "path": [ "stack", "kb", "streams" ], - "name": "delete-streams-name-queries-queryid", "parameters": [ { "role": "flag", @@ -61384,12 +61299,12 @@ } }, { + "name": "put-streams-name-queries-queryid", "path": [ "stack", "kb", "streams" ], - "name": "put-streams-name-queries-queryid", "parameters": [ { "role": "flag", @@ -61460,12 +61375,12 @@ } }, { + "name": "get-streams-name-significant-events", "path": [ "stack", "kb", "streams" ], - "name": "get-streams-name-significant-events", "parameters": [ { "role": "flag", @@ -61530,12 +61445,12 @@ } }, { + "name": "post-streams-name-significant-events-generate", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-name-significant-events-generate", "parameters": [ { "role": "flag", @@ -61591,12 +61506,12 @@ } }, { + "name": "post-streams-name-significant-events-preview", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-name-significant-events-preview", "parameters": [ { "role": "flag", @@ -61650,12 +61565,12 @@ } }, { + "name": "get-streams-streamname-attachments", "path": [ "stack", "kb", "streams" ], - "name": "get-streams-streamname-attachments", "parameters": [ { "role": "flag", @@ -61709,12 +61624,12 @@ } }, { + "name": "post-streams-streamname-attachments-bulk", "path": [ "stack", "kb", "streams" ], - "name": "post-streams-streamname-attachments-bulk", "parameters": [ { "role": "flag", @@ -61750,12 +61665,12 @@ } }, { + "name": "delete-streams-streamname-attachments-attachmenttype-attachmentid", "path": [ "stack", "kb", "streams" ], - "name": "delete-streams-streamname-attachments-attachmenttype-attachmentid", "parameters": [ { "role": "flag", @@ -61802,12 +61717,12 @@ } }, { + "name": "put-streams-streamname-attachments-attachmenttype-attachmentid", "path": [ "stack", "kb", "streams" ], - "name": "put-streams-streamname-attachments-attachmenttype-attachmentid", "parameters": [ { "role": "flag", @@ -61854,19 +61769,18 @@ } } ], - "namespaces": [], "summary": "Kibana streams API commands" }, { "segment": "system", "commands": [ { + "name": "get-status", "path": [ "stack", "kb", "system" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -61906,19 +61820,18 @@ } } ], - "namespaces": [], "summary": "Kibana system API commands" }, { "segment": "task-manager", "commands": [ { + "name": "task-manager-health", "path": [ "stack", "kb", "task-manager" ], - "name": "task-manager-health", "parameters": [ { "role": "flag", @@ -61944,19 +61857,18 @@ } } ], - "namespaces": [], "summary": "Kibana task-manager API commands" }, { "segment": "workflows", "commands": [ { + "name": "delete-workflows", "path": [ "stack", "kb", "workflows" ], - "name": "delete-workflows", "parameters": [ { "role": "flag", @@ -61996,12 +61908,12 @@ } }, { + "name": "get-workflows", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows", "parameters": [ { "role": "flag", @@ -62069,12 +61981,12 @@ } }, { + "name": "post-workflows", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows", "parameters": [ { "role": "flag", @@ -62110,12 +62022,12 @@ } }, { + "name": "get-workflows-aggs", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-aggs", "parameters": [ { "role": "flag", @@ -62148,12 +62060,12 @@ } }, { + "name": "get-workflows-connectors", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-connectors", "parameters": [ { "role": "flag", @@ -62179,12 +62091,12 @@ } }, { + "name": "get-workflows-executions-executionid", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-executions-executionid", "parameters": [ { "role": "flag", @@ -62231,12 +62143,12 @@ } }, { + "name": "post-workflows-executions-executionid-cancel", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-executions-executionid-cancel", "parameters": [ { "role": "flag", @@ -62266,12 +62178,12 @@ } }, { + "name": "get-workflows-executions-executionid-children", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-executions-executionid-children", "parameters": [ { "role": "flag", @@ -62304,12 +62216,12 @@ } }, { + "name": "get-workflows-executions-executionid-logs", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-executions-executionid-logs", "parameters": [ { "role": "flag", @@ -62377,12 +62289,12 @@ } }, { + "name": "post-workflows-executions-executionid-resume", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-executions-executionid-resume", "parameters": [ { "role": "flag", @@ -62419,12 +62331,12 @@ } }, { + "name": "get-workflows-executions-executionid-step-stepexecutionid", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-executions-executionid-step-stepexecutionid", "parameters": [ { "role": "flag", @@ -62464,12 +62376,12 @@ } }, { + "name": "post-workflows-export", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-export", "parameters": [ { "role": "flag", @@ -62499,12 +62411,12 @@ } }, { + "name": "post-workflows-mget", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-mget", "parameters": [ { "role": "flag", @@ -62541,12 +62453,12 @@ } }, { + "name": "get-workflows-schema", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-schema", "parameters": [ { "role": "flag", @@ -62579,12 +62491,12 @@ } }, { + "name": "get-workflows-stats", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-stats", "parameters": [ { "role": "flag", @@ -62610,12 +62522,12 @@ } }, { + "name": "post-workflows-step-test", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-step-test", "parameters": [ { "role": "flag", @@ -62673,12 +62585,12 @@ } }, { + "name": "post-workflows-test", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-test", "parameters": [ { "role": "flag", @@ -62722,12 +62634,12 @@ } }, { + "name": "post-workflows-workflow", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-workflow", "parameters": [ { "role": "flag", @@ -62762,12 +62674,12 @@ } }, { + "name": "delete-workflows-workflow-id", "path": [ "stack", "kb", "workflows" ], - "name": "delete-workflows-workflow-id", "parameters": [ { "role": "flag", @@ -62807,12 +62719,12 @@ } }, { + "name": "get-workflows-workflow-id", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-workflow-id", "parameters": [ { "role": "flag", @@ -62845,12 +62757,12 @@ } }, { + "name": "put-workflows-workflow-id", "path": [ "stack", "kb", "workflows" ], - "name": "put-workflows-workflow-id", "parameters": [ { "role": "flag", @@ -62913,12 +62825,12 @@ } }, { + "name": "post-workflows-workflow-id-clone", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-workflow-id-clone", "parameters": [ { "role": "flag", @@ -62948,12 +62860,12 @@ } }, { + "name": "post-workflows-workflow-id-run", "path": [ "stack", "kb", "workflows" ], - "name": "post-workflows-workflow-id-run", "parameters": [ { "role": "flag", @@ -62997,12 +62909,12 @@ } }, { + "name": "get-workflows-workflow-workflowid-executions", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-workflow-workflowid-executions", "parameters": [ { "role": "flag", @@ -63077,12 +62989,12 @@ } }, { + "name": "get-workflows-workflow-workflowid-executions-steps", "path": [ "stack", "kb", "workflows" ], - "name": "get-workflows-workflow-workflowid-executions-steps", "parameters": [ { "role": "flag", @@ -63150,7 +63062,6 @@ } } ], - "namespaces": [], "summary": "Kibana workflows API commands" } ], @@ -63161,17 +63072,16 @@ }, { "segment": "cloud", - "commands": [], "namespaces": [ { "segment": "trust", "commands": [ { + "name": "get-current-account", "path": [ "cloud", "trust" ], - "name": "get-current-account", "parameters": [], "summary": "Fetch current account information", "intent": { @@ -63179,11 +63089,11 @@ } }, { + "name": "update-current-account", "path": [ "cloud", "trust" ], - "name": "update-current-account", "parameters": [], "summary": "Updates the current account", "intent": { @@ -63191,11 +63101,11 @@ } }, { + "name": "patch-current-account", "path": [ "cloud", "trust" ], - "name": "patch-current-account", "parameters": [], "summary": "Updates the current account", "intent": { @@ -63203,18 +63113,17 @@ } } ], - "namespaces": [], "summary": "Cloud trust commands" }, { "segment": "auth", "commands": [ { + "name": "get-api-keys", "path": [ "cloud", "auth" ], - "name": "get-api-keys", "parameters": [ { "role": "flag", @@ -63230,11 +63139,11 @@ } }, { + "name": "create-api-key", "path": [ "cloud", "auth" ], - "name": "create-api-key", "parameters": [], "summary": "Create API key", "intent": { @@ -63242,11 +63151,11 @@ } }, { + "name": "delete-api-keys", "path": [ "cloud", "auth" ], - "name": "delete-api-keys", "parameters": [], "summary": "Delete API keys", "intent": { @@ -63254,11 +63163,11 @@ } }, { + "name": "get-api-key", "path": [ "cloud", "auth" ], - "name": "get-api-key", "parameters": [ { "role": "flag", @@ -63274,11 +63183,11 @@ } }, { + "name": "delete-api-key", "path": [ "cloud", "auth" ], - "name": "delete-api-key", "parameters": [ { "role": "flag", @@ -63294,18 +63203,17 @@ } } ], - "namespaces": [], "summary": "Cloud auth commands" }, { "segment": "billing", "commands": [ { + "name": "get-costs-overview", "path": [ "cloud", "billing" ], - "name": "get-costs-overview", "parameters": [ { "role": "flag", @@ -63335,11 +63243,11 @@ } }, { + "name": "get-costs-charts", "path": [ "cloud", "billing" ], - "name": "get-costs-charts", "parameters": [ { "role": "flag", @@ -63376,11 +63284,11 @@ } }, { + "name": "get-costs-deployments", "path": [ "cloud", "billing" ], - "name": "get-costs-deployments", "parameters": [ { "role": "flag", @@ -63410,11 +63318,11 @@ } }, { + "name": "get-costs-charts-by-deployment", "path": [ "cloud", "billing" ], - "name": "get-costs-charts-by-deployment", "parameters": [ { "role": "flag", @@ -63458,11 +63366,11 @@ } }, { + "name": "get-costs-items-by-deployment", "path": [ "cloud", "billing" ], - "name": "get-costs-items-by-deployment", "parameters": [ { "role": "flag", @@ -63499,11 +63407,11 @@ } }, { + "name": "get-costs-items", "path": [ "cloud", "billing" ], - "name": "get-costs-items", "parameters": [ { "role": "flag", @@ -63533,18 +63441,17 @@ } } ], - "namespaces": [], "summary": "Cloud billing commands" }, { "segment": "orgs", "commands": [ { + "name": "list-organizations", "path": [ "cloud", "orgs" ], - "name": "list-organizations", "parameters": [], "summary": "List organizations", "intent": { @@ -63552,11 +63459,11 @@ } }, { + "name": "get-organization-invitation", "path": [ "cloud", "orgs" ], - "name": "get-organization-invitation", "parameters": [ { "role": "flag", @@ -63572,11 +63479,11 @@ } }, { + "name": "accept-organization-invitation", "path": [ "cloud", "orgs" ], - "name": "accept-organization-invitation", "parameters": [ { "role": "flag", @@ -63592,11 +63499,11 @@ } }, { + "name": "get-organization", "path": [ "cloud", "orgs" ], - "name": "get-organization", "parameters": [ { "role": "flag", @@ -63612,11 +63519,11 @@ } }, { + "name": "update-organization", "path": [ "cloud", "orgs" ], - "name": "update-organization", "parameters": [ { "role": "flag", @@ -63632,11 +63539,11 @@ } }, { + "name": "domain-claim-get-domain-claims", "path": [ "cloud", "orgs" ], - "name": "domain-claim-get-domain-claims", "parameters": [ { "role": "flag", @@ -63652,11 +63559,11 @@ } }, { + "name": "domain-claim-delete", "path": [ "cloud", "orgs" ], - "name": "domain-claim-delete", "parameters": [ { "role": "flag", @@ -63672,11 +63579,11 @@ } }, { + "name": "domain-claim-generate-verification-code", "path": [ "cloud", "orgs" ], - "name": "domain-claim-generate-verification-code", "parameters": [ { "role": "flag", @@ -63692,11 +63599,11 @@ } }, { + "name": "domain-claim-verify-domain", "path": [ "cloud", "orgs" ], - "name": "domain-claim-verify-domain", "parameters": [ { "role": "flag", @@ -63712,11 +63619,11 @@ } }, { + "name": "get-organization-idp", "path": [ "cloud", "orgs" ], - "name": "get-organization-idp", "parameters": [ { "role": "flag", @@ -63732,11 +63639,11 @@ } }, { + "name": "setup-organization-idp", "path": [ "cloud", "orgs" ], - "name": "setup-organization-idp", "parameters": [ { "role": "flag", @@ -63752,11 +63659,11 @@ } }, { + "name": "teardown-organization-idp", "path": [ "cloud", "orgs" ], - "name": "teardown-organization-idp", "parameters": [ { "role": "flag", @@ -63772,11 +63679,11 @@ } }, { + "name": "get-organization-idp-metadata", "path": [ "cloud", "orgs" ], - "name": "get-organization-idp-metadata", "parameters": [ { "role": "flag", @@ -63792,11 +63699,11 @@ } }, { + "name": "list-organization-invitations", "path": [ "cloud", "orgs" ], - "name": "list-organization-invitations", "parameters": [ { "role": "flag", @@ -63812,11 +63719,11 @@ } }, { + "name": "create-organization-invitations", "path": [ "cloud", "orgs" ], - "name": "create-organization-invitations", "parameters": [ { "role": "flag", @@ -63832,11 +63739,11 @@ } }, { + "name": "delete-organization-invitations", "path": [ "cloud", "orgs" ], - "name": "delete-organization-invitations", "parameters": [ { "role": "flag", @@ -63859,11 +63766,11 @@ } }, { + "name": "list-organization-members", "path": [ "cloud", "orgs" ], - "name": "list-organization-members", "parameters": [ { "role": "flag", @@ -63879,11 +63786,11 @@ } }, { + "name": "delete-organization-memberships", "path": [ "cloud", "orgs" ], - "name": "delete-organization-memberships", "parameters": [ { "role": "flag", @@ -63913,11 +63820,11 @@ } }, { + "name": "get-role-mappings", "path": [ "cloud", "orgs" ], - "name": "get-role-mappings", "parameters": [ { "role": "flag", @@ -63933,11 +63840,11 @@ } }, { + "name": "update-role-mappings", "path": [ "cloud", "orgs" ], - "name": "update-role-mappings", "parameters": [ { "role": "flag", @@ -63953,11 +63860,11 @@ } }, { + "name": "delete-role-mappings", "path": [ "cloud", "orgs" ], - "name": "delete-role-mappings", "parameters": [ { "role": "flag", @@ -63973,18 +63880,17 @@ } } ], - "namespaces": [], "summary": "Cloud orgs commands" }, { "segment": "users", "commands": [ { + "name": "add-role-assignments", "path": [ "cloud", "users" ], - "name": "add-role-assignments", "parameters": [ { "role": "flag", @@ -64000,11 +63906,11 @@ } }, { + "name": "remove-role-assignments", "path": [ "cloud", "users" ], - "name": "remove-role-assignments", "parameters": [ { "role": "flag", @@ -64020,23 +63926,21 @@ } } ], - "namespaces": [], "summary": "Cloud users commands" }, { "segment": "hosted", - "commands": [], "namespaces": [ { "segment": "deployment-templates", "commands": [ { + "name": "get-deployment-templates-v2", "path": [ "cloud", "hosted", "deployment-templates" ], - "name": "get-deployment-templates-v2", "parameters": [ { "role": "flag", @@ -64087,12 +63991,12 @@ } }, { + "name": "get-deployment-template-v2", "path": [ "cloud", "hosted", "deployment-templates" ], - "name": "get-deployment-template-v2", "parameters": [ { "role": "flag", @@ -64136,19 +64040,18 @@ } } ], - "namespaces": [], "summary": "Cloud hosted deployment-templates commands" }, { "segment": "deployments", "commands": [ { + "name": "list-deployments", "path": [ "cloud", "hosted", "deployments" ], - "name": "list-deployments", "parameters": [], "summary": "List Deployments", "intent": { @@ -64156,12 +64059,12 @@ } }, { + "name": "create-deployment", "path": [ "cloud", "hosted", "deployments" ], - "name": "create-deployment", "parameters": [ { "role": "flag", @@ -64191,12 +64094,12 @@ } }, { + "name": "search-deployments", "path": [ "cloud", "hosted", "deployments" ], - "name": "search-deployments", "parameters": [ { "role": "flag", @@ -64212,12 +64115,12 @@ } }, { + "name": "search-eligible-remote-clusters", "path": [ "cloud", "hosted", "deployments" ], - "name": "search-eligible-remote-clusters", "parameters": [ { "role": "flag", @@ -64233,12 +64136,12 @@ } }, { + "name": "get-deployment", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment", "parameters": [ { "role": "flag", @@ -64352,12 +64255,12 @@ } }, { + "name": "update-deployment", "path": [ "cloud", "hosted", "deployments" ], - "name": "update-deployment", "parameters": [ { "role": "flag", @@ -64401,12 +64304,12 @@ } }, { + "name": "restore-deployment", "path": [ "cloud", "hosted", "deployments" ], - "name": "restore-deployment", "parameters": [ { "role": "flag", @@ -64429,12 +64332,12 @@ } }, { + "name": "shutdown-deployment", "path": [ "cloud", "hosted", "deployments" ], - "name": "shutdown-deployment", "parameters": [ { "role": "flag", @@ -64464,12 +64367,12 @@ } }, { + "name": "get-deployment-apm-resource-info", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-apm-resource-info", "parameters": [ { "role": "flag", @@ -64541,12 +64444,12 @@ } }, { + "name": "deployment-apm-reset-secret-token", "path": [ "cloud", "hosted", "deployments" ], - "name": "deployment-apm-reset-secret-token", "parameters": [ { "role": "flag", @@ -64569,12 +64472,12 @@ } }, { + "name": "get-deployment-appsearch-resource-info", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-appsearch-resource-info", "parameters": [ { "role": "flag", @@ -64646,12 +64549,12 @@ } }, { + "name": "get-appsearch-read-only-mode", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-appsearch-read-only-mode", "parameters": [ { "role": "flag", @@ -64674,12 +64577,12 @@ } }, { + "name": "set-appsearch-read-only-mode", "path": [ "cloud", "hosted", "deployments" ], - "name": "set-appsearch-read-only-mode", "parameters": [ { "role": "flag", @@ -64702,12 +64605,12 @@ } }, { + "name": "get-deployment-certificate-authority", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-certificate-authority", "parameters": [ { "role": "flag", @@ -64723,12 +64626,12 @@ } }, { + "name": "get-deployment-es-resource-info", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-es-resource-info", "parameters": [ { "role": "flag", @@ -64828,12 +64731,12 @@ } }, { + "name": "enable-deployment-resource-ccr", "path": [ "cloud", "hosted", "deployments" ], - "name": "enable-deployment-resource-ccr", "parameters": [ { "role": "flag", @@ -64863,12 +64766,12 @@ } }, { + "name": "enable-deployment-resource-ilm", "path": [ "cloud", "hosted", "deployments" ], - "name": "enable-deployment-resource-ilm", "parameters": [ { "role": "flag", @@ -64898,12 +64801,12 @@ } }, { + "name": "enable-deployment-resource-slm", "path": [ "cloud", "hosted", "deployments" ], - "name": "enable-deployment-resource-slm", "parameters": [ { "role": "flag", @@ -64933,12 +64836,12 @@ } }, { + "name": "reset-elasticsearch-user-password", "path": [ "cloud", "hosted", "deployments" ], - "name": "reset-elasticsearch-user-password", "parameters": [ { "role": "flag", @@ -64968,12 +64871,12 @@ } }, { + "name": "restart-deployment-es-resource", "path": [ "cloud", "hosted", "deployments" ], - "name": "restart-deployment-es-resource", "parameters": [ { "role": "flag", @@ -65031,12 +64934,12 @@ } }, { + "name": "shutdown-deployment-es-resource", "path": [ "cloud", "hosted", "deployments" ], - "name": "shutdown-deployment-es-resource", "parameters": [ { "role": "flag", @@ -65073,12 +64976,12 @@ } }, { + "name": "get-deployment-es-resource-eligible-remote-clusters", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-es-resource-eligible-remote-clusters", "parameters": [ { "role": "flag", @@ -65101,12 +65004,12 @@ } }, { + "name": "get-deployment-es-resource-keystore", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-es-resource-keystore", "parameters": [ { "role": "flag", @@ -65129,12 +65032,12 @@ } }, { + "name": "set-deployment-es-resource-keystore", "path": [ "cloud", "hosted", "deployments" ], - "name": "set-deployment-es-resource-keystore", "parameters": [ { "role": "flag", @@ -65164,12 +65067,12 @@ } }, { + "name": "get-deployment-es-resource-remote-clusters", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-es-resource-remote-clusters", "parameters": [ { "role": "flag", @@ -65192,12 +65095,12 @@ } }, { + "name": "set-deployment-es-resource-remote-clusters", "path": [ "cloud", "hosted", "deployments" ], - "name": "set-deployment-es-resource-remote-clusters", "parameters": [ { "role": "flag", @@ -65220,12 +65123,12 @@ } }, { + "name": "get-deployment-es-resource-snapshot-repository", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-es-resource-snapshot-repository", "parameters": [ { "role": "flag", @@ -65248,12 +65151,12 @@ } }, { + "name": "create-deployment-es-resource-snapshot-repository", "path": [ "cloud", "hosted", "deployments" ], - "name": "create-deployment-es-resource-snapshot-repository", "parameters": [ { "role": "flag", @@ -65276,12 +65179,12 @@ } }, { + "name": "delete-deployment-es-resource-snapshot-repository", "path": [ "cloud", "hosted", "deployments" ], - "name": "delete-deployment-es-resource-snapshot-repository", "parameters": [ { "role": "flag", @@ -65311,12 +65214,12 @@ } }, { + "name": "get-deployment-es-resource-tiers", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-es-resource-tiers", "parameters": [ { "role": "flag", @@ -65339,12 +65242,12 @@ } }, { + "name": "update-deployment-es-resource-tier", "path": [ "cloud", "hosted", "deployments" ], - "name": "update-deployment-es-resource-tier", "parameters": [ { "role": "flag", @@ -65367,12 +65270,12 @@ } }, { + "name": "get-deployment-enterprise-search-resource-info", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-enterprise-search-resource-info", "parameters": [ { "role": "flag", @@ -65444,12 +65347,12 @@ } }, { + "name": "get-deployment-integrations-server-resource-info", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-integrations-server-resource-info", "parameters": [ { "role": "flag", @@ -65521,12 +65424,12 @@ } }, { + "name": "get-deployment-kib-resource-info", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-kib-resource-info", "parameters": [ { "role": "flag", @@ -65605,12 +65508,12 @@ } }, { + "name": "migrate-deployment-template", "path": [ "cloud", "hosted", "deployments" ], - "name": "migrate-deployment-template", "parameters": [ { "role": "flag", @@ -65640,12 +65543,12 @@ } }, { + "name": "get-deployment-tags", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-tags", "parameters": [ { "role": "flag", @@ -65661,12 +65564,12 @@ } }, { + "name": "set-deployment-tags", "path": [ "cloud", "hosted", "deployments" ], - "name": "set-deployment-tags", "parameters": [ { "role": "flag", @@ -65682,12 +65585,12 @@ } }, { + "name": "upgrade-deployment", "path": [ "cloud", "hosted", "deployments" ], - "name": "upgrade-deployment", "parameters": [ { "role": "flag", @@ -65703,12 +65606,12 @@ } }, { + "name": "get-deployment-upgrade-assistant-status", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-upgrade-assistant-status", "parameters": [ { "role": "flag", @@ -65731,12 +65634,12 @@ } }, { + "name": "restore-deployment-resource", "path": [ "cloud", "hosted", "deployments" ], - "name": "restore-deployment-resource", "parameters": [ { "role": "flag", @@ -65773,12 +65676,12 @@ } }, { + "name": "start-deployment-resource-instances-all", "path": [ "cloud", "hosted", "deployments" ], - "name": "start-deployment-resource-instances-all", "parameters": [ { "role": "flag", @@ -65808,12 +65711,12 @@ } }, { + "name": "stop-deployment-resource-instances-all", "path": [ "cloud", "hosted", "deployments" ], - "name": "stop-deployment-resource-instances-all", "parameters": [ { "role": "flag", @@ -65843,12 +65746,12 @@ } }, { + "name": "start-deployment-resource-instances-all-maintenance-mode", "path": [ "cloud", "hosted", "deployments" ], - "name": "start-deployment-resource-instances-all-maintenance-mode", "parameters": [ { "role": "flag", @@ -65878,12 +65781,12 @@ } }, { + "name": "stop-deployment-resource-instances-all-maintenance-mode", "path": [ "cloud", "hosted", "deployments" ], - "name": "stop-deployment-resource-instances-all-maintenance-mode", "parameters": [ { "role": "flag", @@ -65913,12 +65816,12 @@ } }, { + "name": "start-deployment-resource-instances", "path": [ "cloud", "hosted", "deployments" ], - "name": "start-deployment-resource-instances", "parameters": [ { "role": "flag", @@ -65962,12 +65865,12 @@ } }, { + "name": "stop-deployment-resource-instances", "path": [ "cloud", "hosted", "deployments" ], - "name": "stop-deployment-resource-instances", "parameters": [ { "role": "flag", @@ -66011,12 +65914,12 @@ } }, { + "name": "start-deployment-resource-maintenance-mode", "path": [ "cloud", "hosted", "deployments" ], - "name": "start-deployment-resource-maintenance-mode", "parameters": [ { "role": "flag", @@ -66060,12 +65963,12 @@ } }, { + "name": "stop-deployment-resource-maintenance-mode", "path": [ "cloud", "hosted", "deployments" ], - "name": "stop-deployment-resource-maintenance-mode", "parameters": [ { "role": "flag", @@ -66109,12 +66012,12 @@ } }, { + "name": "cancel-deployment-resource-pending-plan", "path": [ "cloud", "hosted", "deployments" ], - "name": "cancel-deployment-resource-pending-plan", "parameters": [ { "role": "flag", @@ -66158,12 +66061,12 @@ } }, { + "name": "get-deployment-resource-user-settings", "path": [ "cloud", "hosted", "deployments" ], - "name": "get-deployment-resource-user-settings", "parameters": [ { "role": "flag", @@ -66193,12 +66096,12 @@ } }, { + "name": "update-deployment-resource-user-settings", "path": [ "cloud", "hosted", "deployments" ], - "name": "update-deployment-resource-user-settings", "parameters": [ { "role": "flag", @@ -66228,12 +66131,12 @@ } }, { + "name": "restart-deployment-stateless-resource", "path": [ "cloud", "hosted", "deployments" ], - "name": "restart-deployment-stateless-resource", "parameters": [ { "role": "flag", @@ -66270,12 +66173,12 @@ } }, { + "name": "shutdown-deployment-stateless-resource", "path": [ "cloud", "hosted", "deployments" ], - "name": "shutdown-deployment-stateless-resource", "parameters": [ { "role": "flag", @@ -66319,19 +66222,18 @@ } } ], - "namespaces": [], "summary": "Cloud hosted deployments commands" }, { "segment": "traffic-filters", "commands": [ { + "name": "get-traffic-filter-deployment-ruleset-associations", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "get-traffic-filter-deployment-ruleset-associations", "parameters": [ { "role": "flag", @@ -66354,12 +66256,12 @@ } }, { + "name": "get-traffic-filter-claimed-link-ids", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "get-traffic-filter-claimed-link-ids", "parameters": [ { "role": "flag", @@ -66382,12 +66284,12 @@ } }, { + "name": "claim-traffic-filter-link-id", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "claim-traffic-filter-link-id", "parameters": [], "summary": "Claim a link id", "intent": { @@ -66395,12 +66297,12 @@ } }, { + "name": "unclaim-traffic-filter-link-id", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "unclaim-traffic-filter-link-id", "parameters": [], "summary": "Unclaims a link id", "intent": { @@ -66408,12 +66310,12 @@ } }, { + "name": "get-traffic-filter-rulesets", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "get-traffic-filter-rulesets", "parameters": [ { "role": "flag", @@ -66443,12 +66345,12 @@ } }, { + "name": "create-traffic-filter-ruleset", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "create-traffic-filter-ruleset", "parameters": [], "summary": "Create a ruleset", "intent": { @@ -66456,12 +66358,12 @@ } }, { + "name": "get-traffic-filter-ruleset", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "get-traffic-filter-ruleset", "parameters": [ { "role": "flag", @@ -66484,12 +66386,12 @@ } }, { + "name": "update-traffic-filter-ruleset", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "update-traffic-filter-ruleset", "parameters": [ { "role": "flag", @@ -66505,12 +66407,12 @@ } }, { + "name": "delete-traffic-filter-ruleset", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "delete-traffic-filter-ruleset", "parameters": [ { "role": "flag", @@ -66533,12 +66435,12 @@ } }, { + "name": "get-traffic-filter-ruleset-deployment-associations", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "get-traffic-filter-ruleset-deployment-associations", "parameters": [ { "role": "flag", @@ -66554,12 +66456,12 @@ } }, { + "name": "create-traffic-filter-ruleset-association", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "create-traffic-filter-ruleset-association", "parameters": [ { "role": "flag", @@ -66575,12 +66477,12 @@ } }, { + "name": "delete-traffic-filter-ruleset-association", "path": [ "cloud", "hosted", "traffic-filters" ], - "name": "delete-traffic-filter-ruleset-association", "parameters": [ { "role": "flag", @@ -66610,19 +66512,18 @@ } } ], - "namespaces": [], "summary": "Cloud hosted traffic-filters commands" }, { "segment": "extensions", "commands": [ { + "name": "list-extensions", "path": [ "cloud", "hosted", "extensions" ], - "name": "list-extensions", "parameters": [], "summary": "List Extensions", "intent": { @@ -66630,12 +66531,12 @@ } }, { + "name": "create-extension", "path": [ "cloud", "hosted", "extensions" ], - "name": "create-extension", "parameters": [], "summary": "Create an extension", "intent": { @@ -66643,12 +66544,12 @@ } }, { + "name": "get-extension", "path": [ "cloud", "hosted", "extensions" ], - "name": "get-extension", "parameters": [ { "role": "flag", @@ -66671,12 +66572,12 @@ } }, { + "name": "update-extension", "path": [ "cloud", "hosted", "extensions" ], - "name": "update-extension", "parameters": [ { "role": "flag", @@ -66692,12 +66593,12 @@ } }, { + "name": "upload-extension", "path": [ "cloud", "hosted", "extensions" ], - "name": "upload-extension", "parameters": [ { "role": "flag", @@ -66713,12 +66614,12 @@ } }, { + "name": "delete-extension", "path": [ "cloud", "hosted", "extensions" ], - "name": "delete-extension", "parameters": [ { "role": "flag", @@ -66734,19 +66635,18 @@ } } ], - "namespaces": [], "summary": "Cloud hosted extensions commands" }, { "segment": "stack", "commands": [ { + "name": "get-version-stacks", "path": [ "cloud", "hosted", "stack" ], - "name": "get-version-stacks", "parameters": [ { "role": "flag", @@ -66769,19 +66669,18 @@ } } ], - "namespaces": [], "summary": "Cloud hosted stack commands" }, { "segment": "trusted-environments", "commands": [ { + "name": "get-trusted-envs", "path": [ "cloud", "hosted", "trusted-environments" ], - "name": "get-trusted-envs", "parameters": [], "summary": "Get trusted environments", "intent": { @@ -66789,7 +66688,6 @@ } } ], - "namespaces": [], "summary": "Cloud hosted trusted-environments commands" } ], @@ -66797,23 +66695,21 @@ }, { "segment": "serverless", - "commands": [], "namespaces": [ { "segment": "projects", - "commands": [], "namespaces": [ { "segment": "search", "commands": [ { + "name": "list", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "list", "parameters": [ { "role": "flag", @@ -66836,13 +66732,13 @@ } }, { + "name": "create", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "create", "parameters": [ { "role": "flag", @@ -66886,13 +66782,13 @@ } }, { + "name": "get", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "get", "parameters": [ { "role": "flag", @@ -66908,13 +66804,13 @@ } }, { + "name": "delete", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -66930,13 +66826,13 @@ } }, { + "name": "patch", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "patch", "parameters": [ { "role": "flag", @@ -66952,13 +66848,13 @@ } }, { + "name": "reset-credentials", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "reset-credentials", "parameters": [ { "role": "flag", @@ -67002,13 +66898,13 @@ } }, { + "name": "resume", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "resume", "parameters": [ { "role": "flag", @@ -67024,13 +66920,13 @@ } }, { + "name": "get-roles", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "get-roles", "parameters": [ { "role": "flag", @@ -67046,13 +66942,13 @@ } }, { + "name": "get-status", "path": [ "cloud", "serverless", "projects", "search" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -67068,20 +66964,19 @@ } } ], - "namespaces": [], "summary": "Manage elasticsearch projects" }, { "segment": "observability", "commands": [ { + "name": "list", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "list", "parameters": [ { "role": "flag", @@ -67104,13 +66999,13 @@ } }, { + "name": "create", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "create", "parameters": [ { "role": "flag", @@ -67154,13 +67049,13 @@ } }, { + "name": "get", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "get", "parameters": [ { "role": "flag", @@ -67176,13 +67071,13 @@ } }, { + "name": "delete", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -67198,13 +67093,13 @@ } }, { + "name": "patch", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "patch", "parameters": [ { "role": "flag", @@ -67220,13 +67115,13 @@ } }, { + "name": "reset-credentials", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "reset-credentials", "parameters": [ { "role": "flag", @@ -67270,13 +67165,13 @@ } }, { + "name": "resume", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "resume", "parameters": [ { "role": "flag", @@ -67292,13 +67187,13 @@ } }, { + "name": "get-roles", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "get-roles", "parameters": [ { "role": "flag", @@ -67314,13 +67209,13 @@ } }, { + "name": "get-status", "path": [ "cloud", "serverless", "projects", "observability" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -67336,20 +67231,19 @@ } } ], - "namespaces": [], "summary": "Manage observability projects" }, { "segment": "security", "commands": [ { + "name": "list", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "list", "parameters": [ { "role": "flag", @@ -67372,13 +67266,13 @@ } }, { + "name": "create", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "create", "parameters": [ { "role": "flag", @@ -67422,13 +67316,13 @@ } }, { + "name": "get", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "get", "parameters": [ { "role": "flag", @@ -67444,13 +67338,13 @@ } }, { + "name": "delete", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "delete", "parameters": [ { "role": "flag", @@ -67466,13 +67360,13 @@ } }, { + "name": "patch", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "patch", "parameters": [ { "role": "flag", @@ -67488,13 +67382,13 @@ } }, { + "name": "reset-credentials", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "reset-credentials", "parameters": [ { "role": "flag", @@ -67538,13 +67432,13 @@ } }, { + "name": "resume", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "resume", "parameters": [ { "role": "flag", @@ -67560,13 +67454,13 @@ } }, { + "name": "get-roles", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "get-roles", "parameters": [ { "role": "flag", @@ -67582,13 +67476,13 @@ } }, { + "name": "get-status", "path": [ "cloud", "serverless", "projects", "security" ], - "name": "get-status", "parameters": [ { "role": "flag", @@ -67604,7 +67498,6 @@ } } ], - "namespaces": [], "summary": "Manage security projects" } ], @@ -67614,12 +67507,12 @@ "segment": "cross-project", "commands": [ { + "name": "get-elasticsearch-project-link-candidates", "path": [ "cloud", "serverless", "cross-project" ], - "name": "get-elasticsearch-project-link-candidates", "parameters": [ { "role": "flag", @@ -67670,12 +67563,12 @@ } }, { + "name": "get-observability-project-link-candidates", "path": [ "cloud", "serverless", "cross-project" ], - "name": "get-observability-project-link-candidates", "parameters": [ { "role": "flag", @@ -67726,12 +67619,12 @@ } }, { + "name": "get-security-project-link-candidates", "path": [ "cloud", "serverless", "cross-project" ], - "name": "get-security-project-link-candidates", "parameters": [ { "role": "flag", @@ -67782,12 +67675,12 @@ } }, { + "name": "get-elasticsearch-project-can-delete", "path": [ "cloud", "serverless", "cross-project" ], - "name": "get-elasticsearch-project-can-delete", "parameters": [ { "role": "flag", @@ -67803,12 +67696,12 @@ } }, { + "name": "get-observability-project-can-delete", "path": [ "cloud", "serverless", "cross-project" ], - "name": "get-observability-project-can-delete", "parameters": [ { "role": "flag", @@ -67824,12 +67717,12 @@ } }, { + "name": "get-security-project-can-delete", "path": [ "cloud", "serverless", "cross-project" ], - "name": "get-security-project-can-delete", "parameters": [ { "role": "flag", @@ -67845,19 +67738,18 @@ } } ], - "namespaces": [], "summary": "Serverless cross-project commands" }, { "segment": "regions", "commands": [ { + "name": "list-regions", "path": [ "cloud", "serverless", "regions" ], - "name": "list-regions", "parameters": [], "summary": "Get regions", "intent": { @@ -67865,12 +67757,12 @@ } }, { + "name": "get-region", "path": [ "cloud", "serverless", "regions" ], - "name": "get-region", "parameters": [ { "role": "flag", @@ -67886,19 +67778,18 @@ } } ], - "namespaces": [], "summary": "Serverless regions commands" }, { "segment": "traffic-filters", "commands": [ { + "name": "list-traffic-filters", "path": [ "cloud", "serverless", "traffic-filters" ], - "name": "list-traffic-filters", "parameters": [ { "role": "flag", @@ -67921,12 +67812,12 @@ } }, { + "name": "create-traffic-filter", "path": [ "cloud", "serverless", "traffic-filters" ], - "name": "create-traffic-filter", "parameters": [], "summary": "Create a traffic filter", "intent": { @@ -67934,12 +67825,12 @@ } }, { + "name": "get-traffic-filter-metadata", "path": [ "cloud", "serverless", "traffic-filters" ], - "name": "get-traffic-filter-metadata", "parameters": [ { "role": "flag", @@ -67962,12 +67853,12 @@ } }, { + "name": "get-traffic-filter", "path": [ "cloud", "serverless", "traffic-filters" ], - "name": "get-traffic-filter", "parameters": [ { "role": "flag", @@ -67983,12 +67874,12 @@ } }, { + "name": "delete-traffic-filter", "path": [ "cloud", "serverless", "traffic-filters" ], - "name": "delete-traffic-filter", "parameters": [ { "role": "flag", @@ -68004,12 +67895,12 @@ } }, { + "name": "patch-traffic-filter", "path": [ "cloud", "serverless", "traffic-filters" ], - "name": "patch-traffic-filter", "parameters": [ { "role": "flag", @@ -68025,7 +67916,6 @@ } } ], - "namespaces": [], "summary": "Serverless traffic-filters commands" } ], @@ -68054,10 +67944,10 @@ "segment": "docs", "commands": [ { + "name": "search", "path": [ "docs" ], - "name": "search", "parameters": [ { "role": "flag", @@ -68089,10 +67979,10 @@ } }, { + "name": "ask", "path": [ "docs" ], - "name": "ask", "parameters": [ { "role": "flag", @@ -68108,10 +67998,10 @@ } }, { + "name": "chat", "path": [ "docs" ], - "name": "chat", "parameters": [ { "role": "flag", @@ -68127,10 +68017,10 @@ } }, { + "name": "read", "path": [ "docs" ], - "name": "read", "parameters": [ { "role": "flag", @@ -68153,7 +68043,6 @@ } } ], - "namespaces": [], "summary": "Search, read, and ask questions about Elastic documentation", "options": [ { @@ -68174,17 +68063,16 @@ }, { "segment": "config", - "commands": [], "namespaces": [ { "segment": "context", "commands": [ { + "name": "list", "path": [ "config", "context" ], - "name": "list", "parameters": [], "summary": "List all contexts defined in the config file", "intent": { @@ -68192,11 +68080,11 @@ } }, { + "name": "add", "path": [ "config", "context" ], - "name": "add", "parameters": [ { "role": "positional", @@ -68296,11 +68184,11 @@ } }, { + "name": "edit", "path": [ "config", "context" ], - "name": "edit", "parameters": [ { "role": "positional", @@ -68393,11 +68281,11 @@ } }, { + "name": "remove", "path": [ "config", "context" ], - "name": "remove", "parameters": [ { "role": "positional", @@ -68420,18 +68308,17 @@ } } ], - "namespaces": [], "summary": "Manage contexts in the elastic config file" }, { "segment": "current-context", "commands": [ { + "name": "get", "path": [ "config", "current-context" ], - "name": "get", "parameters": [], "summary": "Print the current context name", "intent": { @@ -68439,11 +68326,11 @@ } }, { + "name": "set", "path": [ "config", "current-context" ], - "name": "set", "parameters": [ { "role": "positional", @@ -68459,7 +68346,6 @@ } } ], - "namespaces": [], "summary": "View or change the current context" } ], @@ -68485,10 +68371,10 @@ "segment": "sanitize", "commands": [ { + "name": "index-name", "path": [ "sanitize" ], - "name": "index-name", "parameters": [ { "role": "positional", @@ -68504,10 +68390,10 @@ } }, { + "name": "snapshot-name", "path": [ "sanitize" ], - "name": "snapshot-name", "parameters": [ { "role": "positional", @@ -68523,10 +68409,10 @@ } }, { + "name": "data-stream-type", "path": [ "sanitize" ], - "name": "data-stream-type", "parameters": [ { "role": "positional", @@ -68542,10 +68428,10 @@ } }, { + "name": "data-stream-dataset", "path": [ "sanitize" ], - "name": "data-stream-dataset", "parameters": [ { "role": "positional", @@ -68561,10 +68447,10 @@ } }, { + "name": "data-stream-namespace", "path": [ "sanitize" ], - "name": "data-stream-namespace", "parameters": [ { "role": "positional", @@ -68580,10 +68466,10 @@ } }, { + "name": "field-name", "path": [ "sanitize" ], - "name": "field-name", "parameters": [ { "role": "positional", @@ -68599,10 +68485,10 @@ } }, { + "name": "pipeline-name", "path": [ "sanitize" ], - "name": "pipeline-name", "parameters": [ { "role": "positional", @@ -68618,10 +68504,10 @@ } }, { + "name": "repository-name", "path": [ "sanitize" ], - "name": "repository-name", "parameters": [ { "role": "positional", @@ -68637,7 +68523,6 @@ } } ], - "namespaces": [], "summary": "Sanitize values for safe use in Elasticsearch", "options": [ { @@ -68649,6 +68534,5 @@ } ] } - ], - "description": "Interface with the Elastic Stack and Elastic Cloud from the command line." + ] } diff --git a/package-lock.json b/package-lock.json index e1286c43..f279a175 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,6 +8,9 @@ "name": "@elastic/cli", "version": "0.2.0", "bundleDependencies": [ + "@cli-schema/commander", + "@cli-schema/spec", + "@cli-schema/zod", "@elastic/config-resolver", "@elastic/es-schemas", "zod" @@ -17,6 +20,9 @@ "packages/*" ], "dependencies": { + "@cli-schema/commander": "^0.1.1", + "@cli-schema/spec": "^0.1.1", + "@cli-schema/zod": "^0.1.1", "@elastic/config-resolver": "*", "@elastic/es-schemas": "1.0.2", "cli-table3": "^0.6.5", @@ -67,6 +73,68 @@ "node": ">=6.9.0" } }, + "node_modules/@cli-schema/commander": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/@cli-schema/commander/-/commander-0.1.1.tgz", + "integrity": "sha512-JN7Q7znqBIxSL7FUGyHhVGxJLBpWajW5JtbI73GgLR5LKgA3ems5rFGoA0GDfwWTy/QlF3VRE/4iCJKRo9W/Uw==", + "inBundle": true, + "license": "MIT", + "dependencies": { + "@cli-schema/spec": "^0.1.1", + "@cli-schema/zod": "^0.1.1" + }, + "peerDependencies": { + "commander": "^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0", + "zod": "^4.0.0" + } + }, + "node_modules/@cli-schema/spec": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/@cli-schema/spec/-/spec-0.1.1.tgz", + "integrity": "sha512-1dsRO8WsmCHRaFPP1r8XRebpEhb9P8bX6uWAyYFXv5DPlWjuEkcX3kLoCQOYyvzmd7gHEfv6Kd6k+pUWS3Yc0g==", + "inBundle": true, + "license": "MIT", + "dependencies": { + "ajv": "^8.17.1" + } + }, + "node_modules/@cli-schema/spec/node_modules/ajv": { + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.20.0.tgz", + "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", + "inBundle": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@cli-schema/spec/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "inBundle": true, + "license": "MIT" + }, + "node_modules/@cli-schema/zod": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/@cli-schema/zod/-/zod-0.1.1.tgz", + "integrity": "sha512-Q8NATnnr+fJ+q9yDDYvtgF1T20dfd3GKU8hSioMmiocx/ipQ/v+ksG4fL+dsx/xzlfi8z3iOsNY/h9xvUWYwOA==", + "inBundle": true, + "license": "MIT", + "dependencies": { + "@cli-schema/spec": "^0.1.1" + }, + "peerDependencies": { + "zod": "^4.0.0" + } + }, "node_modules/@colors/colors": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", @@ -2942,6 +3010,7 @@ "version": "15.0.0", "resolved": "https://registry.npmjs.org/commander/-/commander-15.0.0.tgz", "integrity": "sha512-z67u4ZhzCL/Tydu1lJARtEZYWbWaN7oYLHbsuzocr6y4N6WZAagG3RQ4FW61V1/0+jImpj293XfrcYnd1qxtPg==", + "inBundle": true, "license": "MIT", "engines": { "node": ">=22.12.0" @@ -3484,7 +3553,7 @@ "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true, + "inBundle": true, "license": "MIT" }, "node_modules/fast-fifo": { @@ -3555,6 +3624,23 @@ "fast-string-truncated-width": "^3.0.2" } }, + "node_modules/fast-uri": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.3.tgz", + "integrity": "sha512-i70LwGWUduXqzicKXWshooq+sWL1K3WUU5rKZNG/0i3a1OSoX3HqhH5WbWwTmqWfor4urUakGPiRQcleRZTwOg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "inBundle": true, + "license": "BSD-3-Clause" + }, "node_modules/fast-wrap-ansi": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/fast-wrap-ansi/-/fast-wrap-ansi-0.2.2.tgz", @@ -6407,6 +6493,16 @@ "node": ">=0.10.0" } }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "inBundle": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/resolve": { "version": "1.22.11", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", diff --git a/package.json b/package.json index 048001b1..1954d9c8 100644 --- a/package.json +++ b/package.json @@ -59,6 +59,9 @@ "test": "test" }, "dependencies": { + "@cli-schema/commander": "^0.1.1", + "@cli-schema/spec": "^0.1.1", + "@cli-schema/zod": "^0.1.1", "@elastic/config-resolver": "*", "@elastic/es-schemas": "1.0.2", "cli-table3": "^0.6.5", @@ -81,6 +84,9 @@ "typescript-eslint": "8.62.1" }, "bundleDependencies": [ + "@cli-schema/commander", + "@cli-schema/spec", + "@cli-schema/zod", "@elastic/config-resolver", "@elastic/es-schemas", "zod" diff --git a/src/cli-schema-intent.ts b/src/cli-schema-intent.ts deleted file mode 100644 index 49853727..00000000 --- a/src/cli-schema-intent.ts +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and contributors - * SPDX-License-Identifier: Apache-2.0 - */ - -import type { CommandIntent } from './factory.ts' - -/** - * Derives intent from an HTTP method. - * - * GET and HEAD are safe and idempotent. - * PUT is idempotent (upsert semantics). - * DELETE is destructive and idempotent. - * POST and PATCH are left undefined — their semantics depend on the specific - * endpoint and should be annotated explicitly via EsApiMeta.intent / KbApiMeta.intent. - */ -export function inferIntentFromHttp (method: string): CommandIntent | undefined { - switch (method.toUpperCase()) { - case 'GET': - case 'HEAD': - return { destructive: false, idempotent: true, scope: 'global' } - case 'PUT': - return { destructive: false, idempotent: true, scope: 'global' } - case 'DELETE': - return { destructive: true, idempotent: true, scope: 'global' } - default: - return undefined - } -} diff --git a/src/cli-schema.ts b/src/cli-schema.ts index 57185c4c..d63ce02d 100644 --- a/src/cli-schema.ts +++ b/src/cli-schema.ts @@ -4,95 +4,19 @@ */ import { Command } from 'commander' -import { z } from 'zod' +import { buildCliSchema } from '@cli-schema/commander' +import type { Environment, Parameter, ParameterRole } from '@cli-schema/spec' import { defineCommand } from './factory.ts' -import { stripTransportMeta } from './factory.ts' -import type { OpaqueCommandHandle, CommandConfig, CommandIntent, JsonValue } from './factory.ts' -import type { SchemaArgDefinition } from './lib/schema-args.ts' +import type { OpaqueCommandHandle, JsonValue } from './factory.ts' +import { enrichEsArg, type SchemaArgDefinition } from './lib/schema-args.ts' import type { NamespaceEntry } from './namespaces.ts' -// --------------------------------------------------------------------------- -// CLI schema types -// --------------------------------------------------------------------------- - -interface CliValidation { - kind: string - min?: string - max?: string - pattern?: string - values?: string[] -} - -interface CliParameter { - role: string - name: string - type: string - required: boolean - shortName?: string - summary?: string - defaultValue?: string - repeatable?: boolean - separator?: string - aliases?: string[] - enumValues?: string[] - elementType?: string - hidden?: boolean - validations?: CliValidation[] -} - -interface CliCommand { - path: string[] - name: string - parameters: CliParameter[] - summary?: string - aliases?: string[] - hidden?: boolean - intent?: CommandIntent -} - -interface CliNamespace { - segment: string - commands: CliCommand[] - namespaces: CliNamespace[] - summary?: string - options?: CliParameter[] -} - -interface CliEnvVar { - name: string - required: boolean - description?: string -} - -interface CliConfigFile { - path: string - required: boolean - description?: string -} - -interface CliEnvironment { - variables: CliEnvVar[] - configFiles: CliConfigFile[] -} - -interface CliSchema { - schemaVersion: number - name: string - version: string - reservedMetaCommands: string[] - globalOptions: CliParameter[] - environment: CliEnvironment - commands: CliCommand[] - namespaces: CliNamespace[] - description?: string -} - // --------------------------------------------------------------------------- // Environment declaration (sources: src/config/loader.ts, src/lib/logo.ts, // src/lib/cloud-client.ts) // --------------------------------------------------------------------------- -const ENVIRONMENT: CliEnvironment = { +const ENVIRONMENT: Environment = { variables: [ { name: 'ELASTIC_CLI_CONFIG_FILE', @@ -119,439 +43,27 @@ const ENVIRONMENT: CliEnvironment = { } // --------------------------------------------------------------------------- -// Commander introspection helpers -// --------------------------------------------------------------------------- - -interface AttachedConfig { - config: CommandConfig - schemaArgs: SchemaArgDefinition[] -} - -function getAttachedConfig (cmd: OpaqueCommandHandle): AttachedConfig | undefined { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - return (cmd as unknown as any)._commandConfig as AttachedConfig | undefined -} - -function isHidden (cmd: OpaqueCommandHandle): boolean { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - return (cmd as unknown as any)._hidden === true -} - -function commandAliases (cmd: OpaqueCommandHandle): string[] | undefined { - const list = cmd.aliases() as string[] - return list.length > 0 ? list : undefined -} - -// --------------------------------------------------------------------------- -// JSON Schema extraction helpers -// --------------------------------------------------------------------------- - -type JsonSchemaNode = Record - -function resolveRef (node: JsonSchemaNode, root: JsonSchemaNode): JsonSchemaNode { - const ref = node['$ref'] - if (typeof ref !== 'string') return node - const parts = ref.replace(/^#\//, '').split('/') - let cur: unknown = root - for (const part of parts) { - if (cur == null || typeof cur !== 'object') return node - cur = (cur as JsonSchemaNode)[part] - } - return (cur != null && typeof cur === 'object') ? cur as JsonSchemaNode : node -} - -function unwrapNullable (node: JsonSchemaNode, root: JsonSchemaNode): JsonSchemaNode { - const anyOf = node['anyOf'] - if (!Array.isArray(anyOf)) return node - const nonNull = anyOf.find((b: unknown) => { - if (b == null || typeof b !== 'object') return false - const branch = b as JsonSchemaNode - return branch['type'] !== 'null' && branch['const'] !== null - }) - return nonNull != null ? resolveRef(nonNull as JsonSchemaNode, root) : node -} - -function resolveNode (node: JsonSchemaNode, root: JsonSchemaNode): JsonSchemaNode { - return unwrapNullable(resolveRef(node, root), root) -} - -function extractEnumValues (node: JsonSchemaNode, root: JsonSchemaNode): string[] | undefined { - const resolved = resolveNode(node, root) - const enumVals = resolved['enum'] - if (!Array.isArray(enumVals) || enumVals.length === 0) return undefined - return enumVals.filter((v) => v != null).map(String) -} - -function extractElementType (node: JsonSchemaNode, root: JsonSchemaNode): string | undefined { - const resolved = resolveNode(node, root) - const items = resolved['items'] - if (items == null || typeof items !== 'object') return undefined - const resolvedItems = resolveNode(items as JsonSchemaNode, root) - const t = resolvedItems['type'] - if (typeof t !== 'string') return undefined - // Spec only allows scalar element types; object/array items are not expressible - return ['string', 'integer', 'number', 'boolean'].includes(t) ? t : undefined -} - -function extractValidations (node: JsonSchemaNode, root: JsonSchemaNode): CliValidation[] | undefined { - const resolved = resolveNode(node, root) - const validations: CliValidation[] = [] - - // Enum values are surfaced via the dedicated `enumValues` field; skip here. - - const min = resolved['minimum'] - const max = resolved['maximum'] - if (min !== undefined || max !== undefined) { - validations.push({ - kind: 'range', - ...(min !== undefined && { min: String(min) }), - ...(max !== undefined && { max: String(max) }), - }) - } - - const pattern = resolved['pattern'] - if (typeof pattern === 'string') { - validations.push({ kind: 'regex', pattern }) - } - - return validations.length > 0 ? validations : undefined -} - -// --------------------------------------------------------------------------- -// Parameter builders -// --------------------------------------------------------------------------- - -/** Map SchemaArgDefinition.type to a spec-compliant type string. */ -function schemaArgType (arg: SchemaArgDefinition, enumValues: string[] | undefined): string { - if (enumValues != null && enumValues.length > 0) return 'enum' - switch (arg.type) { - case 'boolean': - case 'number': - case 'array': - return arg.type - case 'object': - case 'enum': - case 'string': - default: - return 'string' - } -} - -function buildGlobalParams (rootCmd: Command): CliParameter[] { - return rootCmd.options.map((opt) => { - const isFlag = !opt.required && !opt.optional - const name = opt.long?.replace(/^--/, '') ?? '' - return { - role: name === 'dry-run' ? 'dryRun' : 'flag', - name, - type: isFlag ? 'boolean' : 'string', - required: opt.mandatory ?? false, - ...(opt.short != null && { shortName: opt.short.replace(/^-/, '') }), - ...(opt.description && { summary: opt.description }), - } - }) -} - -function buildCommandParams (cmd: OpaqueCommandHandle): CliParameter[] { - const attached = getAttachedConfig(cmd) - const params: CliParameter[] = [] - - let jsonSchema: JsonSchemaNode | undefined - let schemaRoot: JsonSchemaNode | undefined - if (attached?.config.input instanceof z.ZodType) { - const raw = stripTransportMeta( - z.toJSONSchema(attached.config.input, { reused: 'ref' }) as JsonValue - ) - jsonSchema = raw as unknown as JsonSchemaNode - schemaRoot = jsonSchema - } - - function propNode (schemaKey: string): JsonSchemaNode | null { - if (jsonSchema == null) return null - const props = jsonSchema['properties'] - if (props == null || typeof props !== 'object') return null - const p = (props as JsonSchemaNode)[schemaKey] - return (p != null && typeof p === 'object') ? p as JsonSchemaNode : null - } - - if (attached != null) { - // Positional arg - if (attached.config.positionalArg != null) { - const pa = attached.config.positionalArg - params.push({ - role: 'positional', - name: pa.name, - type: 'string', - required: pa.required !== false, - ...(pa.description && { summary: pa.description }), - }) - } - - // Hand-declared options (OptionDefinition[]) - for (const opt of (attached.config.options ?? [])) { - params.push({ - role: 'flag', - name: opt.long, - type: opt.type === 'boolean' ? 'boolean' : opt.type === 'number' ? 'number' : 'string', - required: opt.required ?? false, - ...(opt.short != null && { shortName: opt.short }), - ...(opt.description && { summary: opt.description }), - ...(opt.defaultValue != null && { defaultValue: String(opt.defaultValue) }), - }) - } - - // Schema-derived options (from extractSchemaArgs) - for (const arg of attached.schemaArgs) { - const node = propNode(arg.schemaKey) - const root = schemaRoot ?? {} - const enumValues = node != null ? extractEnumValues(node, root) : undefined - params.push({ - role: 'flag', - name: arg.cliFlag, - type: schemaArgType(arg, enumValues), - required: arg.required, - ...(arg.description && { summary: arg.description }), - ...(arg.defaultValue != null && { defaultValue: String(arg.defaultValue) }), - ...(arg.acceptsArrayForm === true && { repeatable: true }), - ...(arg.acceptsArrayForm === true && arg.foundIn === 'body' && { separator: ',' }), - ...(enumValues != null && { enumValues }), - ...(arg.type === 'array' && node != null && extractElementType(node, root) != null && { elementType: extractElementType(node, root) as string }), - ...(node != null && extractValidations(node, root) != null && { validations: extractValidations(node, root) as CliValidation[] }), - }) - } - - // Framework-injected options: --input-file and --dry-run (not in OptionDefinition[]) - const coveredLong = new Set([ - ...(attached.config.options ?? []).map((o) => `--${o.long}`), - ...attached.schemaArgs.map((a) => `--${a.cliFlag}`), - ]) - for (const opt of cmd.options) { - const long = opt.long ?? '' - if (coveredLong.has(long)) continue - const name = long.replace(/^--/, '') - if (!name) continue - const isFlag = !opt.required && !opt.optional - params.push({ - role: name === 'dry-run' ? 'dryRun' : 'flag', - name, - type: isFlag ? 'boolean' : 'string', - required: opt.mandatory ?? false, - ...(opt.short != null && { shortName: opt.short.replace(/^-/, '') }), - ...(opt.description && { summary: opt.description }), - }) - } - } else { - // Fallback: no attached config — introspect Commander directly - for (const opt of cmd.options) { - const name = (opt.long ?? '').replace(/^--/, '') - if (!name) continue - const isFlag = !opt.required && !opt.optional - params.push({ - role: name === 'dry-run' ? 'dryRun' : 'flag', - name, - type: isFlag ? 'boolean' : 'string', - required: opt.mandatory ?? false, - ...(opt.short != null && { shortName: opt.short.replace(/^-/, '') }), - ...(opt.description && { summary: opt.description }), - }) - } - } - - return params -} - -// --------------------------------------------------------------------------- -// Intent helpers +// Role classification and parameter reconciliation // --------------------------------------------------------------------------- /** - * Merges a command's declared intent with the namespace-derived requiresAuth value. - * An explicit requiresAuth on the command's intent takes precedence over the namespace default. + * Matches the emission this CLI has always produced: only `--dry-run` gets a dedicated role. + * `@cli-schema/commander`'s own default heuristic also classifies `--force`/`--yes`/etc. as + * `confirmationSkip`, which would change output for e.g. `config`'s hand-declared `--force`. */ -function mergeIntent (commandIntent: CommandIntent | undefined, requiresAuth: boolean): CommandIntent { - if (commandIntent?.requiresAuth !== undefined) { - return commandIntent - } - return { ...(commandIntent ?? {}), requiresAuth } -} - -// --------------------------------------------------------------------------- -// Tree walker -// --------------------------------------------------------------------------- - -function buildLeafCommand (cmd: OpaqueCommandHandle, path: string[], requiresAuth: boolean): CliCommand { - const attached = getAttachedConfig(cmd) - const intent = mergeIntent(attached?.config.intent, requiresAuth) - const aliases = commandAliases(cmd) - return { - path, - name: cmd.name(), - parameters: buildCommandParams(cmd), - ...(cmd.description() && { summary: cmd.description() }), - ...(aliases != null && { aliases }), - intent, - } -} - -function walkCommands ( - cmd: OpaqueCommandHandle, - pathSoFar: string[], - outCommands: CliCommand[], - requiresAuth: boolean, -): CliNamespace | null { - if (isHidden(cmd)) return null - - const subs = cmd.commands as OpaqueCommandHandle[] - const name = cmd.name() - - if (subs.length === 0) { - outCommands.push(buildLeafCommand(cmd, pathSoFar, requiresAuth)) - return null - } - - const nsCommands: CliCommand[] = [] - const nsNamespaces: CliNamespace[] = [] - const childPath = [...pathSoFar, name] - - for (const sub of subs) { - if (isHidden(sub)) continue - const subSubs = sub.commands as OpaqueCommandHandle[] - if (subSubs.length === 0) { - nsCommands.push(buildLeafCommand(sub, childPath, requiresAuth)) - } else { - const nested = walkCommands(sub, childPath, outCommands, requiresAuth) - if (nested != null) nsNamespaces.push(nested) - } - } - - return { - segment: name, - commands: nsCommands, - namespaces: nsNamespaces, - ...(cmd.description() && { summary: cmd.description() }), - } -} - -// --------------------------------------------------------------------------- -// Option hoisting -// --------------------------------------------------------------------------- - -function collectAllLeaves (ns: CliNamespace): CliCommand[] { - return [...ns.commands, ...ns.namespaces.flatMap(collectAllLeaves)] +function classifyRole (longName: string): ParameterRole { + return longName === 'dry-run' ? 'dryRun' : 'flag' } /** - * Hoists flags common to every leaf command in `ns` up to `ns.options`, - * stripping them from individual command parameters. - * Top-down: call on a namespace before recursing so children inherit the result. + * `acceptsArrayForm` fields routed to the request body need a CSV separator in their help text + * (ES does not split comma-separated values inside JSON bodies, only in querystrings/paths) — + * see `src/lib/schema-args.ts`'s `enrichEsArg` for where `foundIn` comes from. */ -function hoistNamespaceOptions (ns: CliNamespace): void { - const leaves = collectAllLeaves(ns) - if (leaves.length === 0) return - - const firstLeaf = leaves[0] - if (firstLeaf == null) return - const candidates = firstLeaf.parameters.filter(p => p.role !== 'positional') - const commonNames = new Set( - candidates - .map(p => p.name) - .filter(name => leaves.every(cmd => cmd.parameters.some(p => p.name === name))) - ) - if (commonNames.size === 0) return - - ns.options = candidates.filter(p => commonNames.has(p.name)) - - function stripFrom (n: CliNamespace): void { - for (const cmd of n.commands) { - cmd.parameters = cmd.parameters.filter(p => !commonNames.has(p.name)) - } - for (const sub of n.namespaces) stripFrom(sub) - } - stripFrom(ns) -} - -/** - * Promotes flags present in every namespace's options AND every root-level command - * up to globalOptions, removing them from namespace options and root commands. - */ -function promoteToGlobalOptions ( - namespaces: CliNamespace[], - rootCommands: CliCommand[], -): CliParameter[] { - const firstNs = namespaces[0] - if (firstNs == null || (firstNs.options ?? []).length === 0) return [] - - const commonNames = new Set( - (firstNs.options ?? []) - .map(p => p.name) - .filter(name => - namespaces.every(ns => (ns.options ?? []).some(p => p.name === name)) && - (rootCommands.length === 0 || rootCommands.every(cmd => cmd.parameters.some(p => p.name === name))) - ) - ) - if (commonNames.size === 0) return [] - - const promoted = (firstNs.options ?? []).filter(p => commonNames.has(p.name)) - - for (const ns of namespaces) { - const remaining = (ns.options ?? []).filter(p => !commonNames.has(p.name)) - if (remaining.length > 0) { - ns.options = remaining - } else { - delete (ns as { options?: CliParameter[] }).options - } - } - - for (const cmd of rootCommands) { - cmd.parameters = cmd.parameters.filter(p => !commonNames.has(p.name)) - } - - return promoted -} - -// --------------------------------------------------------------------------- -// Schema builder -// --------------------------------------------------------------------------- - -export function buildCliSchema ( - root: OpaqueCommandHandle, - globalOptions: CliParameter[], - version: string, - noContextNames: ReadonlySet = new Set(), -): CliSchema { - const allCommands: CliCommand[] = [] - const namespaces: CliNamespace[] = [] - - for (const sub of root.commands as OpaqueCommandHandle[]) { - if (isHidden(sub)) continue - const requiresAuth = !noContextNames.has(sub.name()) - const subSubs = sub.commands as OpaqueCommandHandle[] - if (subSubs.length === 0) { - allCommands.push(buildLeafCommand(sub, [], requiresAuth)) - } else { - const ns = walkCommands(sub, [], allCommands, requiresAuth) - if (ns != null) namespaces.push(ns) - } - } - - // Hoist common flags within each top-level namespace, then promote any that - // are universal across all namespaces and root commands up to globalOptions. - for (const ns of namespaces) { - hoistNamespaceOptions(ns) - } - const promoted = promoteToGlobalOptions(namespaces, allCommands) - - return { - schemaVersion: 1, - name: root.name() || 'elastic', - version, - reservedMetaCommands: ['cli-schema'], - globalOptions: [...globalOptions, ...promoted], - environment: ENVIRONMENT, - commands: allCommands, - namespaces, - ...(root.description() && { description: root.description() }), - } +function postProcessInputParameter (param: Parameter, arg: SchemaArgDefinition): Parameter { + return arg.acceptsArrayForm === true && arg.foundIn === 'body' + ? { ...param, separator: ',' } + : param } // --------------------------------------------------------------------------- @@ -569,6 +81,9 @@ export async function registerCliSchemaCommand ( handler: async () => { const schemaRoot = new Command(rootProgram?.name() ?? 'elastic') schemaRoot.description(rootProgram?.description() ?? '') + // Copy the real program's options so buildCliSchema derives globalOptions from them + // dynamically, same as it does for every other command in the tree. + for (const opt of rootProgram?.options ?? []) schemaRoot.addOption(opt) schemaRoot.addCommand(defineCommand({ name: 'version', @@ -579,15 +94,23 @@ export async function registerCliSchemaCommand ( const loaded = await Promise.all(namespaces.map((ns) => ns.load({ eager: true }))) for (const ns of loaded) schemaRoot.addCommand(ns) - const globalOptions = rootProgram != null ? buildGlobalParams(rootProgram) : [] - // Build the set of namespace names that don't require context/auth const noContextNames = new Set([ ...namespaces.filter(ns => ns.requiresContext === false).map(ns => ns.name), 'version', // root-level version command needs no auth ]) - return buildCliSchema(schemaRoot, globalOptions, version, noContextNames) as unknown as JsonValue + return buildCliSchema(schemaRoot, { + name: rootProgram?.name() ?? 'elastic', + version, + ...(rootProgram?.description() && { description: rootProgram.description() }), + environment: ENVIRONMENT, + reservedMetaCommands: ['cli-schema'], + noContextNames, + classifyRole, + enrichSchemaArg: enrichEsArg, + postProcessInputParameter: (param, arg) => postProcessInputParameter(param, arg as SchemaArgDefinition), + }) as unknown as JsonValue }, formatOutput: (result) => JSON.stringify(result, null, 2) + '\n', }) diff --git a/src/es/register.ts b/src/es/register.ts index b50a976a..d2067050 100644 --- a/src/es/register.ts +++ b/src/es/register.ts @@ -9,7 +9,7 @@ import { createRequire } from 'node:module' import type { defineCommand as _DefCmd } from '../factory.ts' import { defineGroup } from '../factory-core.ts' import type { OpaqueCommandHandle } from '../factory-core.ts' -import { inferIntentFromHttp } from '../cli-schema-intent.ts' +import { inferIntentFromHttp } from '@cli-schema/spec' import type { EsApiDefinition } from './types.ts' import type { SchemaArgDefinition } from '../lib/schema-args.ts' import { apiManifest } from './api-manifest.ts' diff --git a/src/factory.ts b/src/factory.ts index 04ce03b3..2491c436 100644 --- a/src/factory.ts +++ b/src/factory.ts @@ -16,6 +16,7 @@ import { pickFields, parseFieldList, applyTemplate, TemplateAgainstPrimitiveErro import { validateName, hasGlobalJsonFlag, configureErrorOutput, commandPath, isCommandAllowed, stripTransportMeta } from './factory-core.ts' import type { OpaqueCommandHandle, JsonValue, CommandConfig, ParsedResult } from './factory-core.ts' import { RawJsonValue } from './factory-core.ts' +import { attachInput, attachIntent } from '@cli-schema/commander' // Re-export from factory-core for backward compatibility export { @@ -386,13 +387,10 @@ export function defineCommand (config: CommandConfig): O config.input instanceof getZ().ZodType ? config.input : undefined, ) - // Attach typed metadata for tooling (e.g. cli-schema). Non-enumerable so it - // doesn't appear in JSON.stringify or Commander's own command inspection. - Object.defineProperty(cmd, '_commandConfig', { - value: { config, schemaArgs }, - writable: false, - enumerable: false, - }) + // Attach typed metadata for tooling (cli-schema). Non-enumerable storage, same as before — + // @cli-schema/commander's attach functions use a private symbol under the hood. + if (config.input instanceof getZ().ZodType) attachInput(cmd, config.input) + if (config.intent != null) attachIntent(cmd, config.intent) cmd.action(async () => { const allRaw = cmd.optsWithGlobals() diff --git a/src/kb/register.ts b/src/kb/register.ts index 83f01f91..eb553d02 100644 --- a/src/kb/register.ts +++ b/src/kb/register.ts @@ -7,7 +7,7 @@ import { Command } from 'commander' import { z } from 'zod' import { defineCommand, defineGroup } from '../factory.ts' import type { OpaqueCommandHandle } from '../factory.ts' -import { inferIntentFromHttp } from '../cli-schema-intent.ts' +import { inferIntentFromHttp } from '@cli-schema/spec' import type { KbApiDefinition, KbPathParam, KbQueryParam, KbBodyParam } from './types.ts' import { validateKbApiDefinition } from './types.ts' import { kbApiManifest, loadKbApi } from './apis.ts' diff --git a/src/lib/schema-args.ts b/src/lib/schema-args.ts index fcac9590..12876fbc 100644 --- a/src/lib/schema-args.ts +++ b/src/lib/schema-args.ts @@ -4,39 +4,34 @@ */ import type { z } from 'zod' +import { + extractSchemaArgs as baseExtractSchemaArgs, + toKebabCase, + buildFlagKeyMap, + validateSchemaArgs as baseValidateSchemaArgs, + walkWrapperChain, + readMetaField, + type SchemaArgDefinition as BaseSchemaArgDefinition, + type FlagKeyMap, +} from '@cli-schema/zod' + +export type { FlagKeyMap } +export { toKebabCase, buildFlagKeyMap } + +/** Valid routing destinations for a parameter derived from `found_in` Zod metadata. */ +export type FoundIn = 'path' | 'query' | 'body' /** * Represents a single CLI argument derived from a top-level key in a command's input schema. + * + * The generic shape (`schemaKey`, `cliFlag`, `type`, `required`, `defaultValue`, `description`, + * `acceptsArrayForm`) comes from `@cli-schema/zod`'s `SchemaArgDefinition`; `foundIn` and + * `parseStyle` are Elastic-specific enrichment attached below. */ -export interface SchemaArgDefinition { - /** Original key name as defined in the Zod schema (e.g., `num_shards`, `refreshInterval`) */ - schemaKey: string - - /** Kebab-case flag name derived from `schemaKey` (e.g., `num-shards`, `refresh-interval`) */ - cliFlag: string - - /** Declared type from schema introspection */ - type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'enum' - - /** Whether the field is required (no default, not optional) */ - required: boolean - - /** Default value from the schema, if any */ - defaultValue?: unknown - - /** Description from the schema's metadata, used in help text */ - description: string - +export interface SchemaArgDefinition extends BaseSchemaArgDefinition { /** Routing destination derived from `.meta({found_in: ...})`, or `undefined` if absent */ foundIn?: FoundIn - /** - * True when the schema accepts both a scalar and an array form (e.g. `Fields = union(Field, array(Field))`). - * Registered CLI flag is still scalar for UX; callers split comma-separated values into arrays where - * the destination demands it (e.g. JSON request bodies). - */ - acceptsArrayForm?: boolean - /** * Marks args whose CLI string value needs a non-trivial transformation before reaching the wire. * @@ -47,158 +42,16 @@ export interface SchemaArgDefinition { parseStyle?: 'sort-pairs' } -/** Valid routing destinations for a parameter derived from `found_in` Zod metadata. */ -export type FoundIn = 'path' | 'query' | 'body' - -/** - * A bidirectional mapping between kebab-case CLI flag names and original schema keys. - */ -export interface FlagKeyMap { - /** Maps `cliFlag` -> `schemaKey` for reverse lookup during merge */ - toSchemaKey: Map - - /** Maps `schemaKey` -> `cliFlag` for registration and help text */ - toCliFlag: Map -} - -/** - * Converts a schema key to its kebab-case CLI flag name. - * Handles snake_case, camelCase, and plain lowercase inputs. - * - * @example - * ```ts - * toKebabCase('num_shards') // 'num-shards' - * toKebabCase('refreshInterval') // 'refresh-interval' - * toKebabCase('index') // 'index' - * ``` - */ -export function toKebabCase (key: string): string { - return key - .replace(/^_+/, '') // strip leading underscores (e.g. Elasticsearch's _source, _meta) - .replace(/_/g, '-') - .replace(/([a-z])([A-Z])/g, '$1-$2') - .toLowerCase() -} - -/** Minimal shape of a Zod field def for the properties we need to introspect. */ -interface ZodFieldDef { - type: string - innerType?: { def: ZodFieldDef } - defaultValue?: unknown - getter?: () => z.ZodType - options?: z.ZodType[] -} - -/** - * Unwraps wrapper types from a Zod schema field, resolving lazy thunks, - * records, unions, and any/unknown to their CLI-appropriate type names. - */ -function unwrapField (field: z.ZodType): { typeName: string, isOptional: boolean, defaultValue?: unknown } { - const def = field.def as ZodFieldDef - if (def.type === 'date') { - throw new Error('Date cannot be represented in JSON Schema: use z.string() with an ISO-8601 description instead of z.date()') - } - - if (def.type === 'optional') { - const inner = unwrapField(def.innerType as z.ZodType) - return { ...inner, isOptional: true } - } - - if (def.type === 'default') { - const inner = unwrapField(def.innerType as z.ZodType) - return { ...inner, defaultValue: def.defaultValue, isOptional: false } - } - - if (def.type === 'lazy' && typeof def.getter === 'function') { - return unwrapField(def.getter()) - } - - if (def.type === 'record' || def.type === 'any' || def.type === 'unknown') { - return { typeName: 'object', isOptional: false } - } - - if (def.type === 'union' && Array.isArray(def.options) && def.options.length > 0) { - return unwrapField(def.options[0] as z.ZodType) - } - - return { typeName: def.type, isOptional: false } -} - -const CLI_TYPES = new Set(['string', 'number', 'boolean', 'object', 'array', 'enum']) - /** - * Extracts CLI argument definitions from a Zod object schema. - * Each top-level key becomes a `SchemaArgDefinition` with its kebab-case flag name, - * type, required status, default value, and description. + * Extracts the `found_in` routing metadata from a Zod field. * - * Returns an empty array if `schema` is not a Zod object schema. - */ -export function extractSchemaArgs (schema: unknown): SchemaArgDefinition[] { - const shape = (schema as z.ZodObject | null)?.shape - if (shape == null || typeof shape !== 'object') return [] - - return Object.entries(shape).map(([key, fieldSchema]) => { - const { typeName, isOptional, defaultValue } = unwrapField(fieldSchema as z.ZodType) - const type = (CLI_TYPES.has(typeName) ? typeName : 'string') as SchemaArgDefinition['type'] - - // Read description from the Zod globalRegistry -- much faster than calling - // .toJSONSchema() per field, which would force lazy-schema evaluation. - // The outer field may carry found_in meta while the inner type (unwrapped from - // optional/default) carries the description, so we check both levels. - const outerMeta = (fieldSchema as z.ZodType).meta() as Record | null | undefined - let description: string = typeof outerMeta?.description === 'string' ? outerMeta.description : '' - if (description === '') { - const innerType = ((fieldSchema as z.ZodType).def as { innerType?: z.ZodType } | undefined)?.innerType - if (innerType != null) { - const innerMeta = innerType.meta() as Record | null | undefined - if (typeof innerMeta?.description === 'string') description = innerMeta.description - } - } - - const foundIn = extractFoundIn(fieldSchema as z.ZodType) - const acceptsArrayForm = type !== 'array' && schemaAcceptsArrayForm(fieldSchema as z.ZodType) - const parseStyle = schemaContainsId(fieldSchema as z.ZodType, 'Sort') ? 'sort-pairs' as const : undefined - return { - schemaKey: key, - cliFlag: toKebabCase(key), - type, - required: !isOptional && defaultValue === undefined, - defaultValue, - description, - ...(foundIn !== undefined ? { foundIn } : {}), - ...(acceptsArrayForm ? { acceptsArrayForm: true } : {}), - ...(parseStyle !== undefined ? { parseStyle } : {}) - } - }) -} - -/** - * Walks `field` through `optional`, `default`, `lazy`, and `union` wrappers, returning true - * if `predicate` matches any visited node. The `seen` set breaks cycles in self-referential - * lazy schemas (e.g. `z.lazy(() => Foo)` where `Foo` references itself). + * Reads `.meta()` from the outermost type first; if absent, walks one level into + * wrapper types (`optional`, `default`) to find it on the inner type. * - * Note: evaluating `lazy.getter()` forces lazy-schema evaluation; the schemas this file - * inspects make that unavoidable for predicates that depend on a lazy's inner shape. + * @returns the routing destination, or `undefined` if no `found_in` metadata is present */ -function anyNode (field: z.ZodType, predicate: (node: z.ZodType) => boolean): boolean { - const seen = new Set() - function walk (node: z.ZodType): boolean { - if (seen.has(node)) return false - seen.add(node) - if (predicate(node)) return true - const def = node.def as ZodFieldDef - if (def.type === 'optional' || def.type === 'default') { - return def.innerType != null && walk(def.innerType as unknown as z.ZodType) - } - if (def.type === 'lazy' && typeof def.getter === 'function') { - return walk(def.getter()) - } - if (def.type === 'union' && Array.isArray(def.options)) { - return def.options.some((o) => walk(o)) - } - return false - } - return walk(field) +export function extractFoundIn (field: z.ZodType): FoundIn | undefined { + return readMetaField(field, 'found_in') } /** @@ -207,40 +60,36 @@ function anyNode (field: z.ZodType, predicate: (node: z.ZodType) => boolean): bo * destination-specific transformations. */ function schemaContainsId (field: z.ZodType, id: string): boolean { - return anyNode(field, (n) => { + return walkWrapperChain(field, (n) => { const meta = n.meta() as Record | null | undefined return meta?.id === id }) } -/** - * Returns true when the schema (or any branch of its unions) accepts an array form. - * - * Elasticsearch commonly types fields as `union(T, array(T))` (e.g. `Fields`, `Indices`), - * which `unwrapField` collapses to the scalar branch for CLI ergonomics. Body-routed - * arguments still need the array form because ES does not split CSV strings inside JSON - * bodies (only in querystrings and URL paths). - */ -function schemaAcceptsArrayForm (field: z.ZodType): boolean { - return anyNode(field, (n) => (n.def as ZodFieldDef).type === 'array') +/** Enriches a base schema arg with Elastic's routing (`foundIn`) and parse-style metadata. */ +export function enrichEsArg (field: z.ZodType): Pick { + const foundIn = extractFoundIn(field) + const parseStyle = schemaContainsId(field, 'Sort') ? 'sort-pairs' as const : undefined + return { + ...(foundIn !== undefined && { foundIn }), + ...(parseStyle !== undefined && { parseStyle }), + } } /** - * Builds a bidirectional mapping between CLI flag names and schema keys for a command. - * Created once at registration time; immutable after creation. + * Extracts CLI argument definitions from a Zod object schema. + * Each top-level key becomes a `SchemaArgDefinition` with its kebab-case flag name, + * type, required status, default value, description, and Elastic's routing/parse-style + * enrichment. + * + * Returns an empty array if `schema` is not a Zod object schema. */ -export function buildFlagKeyMap (args: SchemaArgDefinition[]): FlagKeyMap { - const toSchemaKey = new Map() - const toCliFlag = new Map() - for (const arg of args) { - toSchemaKey.set(arg.cliFlag, arg.schemaKey) - toCliFlag.set(arg.schemaKey, arg.cliFlag) - } - return { toSchemaKey, toCliFlag } +export function extractSchemaArgs (schema: unknown): SchemaArgDefinition[] { + return baseExtractSchemaArgs(schema, { enrich: enrichEsArg }) as SchemaArgDefinition[] } /** Reserved CLI flag names that schema keys must not collide with. */ -const RESERVED_FLAGS = new Set(['help', 'json', 'config-file', 'use-context', 'command-profile', 'input-file']) +const RESERVED_FLAGS = ['help', 'json', 'config-file', 'use-context', 'command-profile', 'input-file'] /** * Validates schema arguments for naming conflicts. @@ -248,37 +97,5 @@ const RESERVED_FLAGS = new Set(['help', 'json', 'config-file', 'use-context', 'c * Called at command registration time for fail-fast detection. */ export function validateSchemaArgs (args: SchemaArgDefinition[]): void { - const seen = new Set() - for (const arg of args) { - if (RESERVED_FLAGS.has(arg.cliFlag)) { - throw new Error(`Schema key "${arg.schemaKey}" collides with reserved flag "--${arg.cliFlag}"`) - } - if (seen.has(arg.cliFlag)) { - throw new Error(`Duplicate CLI flag collision: multiple schema keys map to "--${arg.cliFlag}"`) - } - seen.add(arg.cliFlag) - } -} - -/** - * Extracts the `found_in` routing metadata from a Zod field. - * - * Reads `.meta()` from the outermost type first; if absent, walks one level into - * wrapper types (`optional`, `default`) to find it on the inner type. - * - * @returns the routing destination, or `undefined` if no `found_in` metadata is present - */ -export function extractFoundIn (field: z.ZodType): FoundIn | undefined { - // check outermost first - const outerMeta = field.meta() as Record | undefined - if (outerMeta?.found_in != null) return outerMeta.found_in as FoundIn - - // walk one wrapper level (optional/default) to find meta on inner type - const innerType = (field.def as { innerType?: z.ZodType }).innerType - if (innerType != null) { - const innerMeta = innerType.meta() as Record | undefined - if (innerMeta?.found_in != null) return innerMeta.found_in as FoundIn - } - - return undefined + baseValidateSchemaArgs(args, RESERVED_FLAGS) } diff --git a/test/cli-schema.test.ts b/test/cli-schema.test.ts index f1b0efa0..66aefea0 100644 --- a/test/cli-schema.test.ts +++ b/test/cli-schema.test.ts @@ -23,6 +23,36 @@ function runCliSchema (): Promise<{ code: number | null, stdout: string, stderr: }) } +interface CliParameter { + name: string + repeatable?: boolean + separator?: string +} + +interface CliCommand { + name: string + parameters: CliParameter[] +} + +interface CliNamespace { + segment: string + commands?: CliCommand[] + namespaces?: CliNamespace[] +} + +function findCommand (namespaces: CliNamespace[], path: string[], name: string): CliCommand | undefined { + let level = namespaces + for (const segment of path) { + const ns = level.find((n) => n.segment === segment) + if (ns == null) return undefined + if (segment === path[path.length - 1]) { + return ns.commands?.find((c) => c.name === name) + } + level = ns.namespaces ?? [] + } + return undefined +} + describe('cli schema', () => { it('does not emit runtime shortcuts into the docs-builder schema', async () => { const { code, stdout, stderr } = await runCliSchema() @@ -33,4 +63,25 @@ describe('cli schema', () => { assert.ok(Array.isArray(schema['namespaces'])) assert.ok((schema['namespaces'] as Array<{ segment?: string }>).some(ns => ns.segment === 'stack')) }) + + it('emits repeatable+separator for a body-routed array-accepting field, and no separator for a query-routed one', async () => { + const { code, stdout, stderr } = await runCliSchema() + assert.equal(code, 0, stderr) + + const schema = JSON.parse(stdout) as { namespaces: CliNamespace[] } + + // `mget`'s `ids` is routed to the request body -- ES doesn't split comma-separated + // values inside JSON bodies, so the emitted parameter must advertise a separator. + const mget = findCommand(schema.namespaces, ['stack', 'es'], 'mget') + const ids = mget?.parameters.find((p) => p.name === 'ids') + assert.equal(ids?.repeatable, true) + assert.equal(ids?.separator, ',') + + // `bulk`'s `routing` is routed to the querystring -- CSV splitting happens there + // naturally, so no separator should be emitted even though it's repeatable. + const bulk = findCommand(schema.namespaces, ['stack', 'es'], 'bulk') + const routing = bulk?.parameters.find((p) => p.name === 'routing') + assert.equal(routing?.repeatable, true) + assert.equal(routing?.separator, undefined) + }) }) From cb9f04a577a7c5062b10141b9954590f73ee54e9 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Mon, 13 Jul 2026 20:49:19 +0200 Subject: [PATCH 2/3] Drop the addOption copy loop and walkWrapperChain in favor of package support Bumps @cli-schema/{spec,zod,commander} to ^0.2.0, which added two small, generically-useful package APIs precisely to remove these workarounds: - cli-schema.ts: buildCliSchema now takes globalOptionsSource (defaulting to root.options) for callers whose tree-discovery root isn't the same Command that has the real program's global options registered on it. schemaRoot no longer needs `.addOption()` copied onto it by hand -- it's built purely for command-tree assembly now, options included. - lib/schema-args.ts: readMetaField was rebuilt upstream on the existing walkWrapperChain primitive, so it now does the full optional/default/ lazy/union traversal instead of stopping one level in. schemaContainsId (used to detect ES's composite Sort type for the sort-pairs runtime parse style) shrinks from a hand-written predicate on walkWrapperChain to a one-line call to readMetaField -- the walkWrapperChain import is gone from this file entirely. docs/cli/schema.json regenerates byte-identical (confirmed via `git diff --exit-code`) -- both fixes change how the same data is derived, not what's derived. All 1468 tests pass; lint/SPDX/notice/license checks clean (NOTICE.txt regenerated for the version bump). --- NOTICE.txt | 29 ++++++++++++++++++++++++++--- package-lock.json | 30 +++++++++++++++--------------- package.json | 6 +++--- src/cli-schema.ts | 6 +++--- src/lib/schema-args.ts | 6 +----- 5 files changed, 48 insertions(+), 29 deletions(-) diff --git a/NOTICE.txt b/NOTICE.txt index d75711ff..26b4a0be 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -9,7 +9,7 @@ Third-party software notices and licenses ======================================================================== ------------------------------------------------------------------------ -@cli-schema/commander@0.1.1 +@cli-schema/commander@0.2.0 License: MIT Repository: https://github.com/cli-schema/cli-schema-js ------------------------------------------------------------------------ @@ -264,6 +264,29 @@ buildCliSchema(program, { }) ``` +### When the tree you're walking isn't the program with your real global options + +If your CLI lazy-loads its command tree for startup performance — only building the invoked +subtree, leaving everything else as empty stub commands — you can't hand `buildCliSchema` the +real `program` directly; it would see mostly stubs. The usual fix is to assemble a synthetic root +purely for schema generation, eager-loading every command onto it. That synthetic root has no +options of its own, even though your real program's global flags (`--json`, etc.) should still +show up in `globalOptions`. Point `globalOptionsSource` at wherever those really live instead of +copying them onto the synthetic root by hand: + +```ts +const schemaRoot = new Command('mytool') +// ... eager-load every namespace onto schemaRoot ... + +buildCliSchema(schemaRoot, { + name: 'mytool', + version: '1.0.0', + globalOptionsSource: program.options, // the real, lazily-populated program +}) +``` + +Defaults to `root.options` — most callers (a CLI that isn't lazy-loading) never need this. + ## Related packages - [`@cli-schema/spec`](https://www.npmjs.com/package/@cli-schema/spec) — the `CliSchema`/`Intent`/`Parameter` types this package produces, plus a validator to check the result @@ -275,7 +298,7 @@ MIT ------------------------------------------------------------------------ -@cli-schema/spec@0.1.1 +@cli-schema/spec@0.2.0 License: MIT Repository: https://github.com/cli-schema/cli-schema-js ------------------------------------------------------------------------ @@ -432,7 +455,7 @@ MIT ------------------------------------------------------------------------ -@cli-schema/zod@0.1.1 +@cli-schema/zod@0.2.0 License: MIT Repository: https://github.com/cli-schema/cli-schema-js ------------------------------------------------------------------------ diff --git a/package-lock.json b/package-lock.json index f279a175..6fb7ec50 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,9 +20,9 @@ "packages/*" ], "dependencies": { - "@cli-schema/commander": "^0.1.1", - "@cli-schema/spec": "^0.1.1", - "@cli-schema/zod": "^0.1.1", + "@cli-schema/commander": "^0.2.0", + "@cli-schema/spec": "^0.2.0", + "@cli-schema/zod": "^0.2.0", "@elastic/config-resolver": "*", "@elastic/es-schemas": "1.0.2", "cli-table3": "^0.6.5", @@ -74,14 +74,14 @@ } }, "node_modules/@cli-schema/commander": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/@cli-schema/commander/-/commander-0.1.1.tgz", - "integrity": "sha512-JN7Q7znqBIxSL7FUGyHhVGxJLBpWajW5JtbI73GgLR5LKgA3ems5rFGoA0GDfwWTy/QlF3VRE/4iCJKRo9W/Uw==", + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@cli-schema/commander/-/commander-0.2.0.tgz", + "integrity": "sha512-Q/kfKnKtEk3/917mI4tKuTWo8bN3TiwRDZ8ROLqC8qMPG6ukBnY3oUqe3UWMfFlAJSzIwpEbt6Ktcl+ZMri5RQ==", "inBundle": true, "license": "MIT", "dependencies": { - "@cli-schema/spec": "^0.1.1", - "@cli-schema/zod": "^0.1.1" + "@cli-schema/spec": "^0.2.0", + "@cli-schema/zod": "^0.2.0" }, "peerDependencies": { "commander": "^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0", @@ -89,9 +89,9 @@ } }, "node_modules/@cli-schema/spec": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/@cli-schema/spec/-/spec-0.1.1.tgz", - "integrity": "sha512-1dsRO8WsmCHRaFPP1r8XRebpEhb9P8bX6uWAyYFXv5DPlWjuEkcX3kLoCQOYyvzmd7gHEfv6Kd6k+pUWS3Yc0g==", + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@cli-schema/spec/-/spec-0.2.0.tgz", + "integrity": "sha512-J0ioUWQ6wA0L2gAVx4JtknxyZJg4FvhpuZrXVTpOcRruWsjgNHNXtmtQE6WgsyTlpQy6QWZhT685ubzbQuz4yw==", "inBundle": true, "license": "MIT", "dependencies": { @@ -123,13 +123,13 @@ "license": "MIT" }, "node_modules/@cli-schema/zod": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/@cli-schema/zod/-/zod-0.1.1.tgz", - "integrity": "sha512-Q8NATnnr+fJ+q9yDDYvtgF1T20dfd3GKU8hSioMmiocx/ipQ/v+ksG4fL+dsx/xzlfi8z3iOsNY/h9xvUWYwOA==", + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@cli-schema/zod/-/zod-0.2.0.tgz", + "integrity": "sha512-xkQwguq0qL+5FSnO6I51IFMu1Fh57iDhVyqLRsTaOODq0uDx8ZdSiZFVIFA+qCF6Uu87APz32iNBE+S9te00Xg==", "inBundle": true, "license": "MIT", "dependencies": { - "@cli-schema/spec": "^0.1.1" + "@cli-schema/spec": "^0.2.0" }, "peerDependencies": { "zod": "^4.0.0" diff --git a/package.json b/package.json index 1954d9c8..baf80ab8 100644 --- a/package.json +++ b/package.json @@ -59,9 +59,9 @@ "test": "test" }, "dependencies": { - "@cli-schema/commander": "^0.1.1", - "@cli-schema/spec": "^0.1.1", - "@cli-schema/zod": "^0.1.1", + "@cli-schema/commander": "^0.2.0", + "@cli-schema/spec": "^0.2.0", + "@cli-schema/zod": "^0.2.0", "@elastic/config-resolver": "*", "@elastic/es-schemas": "1.0.2", "cli-table3": "^0.6.5", diff --git a/src/cli-schema.ts b/src/cli-schema.ts index d63ce02d..31f49b39 100644 --- a/src/cli-schema.ts +++ b/src/cli-schema.ts @@ -81,9 +81,6 @@ export async function registerCliSchemaCommand ( handler: async () => { const schemaRoot = new Command(rootProgram?.name() ?? 'elastic') schemaRoot.description(rootProgram?.description() ?? '') - // Copy the real program's options so buildCliSchema derives globalOptions from them - // dynamically, same as it does for every other command in the tree. - for (const opt of rootProgram?.options ?? []) schemaRoot.addOption(opt) schemaRoot.addCommand(defineCommand({ name: 'version', @@ -108,6 +105,9 @@ export async function registerCliSchemaCommand ( reservedMetaCommands: ['cli-schema'], noContextNames, classifyRole, + // schemaRoot is a synthetic tree-discovery root with no options of its own — the real + // global flags (--json, etc.) live on the actual running program. + ...(rootProgram != null && { globalOptionsSource: rootProgram.options }), enrichSchemaArg: enrichEsArg, postProcessInputParameter: (param, arg) => postProcessInputParameter(param, arg as SchemaArgDefinition), }) as unknown as JsonValue diff --git a/src/lib/schema-args.ts b/src/lib/schema-args.ts index 12876fbc..dba017ea 100644 --- a/src/lib/schema-args.ts +++ b/src/lib/schema-args.ts @@ -9,7 +9,6 @@ import { toKebabCase, buildFlagKeyMap, validateSchemaArgs as baseValidateSchemaArgs, - walkWrapperChain, readMetaField, type SchemaArgDefinition as BaseSchemaArgDefinition, type FlagKeyMap, @@ -60,10 +59,7 @@ export function extractFoundIn (field: z.ZodType): FoundIn | undefined { * destination-specific transformations. */ function schemaContainsId (field: z.ZodType, id: string): boolean { - return walkWrapperChain(field, (n) => { - const meta = n.meta() as Record | null | undefined - return meta?.id === id - }) + return readMetaField(field, 'id') === id } /** Enriches a base schema arg with Elastic's routing (`foundIn`) and parse-style metadata. */ From 937df15b1cd354368bb04685ea332f1207120463 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Mon, 13 Jul 2026 21:14:40 +0200 Subject: [PATCH 3/3] ci: retrigger CI (previous macos Bun run timed out with no local repro across 2 attempts; see PR discussion)