diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..4c1279be43 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +output/dangling-types/dangling.csv linguist-generated=true +output/schema/schema.json linguist-generated=true +output/schema/validation-errors.json linguist-generated=true +output/typescript/types.ts linguist-generated=true diff --git a/.github/download-artifacts/index.js b/.github/download-artifacts/index.js index bd8ba26bc3..86759c134b 100644 --- a/.github/download-artifacts/index.js +++ b/.github/download-artifacts/index.js @@ -40,22 +40,23 @@ const downloadedSpec = join(esFolder, 'rest-api-spec', 'api') const specFolder = join(__dirname, '..', '..', 'specification', '_json_spec') async function downloadArtifacts (opts) { - if (typeof opts.version !== 'string') { - throw new Error('Missing version') + if (typeof opts.version !== 'string' && typeof opts.branch !== 'string') { + throw new Error('Missing version or branch') } core.info('Checking out spec and test') - core.info('Resolving versions') + core.info('Resolving version') let resolved try { - resolved = await resolve(opts.version, opts.hash) + resolved = await resolve(opts.version || fromBranch(opts.branch), opts.hash) } catch (err) { core.error(err.message) process.exit(1) } opts.version = resolved.version + core.info(`Resolved version ${opts.version}`) core.info('Cleanup') await rm(esFolder) @@ -88,6 +89,16 @@ async function downloadArtifacts (opts) { } async function resolve (version, hash) { + if (version === 'latest') { + const response = await fetch('https://artifacts-api.elastic.co/v1/versions') + if (!response.ok) { + throw new Error(`unexpected response ${response.statusText}`) + } + const { versions } = await response.json() + version = versions.pop() + } + + core.info(`Resolving version ${version}`) const response = await fetch(`https://artifacts-api.elastic.co/v1/versions/${version}`) if (!response.ok) { throw new Error(`unexpected response ${response.statusText}`) @@ -136,12 +147,24 @@ async function resolve (version, hash) { } } +function fromBranch (branch) { + if (branch === 'main') { + return 'latest' + } else if (branch === '7.x') { + return '7.x-SNAPSHOT' + } else if ((branch.startsWith('7.') || branch.startsWith('8.')) && !isNaN(Number(branch.split('.')[1]))) { + return `${branch}-SNAPSHOT` + } else { + throw new Error(`Cannot derive version from branch '${branch}'`) + } +} + async function main (options) { await downloadArtifacts(options) } const options = minimist(process.argv.slice(2), { - string: ['id', 'version', 'hash'] + string: ['id', 'version', 'hash', 'branch'] }) main(options).catch(t => { core.error(t) diff --git a/.github/download-artifacts/package.json b/.github/download-artifacts/package.json index 8ada6ac45c..457a3bc122 100644 --- a/.github/download-artifacts/package.json +++ b/.github/download-artifacts/package.json @@ -10,10 +10,10 @@ "author": "", "license": "ISC", "dependencies": { - "@actions/core": "^1.2.7", + "@actions/core": "^1.6.0", "cross-zip": "^4.0.0", "minimist": "^1.2.5", - "node-fetch": "^2.6.1", + "node-fetch": "^2.6.7", "rimraf": "^3.0.2" } } diff --git a/.github/labeler.yml b/.github/labeler.yml index 01a5313684..06d6ace8cd 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -9,9 +9,3 @@ generator:typescript: compiler: - 'compiler/**/*' - -backport-7.x: - # Add 'backport-7.x` label to any change to compiler/ts-generator files - # as long as the 'specification' hasn't changed - - any: ['compiler/**/*', 'typescript-generator/**/*'] - all: ['!specification/**/*'] diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml index 26801ebbe8..c0d07fef80 100644 --- a/.github/workflows/backport.yml +++ b/.github/workflows/backport.yml @@ -7,7 +7,7 @@ on: jobs: backport: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest name: Backport steps: - name: Backport diff --git a/.github/workflows/code-format.yml b/.github/workflows/code-format.yml index 9db62c442d..2ed7e60166 100644 --- a/.github/workflows/code-format.yml +++ b/.github/workflows/code-format.yml @@ -10,10 +10,10 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Use Node.js 14.x + - name: Use Node.js 16.x uses: actions/setup-node@v1 with: - node-version: 14.x + node-version: 16.x - name: Install run: | diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml new file mode 100644 index 0000000000..d0925e4962 --- /dev/null +++ b/.github/workflows/generate.yml @@ -0,0 +1,92 @@ +name: Generate Output + +on: + push: + branches: + - 'main' + - '7.17' + - '8.[0-9]+' + + # For debugging purposes: + # pull_request: + # types: [opened, synchronize, reopened] + # branches: + # - main + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: false + +defaults: + run: + shell: bash + +jobs: + build: + runs-on: ubuntu-latest + if: github.repository_owner == 'elastic' && github.actor != 'elasticmachine' + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + token: ${{ secrets.PAT }} + persist-credentials: true + + - name: Setup Node 16.x + uses: actions/setup-node@v3 + with: + node-version: 16.x + cache: npm + cache-dependency-path: '**/package-lock.json' + + - name: Setup Dependencies + run: | + make setup + + - name: Generate Output + run: | + make spec-compile + make spec-generate + + - name: Check for Changed Files + id: changes + run: | + if [ -n "$(git status --porcelain)" ]; then + echo "has-changes=1" >> $GITHUB_OUTPUT + fi + + - name: Set Git Identity + if: steps.changes.outputs.has-changes == '1' + run: |- + git config --global user.email "elasticmachine@users.noreply.github.com" + git config --global user.name "Elastic Machine" + + - name: Push Output + if: steps.changes.outputs.has-changes == '1' + run: | + cd ./output + + git add -A + git commit -m "Update specification output" + + git status + + git push + + # For debugging purposes: + # - name: Push Output + # if: steps.changes.outputs.has-changes == '1' + # env: + # BRANCH_NAME: output_${{ github.run_id }}_${{ github.run_attempt }} + # run: | + # cd ./output + + # git fetch + # git switch main + + # git add -A + # git commit -m "Update specification output" + + # git status + + # git push origin HEAD:refs/heads/${{ env.BRANCH_NAME }} diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 2da8e5761e..912864aaa7 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -10,10 +10,10 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Use Node.js 14.x + - name: Use Node.js 16.x uses: actions/setup-node@v1 with: - node-version: 14.x + node-version: 16.x - name: Install run: | diff --git a/.github/workflows/output-check.yml b/.github/workflows/output-check.yml deleted file mode 100644 index f84e858fdb..0000000000 --- a/.github/workflows/output-check.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Check output freshness - -on: [pull_request] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Use Node.js 14.x - uses: actions/setup-node@v1 - with: - node-version: 14.x - - - name: Install - run: | - npm install --prefix compiler - npm install --prefix typescript-generator - - - name: Generate output - run: | - npm run generate-schema --prefix compiler - npm run start --prefix typescript-generator - - - name: Check freshness - run: | - if [ -n "$(git status --porcelain)" ]; then echo Error: changes found after running the generation; git diff; git status; exit 1; fi diff --git a/.github/workflows/update-model-info.yml b/.github/workflows/update-model-info.yml deleted file mode 100644 index d262685693..0000000000 --- a/.github/workflows/update-model-info.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: Update model info - -on: - push: - branches: - - "main" - - "7.*" - paths: - - 'specification/**' - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Use Node.js 14.x - uses: actions/setup-node@v1 - with: - node-version: 14.x - - - name: Install - run: | - npm install --prefix compiler - - - name: Update model info - run: | - npm run generate-schema --prefix compiler - - - uses: stefanzweifel/git-auto-commit-action@v4 - with: - commit_message: Update model info - push_options: --force-with-lease - file_pattern: output/schema/schema.json - diff --git a/.github/workflows/update-rest-api-json.yml b/.github/workflows/update-rest-api-json.yml index ddfb3c5339..1b6de3d689 100644 --- a/.github/workflows/update-rest-api-json.yml +++ b/.github/workflows/update-rest-api-json.yml @@ -9,37 +9,51 @@ jobs: update-rest-api: name: Update rest-api-spec runs-on: ubuntu-latest + + strategy: + matrix: + branch: ['main', '8.1', '8.0', '7.17'] + steps: - uses: actions/checkout@v2 + with: + ref: ${{ matrix.branch }} - - name: Use Node.js 14.x + - name: Use Node.js 16.x uses: actions/setup-node@v1 with: - node-version: 14.x + node-version: 16.x - name: Install deps run: | npm install --prefix .github/download-artifacts npm install --prefix compiler npm install --prefix typescript-generator - - name: Download artifacts run: | - node .github/download-artifacts/index.js --version 7.x-SNAPSHOT - + node .github/download-artifacts/index.js --branch ${{ matrix.branch }} - name: Generate output run: | SKIP_VERSION_UPDATE=true make contrib - - name: Debug git status run: | git status --porcelain - - name: Create Pull Request uses: peter-evans/create-pull-request@v3 with: - title: 'Update rest-api-spec' + title: Update rest-api-spec ${{ matrix.branch }} body: 'As titled.' commit-message: 'Update rest-api-spec' + labels: specification delete-branch: true team-reviewers: elastic/clients-team + branch: automated/rest-api-spec-update-${{ matrix.branch }} + + - name: Open an issue if the action fails + if: ${{ failure() }} + uses: nashmaniac/create-issue-action@v1.1 + with: + title: rest-api-spec update failed + token: ${{ secrets.GITHUB_TOKEN }} + labels: bug + body: The rest-api-spec action is currently failing, see [here](https://github.com/elastic/elasticsearch-specification/actions/workflows/update-rest-api-json.yml). diff --git a/.gitignore b/.gitignore index 8ad162ce39..126fc4a283 100644 --- a/.gitignore +++ b/.gitignore @@ -42,10 +42,22 @@ dist/ flight-recorder-generator/output *.d.ts java-generator/*.js -package-lock.json specification/**/*.js specification/lib .DS_Store artifacts +.github/download-artifacts/package-lock.json + +.validation.json +compiler/lib +typescript-generator/lib + +report +output/schema/import-* +output/schema/schema-no-generics.json +.github/**/package-lock.json + +# Editor lockfiles +.*.swp diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000000..b6a7d89c68 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +16 diff --git a/Makefile b/Makefile index 2ea0278b9b..246601eacd 100644 --- a/Makefile +++ b/Makefile @@ -1,24 +1,10 @@ SHELL := /bin/bash -validation-all: ## Run Validation on all Endpoints - @echo ">> running validations for all endpoints .." - ./run-validations.sh +validate: ## Validate a given endpoint request or response + @node compiler/run-validations.js --api $(api) --type $(type) --stack-version $(stack-version) -validation-all-fresh: ## Run Validation on all Endpoints with a fresh setup - @echo ">> running validations for all endpoints .." - PULL_LATEST=true ./run-validations.sh - -validation-api: ## Validate Endpoint with param: api= - @echo ">> validating request and response of Endpoint: $(api)" - ./run-validations.sh --api $(api) - -validation-api-request: ## Validate request of Endpoint with param: api= - @echo ">> validating request of Endpoint: $(api)" - ./run-validations.sh --api $(api) --request - -validation-api-response: ## Validate response of Endpoint with param: api= - @echo ">> validating response of Endpoint: $(api)" - ./run-validations.sh --api $(api) --response +validate-no-cache: ## Validate a given endpoint request or response without local cache + @node compiler/run-validations.js --api $(api) --type $(type) --stack-version $(stack-version) --no-cache license-check: ## Add the license headers to the files @echo ">> checking license headers .." @@ -48,10 +34,16 @@ spec-imports-fix: ## Fix the TypeScript imports spec-dangling-types: ## Generate the dangling types rreport @npm run generate-dangling --prefix compiler -setup-env: ## Install dependencies for contrib target +setup: ## Install dependencies for contrib target + @node compiler/check-node.js + @make clean-dep @npm install --prefix compiler @npm install --prefix typescript-generator +clean-dep: ## Clean npm dependencies + @rm -rf compiler/node_modules + @rm -rf typescript-generator/node_modules + contrib: | spec-generate license-check spec-format-fix ## Pre contribution target help: ## Display help diff --git a/README.md b/README.md index 79121a921e..c1afdef6ee 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,14 @@ to install and configure Node.js in your development environment. You can install Node.js with [`nvm`](https://github.com/nvm-sh/nvm): ```sh -curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash ``` -Once the installation is completed, install Node.js v14: +Once the installation is completed, install Node.js with `nvm`: ```sh -nvm install 14 +# this command will install the version configured in .nvmrc +nvm install ``` ## How to generate the JSON representation @@ -32,7 +33,7 @@ nvm install 14 $ git clone https://github.com/elastic/elasticsearch-specification.git # install the dependencies -$ npm install --prefix specification +$ make setup # generate the JSON representation $ npm run generate-schema --prefix specification @@ -48,11 +49,8 @@ $ cat output/schema/schema.json ``` Usage: make - validation-all Run Validation on all Endpoints - validation-all-fresh Run Validation on all Endpoints with a fresh setup - validation-api Validate Endpoint with param: api= - validation-api-request Validate request of Endpoint with param: api= - validation-api-response Validate response of Endpoint with param: api= + validate Validate a given endpoint request or response + validate-no-cache Validate a given endpoint request or response without local cache license-check Add the license headers to the files license-add Add the license headers to the files spec-format-check Check specification formatting rules @@ -62,6 +60,7 @@ Usage: spec-imports-fix Fix the TypeScript imports spec-dangling-types Generate the dangling types rreport setup-env Install dependencies for contrib target + clean-dep Clean npm dependencies contrib Pre contribution target help Display help ``` @@ -191,39 +190,32 @@ git clone https://github.com/elastic/elasticsearch-specification.git git clone https://github.com/elastic/clients-flight-recorder.git cd elasticsearch-specification -STACK_VERSION=... ./run-validations.sh +# this will validate the xpack.info request type against the 8.1.0 stack version +make validate api=xpack.info type=request stack-version=8.1.0-SNAPSHOT + +# this will validate the xpack.info request and response types against the 8.1.0 stack version +make validate api=xpack.info stack-version=8.1.0-SNAPSHOT ``` The last command above will install all the dependencies and run, download the test recordings and finally validate the specification. -If you need to download the recordings again, run `STACK_VERSION=... PULL_LATEST=true ./run-validations.sh`. - -You can validate a specific API with the `--api` option, same goes for `--request` and `--response`. -For example, the following command validates the index request api: - -```js -STACK_VERSION=... ./run-validations.sh --api index --request -``` -The following command validates the index response api: - -```js -STACK_VERSION=... ./run-validations.sh --api index --response -``` -The following command validates the index request and response api: - -```js -STACK_VERSION=... ./run-validations.sh --api index --request --response -``` +If you need to download the recordings again, run `make validate-no-cache api=xpack.info type=request stack-version=8.1.0-SNAPSHOT`. Once you see the errors, you can fix the original definition in `/specification` and then run the command again until the types validator does not trigger any new error. Finally open a pull request with your changes. -Namespaced APIs can be validated in the same way, for example: +## Documentation -```js -STACK_VERSION=... ./run-validations.sh --api cat.health --request -``` +- [How to add a new API](./docs/add-new-api.md) +- [Behaviors](./docs/behaviors.md) +- [Compiler](./docs/compiler.md) +- [Documenting the API specification](./docs/doc-comments-guide.md) +- [Known issues](./docs/known-issues.md) +- [Modeling Guide](./docs/modeling-guide.md) +- [Specification structure](./docs/specification-structure.md) +- [Style Guide](./docs/style-guide.md) +- [Fixing a defintion, a complete story](./docs/validation-example.md) ## FAQ @@ -259,12 +251,7 @@ You should copy from there the updated endpoint defintion and change it here. ### The validation in broken on GitHub but works on my machine! -Very likely the recordings on your machine are stale, you can download -the latest version with: - -```sh -STACK_VERSION=... PULL_LATEST=true ./run-validations.sh -``` +Very likely the recordings on your machine are stale, rerun the validation with the `validate-no-cache` make target. You should pull the latest change from the `client-flight-recorder` as well. @@ -299,7 +286,7 @@ If you are using MacOS, run the following command to fix the issue: brew install coreutils ``` -### The `recordings-dev` folder contains a zip file and not the `tmp-*` folders +### The `recordings` folder contains a zip file and not the `tmp-*` folders Very likely your system does not have the `zip` command installed. ```sh diff --git a/compiler/.prettierrc.json b/compiler/.prettierrc.json index da6b628804..58a27f3181 100644 --- a/compiler/.prettierrc.json +++ b/compiler/.prettierrc.json @@ -6,5 +6,6 @@ "singleQuote": true, "quoteProps": "as-needed", "bracketSpacing": true, - "endOfLine": "lf" + "endOfLine": "lf", + "bracketSameLine": true } diff --git a/compiler/check-node.js b/compiler/check-node.js new file mode 100644 index 0000000000..e9f1f5856d --- /dev/null +++ b/compiler/check-node.js @@ -0,0 +1,30 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +const { readFileSync } = require('fs') +const { join } = require('path') + +const nvmrc = readFileSync(join(__dirname, '..', '.nvmrc'), 'utf8') +const nodejsMajor = process.version.split('.').shift()?.slice(1) +const nvmMajor = nvmrc.trim().split('.').shift() + +if (nodejsMajor !== nvmMajor) { + console.error(`Bad nodejs major version, you are using ${nodejsMajor}, while ${nvmMajor} should be used. Run 'nvm install' to fix this.`) + process.exit(1) +} diff --git a/compiler/package-lock.json b/compiler/package-lock.json new file mode 100644 index 0000000000..d7304da1a1 --- /dev/null +++ b/compiler/package-lock.json @@ -0,0 +1,6515 @@ +{ + "name": "elasticsearch-client-specification", + "version": "0.0.1", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "elasticsearch-client-specification", + "version": "0.0.1", + "license": "Apache-2.0", + "dependencies": { + "chalk": "^4.1.2", + "fastest-levenshtein": "^1.0.12", + "ora": "^5.4.1", + "safe-stable-stringify": "^2.3.1", + "semver": "^7.3.5", + "ts-morph": "^13.0.3", + "zx": "^4.3.0" + }, + "devDependencies": { + "@types/node": "^17.0.12", + "minimist": "^1.2.5", + "prettier": "2.5.1", + "ts-node": "^10.4.0", + "ts-standard": "^11.0.0", + "typescript": "^4.5.5" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "dependencies": { + "@babel/highlight": "^7.10.4" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.16.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz", + "integrity": "sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.16.10", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.10.tgz", + "integrity": "sha512-5FnTQLSLswEj6IkgVw5KusNUUFY9ZGqe/TRFnP/BKYHYgfh7tc+C7mwiy95/yNP7Dh9x580Vv8r7u7ZfTBFxdw==", + "dev": true, + "dependencies": { + "@babel/helper-validator-identifier": "^7.16.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight/node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/@babel/highlight/node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "node_modules/@babel/highlight/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/@babel/highlight/node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@cspotcode/source-map-consumer": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", + "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "dev": true, + "engines": { + "node": ">= 12" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", + "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-consumer": "0.8.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", + "integrity": "sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw==", + "dev": true, + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.5.0.tgz", + "integrity": "sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==", + "dev": true, + "dependencies": { + "@humanwhocodes/object-schema": "^1.2.0", + "debug": "^4.1.1", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz", + "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==", + "dev": true + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@ts-morph/common": { + "version": "0.12.3", + "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.12.3.tgz", + "integrity": "sha512-4tUmeLyXJnJWvTFOKtcNJ1yh0a3SsTLi2MUoyj8iUNznFRN1ZquaNe7Oukqrnki2FzZkm0J9adCNLDZxUzvj+w==", + "dependencies": { + "fast-glob": "^3.2.7", + "minimatch": "^3.0.4", + "mkdirp": "^1.0.4", + "path-browserify": "^1.0.1" + } + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", + "integrity": "sha512-6XFfSQmMgq0CFLY1MslA/CPUfhIL919M1rMsa5lP2P097N2Wd1sSX0tx1u4olM16fLNhtHZpRhedZJphNJqmZg==", + "dev": true + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.9.tgz", + "integrity": "sha512-/yBMcem+fbvhSREH+s14YJi18sp7J9jpuhYByADT2rypfajMZZN4WQ6zBGgBKp53NKmqI36wFYDb3yaMPurITw==", + "dev": true + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.1.tgz", + "integrity": "sha512-509r2+yARFfHHE7T6Puu2jjkoycftovhXRqW328PDXTVGKihlb1P8Z9mMZH04ebyajfRY7dedfGynlrFHJUQCg==", + "dev": true + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.2.tgz", + "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", + "dev": true + }, + "node_modules/@types/fs-extra": { + "version": "9.0.13", + "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", + "integrity": "sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", + "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==", + "dev": true + }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", + "dev": true + }, + "node_modules/@types/minimist": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.2.tgz", + "integrity": "sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ==" + }, + "node_modules/@types/node": { + "version": "17.0.12", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.12.tgz", + "integrity": "sha512-4YpbAsnJXWYK/fpTVFlMIcUIho2AYCi4wg5aNPrG1ng7fn/1/RZfCIpRCiBX+12RVa34RluilnvCqD+g3KiSiA==" + }, + "node_modules/@types/node-fetch": { + "version": "2.5.12", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.12.tgz", + "integrity": "sha512-MKgC4dlq4kKNa/mYrwpKfzQMB5X3ee5U6fSprkKpToBqBmX4nFZL9cW5jl6sWn+xpRJ7ypWh2yyqqr8UUCstSw==", + "dependencies": { + "@types/node": "*", + "form-data": "^3.0.0" + } + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.33.0.tgz", + "integrity": "sha512-aINiAxGVdOl1eJyVjaWn/YcVAq4Gi/Yo35qHGCnqbWVz61g39D0h23veY/MA0rFFGfxK7TySg2uwDeNv+JgVpg==", + "dev": true, + "dependencies": { + "@typescript-eslint/experimental-utils": "4.33.0", + "@typescript-eslint/scope-manager": "4.33.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "ignore": "^5.1.8", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/experimental-utils": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.33.0.tgz", + "integrity": "sha512-zeQjOoES5JFjTnAhI5QY7ZviczMzDptls15GFsI6jyUOq0kOf9+WonkhtlIhh0RgHRnqj5gdNxW5j1EvAyYg6Q==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "*" + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.33.0.tgz", + "integrity": "sha512-ZohdsbXadjGBSK0/r+d87X0SBmKzOq4/S5nzK6SBgJspFo9/CUDJ7hjayuze+JK7CZQLDMroqytp7pOcFKTxZA==", + "dev": true, + "dependencies": { + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "debug": "^4.3.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.33.0.tgz", + "integrity": "sha512-5IfJHpgTsTZuONKbODctL4kKuQje/bzBRkwHE8UOZ4f89Zeddg+EGZs8PD8NcN4LdM3ygHWYB3ukPAYjvl/qbQ==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/types": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.33.0.tgz", + "integrity": "sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ==", + "dev": true, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.33.0.tgz", + "integrity": "sha512-rkWRY1MPFzjwnEVHsxGemDzqqddw2QbTJlICPD9p9I9LfsO8fdmfQPOX3uKfUaGRDFJbfrtm/sXhVXN4E+bzCA==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz", + "integrity": "sha512-uqi/2aSz9g2ftcHWf8uLPJA70rUv6yuMW5Bohw+bwcuzaxQIHaKFZCKGoGXIrc9vkTJ3+0txM73K0Hq3d5wgIg==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.33.0", + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/acorn": { + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", + "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/array-includes": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", + "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "is-string": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz", + "integrity": "sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flatmap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", + "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/bl": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", + "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "dependencies": { + "buffer": "^5.5.0", + "inherits": "^2.0.4", + "readable-stream": "^3.4.0" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dependencies": { + "fill-range": "^7.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/buffer": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", + "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.1.13" + } + }, + "node_modules/call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "dependencies": { + "restore-cursor": "^3.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cli-spinners": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.6.1.tgz", + "integrity": "sha512-x/5fWmGMnbKQAaNwN+UZlV79qBLM9JFnJuJ03gIi5whrob0xV0ofNVHy9DhwGdsMJQc2OKv0oGmLzvaqvAVv+g==", + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/clone": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", + "integrity": "sha1-2jCcwmPfFZlMaIypAheco8fNfH4=", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/code-block-writer": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-11.0.0.tgz", + "integrity": "sha512-GEqWvEWWsOvER+g9keO4ohFoD3ymwyCnqY3hoTr7GZipYFwEhMHJw+TtV0rfgRhNImM6QWZGO2XYjlJVyYT62w==", + "dependencies": { + "tslib": "2.3.1" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" + }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/debug": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz", + "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true + }, + "node_modules/defaults": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.3.tgz", + "integrity": "sha1-xlYFHpgX2f8I7YgUd/P+QBnz730=", + "dependencies": { + "clone": "^1.0.2" + } + }, + "node_modules/define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "dependencies": { + "object-keys": "^1.0.12" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/duplexer": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", + "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==" + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "node_modules/enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "dependencies": { + "ansi-colors": "^4.1.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-abstract": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz", + "integrity": "sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "get-symbol-description": "^1.0.0", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "is-callable": "^1.2.4", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.1", + "is-string": "^1.0.7", + "is-weakref": "^1.0.1", + "object-inspect": "^1.11.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint": { + "version": "7.32.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.32.0.tgz", + "integrity": "sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA==", + "dev": true, + "dependencies": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.3", + "@humanwhocodes/config-array": "^0.5.0", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-config-standard": { + "version": "16.0.3", + "resolved": "https://registry.npmjs.org/eslint-config-standard/-/eslint-config-standard-16.0.3.tgz", + "integrity": "sha512-x4fmJL5hGqNJKGHSjnLdgA6U6h1YW/G2dW9fA+cyVur4SK6lyue8+UgNKWlZtUDTXvgKDD/Oa3GQjmB5kjtVvg==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "peerDependencies": { + "eslint": "^7.12.1", + "eslint-plugin-import": "^2.22.1", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^4.2.1 || ^5.0.0" + } + }, + "node_modules/eslint-config-standard-jsx": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-jsx/-/eslint-config-standard-jsx-10.0.0.tgz", + "integrity": "sha512-hLeA2f5e06W1xyr/93/QJulN/rLbUVUmqTlexv9PRKHFwEC9ffJcH2LvJhMoEqYQBEYafedgGZXH2W8NUpt5lA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "peerDependencies": { + "eslint": "^7.12.1", + "eslint-plugin-react": "^7.21.5" + } + }, + "node_modules/eslint-config-standard-with-typescript": { + "version": "21.0.1", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-21.0.1.tgz", + "integrity": "sha512-FeiMHljEJ346Y0I/HpAymNKdrgKEpHpcg/D93FvPHWfCzbT4QyUJba/0FwntZeGLXfUiWDSeKmdJD597d9wwiw==", + "dev": true, + "dependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint-config-standard": "^16.0.0" + }, + "peerDependencies": { + "@typescript-eslint/eslint-plugin": "^4.0.1", + "eslint": "^7.12.1", + "eslint-plugin-import": "^2.22.1", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^4.2.1 || ^5.0.0", + "typescript": "^3.9 || ^4.0.0" + } + }, + "node_modules/eslint-import-resolver-node": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz", + "integrity": "sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw==", + "dev": true, + "dependencies": { + "debug": "^3.2.7", + "resolve": "^1.20.0" + } + }, + "node_modules/eslint-import-resolver-node/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-module-utils": { + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.2.tgz", + "integrity": "sha512-zquepFnWCY2ISMFwD/DqzaM++H+7PDzOpUvotJWm/y1BAFt5R4oeULgdrTejKqLkz7MA/tgstsUMNYc7wNdTrg==", + "dev": true, + "dependencies": { + "debug": "^3.2.7", + "find-up": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-es": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-3.0.1.tgz", + "integrity": "sha512-GUmAsJaN4Fc7Gbtl8uOBlayo2DqhwWvEzykMHSCZHU3XdJ+NSzzZcVhXh3VxX5icqQ+oQdIEawXX8xkR3mIFmQ==", + "dev": true, + "dependencies": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=4.19.1" + } + }, + "node_modules/eslint-plugin-es/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint-plugin-es/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-plugin-import": { + "version": "2.25.4", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz", + "integrity": "sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.4", + "array.prototype.flat": "^1.2.5", + "debug": "^2.6.9", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.6", + "eslint-module-utils": "^2.7.2", + "has": "^1.0.3", + "is-core-module": "^2.8.0", + "is-glob": "^4.0.3", + "minimatch": "^3.0.4", + "object.values": "^1.1.5", + "resolve": "^1.20.0", + "tsconfig-paths": "^3.12.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8" + } + }, + "node_modules/eslint-plugin-import/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "dev": true + }, + "node_modules/eslint-plugin-node": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz", + "integrity": "sha512-oUwtPJ1W0SKD0Tr+wqu92c5xuCeQqB3hSCHasn/ZgjFdA9iDGNkNf2Zi9ztY7X+hNuMib23LNGRm6+uN+KLE3g==", + "dev": true, + "dependencies": { + "eslint-plugin-es": "^3.0.0", + "eslint-utils": "^2.0.0", + "ignore": "^5.1.1", + "minimatch": "^3.0.4", + "resolve": "^1.10.1", + "semver": "^6.1.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "peerDependencies": { + "eslint": ">=5.16.0" + } + }, + "node_modules/eslint-plugin-node/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint-plugin-node/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-plugin-node/node_modules/semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/eslint-plugin-promise": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-5.2.0.tgz", + "integrity": "sha512-SftLb1pUG01QYq2A/hGAWfDRXqYD82zE7j7TopDOyNdU+7SvvoXREls/+PRTY17vUXzXnZA/zfnyKgRH6x4JJw==", + "dev": true, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "peerDependencies": { + "eslint": "^7.0.0" + } + }, + "node_modules/eslint-plugin-react": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.28.0.tgz", + "integrity": "sha512-IOlFIRHzWfEQQKcAD4iyYDndHwTQiCMcJVJjxempf203jnNLUnW34AXLrV33+nEXoifJE2ZEGmcjKPL8957eSw==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.4", + "array.prototype.flatmap": "^1.2.5", + "doctrine": "^2.1.0", + "estraverse": "^5.3.0", + "jsx-ast-utils": "^2.4.1 || ^3.0.0", + "minimatch": "^3.0.4", + "object.entries": "^1.1.5", + "object.fromentries": "^2.0.5", + "object.hasown": "^1.1.0", + "object.values": "^1.1.5", + "prop-types": "^15.7.2", + "resolve": "^2.0.0-next.3", + "semver": "^6.3.0", + "string.prototype.matchall": "^4.0.6" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8" + } + }, + "node_modules/eslint-plugin-react/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-plugin-react/node_modules/resolve": { + "version": "2.0.0-next.3", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.3.tgz", + "integrity": "sha512-W8LucSynKUIDu9ylraa7ueVZ7hc0uAgJBxVsQSKOXOyle8a93qXhcz+XAXZ8bIq2d6i4Ehddn6Evt+0/UwKk6Q==", + "dev": true, + "dependencies": { + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/eslint-plugin-react/node_modules/semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/eslint-scope/node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint/node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "dependencies": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/espree/node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/espree/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/event-stream": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/event-stream/-/event-stream-3.3.4.tgz", + "integrity": "sha1-SrTJoPWlTbkzi0w02Gv86PSzVXE=", + "dependencies": { + "duplexer": "~0.1.1", + "from": "~0", + "map-stream": "~0.1.0", + "pause-stream": "0.0.11", + "split": "0.3", + "stream-combiner": "~0.0.4", + "through": "~2.3.1" + } + }, + "node_modules/fast-deep-equal": { + "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 + }, + "node_modules/fast-glob": { + "version": "3.2.11", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.11.tgz", + "integrity": "sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew==", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true + }, + "node_modules/fastest-levenshtein": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/fastest-levenshtein/-/fastest-levenshtein-1.0.12.tgz", + "integrity": "sha512-On2N+BpYJ15xIC974QNVuYGMOlEVt4s0EOI3wwMqOmK1fdDY+FN/zltPV8vosq4ad4c/gJ1KHScUn/6AWIgiow==" + }, + "node_modules/fastq": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", + "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-up": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", + "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", + "dev": true, + "dependencies": { + "locate-path": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "dependencies": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flatted": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.4.tgz", + "integrity": "sha512-8/sOawo8tJ4QOBX8YlQBMxL8+RLZfxMQOif9o0KUKTNTjMYElWPE0r/m5VNFxTRd0NSw8qSy8dajrwX4RYI1Hw==", + "dev": true + }, + "node_modules/form-data": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz", + "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/from": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/from/-/from-0.1.7.tgz", + "integrity": "sha1-g8YK/Fi5xWmXAH7Rp2izqzA6RP4=" + }, + "node_modules/fs-extra": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz", + "integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "node_modules/function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "node_modules/functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, + "node_modules/get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-stdin": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz", + "integrity": "sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/get-symbol-description": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", + "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/globals": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.12.0.tgz", + "integrity": "sha512-uS8X6lSKN2JumVoXrbUz+uG4BYG+eiawqm3qFcT7ammfbUHeCBoJMlHcec/S3krSk73/AE/f0szYFmgAA3kYZg==", + "dev": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.9", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.9.tgz", + "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==" + }, + "node_modules/has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", + "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/ignore": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", + "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "engines": { + "node": ">= 4" + } + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", + "dev": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + }, + "node_modules/internal-slot": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz", + "integrity": "sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.1.0", + "has": "^1.0.3", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "node_modules/is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "dependencies": { + "has-bigints": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", + "integrity": "sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-core-module": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", + "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "dev": true, + "dependencies": { + "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-interactive": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", + "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-negative-zero": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", + "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-number-object": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz", + "integrity": "sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", + "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-unicode-supported": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", + "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=" + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-parse-better-errors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", + "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", + "dev": true + }, + "node_modules/json5": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", + "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "dev": true, + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsx-ast-utils": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.1.tgz", + "integrity": "sha512-uP5vu8xfy2F9A6LGC22KO7e2/vGTS1MhP+18f++ZNlf0Ohaxbc9nIEwHAsejlJKyzfZzU5UIhe5ItYkitcZnZA==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.3", + "object.assign": "^4.1.2" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/load-json-file": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-5.3.0.tgz", + "integrity": "sha512-cJGP40Jc/VXUsp8/OrnyKyTZ1y6v/dphm3bioS+RrKXjK2BB6wHUd6JptZEFDGgGahMT+InnZO5i1Ei9mpC8Bw==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.15", + "parse-json": "^4.0.0", + "pify": "^4.0.1", + "strip-bom": "^3.0.0", + "type-fest": "^0.3.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/load-json-file/node_modules/type-fest": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.3.1.tgz", + "integrity": "sha512-cUGJnCdr4STbePCgqNFbpVNCepa+kAVohJs1sLhxzdH+gnEoOd8VhbYa7pD3zZYGiURWM2xzEII3fQcRizDkYQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/locate-path": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", + "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", + "dev": true, + "dependencies": { + "p-locate": "^2.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "node_modules/lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true + }, + "node_modules/log-symbols": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", + "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "dependencies": { + "chalk": "^4.1.0", + "is-unicode-supported": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, + "node_modules/map-stream": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/map-stream/-/map-stream-0.1.0.tgz", + "integrity": "sha1-5WqpTEyAVaFkBKBnS3jyFffI4ZQ=" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dependencies": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime-db": { + "version": "1.51.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.51.0.tgz", + "integrity": "sha512-5y8A56jg7XVQx2mbv1lu49NR4dokRnhZYTtL+KGfaa27uq4pSTXkwQkFJl4pkRMyNFz/EtYDSkiiEHx3F7UN6g==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.34", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.34.tgz", + "integrity": "sha512-6cP692WwGIs9XXdOO4++N+7qjqv0rqxxVvJ3VHPh/Sc9mVZcQP+ZGhkKiTvWMQRr2tbHkJP/Yn7Y0npb3ZBs4A==", + "dependencies": { + "mime-db": "1.51.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "engines": { + "node": ">=6" + } + }, + "node_modules/minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==" + }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", + "dev": true + }, + "node_modules/node-fetch": { + "version": "2.6.7", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", + "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.0.tgz", + "integrity": "sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.entries": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.5.tgz", + "integrity": "sha512-TyxmjUoZggd4OrrU1W66FMDG6CuqJxsFvymeyXI51+vQLN67zYfZseptRge703kKQdo4uccgAKebXFcRCzk4+g==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.fromentries": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.5.tgz", + "integrity": "sha512-CAyG5mWQRRiBU57Re4FKoTBjXfDoNwdFVH2Y1tS9PqCsfUTymAohOkEMSG3aRNKmv4lV3O7p1et7c187q6bynw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.hasown": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", + "integrity": "sha512-MhjYRfj3GBlhSkDHo6QmvgjRLXQ2zndabdf3nX0yTyZK9rPfxb6uRpAac8HXNLy1GpqWtZ81Qh4v3uOls2sRAg==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.values": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz", + "integrity": "sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/ora": { + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", + "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "dependencies": { + "bl": "^4.1.0", + "chalk": "^4.1.0", + "cli-cursor": "^3.1.0", + "cli-spinners": "^2.5.0", + "is-interactive": "^1.0.0", + "is-unicode-supported": "^0.1.0", + "log-symbols": "^4.1.0", + "strip-ansi": "^6.0.0", + "wcwidth": "^1.0.1" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-limit": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", + "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", + "dev": true, + "dependencies": { + "p-try": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/p-locate": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", + "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", + "dev": true, + "dependencies": { + "p-limit": "^1.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/p-try": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", + "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", + "dev": true, + "dependencies": { + "error-ex": "^1.3.1", + "json-parse-better-errors": "^1.0.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==" + }, + "node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "engines": { + "node": ">=8" + } + }, + "node_modules/pause-stream": { + "version": "0.0.11", + "resolved": "https://registry.npmjs.org/pause-stream/-/pause-stream-0.0.11.tgz", + "integrity": "sha1-/lo0sMvOErWqaitAPuLnO2AvFEU=", + "dependencies": { + "through": "~2.3" + } + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pkg-conf/-/pkg-conf-3.1.0.tgz", + "integrity": "sha512-m0OTbR/5VPNPqO1ph6Fqbj7Hv6QU7gR/tQW40ZqrL1rjgCU85W6C1bJn0BItuJqnR98PWzw7Z8hHeChD1WrgdQ==", + "dev": true, + "dependencies": { + "find-up": "^3.0.0", + "load-json-file": "^5.2.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-conf/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/prettier": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.5.1.tgz", + "integrity": "sha512-vBZcPRUR5MZJwoyi3ZoyQlc1rXeEck8KgeC9AwwOn+exuxLxq5toTRDTSaVrXHxelDMHy9zlicw8u66yxoSUFg==", + "dev": true, + "bin": { + "prettier": "bin-prettier.js" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dev": true, + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "node_modules/ps-tree": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/ps-tree/-/ps-tree-1.2.0.tgz", + "integrity": "sha512-0VnamPPYHl4uaU/nSFeZZpR21QAWRz+sRv4iW9+v/GS/J5U5iZB5BNN6J0RMoOvdx2gWM2+ZFMIm58q24e4UYA==", + "dependencies": { + "event-stream": "=3.3.4" + }, + "bin": { + "ps-tree": "bin/ps-tree.js" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "dev": true + }, + "node_modules/readable-stream": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", + "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/regexp.prototype.flags": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", + "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "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==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/resolve": { + "version": "1.22.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz", + "integrity": "sha512-Hhtrw0nLeSrFQ7phPp4OOcVjLPIeMnRlr5mcnVuMe7M/7eBn98A3hmFRLoFo3DLZkivSYwhRUJTyPyWAk56WLw==", + "dev": true, + "dependencies": { + "is-core-module": "^2.8.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "dependencies": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safe-stable-stringify": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.3.1.tgz", + "integrity": "sha512-kYBSfT+troD9cDA85VDnHZ1rpHC50O0g1e6WlGHVCz/g+JS+9WKLj+XwFYyR8UbrZN8ll9HUpDAAddY58MGisg==", + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.6.tgz", + "integrity": "sha512-sDl4qMFpijcGw22U5w63KmD3cZJfBuFlVNbVMKje2keoKML7X2UzWbc4XrmEbDwg0NXJc3yv4/ox7b+JWb57kQ==" + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/split": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/split/-/split-0.3.3.tgz", + "integrity": "sha1-zQ7qXmOiEd//frDwkcQTPi0N0o8=", + "dependencies": { + "through": "2" + }, + "engines": { + "node": "*" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true + }, + "node_modules/standard-engine": { + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/standard-engine/-/standard-engine-14.0.1.tgz", + "integrity": "sha512-7FEzDwmHDOGva7r9ifOzD3BGdTbA7ujJ50afLVdW/tK14zQEptJjbFuUfn50irqdHDcTbNh0DTIoMPynMCXb0Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "xdg-basedir": "^4.0.0" + }, + "engines": { + "node": ">=8.10" + } + }, + "node_modules/stream-combiner": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/stream-combiner/-/stream-combiner-0.0.4.tgz", + "integrity": "sha1-TV5DPBhSYd3mI8o/RMWGvPXErRQ=", + "dependencies": { + "duplexer": "~0.1.1" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string.prototype.matchall": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.6.tgz", + "integrity": "sha512-6WgDX8HmQqvEd7J+G6VtAahhsQIssiZ8zl7zKh1VDMFyL3hRTJP4FTNA3RbIp2TOQ9AYNDcc7e3fH0Qbup+DBg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "regexp.prototype.flags": "^1.3.1", + "side-channel": "^1.0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/table": { + "version": "6.8.0", + "resolved": "https://registry.npmjs.org/table/-/table-6.8.0.tgz", + "integrity": "sha512-s/fitrbVeEyHKFa7mFdkuQMWlH1Wgw/yEXMt5xACT4ZpzWFluehAxRtUUQKPuWhaLAWhFcVx6w3oC8VKaUfPGA==", + "dev": true, + "dependencies": { + "ajv": "^8.0.1", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.3", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/table/node_modules/ajv": { + "version": "8.9.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.9.0.tgz", + "integrity": "sha512-qOKJyNj/h+OWx7s5DePL6Zu1KeM9jPZhwBqs+7DzP6bGOvqzVCSf0xueYmVuaC/oQ/VtS2zLMLHdQFbkka+XDQ==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/table/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==", + "dev": true + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true + }, + "node_modules/through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=" + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o=" + }, + "node_modules/ts-morph": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-13.0.3.tgz", + "integrity": "sha512-pSOfUMx8Ld/WUreoSzvMFQG5i9uEiWIsBYjpU9+TTASOeUa89j5HykomeqVULm1oqWtBdleI3KEFRLrlA3zGIw==", + "dependencies": { + "@ts-morph/common": "~0.12.3", + "code-block-writer": "^11.0.0" + } + }, + "node_modules/ts-node": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.4.0.tgz", + "integrity": "sha512-g0FlPvvCXSIO1JDF6S232P5jPYqBkRL9qly81ZgAOSU7rwI0stphCgd2kLiCrU9DjQCrJMWEqcNSjQL02s6d8A==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-support": "0.7.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/ts-standard": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/ts-standard/-/ts-standard-11.0.0.tgz", + "integrity": "sha512-fe+PCOM6JTMIcG1Smr8BQJztUi3dc/SDJMqezxNAL8pe/0+h0shK0+fNPTuF1hMVMYO+O53Wtp9WQHqj0GJtMw==", + "dev": true, + "dependencies": { + "@typescript-eslint/eslint-plugin": "^4.26.1", + "eslint": "^7.28.0", + "eslint-config-standard": "^16.0.3", + "eslint-config-standard-jsx": "^10.0.0", + "eslint-config-standard-with-typescript": "^21.0.1", + "eslint-plugin-import": "^2.23.4", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^5.1.0", + "eslint-plugin-react": "^7.24.0", + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "standard-engine": "^14.0.1" + }, + "bin": { + "ts-standard": "bin/cmd.js" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "typescript": ">=3.8" + } + }, + "node_modules/tsconfig-paths": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.12.0.tgz", + "integrity": "sha512-e5adrnOYT6zqVnWqZu7i/BQ3BnhzvGbjEjejFXO20lKIKpwTaupkCPgEfv4GZK1IBciJUEhYs3J3p75FdaTFVg==", + "dev": true, + "dependencies": { + "@types/json5": "^0.0.29", + "json5": "^1.0.1", + "minimist": "^1.2.0", + "strip-bom": "^3.0.0" + } + }, + "node_modules/tslib": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", + "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==" + }, + "node_modules/tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "dependencies": { + "tslib": "^1.8.1" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" + } + }, + "node_modules/tsutils/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typescript": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", + "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=" + }, + "node_modules/v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true + }, + "node_modules/wcwidth": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", + "integrity": "sha1-8LDc+RW8X/FSivrbLA4XtTLaL+g=", + "dependencies": { + "defaults": "^1.0.3" + } + }, + "node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=" + }, + "node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "node_modules/xdg-basedir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", + "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/zx": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/zx/-/zx-4.3.0.tgz", + "integrity": "sha512-KuEjpu5QFIMx0wWfzknDRhY98s7a3tWNRmYt19XNmB7AfOmz5zISA4+3Q8vlJc2qguxMn89uSxhPDCldPa3YLA==", + "dependencies": { + "@types/fs-extra": "^9.0.12", + "@types/minimist": "^1.2.2", + "@types/node": "^16.6", + "@types/node-fetch": "^2.5.12", + "chalk": "^4.1.2", + "fs-extra": "^10.0.0", + "globby": "^12.0.1", + "minimist": "^1.2.5", + "node-fetch": "^2.6.1", + "ps-tree": "^1.2.0", + "which": "^2.0.2" + }, + "bin": { + "zx": "zx.mjs" + }, + "engines": { + "node": ">= 14.13.1" + } + }, + "node_modules/zx/node_modules/@types/node": { + "version": "16.11.21", + "resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.21.tgz", + "integrity": "sha512-Pf8M1XD9i1ksZEcCP8vuSNwooJ/bZapNmIzpmsMaL+jMI+8mEYU3PKvs+xDNuQcJWF/x24WzY4qxLtB0zNow9A==" + }, + "node_modules/zx/node_modules/array-union": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-3.0.1.tgz", + "integrity": "sha512-1OvF9IbWwaeiM9VhzYXVQacMibxpXOMYVNIvMtKRyX9SImBXpKcFr8XvFDeEslCyuH/t6KRt7HEO94AlP8Iatw==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zx/node_modules/globby": { + "version": "12.2.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-12.2.0.tgz", + "integrity": "sha512-wiSuFQLZ+urS9x2gGPl1H5drc5twabmm4m2gTR27XDFyjUHJUNsS8o/2aKyIF6IoBaR630atdher0XJ5g6OMmA==", + "dependencies": { + "array-union": "^3.0.1", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.7", + "ignore": "^5.1.9", + "merge2": "^1.4.1", + "slash": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zx/node_modules/slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + } + }, + "dependencies": { + "@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "requires": { + "@babel/highlight": "^7.10.4" + } + }, + "@babel/helper-validator-identifier": { + "version": "7.16.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz", + "integrity": "sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw==", + "dev": true + }, + "@babel/highlight": { + "version": "7.16.10", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.10.tgz", + "integrity": "sha512-5FnTQLSLswEj6IkgVw5KusNUUFY9ZGqe/TRFnP/BKYHYgfh7tc+C7mwiy95/yNP7Dh9x580Vv8r7u7ZfTBFxdw==", + "dev": true, + "requires": { + "@babel/helper-validator-identifier": "^7.16.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "@cspotcode/source-map-consumer": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", + "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "dev": true + }, + "@cspotcode/source-map-support": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", + "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "dev": true, + "requires": { + "@cspotcode/source-map-consumer": "0.8.0" + } + }, + "@eslint/eslintrc": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", + "integrity": "sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw==", + "dev": true, + "requires": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "dependencies": { + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true + } + } + }, + "@humanwhocodes/config-array": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.5.0.tgz", + "integrity": "sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==", + "dev": true, + "requires": { + "@humanwhocodes/object-schema": "^1.2.0", + "debug": "^4.1.1", + "minimatch": "^3.0.4" + } + }, + "@humanwhocodes/object-schema": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz", + "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==", + "dev": true + }, + "@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "requires": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + } + }, + "@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==" + }, + "@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "requires": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + } + }, + "@ts-morph/common": { + "version": "0.12.3", + "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.12.3.tgz", + "integrity": "sha512-4tUmeLyXJnJWvTFOKtcNJ1yh0a3SsTLi2MUoyj8iUNznFRN1ZquaNe7Oukqrnki2FzZkm0J9adCNLDZxUzvj+w==", + "requires": { + "fast-glob": "^3.2.7", + "minimatch": "^3.0.4", + "mkdirp": "^1.0.4", + "path-browserify": "^1.0.1" + } + }, + "@tsconfig/node10": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", + "integrity": "sha512-6XFfSQmMgq0CFLY1MslA/CPUfhIL919M1rMsa5lP2P097N2Wd1sSX0tx1u4olM16fLNhtHZpRhedZJphNJqmZg==", + "dev": true + }, + "@tsconfig/node12": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.9.tgz", + "integrity": "sha512-/yBMcem+fbvhSREH+s14YJi18sp7J9jpuhYByADT2rypfajMZZN4WQ6zBGgBKp53NKmqI36wFYDb3yaMPurITw==", + "dev": true + }, + "@tsconfig/node14": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.1.tgz", + "integrity": "sha512-509r2+yARFfHHE7T6Puu2jjkoycftovhXRqW328PDXTVGKihlb1P8Z9mMZH04ebyajfRY7dedfGynlrFHJUQCg==", + "dev": true + }, + "@tsconfig/node16": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.2.tgz", + "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", + "dev": true + }, + "@types/fs-extra": { + "version": "9.0.13", + "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", + "integrity": "sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA==", + "requires": { + "@types/node": "*" + } + }, + "@types/json-schema": { + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", + "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==", + "dev": true + }, + "@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", + "dev": true + }, + "@types/minimist": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.2.tgz", + "integrity": "sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ==" + }, + "@types/node": { + "version": "17.0.12", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.12.tgz", + "integrity": "sha512-4YpbAsnJXWYK/fpTVFlMIcUIho2AYCi4wg5aNPrG1ng7fn/1/RZfCIpRCiBX+12RVa34RluilnvCqD+g3KiSiA==" + }, + "@types/node-fetch": { + "version": "2.5.12", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.12.tgz", + "integrity": "sha512-MKgC4dlq4kKNa/mYrwpKfzQMB5X3ee5U6fSprkKpToBqBmX4nFZL9cW5jl6sWn+xpRJ7ypWh2yyqqr8UUCstSw==", + "requires": { + "@types/node": "*", + "form-data": "^3.0.0" + } + }, + "@typescript-eslint/eslint-plugin": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.33.0.tgz", + "integrity": "sha512-aINiAxGVdOl1eJyVjaWn/YcVAq4Gi/Yo35qHGCnqbWVz61g39D0h23veY/MA0rFFGfxK7TySg2uwDeNv+JgVpg==", + "dev": true, + "requires": { + "@typescript-eslint/experimental-utils": "4.33.0", + "@typescript-eslint/scope-manager": "4.33.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "ignore": "^5.1.8", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + } + }, + "@typescript-eslint/experimental-utils": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.33.0.tgz", + "integrity": "sha512-zeQjOoES5JFjTnAhI5QY7ZviczMzDptls15GFsI6jyUOq0kOf9+WonkhtlIhh0RgHRnqj5gdNxW5j1EvAyYg6Q==", + "dev": true, + "requires": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + } + }, + "@typescript-eslint/parser": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.33.0.tgz", + "integrity": "sha512-ZohdsbXadjGBSK0/r+d87X0SBmKzOq4/S5nzK6SBgJspFo9/CUDJ7hjayuze+JK7CZQLDMroqytp7pOcFKTxZA==", + "dev": true, + "requires": { + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "debug": "^4.3.1" + } + }, + "@typescript-eslint/scope-manager": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.33.0.tgz", + "integrity": "sha512-5IfJHpgTsTZuONKbODctL4kKuQje/bzBRkwHE8UOZ4f89Zeddg+EGZs8PD8NcN4LdM3ygHWYB3ukPAYjvl/qbQ==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0" + } + }, + "@typescript-eslint/types": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.33.0.tgz", + "integrity": "sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ==", + "dev": true + }, + "@typescript-eslint/typescript-estree": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.33.0.tgz", + "integrity": "sha512-rkWRY1MPFzjwnEVHsxGemDzqqddw2QbTJlICPD9p9I9LfsO8fdmfQPOX3uKfUaGRDFJbfrtm/sXhVXN4E+bzCA==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + } + }, + "@typescript-eslint/visitor-keys": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz", + "integrity": "sha512-uqi/2aSz9g2ftcHWf8uLPJA70rUv6yuMW5Bohw+bwcuzaxQIHaKFZCKGoGXIrc9vkTJ3+0txM73K0Hq3d5wgIg==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.33.0", + "eslint-visitor-keys": "^2.0.0" + } + }, + "acorn": { + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", + "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ==", + "dev": true + }, + "acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "requires": {} + }, + "acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "dev": true + }, + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true + }, + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==" + }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "requires": { + "color-convert": "^2.0.1" + } + }, + "arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, + "argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "requires": { + "sprintf-js": "~1.0.2" + } + }, + "array-includes": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", + "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "is-string": "^1.0.7" + } + }, + "array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true + }, + "array.prototype.flat": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz", + "integrity": "sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + } + }, + "array.prototype.flatmap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", + "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + } + }, + "astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true + }, + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" + }, + "balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + }, + "base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==" + }, + "bl": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", + "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "requires": { + "buffer": "^5.5.0", + "inherits": "^2.0.4", + "readable-stream": "^3.4.0" + } + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "requires": { + "fill-range": "^7.0.1" + } + }, + "buffer": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", + "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", + "requires": { + "base64-js": "^1.3.1", + "ieee754": "^1.1.13" + } + }, + "call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + } + }, + "callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true + }, + "chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "requires": { + "restore-cursor": "^3.1.0" + } + }, + "cli-spinners": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.6.1.tgz", + "integrity": "sha512-x/5fWmGMnbKQAaNwN+UZlV79qBLM9JFnJuJ03gIi5whrob0xV0ofNVHy9DhwGdsMJQc2OKv0oGmLzvaqvAVv+g==" + }, + "clone": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", + "integrity": "sha1-2jCcwmPfFZlMaIypAheco8fNfH4=" + }, + "code-block-writer": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-11.0.0.tgz", + "integrity": "sha512-GEqWvEWWsOvER+g9keO4ohFoD3ymwyCnqY3hoTr7GZipYFwEhMHJw+TtV0rfgRhNImM6QWZGO2XYjlJVyYT62w==", + "requires": { + "tslib": "2.3.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + }, + "combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "requires": { + "delayed-stream": "~1.0.0" + } + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" + }, + "create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, + "debug": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz", + "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true + }, + "defaults": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.3.tgz", + "integrity": "sha1-xlYFHpgX2f8I7YgUd/P+QBnz730=", + "requires": { + "clone": "^1.0.2" + } + }, + "define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "requires": { + "object-keys": "^1.0.12" + } + }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=" + }, + "diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true + }, + "dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "requires": { + "path-type": "^4.0.0" + } + }, + "doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "duplexer": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", + "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==" + }, + "emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "requires": { + "ansi-colors": "^4.1.1" + } + }, + "error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "requires": { + "is-arrayish": "^0.2.1" + } + }, + "es-abstract": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz", + "integrity": "sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "get-symbol-description": "^1.0.0", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "is-callable": "^1.2.4", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.1", + "is-string": "^1.0.7", + "is-weakref": "^1.0.1", + "object-inspect": "^1.11.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + } + }, + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true + }, + "eslint": { + "version": "7.32.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.32.0.tgz", + "integrity": "sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA==", + "dev": true, + "requires": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.3", + "@humanwhocodes/config-array": "^0.5.0", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "dependencies": { + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true + } + } + }, + "eslint-config-standard": { + "version": "16.0.3", + "resolved": "https://registry.npmjs.org/eslint-config-standard/-/eslint-config-standard-16.0.3.tgz", + "integrity": "sha512-x4fmJL5hGqNJKGHSjnLdgA6U6h1YW/G2dW9fA+cyVur4SK6lyue8+UgNKWlZtUDTXvgKDD/Oa3GQjmB5kjtVvg==", + "dev": true, + "requires": {} + }, + "eslint-config-standard-jsx": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-jsx/-/eslint-config-standard-jsx-10.0.0.tgz", + "integrity": "sha512-hLeA2f5e06W1xyr/93/QJulN/rLbUVUmqTlexv9PRKHFwEC9ffJcH2LvJhMoEqYQBEYafedgGZXH2W8NUpt5lA==", + "dev": true, + "requires": {} + }, + "eslint-config-standard-with-typescript": { + "version": "21.0.1", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-21.0.1.tgz", + "integrity": "sha512-FeiMHljEJ346Y0I/HpAymNKdrgKEpHpcg/D93FvPHWfCzbT4QyUJba/0FwntZeGLXfUiWDSeKmdJD597d9wwiw==", + "dev": true, + "requires": { + "@typescript-eslint/parser": "^4.0.0", + "eslint-config-standard": "^16.0.0" + } + }, + "eslint-import-resolver-node": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz", + "integrity": "sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw==", + "dev": true, + "requires": { + "debug": "^3.2.7", + "resolve": "^1.20.0" + }, + "dependencies": { + "debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + } + } + }, + "eslint-module-utils": { + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.2.tgz", + "integrity": "sha512-zquepFnWCY2ISMFwD/DqzaM++H+7PDzOpUvotJWm/y1BAFt5R4oeULgdrTejKqLkz7MA/tgstsUMNYc7wNdTrg==", + "dev": true, + "requires": { + "debug": "^3.2.7", + "find-up": "^2.1.0" + }, + "dependencies": { + "debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + } + } + }, + "eslint-plugin-es": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-3.0.1.tgz", + "integrity": "sha512-GUmAsJaN4Fc7Gbtl8uOBlayo2DqhwWvEzykMHSCZHU3XdJ+NSzzZcVhXh3VxX5icqQ+oQdIEawXX8xkR3mIFmQ==", + "dev": true, + "requires": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "dependencies": { + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + } + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "eslint-plugin-import": { + "version": "2.25.4", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz", + "integrity": "sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA==", + "dev": true, + "requires": { + "array-includes": "^3.1.4", + "array.prototype.flat": "^1.2.5", + "debug": "^2.6.9", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.6", + "eslint-module-utils": "^2.7.2", + "has": "^1.0.3", + "is-core-module": "^2.8.0", + "is-glob": "^4.0.3", + "minimatch": "^3.0.4", + "object.values": "^1.1.5", + "resolve": "^1.20.0", + "tsconfig-paths": "^3.12.0" + }, + "dependencies": { + "debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + }, + "doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "dev": true + } + } + }, + "eslint-plugin-node": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz", + "integrity": "sha512-oUwtPJ1W0SKD0Tr+wqu92c5xuCeQqB3hSCHasn/ZgjFdA9iDGNkNf2Zi9ztY7X+hNuMib23LNGRm6+uN+KLE3g==", + "dev": true, + "requires": { + "eslint-plugin-es": "^3.0.0", + "eslint-utils": "^2.0.0", + "ignore": "^5.1.1", + "minimatch": "^3.0.4", + "resolve": "^1.10.1", + "semver": "^6.1.0" + }, + "dependencies": { + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + } + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true + } + } + }, + "eslint-plugin-promise": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-5.2.0.tgz", + "integrity": "sha512-SftLb1pUG01QYq2A/hGAWfDRXqYD82zE7j7TopDOyNdU+7SvvoXREls/+PRTY17vUXzXnZA/zfnyKgRH6x4JJw==", + "dev": true, + "requires": {} + }, + "eslint-plugin-react": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.28.0.tgz", + "integrity": "sha512-IOlFIRHzWfEQQKcAD4iyYDndHwTQiCMcJVJjxempf203jnNLUnW34AXLrV33+nEXoifJE2ZEGmcjKPL8957eSw==", + "dev": true, + "requires": { + "array-includes": "^3.1.4", + "array.prototype.flatmap": "^1.2.5", + "doctrine": "^2.1.0", + "estraverse": "^5.3.0", + "jsx-ast-utils": "^2.4.1 || ^3.0.0", + "minimatch": "^3.0.4", + "object.entries": "^1.1.5", + "object.fromentries": "^2.0.5", + "object.hasown": "^1.1.0", + "object.values": "^1.1.5", + "prop-types": "^15.7.2", + "resolve": "^2.0.0-next.3", + "semver": "^6.3.0", + "string.prototype.matchall": "^4.0.6" + }, + "dependencies": { + "doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "resolve": { + "version": "2.0.0-next.3", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.3.tgz", + "integrity": "sha512-W8LucSynKUIDu9ylraa7ueVZ7hc0uAgJBxVsQSKOXOyle8a93qXhcz+XAXZ8bIq2d6i4Ehddn6Evt+0/UwKk6Q==", + "dev": true, + "requires": { + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" + } + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true + } + } + }, + "eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "requires": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "dependencies": { + "estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true + } + } + }, + "eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^2.0.0" + } + }, + "eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true + }, + "espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "requires": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "dependencies": { + "acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true + }, + "esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "requires": { + "estraverse": "^5.1.0" + } + }, + "esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "requires": { + "estraverse": "^5.2.0" + } + }, + "estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true + }, + "esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true + }, + "event-stream": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/event-stream/-/event-stream-3.3.4.tgz", + "integrity": "sha1-SrTJoPWlTbkzi0w02Gv86PSzVXE=", + "requires": { + "duplexer": "~0.1.1", + "from": "~0", + "map-stream": "~0.1.0", + "pause-stream": "0.0.11", + "split": "0.3", + "stream-combiner": "~0.0.4", + "through": "~2.3.1" + } + }, + "fast-deep-equal": { + "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 + }, + "fast-glob": { + "version": "3.2.11", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.11.tgz", + "integrity": "sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew==", + "requires": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + } + }, + "fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true + }, + "fastest-levenshtein": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/fastest-levenshtein/-/fastest-levenshtein-1.0.12.tgz", + "integrity": "sha512-On2N+BpYJ15xIC974QNVuYGMOlEVt4s0EOI3wwMqOmK1fdDY+FN/zltPV8vosq4ad4c/gJ1KHScUn/6AWIgiow==" + }, + "fastq": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", + "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "requires": { + "reusify": "^1.0.4" + } + }, + "file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "requires": { + "flat-cache": "^3.0.4" + } + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "find-up": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", + "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", + "dev": true, + "requires": { + "locate-path": "^2.0.0" + } + }, + "flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "requires": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + } + }, + "flatted": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.4.tgz", + "integrity": "sha512-8/sOawo8tJ4QOBX8YlQBMxL8+RLZfxMQOif9o0KUKTNTjMYElWPE0r/m5VNFxTRd0NSw8qSy8dajrwX4RYI1Hw==", + "dev": true + }, + "form-data": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz", + "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==", + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + } + }, + "from": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/from/-/from-0.1.7.tgz", + "integrity": "sha1-g8YK/Fi5xWmXAH7Rp2izqzA6RP4=" + }, + "fs-extra": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz", + "integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==", + "requires": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + } + }, + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, + "get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + } + }, + "get-stdin": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz", + "integrity": "sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==", + "dev": true + }, + "get-symbol-description": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", + "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + } + }, + "glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "requires": { + "is-glob": "^4.0.1" + } + }, + "globals": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.12.0.tgz", + "integrity": "sha512-uS8X6lSKN2JumVoXrbUz+uG4BYG+eiawqm3qFcT7ammfbUHeCBoJMlHcec/S3krSk73/AE/f0szYFmgAA3kYZg==", + "dev": true, + "requires": { + "type-fest": "^0.20.2" + } + }, + "globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "requires": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + } + }, + "graceful-fs": { + "version": "4.2.9", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.9.tgz", + "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==" + }, + "has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "requires": { + "function-bind": "^1.1.1" + } + }, + "has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==" + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "has-tostringtag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", + "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + }, + "ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==" + }, + "ignore": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", + "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==" + }, + "import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "requires": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + } + }, + "imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", + "dev": true + }, + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "requires": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + }, + "internal-slot": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz", + "integrity": "sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==", + "dev": true, + "requires": { + "get-intrinsic": "^1.1.0", + "has": "^1.0.3", + "side-channel": "^1.0.4" + } + }, + "is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "requires": { + "has-bigints": "^1.0.1" + } + }, + "is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-callable": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", + "integrity": "sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w==", + "dev": true + }, + "is-core-module": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", + "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, + "is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=" + }, + "is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true + }, + "is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "requires": { + "is-extglob": "^2.1.1" + } + }, + "is-interactive": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", + "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==" + }, + "is-negative-zero": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", + "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==" + }, + "is-number-object": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz", + "integrity": "sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-shared-array-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", + "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", + "dev": true + }, + "is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + }, + "is-unicode-supported": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", + "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==" + }, + "is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2" + } + }, + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=" + }, + "js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "json-parse-better-errors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", + "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", + "dev": true + }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", + "dev": true + }, + "json5": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", + "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "dev": true, + "requires": { + "minimist": "^1.2.0" + } + }, + "jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "requires": { + "graceful-fs": "^4.1.6", + "universalify": "^2.0.0" + } + }, + "jsx-ast-utils": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.1.tgz", + "integrity": "sha512-uP5vu8xfy2F9A6LGC22KO7e2/vGTS1MhP+18f++ZNlf0Ohaxbc9nIEwHAsejlJKyzfZzU5UIhe5ItYkitcZnZA==", + "dev": true, + "requires": { + "array-includes": "^3.1.3", + "object.assign": "^4.1.2" + } + }, + "levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "requires": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + } + }, + "load-json-file": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-5.3.0.tgz", + "integrity": "sha512-cJGP40Jc/VXUsp8/OrnyKyTZ1y6v/dphm3bioS+RrKXjK2BB6wHUd6JptZEFDGgGahMT+InnZO5i1Ei9mpC8Bw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.15", + "parse-json": "^4.0.0", + "pify": "^4.0.1", + "strip-bom": "^3.0.0", + "type-fest": "^0.3.0" + }, + "dependencies": { + "type-fest": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.3.1.tgz", + "integrity": "sha512-cUGJnCdr4STbePCgqNFbpVNCepa+kAVohJs1sLhxzdH+gnEoOd8VhbYa7pD3zZYGiURWM2xzEII3fQcRizDkYQ==", + "dev": true + } + } + }, + "locate-path": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", + "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", + "dev": true, + "requires": { + "p-locate": "^2.0.0", + "path-exists": "^3.0.0" + } + }, + "lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true + }, + "log-symbols": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", + "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "requires": { + "chalk": "^4.1.0", + "is-unicode-supported": "^0.1.0" + } + }, + "loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "requires": { + "js-tokens": "^3.0.0 || ^4.0.0" + } + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "requires": { + "yallist": "^4.0.0" + } + }, + "make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, + "map-stream": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/map-stream/-/map-stream-0.1.0.tgz", + "integrity": "sha1-5WqpTEyAVaFkBKBnS3jyFffI4ZQ=" + }, + "merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==" + }, + "micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + } + }, + "mime-db": { + "version": "1.51.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.51.0.tgz", + "integrity": "sha512-5y8A56jg7XVQx2mbv1lu49NR4dokRnhZYTtL+KGfaa27uq4pSTXkwQkFJl4pkRMyNFz/EtYDSkiiEHx3F7UN6g==" + }, + "mime-types": { + "version": "2.1.34", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.34.tgz", + "integrity": "sha512-6cP692WwGIs9XXdOO4++N+7qjqv0rqxxVvJ3VHPh/Sc9mVZcQP+ZGhkKiTvWMQRr2tbHkJP/Yn7Y0npb3ZBs4A==", + "requires": { + "mime-db": "1.51.0" + } + }, + "mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==" + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==" + }, + "mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==" + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", + "dev": true + }, + "node-fetch": { + "version": "2.6.7", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", + "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", + "requires": { + "whatwg-url": "^5.0.0" + } + }, + "object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true + }, + "object-inspect": { + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.0.tgz", + "integrity": "sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g==", + "dev": true + }, + "object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + }, + "object.entries": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.5.tgz", + "integrity": "sha512-TyxmjUoZggd4OrrU1W66FMDG6CuqJxsFvymeyXI51+vQLN67zYfZseptRge703kKQdo4uccgAKebXFcRCzk4+g==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "object.fromentries": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.5.tgz", + "integrity": "sha512-CAyG5mWQRRiBU57Re4FKoTBjXfDoNwdFVH2Y1tS9PqCsfUTymAohOkEMSG3aRNKmv4lV3O7p1et7c187q6bynw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "object.hasown": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", + "integrity": "sha512-MhjYRfj3GBlhSkDHo6QmvgjRLXQ2zndabdf3nX0yTyZK9rPfxb6uRpAac8HXNLy1GpqWtZ81Qh4v3uOls2sRAg==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "object.values": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz", + "integrity": "sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "requires": { + "wrappy": "1" + } + }, + "onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "requires": { + "mimic-fn": "^2.1.0" + } + }, + "optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "requires": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + } + }, + "ora": { + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", + "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "requires": { + "bl": "^4.1.0", + "chalk": "^4.1.0", + "cli-cursor": "^3.1.0", + "cli-spinners": "^2.5.0", + "is-interactive": "^1.0.0", + "is-unicode-supported": "^0.1.0", + "log-symbols": "^4.1.0", + "strip-ansi": "^6.0.0", + "wcwidth": "^1.0.1" + } + }, + "p-limit": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", + "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", + "dev": true, + "requires": { + "p-try": "^1.0.0" + } + }, + "p-locate": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", + "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", + "dev": true, + "requires": { + "p-limit": "^1.1.0" + } + }, + "p-try": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", + "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", + "dev": true + }, + "parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "requires": { + "callsites": "^3.0.0" + } + }, + "parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", + "dev": true, + "requires": { + "error-ex": "^1.3.1", + "json-parse-better-errors": "^1.0.1" + } + }, + "path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==" + }, + "path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true + }, + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true + }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, + "path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, + "path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==" + }, + "pause-stream": { + "version": "0.0.11", + "resolved": "https://registry.npmjs.org/pause-stream/-/pause-stream-0.0.11.tgz", + "integrity": "sha1-/lo0sMvOErWqaitAPuLnO2AvFEU=", + "requires": { + "through": "~2.3" + } + }, + "picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==" + }, + "pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true + }, + "pkg-conf": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pkg-conf/-/pkg-conf-3.1.0.tgz", + "integrity": "sha512-m0OTbR/5VPNPqO1ph6Fqbj7Hv6QU7gR/tQW40ZqrL1rjgCU85W6C1bJn0BItuJqnR98PWzw7Z8hHeChD1WrgdQ==", + "dev": true, + "requires": { + "find-up": "^3.0.0", + "load-json-file": "^5.2.0" + }, + "dependencies": { + "find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "requires": { + "locate-path": "^3.0.0" + } + }, + "locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "requires": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + } + }, + "p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "requires": { + "p-limit": "^2.0.0" + } + }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + } + } + }, + "prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true + }, + "prettier": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.5.1.tgz", + "integrity": "sha512-vBZcPRUR5MZJwoyi3ZoyQlc1rXeEck8KgeC9AwwOn+exuxLxq5toTRDTSaVrXHxelDMHy9zlicw8u66yxoSUFg==", + "dev": true + }, + "progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true + }, + "prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dev": true, + "requires": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "ps-tree": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/ps-tree/-/ps-tree-1.2.0.tgz", + "integrity": "sha512-0VnamPPYHl4uaU/nSFeZZpR21QAWRz+sRv4iW9+v/GS/J5U5iZB5BNN6J0RMoOvdx2gWM2+ZFMIm58q24e4UYA==", + "requires": { + "event-stream": "=3.3.4" + } + }, + "punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true + }, + "queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==" + }, + "react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "dev": true + }, + "readable-stream": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", + "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", + "requires": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + } + }, + "regexp.prototype.flags": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", + "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true + }, + "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==", + "dev": true + }, + "resolve": { + "version": "1.22.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz", + "integrity": "sha512-Hhtrw0nLeSrFQ7phPp4OOcVjLPIeMnRlr5mcnVuMe7M/7eBn98A3hmFRLoFo3DLZkivSYwhRUJTyPyWAk56WLw==", + "dev": true, + "requires": { + "is-core-module": "^2.8.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + } + }, + "resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true + }, + "restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "requires": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + } + }, + "reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==" + }, + "rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "requires": { + "glob": "^7.1.3" + } + }, + "run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "requires": { + "queue-microtask": "^1.2.2" + } + }, + "safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==" + }, + "safe-stable-stringify": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.3.1.tgz", + "integrity": "sha512-kYBSfT+troD9cDA85VDnHZ1rpHC50O0g1e6WlGHVCz/g+JS+9WKLj+XwFYyR8UbrZN8ll9HUpDAAddY58MGisg==" + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "requires": { + "lru-cache": "^6.0.0" + } + }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + }, + "side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + } + }, + "signal-exit": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.6.tgz", + "integrity": "sha512-sDl4qMFpijcGw22U5w63KmD3cZJfBuFlVNbVMKje2keoKML7X2UzWbc4XrmEbDwg0NXJc3yv4/ox7b+JWb57kQ==" + }, + "slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true + }, + "slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + }, + "split": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/split/-/split-0.3.3.tgz", + "integrity": "sha1-zQ7qXmOiEd//frDwkcQTPi0N0o8=", + "requires": { + "through": "2" + } + }, + "sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true + }, + "standard-engine": { + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/standard-engine/-/standard-engine-14.0.1.tgz", + "integrity": "sha512-7FEzDwmHDOGva7r9ifOzD3BGdTbA7ujJ50afLVdW/tK14zQEptJjbFuUfn50irqdHDcTbNh0DTIoMPynMCXb0Q==", + "dev": true, + "requires": { + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "xdg-basedir": "^4.0.0" + } + }, + "stream-combiner": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/stream-combiner/-/stream-combiner-0.0.4.tgz", + "integrity": "sha1-TV5DPBhSYd3mI8o/RMWGvPXErRQ=", + "requires": { + "duplexer": "~0.1.1" + } + }, + "string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "requires": { + "safe-buffer": "~5.2.0" + } + }, + "string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "requires": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + } + }, + "string.prototype.matchall": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.6.tgz", + "integrity": "sha512-6WgDX8HmQqvEd7J+G6VtAahhsQIssiZ8zl7zKh1VDMFyL3hRTJP4FTNA3RbIp2TOQ9AYNDcc7e3fH0Qbup+DBg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "regexp.prototype.flags": "^1.3.1", + "side-channel": "^1.0.4" + } + }, + "string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "requires": { + "ansi-regex": "^5.0.1" + } + }, + "strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", + "dev": true + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "requires": { + "has-flag": "^4.0.0" + } + }, + "supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true + }, + "table": { + "version": "6.8.0", + "resolved": "https://registry.npmjs.org/table/-/table-6.8.0.tgz", + "integrity": "sha512-s/fitrbVeEyHKFa7mFdkuQMWlH1Wgw/yEXMt5xACT4ZpzWFluehAxRtUUQKPuWhaLAWhFcVx6w3oC8VKaUfPGA==", + "dev": true, + "requires": { + "ajv": "^8.0.1", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.3", + "strip-ansi": "^6.0.1" + }, + "dependencies": { + "ajv": { + "version": "8.9.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.9.0.tgz", + "integrity": "sha512-qOKJyNj/h+OWx7s5DePL6Zu1KeM9jPZhwBqs+7DzP6bGOvqzVCSf0xueYmVuaC/oQ/VtS2zLMLHdQFbkka+XDQ==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + } + }, + "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==", + "dev": true + } + } + }, + "text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true + }, + "through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=" + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "requires": { + "is-number": "^7.0.0" + } + }, + "tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o=" + }, + "ts-morph": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-13.0.3.tgz", + "integrity": "sha512-pSOfUMx8Ld/WUreoSzvMFQG5i9uEiWIsBYjpU9+TTASOeUa89j5HykomeqVULm1oqWtBdleI3KEFRLrlA3zGIw==", + "requires": { + "@ts-morph/common": "~0.12.3", + "code-block-writer": "^11.0.0" + } + }, + "ts-node": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.4.0.tgz", + "integrity": "sha512-g0FlPvvCXSIO1JDF6S232P5jPYqBkRL9qly81ZgAOSU7rwI0stphCgd2kLiCrU9DjQCrJMWEqcNSjQL02s6d8A==", + "dev": true, + "requires": { + "@cspotcode/source-map-support": "0.7.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "yn": "3.1.1" + } + }, + "ts-standard": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/ts-standard/-/ts-standard-11.0.0.tgz", + "integrity": "sha512-fe+PCOM6JTMIcG1Smr8BQJztUi3dc/SDJMqezxNAL8pe/0+h0shK0+fNPTuF1hMVMYO+O53Wtp9WQHqj0GJtMw==", + "dev": true, + "requires": { + "@typescript-eslint/eslint-plugin": "^4.26.1", + "eslint": "^7.28.0", + "eslint-config-standard": "^16.0.3", + "eslint-config-standard-jsx": "^10.0.0", + "eslint-config-standard-with-typescript": "^21.0.1", + "eslint-plugin-import": "^2.23.4", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^5.1.0", + "eslint-plugin-react": "^7.24.0", + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "standard-engine": "^14.0.1" + } + }, + "tsconfig-paths": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.12.0.tgz", + "integrity": "sha512-e5adrnOYT6zqVnWqZu7i/BQ3BnhzvGbjEjejFXO20lKIKpwTaupkCPgEfv4GZK1IBciJUEhYs3J3p75FdaTFVg==", + "dev": true, + "requires": { + "@types/json5": "^0.0.29", + "json5": "^1.0.1", + "minimist": "^1.2.0", + "strip-bom": "^3.0.0" + } + }, + "tslib": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", + "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==" + }, + "tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "requires": { + "tslib": "^1.8.1" + }, + "dependencies": { + "tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + } + } + }, + "type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "requires": { + "prelude-ls": "^1.2.1" + } + }, + "type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true + }, + "typescript": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", + "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "dev": true + }, + "unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + } + }, + "universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==" + }, + "uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "requires": { + "punycode": "^2.1.0" + } + }, + "util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=" + }, + "v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true + }, + "wcwidth": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", + "integrity": "sha1-8LDc+RW8X/FSivrbLA4XtTLaL+g=", + "requires": { + "defaults": "^1.0.3" + } + }, + "webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=" + }, + "whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=", + "requires": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "requires": { + "isexe": "^2.0.0" + } + }, + "which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "requires": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + } + }, + "word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true + }, + "wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "xdg-basedir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", + "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", + "dev": true + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" + }, + "yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true + }, + "zx": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/zx/-/zx-4.3.0.tgz", + "integrity": "sha512-KuEjpu5QFIMx0wWfzknDRhY98s7a3tWNRmYt19XNmB7AfOmz5zISA4+3Q8vlJc2qguxMn89uSxhPDCldPa3YLA==", + "requires": { + "@types/fs-extra": "^9.0.12", + "@types/minimist": "^1.2.2", + "@types/node": "^16.6", + "@types/node-fetch": "^2.5.12", + "chalk": "^4.1.2", + "fs-extra": "^10.0.0", + "globby": "^12.0.1", + "minimist": "^1.2.5", + "node-fetch": "^2.6.1", + "ps-tree": "^1.2.0", + "which": "^2.0.2" + }, + "dependencies": { + "@types/node": { + "version": "16.11.21", + "resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.21.tgz", + "integrity": "sha512-Pf8M1XD9i1ksZEcCP8vuSNwooJ/bZapNmIzpmsMaL+jMI+8mEYU3PKvs+xDNuQcJWF/x24WzY4qxLtB0zNow9A==" + }, + "array-union": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-3.0.1.tgz", + "integrity": "sha512-1OvF9IbWwaeiM9VhzYXVQacMibxpXOMYVNIvMtKRyX9SImBXpKcFr8XvFDeEslCyuH/t6KRt7HEO94AlP8Iatw==" + }, + "globby": { + "version": "12.2.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-12.2.0.tgz", + "integrity": "sha512-wiSuFQLZ+urS9x2gGPl1H5drc5twabmm4m2gTR27XDFyjUHJUNsS8o/2aKyIF6IoBaR630atdher0XJ5g6OMmA==", + "requires": { + "array-union": "^3.0.1", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.7", + "ignore": "^5.1.9", + "merge2": "^1.4.1", + "slash": "^4.0.0" + } + }, + "slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==" + } + } + } + } +} diff --git a/compiler/package.json b/compiler/package.json index 3d5e8e8483..20cf372958 100644 --- a/compiler/package.json +++ b/compiler/package.json @@ -2,32 +2,36 @@ "name": "elasticsearch-client-specification", "version": "0.0.1", "description": "A library that exposes the elasticsearch client specification as a validatable and iteratable source", - "main": "compiler/index.ts", + "main": "src/index.ts", "scripts": { - "lint": "ts-standard", - "lint:fix": "ts-standard --fix", + "lint": "ts-standard src", + "lint:fix": "ts-standard --fix src", "format:check": "prettier --config .prettierrc.json --check ../specification/", "format:fix": "prettier --config .prettierrc.json --write ../specification/", - "imports:fix": "ts-node update-imports.ts", - "generate-schema": "ts-node index.ts", + "imports:fix": "ts-node src/update-imports.ts", + "generate-schema": "ts-node src/index.ts", "compile:specification": "tsc --project ../specification/tsconfig.json --noEmit", - "generate-dangling": "ts-node dangling-types-report.ts" + "build": "rm -rf lib && tsc", + "generate-dangling": "ts-node src dangling-types-report.ts" }, "author": "Elastic", "license": "Apache-2.0", "devDependencies": { - "@types/node": "^14.14.21", + "@types/node": "^17.0.12", "minimist": "^1.2.5", - "prettier": "2.2.1", - "ts-node": "^9.1.1", - "ts-standard": "^10.0.0", - "typescript": "^4.1.3" + "prettier": "2.5.1", + "ts-node": "^10.4.0", + "ts-standard": "^11.0.0", + "typescript": "^4.5.5" }, "dependencies": { - "chalk": "^4.1.0", - "safe-stable-stringify": "^1.1.1", - "semver": "^7.3.4", - "ts-morph": "^9.1.0" + "chalk": "^4.1.2", + "fastest-levenshtein": "^1.0.12", + "ora": "^5.4.1", + "safe-stable-stringify": "^2.3.1", + "semver": "^7.3.5", + "ts-morph": "^13.0.3", + "zx": "^4.3.0" }, "engines": { "node": ">=14" diff --git a/compiler/run-validations.js b/compiler/run-validations.js new file mode 100644 index 0000000000..7457bd0c36 --- /dev/null +++ b/compiler/run-validations.js @@ -0,0 +1,211 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +/* global $ argv, path, cd, nothrow */ + +let ora +let closest +try { + require('zx/globals') + ora = require('ora') + const fl = require('fastest-levenshtein') + closest = fl.closest +} catch (err) { + console.log('It looks like you didn\'t install the project dependencies, please run \'make setup\'') + process.exit(1) +} + +const { readFile, writeFile } = require('fs/promises') + +// enable subprocess colors +process.env.COLOR = true +process.env.FORCE_COLOR = 3 + +$.verbose = false + +const spinner = ora('Loading').start() +const compilerPath = __dirname +const tsGeneratorPath = path.join(__dirname, '..', 'typescript-generator') +const cloneEsPath = path.join(__dirname, '..', '..', 'clients-flight-recorder', 'scripts', 'clone-elasticsearch') +const uploadRecordingsPath = path.join(__dirname, '..', '..', 'clients-flight-recorder', 'scripts', 'upload-recording') +const tsValidationPath = path.join(__dirname, '..', '..', 'clients-flight-recorder', 'scripts', 'types-validator') +const DAY = 1000 * 60 * 60 * 24 + +const apis = require('../output/schema/schema.json') + .endpoints + .map(endpoint => endpoint.name) + +async function run () { + spinner.text = 'Checking requirements' + + const noCache = argv.cache === false + const metadata = await readMetadata() + const lastRun = metadata.lastRun ? new Date(metadata.lastRun) : new Date(0) + const isStale = lastRun.getTime() + DAY < Date.now() + + if (typeof argv.api !== 'string') { + spinner.fail('You must specify the api, for example: \'make validate api=index type=request stack-version=8.1.0-SNAPSHOT\'') + process.exit(1) + } + + if (!apis.includes(argv.api)) { + spinner.fail(`The api '${argv.api}' does not exists, did you mean '${closest(argv.api, apis)}'?`) + process.exit(1) + } + + // if true it's because the make target wasn't configured with a type argument + if (argv.type !== true && argv.type !== 'request' && argv.type !== 'response') { + spinner.fail('You must specify the type (request or response), for example: \'make validate api=index type=request stack-version=8.1.0-SNAPSHOT\'') + process.exit(1) + } + + if (typeof argv['stack-version'] !== 'string') { + spinner.fail('You must specify the stack version, for example: \'make validate api=index type=request stack-version=8.1.0-SNAPSHOT\'') + process.exit(1) + } + + const isFlightRecorderCloned = await $`[[ -d ${path.join(__dirname, '..', '..', 'clients-flight-recorder')} ]]`.exitCode === 0 + if (!isFlightRecorderCloned) { + spinner.text = 'It looks like you didn\'t cloned the flight recorder, doing that for you' + await $`git clone https://github.com/elastic/clients-flight-recorder.git ${path.join(__dirname, '..', '..', 'clients-flight-recorder')}` + } else if (isStale) { + spinner.text = 'Pulling the latest flight recorder changes' + cd(path.join(__dirname, '..', '..', 'clients-flight-recorder')) + await $`git pull` + cd(path.join(compilerPath, '..')) + } + + const isCompilerInstalled = await $`[[ -d ${path.join(compilerPath, 'node_modules')} ]]`.exitCode === 0 + const isTsGeneratorInstalled = await $`[[ -d ${path.join(tsGeneratorPath, 'node_modules')} ]]`.exitCode === 0 + if (noCache || !isCompilerInstalled || !isTsGeneratorInstalled) { + spinner.text = 'It looks like you didn\'t installed the project dependencies, doing that for you' + await $`npm install --prefix ${compilerPath}` + await $`npm install --prefix ${tsGeneratorPath}` + } + + const isCloneEsInstalled = await $`[[ -d ${path.join(cloneEsPath, 'node_modules')} ]]`.exitCode === 0 + const isUploadRecordingInstalled = await $`[[ -d ${path.join(uploadRecordingsPath, 'node_modules')} ]]`.exitCode === 0 + const isTypesValidatorInstalled = await $`[[ -d ${path.join(tsValidationPath, 'node_modules')} ]]`.exitCode === 0 + + if (noCache || !isCloneEsInstalled || !isUploadRecordingInstalled || !isTypesValidatorInstalled) { + spinner.text = 'It looks like you didn\'t installed the flight recorder project dependencies, doing that for you' + await $`npm install --prefix ${cloneEsPath}` + await $`npm install --prefix ${uploadRecordingsPath}` + await $`npm install --prefix ${tsValidationPath}` + } + + const isCompilerBuilt = await $`[[ -d ${path.join(compilerPath, 'lib')} ]]`.exitCode === 0 + if (noCache || isStale || !isCompilerBuilt) { + spinner.text = 'Optimizing the compiler' + await $`npm run build --prefix ${compilerPath}` + } + + const isTsGeneratorBuilt = await $`[[ -d ${path.join(tsGeneratorPath, 'lib')} ]]`.exitCode === 0 + if (noCache || isStale || !isTsGeneratorBuilt) { + spinner.text = 'Optimizing the ts generator' + await $`npm run build --prefix ${tsGeneratorPath}` + } + + { + spinner.text = 'Compiling specification' + const Process = await nothrow($`npm run compile:specification --prefix ${compilerPath}`) + if (Process.exitCode !== 0) { + spinner.fail(removeHeader(Process.stdout)) + process.exit(1) + } + } + + { + spinner.text = 'Generating schema' + const Process = await nothrow($`node ${path.join(compilerPath, 'lib', 'index.js')}`) + if (Process.exitCode !== 0) { + spinner.fail(removeHeader(Process.stdout)) + console.log(Process.stderr) + process.exit(1) + } + } + + { + spinner.text = 'Generating typescript view' + const Process = await nothrow($`node ${path.join(tsGeneratorPath, 'lib', 'index.js')}`) + if (Process.exitCode !== 0) { + spinner.fail(removeHeader(Process.toString())) + process.exit(1) + } + } + + spinner.text = 'Running validations' + + const branchName = argv['stack-version'].startsWith('7.') ? '7.x' : argv['stack-version'].slice(0, 3) + + if (noCache || isStale || metadata.branchName !== branchName) { + metadata.lastRun = new Date() + metadata.branchName = branchName + + spinner.text = 'Downloading recordings' + await $`node ${path.join(uploadRecordingsPath, 'download.js')} --branch ${branchName}` + + spinner.text = 'Fetching artifacts' + await $`node ${path.join(cloneEsPath, 'index.js')} --version ${argv['stack-version']}` + } + + cd(tsValidationPath) + spinner.text = 'Validating endpoints' + // the ts validator will copy types.ts and schema.json autonomously + const flags = ['--verbose'] + if (argv.type === true) { + flags.push('--request') + flags.push('--response') + } else { + flags.push(`--${argv.type}`) + } + const output = await $`STACK_VERSION=${argv['stack-version']} node ${path.join(tsValidationPath, 'index.js')} --api ${argv.api} ${flags}` + + cd(path.join(compilerPath, '..')) + if (output.exitCode === 0) { + spinner.stop() + console.log(output.toString()) + } else { + spinner.fail(output.toString()) + } + + await writeFile( + path.join(compilerPath, '..', '.validation.json'), + JSON.stringify(metadata), + 'utf8' + ) +} + +async function readMetadata () { + try { + return JSON.parse(await readFile(path.join(compilerPath, '..', '.validation.json'), 'utf8')) + } catch (err) { + return {} + } +} + +function removeHeader (log) { + return log.split('\n').slice(4).join('\n') +} + +run().catch(err => { + cd(path.join(compilerPath, '..')) + spinner.fail(err.message) + process.exit(1) +}) diff --git a/compiler/compiler.ts b/compiler/src/compiler.ts similarity index 88% rename from compiler/compiler.ts rename to compiler/src/compiler.ts index 283f9f1912..717b9cd95d 100644 --- a/compiler/compiler.ts +++ b/compiler/src/compiler.ts @@ -20,7 +20,7 @@ import { writeFile } from 'fs/promises' import { join } from 'path' import stringify from 'safe-stable-stringify' -import { Model, Stability } from './model/metamodel' +import { Model } from './model/metamodel' import { compileEndpoints, compileSpecification } from './model/build-model' import buildJsonSpec, { JsonSpec } from './model/json-spec' import { ValidationErrors } from './validation-errors' @@ -59,18 +59,15 @@ export default class Compiler { } await writeFile( - join(__dirname, '..', 'output', 'schema', 'schema.json'), + join(__dirname, '..', '..', 'output', 'schema', 'schema.json'), stringify(this.model, null, 2), 'utf8' ) - this.errors.cleanup( - this.model.endpoints.filter(e => e.stability === Stability.TODO).map(e => e.name) - ) this.errors.log() await writeFile( - join(__dirname, '..', 'output', 'schema', 'validation-errors.json'), + join(__dirname, '..', '..', 'output', 'schema', 'validation-errors.json'), stringify(this.errors, null, 2), 'utf8' ) diff --git a/compiler/dangling-types-report.ts b/compiler/src/dangling-types-report.ts similarity index 94% rename from compiler/dangling-types-report.ts rename to compiler/src/dangling-types-report.ts index 5708cbba38..5140b4594e 100644 --- a/compiler/dangling-types-report.ts +++ b/compiler/src/dangling-types-report.ts @@ -22,7 +22,7 @@ import { join } from 'path' import { Project } from 'ts-morph' import { isDefinedButNeverUsed, customTypes } from './model/utils' -const specsFolder = join(__dirname, '..', 'specification') +const specsFolder = join(__dirname, '..', '..', 'specification') const tsConfigFilePath = join(specsFolder, 'tsconfig.json') function findDanglingTypes (): void { @@ -54,7 +54,7 @@ function findDanglingTypes (): void { } writeFileSync( - join(__dirname, '..', 'output', 'dangling-types', 'dangling.csv'), + join(__dirname, '..', '..', 'output', 'dangling-types', 'dangling.csv'), definedButNeverUsed.join('\n'), 'utf8' ) diff --git a/compiler/index.ts b/compiler/src/index.ts similarity index 71% rename from compiler/index.ts rename to compiler/src/index.ts index 12dd75857e..cf3ae8474d 100644 --- a/compiler/index.ts +++ b/compiler/src/index.ts @@ -17,12 +17,24 @@ * under the License. */ +import { readFileSync } from 'fs' +import { join } from 'path' import Compiler from './compiler' import validateRestSpec from './steps/validate-rest-spec' import addInfo from './steps/add-info' import addDescription from './steps/add-description' import validateModel from './steps/validate-model' import addContentType from './steps/add-content-type' +import readDefinitionValidation from './steps/read-definition-validation' + +const nvmrc = readFileSync(join(__dirname, '..', '..', '.nvmrc'), 'utf8') +const nodejsMajor = process.version.split('.').shift()?.slice(1) ?? '' +const nvmMajor = nvmrc.trim().split('.').shift() ?? '' + +if (nodejsMajor !== nvmMajor) { + console.error(`Bad nodejs major version, you are using ${nodejsMajor}, while ${nvmMajor} should be used. Run 'nvm install' to fix this.`) + process.exit(1) +} const compiler = new Compiler() @@ -30,6 +42,7 @@ compiler .generateModel() .step(addInfo) .step(addContentType) + .step(readDefinitionValidation) .step(validateRestSpec) .step(addDescription) .step(validateModel) diff --git a/compiler/model/build-model.ts b/compiler/src/model/build-model.ts similarity index 72% rename from compiler/model/build-model.ts rename to compiler/src/model/build-model.ts index 78f4dbf81a..cd5e2deb60 100644 --- a/compiler/model/build-model.ts +++ b/compiler/src/model/build-model.ts @@ -50,10 +50,13 @@ import { modelTypeAlias, parseVariantNameTag, parseVariantsTag, - verifyUniqueness + verifyUniqueness, + parseJsDocTags, + deepEqual, + sourceLocation } from './utils' -const specsFolder = join(__dirname, '..', '..', 'specification') +const specsFolder = join(__dirname, '..', '..', '..', 'specification') const tsConfigFilePath = join(specsFolder, 'tsconfig.json') const jsonSpec = buildJsonSpec() @@ -118,7 +121,7 @@ export function compileSpecification (endpointMappings: Record(), query: new Array(), body: { kind: 'no_body' } @@ -201,6 +204,25 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int hoistRequestAnnotations(type, declaration.getJsDocs(), mappings, response) + const mapping = mappings[namespace.includes('_global') ? namespace.slice(8) : namespace] + if (mapping == null) { + throw new Error(`Cannot find url template for ${namespace}, very likely the specification folder does not follow the rest-api-spec`) + } + // list of unique dynamic parameters + const urlTemplateParams = [...new Set( + mapping.urls.flatMap(url => url.path.split('/') + .filter(part => part.includes('{')) + .map(part => part.slice(1, -1)) + ) + )] + const methods = [...new Set(mapping.urls.flatMap(url => url.methods))] + + let pathMember: Node | null = null + let bodyProperties: model.Property[] = [] + let bodyValue: model.ValueOf | null = null + let bodyMember: Node | null = null + + // collect path/query/body properties for (const member of declaration.getMembers()) { // we are visiting `path_parts, `query_parameters` or `body` assert( @@ -210,27 +232,82 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int ) const property = visitRequestOrResponseProperty(member) if (property.name === 'path_parts') { + assert(member, property.properties.length > 0, 'There is no need to declare an empty object path_parts, just remove the path_parts declaration.') + pathMember = member type.path = property.properties } else if (property.name === 'query_parameters') { + assert(member, property.properties.length > 0, 'There is no need to declare an empty object query_parameters, just remove the query_parameters declaration.') type.query = property.properties } else if (property.name === 'body') { - bodyWasSet = true - // the body can either be a value (eg Array or an object with properties) + bodyMember = member + assert( + member, + methods.some(method => ['POST', 'PUT', 'DELETE'].includes(method)), + `${namespace}.${name} can't have a body, allowed methods: ${methods.join(', ')}` + ) if (property.valueOf != null) { - if (property.valueOf.kind === 'instance_of' && property.valueOf.type.name === 'Void') { - type.body = { kind: 'no_body' } - } else { - type.body = { kind: 'value', value: property.valueOf } - } - } else if (property.properties.length > 0) { - type.body = { kind: 'properties', properties: property.properties } + bodyValue = property.valueOf + } else { + assert(member, property.properties.length > 0, 'There is no need to declare an empty object body, just remove the body declaration.') + bodyProperties = property.properties + } + } else { + assert(member, false, `Unknown request property: ${property.name}`) + } + } + + // validate path properties + for (const part of type.path) { + assert( + pathMember as Node, + urlTemplateParams.includes(part.name), + `The property '${part.name}' does not exist in the rest-api-spec ${namespace} url template` + ) + if (type.query.map(p => p.name).includes(part.name)) { + const queryType = type.query.find(property => property != null && property.name === part.name) as model.Property + if (!deepEqual(queryType.type, part.type)) { + assert(pathMember as Node, part.codegenName != null, `'${part.name}' already exist in the query_parameters with a different type, you should define an @codegen_name.`) + assert(pathMember as Node, !type.query.map(p => p.name).includes(part.codegenName), `The codegen_name '${part.codegenName}' already exists as parameter in query_parameters.`) + } + } + if (bodyProperties.map(p => p.name).includes(part.name)) { + const bodyType = bodyProperties.find(property => property != null && property.name === part.name) as model.Property + if (!deepEqual(bodyType.type, part.type)) { + assert(pathMember as Node, part.codegenName != null, `'${part.name}' already exist in the body with a different type, you should define an @codegen_name.`) + assert(pathMember as Node, !bodyProperties.map(p => p.name).includes(part.codegenName), `The codegen_name '${part.codegenName}' already exists as parameter in body.`) } + } + } + + // validate body + // the body can either be a value (eg Array or an object with properties) + if (bodyValue != null) { + if (bodyValue.kind === 'instance_of' && bodyValue.type.name === 'Void') { + assert(bodyMember as Node, false, 'There is no need to use Void in requets definitions, just remove the body declaration.') } else { - assert(member, false, 'Unknown request property ' + property.name) + const tags = parseJsDocTags((bodyMember as PropertySignature).getJsDocs()) + assert( + bodyMember as Node, + tags.codegen_name != null, + 'You should configure a body @codegen_name' + ) + assert( + (bodyMember as PropertySignature).getJsDocs(), + !type.path.map(p => p.name).concat(type.query.map(p => p.name)).includes(tags.codegen_name), + `The codegen_name '${tags.codegen_name}' already exists as a property in the path or query.` + ) + type.body = { + kind: 'value', + value: bodyValue, + codegenName: tags.codegen_name + } } + } else if (bodyProperties.length > 0) { + type.body = { kind: 'properties', properties: bodyProperties } } } else { type = { + specLocation: sourceLocation(declaration), kind: 'response', name: { name, namespace: getNameSpace(declaration) }, body: { kind: 'no_body' } @@ -245,7 +322,6 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int ) const property = visitRequestOrResponseProperty(member) if (property.name === 'body') { - bodyWasSet = true // the body can either by a value (eg Array or an object with properties) if (property.valueOf != null) { if (property.valueOf.kind === 'instance_of' && property.valueOf.type.name === 'Void') { @@ -295,10 +371,15 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int } // If the body wasn't set and we have a parent class, then it's a property body with no additional properties - if (!bodyWasSet && type.inherits != null) { + if (type.body.kind === 'no_body' && type.inherits != null) { const parent = type.inherits.type // RequestBase is special as it's a "marker" base class that doesn't imply a property body type. We should get rid of it. - if (!(parent.name === 'RequestBase' && parent.namespace === '_types')) { + if (parent.name === 'RequestBase' && parent.namespace === '_types') { + // nothing to do + // CatRequestBase is special as it's a "marker" base class that doesn't imply a property body type. We should get rid of it. + } else if (parent.name === 'CatRequestBase' && parent.namespace === 'cat._types') { + // nothing to do + } else { type.body = { kind: 'properties', properties: new Array() } } } @@ -308,6 +389,7 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int // Every other class or interface will be handled here } else { const type: model.Interface = { + specLocation: sourceLocation(declaration), kind: 'interface', name: { name, namespace: getNameSpace(declaration) }, properties: new Array() @@ -334,6 +416,13 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int 'Class and interfaces can only have property declarations or signatures' ) const property = modelProperty(member) + if (type.variants?.kind === 'container' && property.containerProperty == null) { + assert( + member, + !property.required, + 'All @variants container properties must be optional' + ) + } type.properties.push(property) } @@ -411,7 +500,7 @@ function visitRequestOrResponseProperty (member: PropertyDeclaration | PropertyS // declaration is a child of the top level properties, while TypeReference should // directly by "unwrapped" with `modelType` because if you navigate the children of a TypeReference // you will lose the context and crafting the types becomes really hard. - if (Node.isTypeReferenceNode(value)) { + if (Node.isTypeReference(value)) { valueOf = modelType(value) } else { value.forEachChild(child => { diff --git a/compiler/model/json-spec.ts b/compiler/src/model/json-spec.ts similarity index 95% rename from compiler/model/json-spec.ts rename to compiler/src/model/json-spec.ts index 816998463b..53f0f9e286 100644 --- a/compiler/model/json-spec.ts +++ b/compiler/src/model/json-spec.ts @@ -23,7 +23,7 @@ import { join } from 'path' import { readdirSync } from 'fs' import * as model from './metamodel' -const jsonSpecPath = join(__dirname, '..', '..', 'specification', '_json_spec') +const jsonSpecPath = join(__dirname, '..', '..', '..', 'specification', '_json_spec') export interface JsonSpec { documentation: { diff --git a/compiler/src/model/metamodel.ts b/compiler/src/model/metamodel.ts new file mode 100644 index 0000000000..bbd2c59523 --- /dev/null +++ b/compiler/src/model/metamodel.ts @@ -0,0 +1,430 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +/** + * The name of a type, composed of a simple name and a namespace. Hierarchical namespace elements are separated by + * a dot, e.g 'cat.cat_aliases'. + * + * Builtin namespaces: + * - "generic" for type names that are generic parameter values from the enclosing type. + * - "internal" for primitive and builtin types (e.g. Id, IndexName, etc) + * Builtin types: + * - boolean, + * - string, + * - number: a 64bits floating point number. Additional types will be added for integers. + * - null: the null value. Since JS distinguishes undefined and null, some APIs make use of this value. + * - object: used to represent "any". We may forbid it at some point. UserDefinedValue should be used for user data. + */ +export class TypeName { + namespace: string + name: string +} + +// ------------------------------------------------------------------------------------------------ +// Value types + +// Note: "required" is part of Property. This means we can have optional properties but we can't have null entries in +// containers (array and dictionary), which doesn't seem to be needed. +// +// The 'kind' property is used to tag and disambiguate union type members, and allow type-safe pattern matching in TS: +// see https://blog.logrocket.com/pattern-matching-and-type-safety-in-typescript-1da1231a2e34/ +// and https://medium.com/@fillopeter/pattern-matching-with-typescript-done-right-94049ddd671c + +/** + * Type of a value. Used both for property types and nested type definitions. + */ +export type ValueOf = InstanceOf | ArrayOf | UnionOf | DictionaryOf | UserDefinedValue | LiteralValue + +/** + * A single value + */ +export class InstanceOf { + kind: 'instance_of' + type: TypeName + /** generic parameters: either concrete types or open parameters from the enclosing type */ + generics?: ValueOf[] +} + +/** + * An array + */ +export class ArrayOf { + kind: 'array_of' + value: ValueOf +} + +/** + * One of several possible types which don't necessarily have a common superclass + */ +export class UnionOf { + kind: 'union_of' + items: ValueOf[] +} + +/** + * A dictionary (or map). The key is a string or a number (or a union thereof), possibly through an alias. + * + * If `singleKey` is true, then this dictionary can only have a single key. This is a common pattern in ES APIs, + * used to associate a value to a field name or some other identifier. + */ +export class DictionaryOf { + kind: 'dictionary_of' + key: ValueOf + value: ValueOf + singleKey: boolean +} + +/** + * A user defined value. To be used when bubbling a generic parameter up to the top-level class is + * inconvenient or impossible (e.g. for lists of user-defined values of possibly different types). + * + * Clients will allow providing a serializer/deserializer when reading/writing properties of this type, + * and should also accept raw json. + * + * Think twice before using this as it defeats the purpose of a strongly typed API, and deserialization + * will also require to buffer raw JSON data which may have performance implications. + */ +export class UserDefinedValue { + kind: 'user_defined_value' +} + +/** + * A literal value. This is used for tagged unions, where each type member of a union has a 'type' + * attribute that defines its kind. This metamodel heavily uses this approach with its 'kind' attributes. + * + * It may later be used to set a property to a constant value, which is why it accepts not only strings but also + * other primitive types. + */ +export class LiteralValue { + kind: 'literal_value' + value: string | number | boolean +} + +/** + * An interface or request interface property. + */ +export class Property { + name: string + type: ValueOf + required: boolean + description?: string + docUrl?: string + docId?: string + since?: string + serverDefault?: boolean | string | number | string[] | number[] + deprecation?: Deprecation + stability?: Stability + /** + * If specified takes precedence over `name` when generating code. `name` is always the value + * to be sent over the wire + */ + codegenName?: string + /** An optional set of aliases for `name` */ + aliases?: string[] + /** If the enclosing class is a variants container, is this a property of the container and not a variant? */ + containerProperty?: boolean + /** If this property has a quirk that needs special attention, give a short explanation about it */ + esQuirk?: string +} + +// ------------------------------------------------------------------------------------------------ +// Type definitions + +export type TypeDefinition = Interface | Request | Response | Enum | TypeAlias + +// ------------------------------------------------------------------------------------------------ + +/** + * Common attributes for all type definitions + */ +export abstract class BaseType { + name: TypeName + description?: string + /** Link to public documentation */ + docUrl?: string + docId?: string + deprecation?: Deprecation + /** If this endpoint has a quirk that needs special attention, give a short explanation about it */ + esQuirk?: string + kind: string + /** Variant name for externally tagged variants */ + variantName?: string + /** + * Additional identifiers for use by code generators. Usage depends on the actual type: + * - on unions (modeled as alias(union_of)), these are identifiers for the union members + * - for additional properties, this is the name of the dict that holds these properties + * - for additional property, this is the name of the key and value fields that hold the + * additional property + */ + codegenNames?: string[] + /** + * Location of an item. The path is relative to the "specification" directory, e.g "_types/common.ts#L1-L2" + */ + specLocation: string +} + +export type Variants = ExternalTag | InternalTag | Container + +export class VariantBase { + /** + * Is this variant type open to extensions? Default to false. Used for variants that can + * be extended with plugins. If true, target clients should allow for additional variants + * with a variant tag outside the ones defined in the spec and arbitrary data as the value. + */ + nonExhaustive?: boolean +} + +export class ExternalTag extends VariantBase { + kind: 'external_tag' +} + +export class InternalTag extends VariantBase { + kind: 'internal_tag' + /* Name of the property that holds the variant tag */ + tag: string + /* Default value for the variant tag if it's missing */ + defaultTag?: string +} + +export class Container extends VariantBase { + kind: 'container' +} + +/** + * Inherits clause (aka extends or implements) for an interface or request + */ +export class Inherits { + type: TypeName + generics?: ValueOf[] +} + +/** + * An interface type + */ +export class Interface extends BaseType { + kind: 'interface' + /** + * Open generic parameters. The name is that of the parameter, the namespace is an arbitrary value that allows + * this fully qualified type name to be used when this open generic parameter is used in property's type. + */ + generics?: TypeName[] + inherits?: Inherits + implements?: Inherits[] + + /** + * Behaviors directly implemented by this interface + */ + behaviors?: Inherits[] + + /** + * Behaviors attached to this interface, coming from the interface itself (see `behaviors`) + * or from inherits and implements ancestors + */ + attachedBehaviors?: string[] + properties: Property[] + /** + * The property that can be used as a shortcut for the entire data structure in the JSON. + */ + shortcutProperty?: string + + /** Identify containers */ + variants?: Container +} + +/** + * A request type + */ +export class Request extends BaseType { + // Note: does not extend Interface as properties are split across path, query and body + kind: 'request' + generics?: TypeName[] + /** The parent defines additional body properties that are added to the body, that has to be a PropertyBody */ + inherits?: Inherits + implements?: Inherits[] + /** URL path properties */ + path: Property[] + /** Query string properties */ + query: Property[] + // FIXME: we need an annotation that lists query params replaced by a body property so that we can skip them. + // Examples on _search: sort -> sort, _source -> (_source, _source_include, _source_exclude) + // Or can we say that implicitly a body property replaces all path params starting with its name? + // Is there a priority rule between path and body parameters? + // + // We can also pull path parameter descriptions on body properties they replace + + /** + * Body type. Most often a list of properties (that can extend those of the inherited class, see above), except for a + * few specific cases that use other types such as bulk (array) or create (generic parameter). Or NoBody for requests + * that don't have a body. + */ + body: Body + behaviors?: Inherits[] + attachedBehaviors?: string[] +} + +/** + * A response type + */ +export class Response extends BaseType { + kind: 'response' + generics?: TypeName[] + inherits?: Inherits + implements?: Inherits[] + body: Body + behaviors?: Inherits[] + attachedBehaviors?: string[] +} + +export type Body = ValueBody | PropertiesBody | NoBody + +export class ValueBody { + kind: 'value' + value: ValueOf + codegenName?: string +} + +export class PropertiesBody { + kind: 'properties' + properties: Property[] +} + +export class NoBody { + kind: 'no_body' +} + +/** + * An enumeration member. + * + * When enumeration members can become ambiguous when translated to an identifier, the `name` property will be a good + * identifier name, and `stringValue` will be the string value to use on the wire. + * See DateMathTimeUnit for an example of this, which have members for "m" (minute) and "M" (month). + */ +export class EnumMember { + /** The identifier to use for this enum */ + name: string + /** An optional set of aliases for `name` */ + aliases?: string[] + /** + * If specified takes precedence over `name` when generating code. `name` is always the value + * to be sent over the wire + */ + codegenName?: string + description?: string + deprecation?: Deprecation + since?: string +} + +/** + * An enumeration + */ +export class Enum extends BaseType { + kind: 'enum' + /** + * If the enum is open, it means that other than the specified values it can accept an arbitrary value. + * If this property is not present, it means that the enum is not open (in other words, is closed). + */ + isOpen?: boolean + members: EnumMember[] +} + +/** + * An alias for an existing type. + */ +export class TypeAlias extends BaseType { + kind: 'type_alias' + type: ValueOf + /** generic parameters: either concrete types or open parameters from the enclosing type */ + generics?: TypeName[] + /** Only applicable to `union_of` aliases: identify typed_key unions (external) and variant inventories (internal) */ + variants?: InternalTag | ExternalTag +} + +// ------------------------------------------------------------------------------------------------ + +export enum Stability { + stable = 'stable', + beta = 'beta', + experimental = 'experimental' +} +export enum Visibility { + public = 'public', + featureFlag = 'feature_flag', + private = 'private' +} + +export class Deprecation { + version: string + description: string +} + +export class Endpoint { + name: string + description: string + docUrl: string + docId?: string + deprecation?: Deprecation + + /** + * If the request value is `null` it means that there is not yet a + * request type definition for this endpoint. + */ + request: TypeName | null + requestBodyRequired: boolean // Not sure this is useful + + /** + * If the response value is `null` it means that there is not yet a + * response type definition for this endpoint. + */ + response: TypeName | null + + urls: UrlTemplate[] + + /** + * The version when this endpoint reached its current stability level. + * Missing data means "forever", i.e. before any of the target client versions produced from this spec. + */ + since?: string + stability?: Stability + visibility?: Visibility + requestMediaType?: string[] + responseMediaType?: string[] + privileges?: { + index?: string[] + cluster?: string[] + } +} + +export class UrlTemplate { + path: string + methods: string[] + deprecation?: Deprecation +} + +export class Model { + _info?: { + title: string + license: { + name: string + url: string + } + } + + types: TypeDefinition[] + endpoints: Endpoint[] +} diff --git a/compiler/model/utils.ts b/compiler/src/model/utils.ts similarity index 74% rename from compiler/model/utils.ts rename to compiler/src/model/utils.ts index 93da3c3b92..f779171a5f 100644 --- a/compiler/model/utils.ts +++ b/compiler/src/model/utils.ts @@ -17,6 +17,9 @@ * under the License. */ +/* eslint-disable no-empty */ + +import { deepStrictEqual } from 'assert' import { ts, ClassDeclaration, @@ -32,11 +35,12 @@ import { Node, Project } from 'ts-morph' +import { closest } from 'fastest-levenshtein' import semver from 'semver' import chalk from 'chalk' import * as model from './metamodel' import { EOL } from 'os' -import { dirname, sep } from 'path' +import { dirname, join, sep } from 'path' /** * Behaviors that the compiler recognized @@ -47,7 +51,8 @@ export const knownBehaviors = [ 'AdditionalProperties', 'AdditionalProperty', 'CommonQueryParameters', - 'CommonCatQueryParameters' + 'CommonCatQueryParameters', + 'OverloadOf' ] /** @@ -72,7 +77,7 @@ export function modelType (node: Node): model.ValueOf { kind: 'instance_of', type: { name: 'boolean', - namespace: 'internal' + namespace: '_builtins' } } return type @@ -83,7 +88,7 @@ export function modelType (node: Node): model.ValueOf { kind: 'instance_of', type: { name: 'string', - namespace: 'internal' + namespace: '_builtins' } } return type @@ -94,7 +99,7 @@ export function modelType (node: Node): model.ValueOf { kind: 'instance_of', type: { name: 'number', - namespace: 'internal' + namespace: '_builtins' } } return type @@ -105,7 +110,7 @@ export function modelType (node: Node): model.ValueOf { kind: 'instance_of', type: { name: 'null', - namespace: 'internal' + namespace: '_builtins' } } return type @@ -116,7 +121,7 @@ export function modelType (node: Node): model.ValueOf { kind: 'instance_of', type: { name: 'void', - namespace: 'internal' + namespace: '_builtins' } } return type @@ -129,7 +134,7 @@ export function modelType (node: Node): model.ValueOf { kind: 'instance_of', type: { name: 'object', - namespace: 'internal' + namespace: '_builtins' } } return type @@ -178,6 +183,33 @@ export function modelType (node: Node): model.ValueOf { return type } + case ts.SyntaxKind.TrueKeyword: { + assert(node, Node.isTrueLiteral(node), `The node is not of type ${ts.SyntaxKind[ts.SyntaxKind.TrueKeyword]} but ${ts.SyntaxKind[node.getKind()]} instead`) + const type: model.LiteralValue = { + kind: 'literal_value', + value: true + } + return type + } + + case ts.SyntaxKind.FalseKeyword: { + assert(node, Node.isFalseLiteral(node), `The node is not of type ${ts.SyntaxKind[ts.SyntaxKind.FalseKeyword]} but ${ts.SyntaxKind[node.getKind()]} instead`) + const type: model.LiteralValue = { + kind: 'literal_value', + value: false + } + return type + } + + case ts.SyntaxKind.NumericLiteral: { + assert(node, Node.isNumericLiteral(node), `The node is not of type ${ts.SyntaxKind[ts.SyntaxKind.NumericLiteral]} but ${ts.SyntaxKind[node.getKind()]} instead`) + const type: model.LiteralValue = { + kind: 'literal_value', + value: Number(node.getText()) + } + return type + } + case ts.SyntaxKind.TypeParameter: { assert(node, Node.isTypeParameterDeclaration(node), `The node is not of type ${ts.SyntaxKind[ts.SyntaxKind.TypeReference]} but ${ts.SyntaxKind[node.getKind()]} instead`) const name = node.compilerNode.getText() @@ -199,7 +231,7 @@ export function modelType (node: Node): model.ValueOf { // The two most important fields of a TypeReference are `typeName` and `typeArguments`, // the first one is the name of the type (eg: `Foo`), while the second is the // possible generics (eg: Foo => T will be in typeArguments). - assert(node, Node.isTypeReferenceNode(node), `The node is not of type ${ts.SyntaxKind[ts.SyntaxKind.TypeReference]} but ${ts.SyntaxKind[node.getKind()]} instead`) + assert(node, Node.isTypeReference(node), `The node is not of type ${ts.SyntaxKind[ts.SyntaxKind.TypeReference]} but ${ts.SyntaxKind[node.getKind()]} instead`) const identifier = node.getTypeName() assert(node, Node.isIdentifier(identifier), 'Should be an identifier') @@ -216,6 +248,17 @@ export function modelType (node: Node): model.ValueOf { return type } + case 'ArrayBuffer': { + const type: model.InstanceOf = { + kind: 'instance_of', + type: { + name: 'binary', + namespace: '_builtins' + } + } + return type + } + case 'Dictionary': case 'AdditionalProperties': { assert(node, node.getTypeArguments().length === 2, 'A Dictionary must have two arguments') @@ -253,6 +296,7 @@ export function modelType (node: Node): model.ValueOf { const generics = node.getTypeArguments().map(node => modelType(node)) const identifier = node.getTypeName() assert(node, Node.isIdentifier(identifier), 'Not an identifier') + assert(node, identifier.getDefinitions().length > 0, 'Unknown definition (missing import?)') const declaration = identifier.getDefinitions()[0].getDeclarationNode() // We are looking at a generic parameter @@ -371,7 +415,8 @@ export function modelGenerics (node: TypeParameterDeclaration): string { * which returns an array that only contains the member of the Enum. */ export function modelEnumDeclaration (declaration: EnumDeclaration): model.Enum { - return { + const type: model.Enum = { + specLocation: sourceLocation(declaration), name: { name: declaration.getName(), namespace: getNameSpace(declaration) @@ -389,6 +434,17 @@ export function modelEnumDeclaration (declaration: EnumDeclaration): model.Enum return member }) } + + const tags = parseJsDocTags(declaration.getJsDocs()) + if (typeof tags.non_exhaustive === 'string') { + type.isOpen = true + } + + if (typeof tags.es_quirk === 'string') { + type.esQuirk = tags.es_quirk + } + + return type } /** @@ -407,6 +463,7 @@ export function modelTypeAlias (declaration: TypeAliasDeclaration): model.TypeAl const alias = modelType(type) const typeAlias: model.TypeAlias = { + specLocation: sourceLocation(declaration), name: { name: declaration.getName(), namespace: getNameSpace(declaration) @@ -452,16 +509,15 @@ export function modelProperty (declaration: PropertySignature | PropertyDeclarat } /** - * Pulls @obsolete and @obsolete_description from types and properties + * Pulls @deprecated from types and properties */ -function setObsolete (type: model.BaseType | model.Property | model.EnumMember, tags: Record): void { - const obsolete = tags.obsolete - const description = tags.obsolete_description - if (obsolete !== undefined) { - type.deprecation = { version: obsolete, description: description } +function setDeprecated (type: model.BaseType | model.Property | model.EnumMember, tags: Record, jsDocs: JSDoc[]): void { + if (tags.deprecated !== undefined) { + const [version, ...description] = tags.deprecated.split(' ') + assert(jsDocs, semver.valid(version), 'Invalid semver value') + type.deprecation = { version, description: description.join(' ') } } - delete tags.obsolete - delete tags.obsolete_description + delete tags.deprecated } /** @@ -476,7 +532,7 @@ function setTags !validTags.includes(tag)) assert( jsDocs, @@ -505,8 +561,17 @@ export function hoistRequestAnnotations ( request: model.Request, jsDocs: JSDoc[], mappings: Record, response: model.TypeName | null ): void { const knownRequestAnnotations = [ - 'since', 'rest_spec_name', 'stability', 'visibility', 'behavior', 'class_serializer' + 'since', 'rest_spec_name', 'stability', 'visibility', 'behavior', 'class_serializer', 'index_privileges', 'cluster_privileges', 'doc_id' ] + // in most of the cases the jsDocs comes in a single block, + // but it can happen that the user defines multiple single line jsDoc. + // We want to enforce a single jsDoc block. + assert(jsDocs, jsDocs.length < 2, 'Use a single multiline jsDoc block instead of multiple single line blocks') + + if (jsDocs.length === 1) { + const description = jsDocs[0].getDescription() + if (description.length > 0) request.description = description.trim() + } const tags = parseJsDocTags(jsDocs) const apiName = tags.rest_spec_name // TODO (@typescript-eslint/strict-boolean-expressions) is no fun @@ -514,7 +579,7 @@ export function hoistRequestAnnotations ( `Request ${request.name.name} does not declare the @rest_spec_name to link back to`) const endpoint = mappings[apiName] - assert(jsDocs, endpoint != null, `${apiName} is not represented in the spec as a json file`) + assert(jsDocs, endpoint != null, `The api '${apiName}' does not exists, did you mean '${closest(apiName, Object.keys(mappings))}'?`) endpoint.request = request.name endpoint.response = response @@ -530,14 +595,42 @@ export function hoistRequestAnnotations ( } endpoint.visibility = model.Visibility[value] } else if (tag === 'stability') { - if (value !== 'TODO' && endpoint.stability !== null && endpoint.stability !== undefined) { - assert(jsDocs, endpoint.stability === value, - `Request ${request.name.name} stability on annotation ${value} does not match spec: ${endpoint.stability ?? ''}`) - } + assert(jsDocs, endpoint.stability === value, + `Request ${request.name.name} stability on annotation ${value} does not match spec: ${endpoint.stability ?? ''}`) endpoint.stability = model.Stability[value] } else if (tag === 'since') { assert(jsDocs, semver.valid(value), `Request ${request.name.name}'s @since is not valid semver: ${value}`) endpoint.since = value + } else if (tag === 'index_privileges') { + const privileges = [ + 'all', 'auto_configure', 'create', 'create_doc', 'create_index', 'delete', 'delete_index', 'index', + 'maintenance', 'manage', 'manage_follow_index', 'manage_ilm', 'manage_leader_index', 'monitor', + 'read', 'read_cross_cluster', 'view_index_metadata', 'write' + ] + const values = parseCommaSeparated(value) + for (const v of values) { + assert(jsDocs, privileges.includes(v), `The index privilege '${v}' does not exists.`) + } + endpoint.privileges = endpoint.privileges ?? {} + endpoint.privileges.index = values + } else if (tag === 'cluster_privileges') { + const privileges = [ + 'all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr', + 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', + 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', + 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', + 'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', + 'monitor_transform', 'monitor_watcher', 'read_ccr', 'read_ilm', 'read_pipeline', 'read_slm', 'transport_client' + ] + const values = parseCommaSeparated(value) + for (const v of values) { + assert(jsDocs, privileges.includes(v), `The cluster privilege '${v}' does not exists.`) + } + endpoint.privileges = endpoint.privileges ?? {} + endpoint.privileges.cluster = values + } else if (tag === 'doc_id') { + assert(jsDocs, value.trim() !== '', `Request ${request.name.name}'s @doc_id is cannot be empty`) + endpoint.docId = value } else { assert(jsDocs, false, `Unhandled tag: '${tag}' with value: '${value}' on request ${request.name.name}`) } @@ -551,11 +644,12 @@ export function hoistTypeAnnotations (type: model.TypeDefinition, jsDocs: JSDoc[ // We want to enforce a single jsDoc block. assert(jsDocs, jsDocs.length < 2, 'Use a single multiline jsDoc block instead of multiple single line blocks') - const validTags = ['class_serializer', 'doc_url', 'behavior', 'variants', 'variant', 'shortcut_property'] + const validTags = ['class_serializer', 'doc_url', 'doc_id', 'behavior', 'variants', 'variant', 'shortcut_property', + 'codegen_names', 'non_exhaustive', 'es_quirk'] const tags = parseJsDocTags(jsDocs) if (jsDocs.length === 1) { const description = jsDocs[0].getDescription() - if (description.length > 0) type.description = description.split(EOL).filter(Boolean).join(EOL) + if (description.length > 0) type.description = description.trim() } setTags(jsDocs, type, tags, validTags, (tags, tag, value) => { @@ -569,8 +663,22 @@ export function hoistTypeAnnotations (type: model.TypeDefinition, jsDocs: JSDoc[ } } else if (tag === 'variants') { } else if (tag === 'variant') { + } else if (tag === 'non_exhaustive') { + assert(jsDocs, typeof tags.variants === 'string', '@non_exhaustive only applies to enums and @variants') } else if (tag === 'doc_url') { + assert(jsDocs, isValidUrl(value), '@doc_url is not a valid url') type.docUrl = value + } else if (tag === 'doc_id') { + assert(jsDocs, value.trim() !== '', `Type ${type.name.namespace}.${type.name.name}'s @doc_id cannot be empty`) + type.docId = value.trim() + } else if (tag === 'codegen_names') { + type.codegenNames = parseCommaSeparated(value) + assert(jsDocs, + type.kind === 'type_alias' && type.type.kind === 'union_of' && type.type.items.length === type.codegenNames.length, + '@codegen_names must have the number of items as the union definition' + ) + } else if (tag === 'es_quirk') { + type.esQuirk = value } else { assert(jsDocs, false, `Unhandled tag: '${tag}' with value: '${value}' on type ${type.name.name}`) } @@ -584,42 +692,89 @@ function hoistPropertyAnnotations (property: model.Property, jsDocs: JSDoc[]): v // We want to enforce a single jsDoc block. assert(jsDocs, jsDocs.length < 2, 'Use a single multiline jsDoc block instead of multiple single line blocks') - const validTags = ['stability', 'prop_serializer', 'doc_url', 'aliases', 'identifier', 'since', 'server_default', 'variant'] + const validTags = ['stability', 'prop_serializer', 'doc_url', 'aliases', 'codegen_name', 'since', 'server_default', + 'variant', 'doc_id', 'es_quirk'] const tags = parseJsDocTags(jsDocs) if (jsDocs.length === 1) { const description = jsDocs[0].getDescription() - if (description.length > 0) property.description = description.split(EOL).filter(Boolean).join(EOL) + if (description.length > 0) property.description = description.trim() } setTags(jsDocs, property, tags, validTags, (tags, tag, value) => { if (tag.endsWith('_serializer')) { } else if (tag === 'aliases') { - property.aliases = value.split(',').map(v => v.trim()) - } else if (tag === 'identifier') { - property.identifier = value + property.aliases = parseCommaSeparated(value) + } else if (tag === 'codegen_name') { + property.codegenName = value } else if (tag === 'doc_url') { + assert(jsDocs, isValidUrl(value), '@doc_url is not a valid url') property.docUrl = value } else if (tag === 'since') { assert(jsDocs, semver.valid(value), `${property.name}'s @since is not valid semver: ${value}`) property.since = value + } else if (tag === 'doc_id') { + assert(jsDocs, value.trim() !== '', `Property ${property.name}'s @doc_id is cannot be empty`) + property.docId = value + } else if (tag === 'stability') { + assert(jsDocs, model.Stability[value] != null, `Property ${property.name}'s @stability can be either 'beta' or 'experimental'`) + property.stability = model.Stability[value] } else if (tag === 'server_default') { - assert(jsDocs, property.type.kind === 'instance_of', `Default values can only be configured for instance_of types, you are using ${property.type.kind}`) + assert(jsDocs, property.type.kind === 'instance_of' || property.type.kind === 'union_of' || property.type.kind === 'array_of', `Default values can only be configured for instance_of or union_of types, you are using ${property.type.kind}`) assert(jsDocs, !property.required, 'Default values can only be specified on optional properties') - switch (property.type.type.name) { - case 'boolean': - assert(jsDocs, value === 'true' || value === 'false', `The default value for ${property.name} should be a boolean`) - property.serverDefault = value === 'true' - break - case 'number': - assert(jsDocs, !isNaN(Number(value)), `The default value for ${property.name} should be a number`) - property.serverDefault = Number(value) - break - default: - property.serverDefault = value + if (property.type.kind === 'union_of') { + let valueType = '' + if (value === 'true' || value === 'false') { + valueType = 'boolean' + } else if (!isNaN(Number(value))) { + valueType = 'number' + } else { + valueType = 'string' + } + const unionTypes = property.type.items.map(item => { + assert(jsDocs, item.kind === 'instance_of', `Default values in unions can only be configured for instance_of types, you are using ${property.type.kind}`) + if (['short', 'byte', 'integer', 'uint', 'long', 'ulong', 'float', 'double', 'Percentage'].includes(item.type.name)) { + return 'number' + } + return item.type.name + }) + assert(jsDocs, unionTypes.includes(valueType), `The configured server_default value is not present in the union value: ${unionTypes.join(' | ')}`) + property.serverDefault = value + } else if (property.type.kind === 'array_of') { + try { + value = eval(value) // eslint-disable-line + } catch (err) { + assert(jsDocs, false, 'The default value is not formatted properly') + } + assert(jsDocs, Array.isArray(value), 'The default value should be an array') + property.serverDefault = value + } else { + switch (property.type.type.name) { + case 'boolean': + assert(jsDocs, value === 'true' || value === 'false', `The default value for ${property.name} should be a boolean`) + property.serverDefault = value === 'true' + break + case 'number': + case 'short': + case 'byte': + case 'integer': + case 'uint': + case 'long': + case 'ulong': + case 'float': + case 'double': + case 'Percentage': + assert(jsDocs, !isNaN(Number(value)), `The default value for ${property.name} should be a number`) + property.serverDefault = Number(value) + break + default: + property.serverDefault = value + } } } else if (tag === 'variant') { assert(jsDocs, value === 'container_property', `Unknown 'variant' value '${value}' on property ${property.name}`) property.containerProperty = true + } else if (tag === 'es_quirk') { + property.esQuirk = value } else { assert(jsDocs, false, `Unhandled tag: '${tag}' with value: '${value}' on property ${property.name}`) } @@ -632,16 +787,18 @@ function hoistEnumMemberAnnotations (member: model.EnumMember, jsDocs: JSDoc[]): // We want to enforce a single jsDoc block. assert(jsDocs, jsDocs.length < 2, 'Use a single multiline jsDoc block instead of multiple single line blocks') - const validTags = ['obsolete', 'obsolete_description', 'identifier', 'since'] + const validTags = ['obsolete', 'obsolete_description', 'codegen_name', 'since', 'aliases'] const tags = parseJsDocTags(jsDocs) if (jsDocs.length === 1) { const description = jsDocs[0].getDescription() - if (description.length > 0) member.description = description.split(EOL).filter(Boolean).join(EOL) + if (description.length > 0) member.description = description.trim() } setTags(jsDocs, member, tags, validTags, (tags, tag, value) => { - if (tag === 'identifier') { - member.identifier = value + if (tag === 'codegen_name') { + member.codegenName = value + } else if (tag === 'aliases') { + member.aliases = parseCommaSeparated(value) } else if (tag === 'since') { assert(jsDocs, semver.valid(value), `${member.name}'s @since is not valid semver: ${value}`) member.since = value @@ -676,20 +833,20 @@ export function isKnownBehavior (node: HeritageClause | ExpressionWithTypeArgume /** * Given a Node, it returns its namespace computed from the symbol declarations. - * If it can't compute it, defaults to `internal`. + * If it can't compute it, defaults to `_builtins`. */ export function getNameSpace (node: Node): string { // if the node we are checking is a TypeReferenceNode, - // then we can get the identifier and find where + // then we can get the codegen_name and find where // it has been defined and compute the namespace from that. - if (Node.isTypeReferenceNode(node)) { + if (Node.isTypeReference(node)) { const identifier = node.getTypeName() if (Node.isIdentifier(identifier)) { const name = identifier.compilerNode.escapedText as string // the Array object is defined by TypeScript - if (name === 'Array') return 'internal' + if (name === 'Array') return '_builtins' const definition = identifier.getDefinitions()[0] - assert(identifier, definition != null, 'Cannot find identifier') + assert(identifier, definition != null, 'Cannot find codegen_name') return cleanPath(definition.getSourceFile().getFilePath()) } } @@ -703,7 +860,7 @@ export function getNameSpace (node: Node): string { const declaration = node.getType().getSymbol()?.getDeclarations()[0] if (declaration == null) { - return 'internal' + return '_builtins' } return cleanPath(declaration.getSourceFile().getFilePath()) @@ -712,7 +869,7 @@ export function getNameSpace (node: Node): string { path = dirname(path) .replace(/.*[/\\]specification[/\\]?/, '') .replace(/[/\\]/g, '.') - if (path === '') path = 'internal' + if (path === '') path = '_builtins' return path } } @@ -728,7 +885,7 @@ export function getAllBehaviors (node: ClassDeclaration | InterfaceDeclaration): .map(t => t.getExpression()) for (const extend of extended) { - assert(extend, Node.isReferenceFindableNode(extend), 'Should be a reference node') + assert(extend, Node.isReferenceFindable(extend), 'Should be a reference node') const declaration = extend.getType().getSymbol()?.getDeclarations()[0] assert(extend, declaration != null, `Cannot find declaration for ${extend.getText()}`) if (Node.isClassDeclaration(declaration) || Node.isInterfaceDeclaration(declaration)) { @@ -787,24 +944,33 @@ export function parseVariantsTag (jsDoc: JSDoc[]): model.Variants | undefined { return undefined } - const [type, value] = tags.variants.split(' ') + const nonExhaustive = (typeof tags.non_exhaustive === 'string') ? true : undefined + + const [type, ...values] = tags.variants.split(' ') if (type === 'external') { - return { kind: 'external_tag' } + return { + kind: 'external_tag', + nonExhaustive: nonExhaustive + } } if (type === 'container') { - return { kind: 'container' } + return { + kind: 'container', + nonExhaustive: nonExhaustive + } } assert(jsDoc, type === 'internal', `Bad variant type: ${type}`) - assert(jsDoc, typeof value === 'string', 'Internal variant requires a tag definition') - const [tag, property] = value.split('=') - assert(jsDoc, tag === 'tag', 'The tag name should be "tag"') - assert(jsDoc, typeof property === 'string', 'The tag property is not defined') + + const pairs = parseKeyValues(jsDoc, values, 'tag', 'default') + assert(jsDoc, typeof pairs.tag === 'string', 'Internal variant requires a tag definition') return { kind: 'internal_tag', - tag: property.replace(/'/g, '') + nonExhaustive: nonExhaustive, + tag: pairs.tag, + defaultTag: pairs.default } } @@ -819,12 +985,38 @@ export function parseVariantNameTag (jsDoc: JSDoc[]): string | undefined { } const [key, name] = tags.variant.split('=') - assert(jsDoc, key === 'name', 'The key value should be "name"') - assert(jsDoc, typeof name === 'string', 'The key value should be "name"') + assert(jsDoc, key === 'name', 'The @variant key should be "name"') + assert(jsDoc, typeof name === 'string', 'The @variant key should be "name"') return name.replace(/'/g, '') } +/** + * Parses a list of comma-separated values as an array. Values can optionally be enclosed with single + * or double quotes. + */ +export function parseCommaSeparated (value: string): string[] { + return value.split(',').map(v => v.trim().replace(/["']/g, '')) +} + +/** + * Parses an array of "key=value" pairs and validate key names. Values can optionally be enclosed with single + * or double quotes. If there is only a key with no value (no '=') the value is set to 'true' + */ +export function parseKeyValues (node: Node | Node[], pairs: string[], ...validKeys: string[]): Record { + const result = {} + pairs.forEach(item => { + const kv = item.split('=') + assert(node, kv.length <= 2, 'Malformed key/value list') + if (kv.length === 1) { + kv.push('true') + } + assert(node, validKeys.includes(kv[0]), `Unknown key '${kv[0]}'`) + result[kv[0]] = kv[1].replace(/["']/g, '') + }) + return result +} + /** * Given a declaration, returns true if the declaration * if defined but never used, false otherwise. @@ -1031,3 +1223,28 @@ export function verifyUniqueness (project: Project): void { types.set(path, names) } } + +export function isValidUrl (str: string): boolean { + try { + new URL(str) // eslint-disable-line + return true + } catch (err) { + return false + } +} + +export function deepEqual (a: any, b: any): boolean { + try { + deepStrictEqual(a, b) + return true + } catch (err) { + return false + } +} + +const basePath = join(__dirname, '..', '..', '..', 'specification') + '/' + +export function sourceLocation (node: Node): string { + const sourceFile = node.getSourceFile() + return `${sourceFile.getFilePath().replace(basePath, '')}#L${node.getStartLineNumber(true)}-L${node.getEndLineNumber()}` +} diff --git a/compiler/steps/add-content-type.ts b/compiler/src/steps/add-content-type.ts similarity index 81% rename from compiler/steps/add-content-type.ts rename to compiler/src/steps/add-content-type.ts index ad6e315962..23f509e80d 100644 --- a/compiler/steps/add-content-type.ts +++ b/compiler/src/steps/add-content-type.ts @@ -22,8 +22,9 @@ import * as model from '../model/metamodel' import { JsonSpec } from '../model/json-spec' /** - * Adds the `accept` and `contentType` fields to every endpoint - * from the rest-api-spec if present. + * Adds the `responseMediaType` (accept in the rest-api-spec) + * and `responseMediaType` (content_type in the rest api spec) + * fields to every endpoint from the rest-api-spec if present. */ export default async function addContentType (model: model.Model, jsonSpec: Map): Promise { for (const endpoint of model.endpoints) { @@ -31,11 +32,11 @@ export default async function addContentType (model: model.Model, jsonSpec: Map< assert(spec, `Can't find the json spec for ${endpoint.name}`) if (Array.isArray(spec.headers.accept)) { - endpoint.accept = spec.headers.accept + endpoint.responseMediaType = spec.headers.accept } if (Array.isArray(spec.headers.content_type)) { - endpoint.contentType = spec.headers.content_type + endpoint.requestMediaType = spec.headers.content_type } } diff --git a/compiler/steps/add-description.ts b/compiler/src/steps/add-description.ts similarity index 67% rename from compiler/steps/add-description.ts rename to compiler/src/steps/add-description.ts index 9318886b95..299a93dc23 100644 --- a/compiler/steps/add-description.ts +++ b/compiler/src/steps/add-description.ts @@ -29,7 +29,7 @@ import { JsonSpec } from '../model/json-spec' export default async function addDescription (model: model.Model, jsonSpec: Map): Promise { for (const endpoint of model.endpoints) { if (endpoint.request == null) continue - const requestDefinition = getDefinition(endpoint.request.name) + const requestDefinition = getDefinition(endpoint.request) const spec = jsonSpec.get(endpoint.name) assert(spec, `Can't find the json spec for ${endpoint.name}`) @@ -40,21 +40,36 @@ export default async function addDescription (model: model.Model, jsonSpec: Map< }) if (definition?.parts != null) { const { description } = definition.parts[property.name] - property.description = description + if (typeof description === 'string') { + property.description = property.description ?? description + } } } + + if (spec.params != null) { + for (const property of requestDefinition.query) { + const param = spec.params[property.name] + if (param != null && typeof param.description === 'string') { + property.description = property.description ?? param.description + } + } + } + + if (spec.documentation.description != null) { + requestDefinition.description = requestDefinition.description ?? spec.documentation.description + } } return model - function getDefinition (name: string): model.Request { + function getDefinition (request: model.TypeName): model.Request { for (const type of model.types) { if (type.kind === 'request') { - if (type.name.name === name) { + if (type.name.name === request.name && type.name.namespace === request.namespace) { return type } } } - throw new Error(`Can't find the request definiton for ${name}`) + throw new Error(`Can't find the request definiton for ${request.namespace}.${request.name}`) } } diff --git a/specification/cat/jobs/CatJobsRequest.ts b/compiler/src/steps/add-info.ts similarity index 62% rename from specification/cat/jobs/CatJobsRequest.ts rename to compiler/src/steps/add-info.ts index ea25725ba8..19205c22d3 100644 --- a/specification/cat/jobs/CatJobsRequest.ts +++ b/compiler/src/steps/add-info.ts @@ -17,21 +17,20 @@ * under the License. */ -import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, Id } from '@_types/common' +import * as model from '../model/metamodel' +import { JsonSpec } from '../model/json-spec' /** - * @rest_spec_name cat.ml_jobs - * @since 7.7.0 - * @stability TODO + * Adds the `_info` field to the JSON model. */ -export interface Request extends CatRequestBase { - path_parts?: { - job_id?: Id +export default async function addInfo (model: model.Model, jsonSpec: Map): Promise { + model._info = { + title: 'Elasticsearch Request & Response Specification', + license: { + name: 'Apache 2.0', + url: 'https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE' + } } - query_parameters?: { - allow_no_jobs?: boolean - bytes?: Bytes - } - body?: {} + + return model } diff --git a/compiler/src/steps/read-definition-validation.ts b/compiler/src/steps/read-definition-validation.ts new file mode 100644 index 0000000000..cf1b5ce668 --- /dev/null +++ b/compiler/src/steps/read-definition-validation.ts @@ -0,0 +1,123 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import assert from 'assert' +import * as model from '../model/metamodel' +import { JsonSpec } from '../model/json-spec' +import chalk from 'chalk' + +/** + * Verifies if "read" version of interface definitions + * contains the same properties of their "write" version. + * Then, it copies every model.Property from write to read but 'required'. + */ +export default async function readDefinitionValidation (model: model.Model, jsonSpec: Map): Promise { + for (const type of model.types) { + if (type.kind !== 'interface') continue + const readBehavior = type.behaviors?.find(behavior => behavior.type.name === 'OverloadOf') + if (readBehavior == null) continue + assert(Array.isArray(readBehavior.generics)) + assert(readBehavior.generics[0].kind === 'instance_of') + + for (const parent of model.types) { + if (parent.name.name === readBehavior.generics[0].type.name && parent.name.namespace === readBehavior.generics[0].type.namespace) { + assert(parent.kind === 'interface') + const readProperties = type.properties.map(p => p.name) + for (const property of parent.properties) { + // have we defined the same properties? + if (!readProperties.includes(property.name)) { + console.log(chalk.red`The property '${property.name}' is present in ${parent.name.namespace}.${parent.name.name} but not in ${type.name.namespace}.${type.name.name}`) + process.exit(1) + } + + const readProperty = type.properties.find(p => p.name === property.name) as model.Property + + if (property.type.kind === 'union_of' && property.type.items.some(contains(readProperty.type))) { + // this is allowed, as if the original property type is an union (of type and type[]), + // the overloaded property type should be either the same type or an element of the union + } else if (isOverloadOf(readProperty.type, property.type)) { + // this is allowed, as if the overloaded property has a different type, + // this type should be an overload of the original property type + } else if (!deepEqual(readProperty.type, property.type)) { + console.log(chalk.red`The property '${property.name}' present in ${parent.name.namespace}.${parent.name.name} does not have the same type in ${type.name.namespace}.${type.name.name}`) + process.exit(1) + } + + // we have the same properties, so let's copy the metadata + for (const key in property) { + if (key === 'required') continue + if (readProperty[key] == null) { + readProperty[key] = property[key] + } + } + } + } + } + } + + return model + + function isOverloadOf (readType: model.ValueOf, type: model.ValueOf): boolean { + const readTypeInstance = unwrap(readType) + const typeInstance = unwrap(type) + if (readTypeInstance == null || typeInstance == null) return false + if (readTypeInstance.type.namespace !== '_builtins') { + const definition = model.types.find(t => t.name.namespace === readTypeInstance.type.namespace && t.name.name === readTypeInstance.type.name) + return definition?.kind === 'interface' && (definition.behaviors?.some(overloaded) ?? false) + } + return false + + function overloaded (def: model.Inherits): boolean { + if (def.type.name !== 'OverloadOf') return false + assert(Array.isArray(def.generics)) + return def.generics[0].kind === 'instance_of' && + def.generics[0].type.namespace === typeInstance?.type.namespace && + def.generics[0].type.name === typeInstance?.type.name + } + + function unwrap (type: model.ValueOf): model.InstanceOf | null { + switch (type.kind) { + case 'instance_of': + return type + case 'array_of': + return unwrap(type.value) + default: + return null + } + } + } + + function contains (readType: model.ValueOf) { + return function (type: model.ValueOf, index: number, arr: model.ValueOf[]): boolean { + if (type.kind === 'array_of') { + return deepEqual(type.value, readType) + } + return deepEqual(type, readType) + } + } + + function deepEqual (a: any, b: any): boolean { + try { + assert.deepStrictEqual(a, b) + return true + } catch (err) { + return false + } + } +} diff --git a/compiler/steps/validate-model.ts b/compiler/src/steps/validate-model.ts similarity index 96% rename from compiler/steps/validate-model.ts rename to compiler/src/steps/validate-model.ts index 0808b341ae..48d32a4d56 100644 --- a/compiler/steps/validate-model.ts +++ b/compiler/src/steps/validate-model.ts @@ -158,13 +158,15 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma 'string', 'boolean', 'number', 'null' ]) { const typeName = { - namespace: 'internal', + namespace: '_builtins', name: name } typeDefByName.set(fqn(typeName), { kind: 'interface', name: typeName, - properties: [] + properties: [], + // arbitrary location, it's not written to schema.json + specLocation: '' }) } @@ -174,7 +176,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma // ----- Alright, let's go! function readyForValidation (ep: model.Endpoint): boolean { - return ep.stability !== model.Stability.TODO && ep.request != null && ep.response != null + return ep.request != null && ep.response != null } // Validate all endpoints. We start by those that are ready for validation so that transitive validation of common @@ -380,7 +382,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma validateImplements(typeDef.implements, openGenerics) validateBehaviors(typeDef, openGenerics) - // Note: we validate identifier/name uniqueness independently in the path, query and body as there are some + // Note: we validate codegen_name/name uniqueness independently in the path, query and body as there are some // valid overlaps, with some parameters that can also be represented as body properties. // Client generators will have to take care of this. @@ -425,7 +427,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma validateImplements(typeDef.implements, openGenerics) validateBehaviors(typeDef, openGenerics) - // Note: we validate identifier/name uniqueness independently in the path, query and body as there are some + // Note: we validate codegen_name/name uniqueness independently in the path, query and body as there are some // valid overlaps, with some parameters that can also be represented as body properties. // Client generators will have to take care of this. @@ -458,7 +460,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma const result = accum ?? new Set() function addProperties (props: model.Property[]): void { - props.forEach(prop => result.add((prop.identifier ?? prop.name).toLowerCase())) + props.forEach(prop => result.add((prop.codegenName ?? prop.name).toLowerCase())) } function addInherits (inherits?: model.Inherits): void { @@ -537,11 +539,11 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma for (const item of typeDef.members) { // Identifier must be unique among all items (case insensitive) - const identifier = (item.identifier ?? item.name).toLowerCase() - if (allIdentifiers.has(identifier)) { - modelError(`Duplicate enum member identifier '${item.name}'`) + const codegenName = (item.codegenName ?? item.name).toLowerCase() + if (allIdentifiers.has(codegenName)) { + modelError(`Duplicate enum member codegen_name '${item.name}'`) } - allIdentifiers.add(identifier) + allIdentifiers.add(codegenName) // Name must be unique among all items (case sensitive) if (allNames.has(item.name)) { @@ -699,13 +701,13 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma for (const prop of props) { // Identifier must be unique among all items (case insensitive) - const identifier = (prop.identifier ?? prop.name).toLowerCase() - if (allIdentifiers.has(identifier)) { - modelError(`Duplicate property identifier: '${prop.name}'`) + const codegenName = (prop.codegenName ?? prop.name).toLowerCase() + if (allIdentifiers.has(codegenName)) { + modelError(`Duplicate property codegen_name: '${prop.name}'`) } - allIdentifiers.add(identifier) + allIdentifiers.add(codegenName) - if (inheritedProperties.has(identifier)) { + if (inheritedProperties.has(codegenName)) { modelError(`Property '${prop.name}' is already defined in an ancestor class`) } @@ -737,7 +739,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma switch (fqName) { // Base type also used as property, no polymorphic usage - case 'internal:ErrorCause': + case '_builtins:ErrorCause': case 'x_pack.enrich:EnrichPolicy': case 'x_pack.info.x_pack_usage:XPackUsage': case 'x_pack.info.x_pack_usage:SecurityFeatureToggle': @@ -823,7 +825,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma } function typeDefJsonEvents (events: Set, typeDef: model.TypeDefinition): void { - if (typeDef.name.namespace === 'internal') { + if (typeDef.name.namespace === '_builtins') { switch (typeDef.name.name) { case 'string': validateEvent(events, JsonEvent.string) diff --git a/compiler/steps/validate-rest-spec.ts b/compiler/src/steps/validate-rest-spec.ts similarity index 100% rename from compiler/steps/validate-rest-spec.ts rename to compiler/src/steps/validate-rest-spec.ts diff --git a/compiler/update-imports.ts b/compiler/src/update-imports.ts similarity index 96% rename from compiler/update-imports.ts rename to compiler/src/update-imports.ts index dd0f24feb1..9561d6adf4 100644 --- a/compiler/update-imports.ts +++ b/compiler/src/update-imports.ts @@ -46,7 +46,7 @@ Example: npm run imports:fix -- --help process.exit(0) } -const specsFolder = join(__dirname, '..', 'specification') +const specsFolder = join(__dirname, '..', '..', 'specification') const tsConfigFilePath = join(specsFolder, 'tsconfig.json') const aliasedImports: string[] = [] @@ -81,11 +81,13 @@ async function fixImports (): Promise { console.log(`Updating imports in ${sourceFile.getFilePath().replace(/.*[/\\]specification[/\\]?/, '')}`) sourceFile.fixMissingImports({ semicolons: ts.SemicolonPreference.Remove }, { quotePreference: 'single', + // @ts-expect-error importModuleSpecifierPreference: 'auto', includePackageJsonAutoImports: 'off' }) sourceFile.organizeImports({ semicolons: ts.SemicolonPreference.Remove }, { quotePreference: 'single', + // @ts-expect-error importModuleSpecifierPreference: 'auto', includePackageJsonAutoImports: 'off' }) diff --git a/compiler/validation-errors.ts b/compiler/src/validation-errors.ts similarity index 81% rename from compiler/validation-errors.ts rename to compiler/src/validation-errors.ts index de5e5c7513..221e35a072 100644 --- a/compiler/validation-errors.ts +++ b/compiler/src/validation-errors.ts @@ -49,26 +49,12 @@ export class ValidationErrors { this.generalErrors.push(message) } - /** Replace multiple errors for endpoints in the "TODO" state by a single one, to avoid clogging up the report */ - cleanup (todoEndpoints: string[]): void { - const names = new Set(todoEndpoints) - - for (const name of Object.keys(this.endpointErrors)) { - if (names.has(name)) { - this.endpointErrors[name] = { - request: ['Endpoint has "@stability: TODO'], - response: [] - } - } - } - } - /** Output this error log to the console */ log (): void { let count = 0 const logArray = function (errs: string[], prefix = ''): void { for (const err of errs) { - if (err !== 'Endpoint has "@stability: TODO' && err !== 'Missing request & response') { + if (err !== 'Missing request & response') { console.error(`${prefix}${err}`) count++ } diff --git a/compiler/steps/add-info.ts b/compiler/steps/add-info.ts deleted file mode 100644 index fd3419f356..0000000000 --- a/compiler/steps/add-info.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import * as model from '../model/metamodel' -import { JsonSpec } from '../model/json-spec' -import { execSync } from 'child_process' -import { readFileSync } from 'fs' -import { join } from 'path' - -/** - * Adds the `_info` field to the JSON model. - * If this code is being run in the base branch, it will update the version and hash - * fields with the value read from git, otherwise it will reuse the values - * currently stored in the output schema. - */ -export default async function addInfo (model: model.Model, jsonSpec: Map): Promise { - const branch = execSync('git branch --show-current').toString().trim() - const isBaseBranch = branch === 'main' || branch.startsWith('7.') - - if (isBaseBranch && process.env.SKIP_VERSION_UPDATE !== 'true') { - model._info = { - version: branch, - hash: execSync('git rev-parse --short HEAD').toString().trim(), - title: 'Elasticsearch Request & Response Specification', - license: { - name: 'Apache 2.0', - url: 'https://github.com/elastic/elasticsearch-specification/blob/master/LICENSE' - } - } - } else { - const current: model.Model = JSON.parse( - readFileSync(join(__dirname, '..', '..', 'output', 'schema', 'schema.json'), 'utf8') - ) - model._info = { - version: current._info!.version, // eslint-disable-line - hash: current._info!.hash, // eslint-disable-line - title: 'Elasticsearch Request & Response Specification', - license: { - name: 'Apache 2.0', - url: 'https://github.com/elastic/elasticsearch-specification/blob/master/LICENSE' - } - } - } - - return model -} diff --git a/compiler/tsconfig.json b/compiler/tsconfig.json index 144597cff7..e0643c58ed 100644 --- a/compiler/tsconfig.json +++ b/compiler/tsconfig.json @@ -6,7 +6,7 @@ "esModuleInterop": true, "isolatedModules": false, "jsx": "react", - "outDir": "lib/src", + "outDir": "lib", "experimentalDecorators": true, "emitDecoratorMetadata": true, "strictNullChecks": true, @@ -15,7 +15,7 @@ "removeComments": true, "noLib": false, "preserveConstEnums": true, - "sourceMap": true, + "sourceMap": false, "suppressImplicitAnyIndexErrors": true, "strictPropertyInitialization": false }, diff --git a/docs/add-new-api.md b/docs/add-new-api.md index c7e47d4e37..c4e9822c6d 100644 --- a/docs/add-new-api.md +++ b/docs/add-new-api.md @@ -5,8 +5,6 @@ in this repository, or we do have an endpoint definition in [`/specification/_js but we don't have a type definition for it. In this document you will see how to add a new endpopint and how to add a new endpoint definition. -**NOTE:** Currenlty we are following the work on the `7.x` release line. - ## How to add a new endpoint Add a new endpoint is straightforward, you only need to copy-paste the json rest-api-spec defintion @@ -62,16 +60,16 @@ Following you can find a template valid for any request definition. /* * @rest_spec_name endpoint.name * @since 1.2.3 - * @stability TODO + * @stability stable | beta | experimental */ interface Request extends RequestBase { - path_parts?: { + path_parts: { }; - query_parameters?: { + query_parameters: { }; - body?: { + body: { }; } @@ -82,16 +80,16 @@ In some cases, the request could take one or more generics, in such case the def /* * @rest_spec_name endpoint.name * @since 1.2.3 - * @stability TODO + * @stability stable | beta | experimental */ interface Request extends RequestBase { - path_parts?: { + path_parts: { }; - query_parameters?: { + query_parameters: { }; - body?: { + body: { }; } diff --git a/docs/behaviors.md b/docs/behaviors.md index 384acae1ba..9cd1578e41 100644 --- a/docs/behaviors.md +++ b/docs/behaviors.md @@ -44,3 +44,53 @@ Since these can break the request structure these are listed explicitly as a beh ```ts class CatRequestBase extends RequestBase implements CommonCatQueryParameters {} ``` + +## OverloadOf + +Defines a class that is the "overload" version of a definition used when writing a property. +A class that implements `OverloadOf` should have the exact same properties of the overloaded type. +You can change if a property is required or not and its type, as long as it's either an Overloaded type +or is part of the parent union type. There is no need to port the descriptions +and js doc tags, the compiler will do that for you. + +```ts +export class Foo { + bar?: string +} + +export class FooRead implements OverloadOf { + bar: string +} +``` + +```ts +// if the original property type is an union (of type and type[]), +// the overloaded property type should be either the same type or an element of the union +export class Foo { + bar: string | string[] +} + +export class FooRead implements OverloadOf { + bar: string[] +} +``` + +```ts +// if the overloaded property has a different type, +// this type should be an overload of the original property type +export class Foo { + bar?: string +} + +export class FooRead implements OverloadOf { + bar: string +} + +export class Config { + foo: Foo +} + +export class ConfigRead implements { + foo: FooRead +} +``` diff --git a/docs/compiler.md b/docs/compiler.md index df421617b9..b87ea7134b 100644 --- a/docs/compiler.md +++ b/docs/compiler.md @@ -3,7 +3,7 @@ The TypeScript specification is compiled to a JSON representation, that can currently be found in [`output/schema/schema.json`](../output/schema/schema.json). -The code that compiles the TypeScript specification can be found in [`/compiler`](..//compiler). +The code that compiles the TypeScript specification can be found in [`/compiler`](../compiler/src). The compiler is a TypeScript program that compiles the content of the [`/specification`](../specification) folder, given that we only need a subset of the TypeScript types, it's designed to handle only those. (classes, interfaces, Enums and type aliases). @@ -13,8 +13,8 @@ to handle only those. (classes, interfaces, Enums and type aliases). By default the compiler generates the JSON representation and writes it on disk. If needed you can add one or more intermediate steps before writing on disk, for example you can run an additional validation or change a specific field. -Take a look at the [compiler](../compiler/compiler.ts) definition -and at the [`compiler/steps`](../compiler/steps) folder +Take a look at the [compiler](../compiler/src/compiler.ts) definition +and at the [`compiler/steps`](../compiler/src/steps) folder to see the currenlty defined steps. ## Structure @@ -26,9 +26,9 @@ The compiler divides the specification into four categories: - enum declarations - type alias declarations -Then each category gets modeled according to the [metamodel](../compiler/model/metamodel.ts) +Then each category gets modeled according to the [metamodel](../compiler/src/model/metamodel.ts) that defines the structure of the JSON output. -Inside [`compiler/model/utils.ts`](../compiler/model/utils.ts) there is a set of +Inside [`compiler/model/utils.ts`](../compiler/src/model/utils.ts) there is a set of utilities that are used to model the different strctures, the most important one is `modelType`, which recursively traverse the types until everything is modeles accorduing to the metamodel. @@ -50,14 +50,14 @@ Another useful tool that you can use for understanding how a declaration gets vi Certain APIs needs to be handled differently based on the language, to express this in the specification we use behaviors. All the currently supported behaviors are living in [`specification/__spec_utils/behaviors.ts`](../specification/__spec_utils/behaviors.ts) -and must be defined in the compiler (in [`compiler/model/utils.ts`](../compiler/model/utils.ts)) as well. +and must be defined in the compiler (in [`compiler/model/utils.ts`](../compiler/src/model/utils.ts)) as well. If a behaviors is defined in [`specification/__spec_utils/behaviors.ts`](../specification/__spec_utils/behaviors.ts) and -it's not added in [`compiler/model/utils.ts`](../compiler/model/utils.ts) as well, the compiler will throw and error. +it's not added in [`compiler/model/utils.ts`](../compiler/src/model/utils.ts) as well, the compiler will throw and error. ## Custom Types You can find the full definition of this types in the [modeling guide](./modeling-guide.md). -Those types are also tracked in [`compiler/model/utils.ts`](../compiler/model/utils.ts), +Those types are also tracked in [`compiler/model/utils.ts`](../compiler/src/model/utils.ts), because they can't be added in the output JSON, as we only need them to let the compiler know how those structures should be represented in the output JSON. diff --git a/docs/doc-comments-guide.md b/docs/doc-comments-guide.md new file mode 100644 index 0000000000..5d4560417d --- /dev/null +++ b/docs/doc-comments-guide.md @@ -0,0 +1,92 @@ +# Documenting the API specification + +A specification is not only about formalizing data structures, it's also about explaining what these structures and their properties are used for. + +Documentation of the TypeScript specification is made using [JSDoc](https://jsdoc.app/) comments, i.e. multiline comments starting with `/**` above a type or field declaration. + +Additional lines start with a `*` followed by a space. Long lines are allowed but it's better if text is formatted to a maximum of 120 characters per line. + +## Example + +```ts +/** + * Enables you to evaluate the quality of ranked search results over a set of typical search queries. + * @rest_spec_name rank_eval + * @since 6.2.0 + * @index_privileges read + */ +export interface Request extends RequestBase { + path_parts: { + /** + * List of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. + * + * To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + */ + index: Indices + } + query_parameters?: { + /** + * Accept no matching indices? + * + * If `false`, the request returns an error if any wildcard expression, index alias, or _all value targets only + * missing or closed indices. This behavior applies even if the request targets other open indices. For example, + * a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * + * @server_default true + */ + allow_no_indices?: boolean + + expand_wildcards?: ExpandWildcards + + /** + * If `true`, missing or closed indices are not included in the response. + * @server_default false + */ + ignore_unavailable?: boolean + + search_type?: string + } + body: { + /** + * A set of typical search requests, together with their provided ratings. + */ + requests: RankEvalRequestItem[] + + /** + * Definition of the evaluation metric to calculate. + * + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_available_evaluation_metrics + */ + metric?: RankEvalMetric + } +} +``` + +([original source code](https://github.com/elastic/elasticsearch-specification/blob/main/specification/_global/rank_eval/RankEvalRequest.ts)) + + +## Markup language + +The specification is the starting point for a number of generators that produce a large range of artifacts, starting with source code in 10 different programming languages. It's essential for the API documentation to be part of these generated artifacts, e.g. to provide autocompletion help in IDEs when using a client library. + +Each of these targets has a different way to format inline documentation: Java code uses HTML, Python uses reStructuredText, Rust uses Markdown, etc. To enable rich documentation to be output, the specification doc comments must not be just plain text, but use a well-defined markup language so that generators can reliably transcode them to their target representation. + +**We have settled on using [GitHub Flavored Markdown](https://github.github.com/gfm/) (GFM) for doc comments.** It is based on the well-defined [CommonMark](https://commonmark.org/) specification with a few additions, most notably tables. + +GFM also has implementations in most languages, meaning that code generators will be able to easily parse the doc comments and transcode them. + +## Structuring a doc-comment + +### Terseness + +**Doc comments are reference material**: they should be as succinct as possible while capturing all the necessary information to use the elements they're documenting. Remember that they will often show up in small IDE autocompletion popups! + +In particular, doc comments are not the right place for tutorials or examples, which should be in dedicated documentation pages. These pages can of course be linked from the doc comments. + +API endpoints will also have a `@doc_url` JSDoc tag that links to that API's detailed documentation page. + +### Multi-paragraph doc comments + +A single sentence is not always enough to explain a type or a field and doc comments will have multiple paragraphs. It is important that **the first paragraph provides a self-contained description** of the item that is being documented. The reason is twofold: +- people skim documentation quickly and should get the gist of the information from that first sentence, and read others if they want to dive in, +- Some IDEs may choose to display only the first paragraph or even the first sentence of a doc-comment in their help popup to keep it small, and then require an additional action from the user to display the full text. diff --git a/docs/modeling-guide.md b/docs/modeling-guide.md index 30b69a3dd8..60a37c32cf 100644 --- a/docs/modeling-guide.md +++ b/docs/modeling-guide.md @@ -2,7 +2,7 @@ The goal of the specification is to be used by different languages, from dynamically typed to statically typed. To achieve this goal the specification contains a series of custom types that do not have a meaning -for the target language, but they should be translated to the most approriate construct. +for the target language, but they should be translated to the most appropriate construct. The specification is written in [TypeScript](https://www.typescriptlang.org/), you can find all the basic types [here](https://www.typescriptlang.org/docs/handbook/basic-types.html), @@ -85,6 +85,30 @@ enum MyEnum { property: MyEnum ``` +Some enumerations accept alternate values for some of their members. The `@aliases` jsdoc tac can be used to capture these values: + +```ts +enum Orientation { + /** @aliases counterclockwise, ccw */ + right, + /** @aliases clockwise, cw */ + left +} +``` + +Some enumerations can accept arbitrary values other than the ones defined. The `@non_exhaustive` jsdoc tag can be used to describe this behavior. +By default, an enum is to be considered exhaustive. + +```ts +/** @non_exhaustive */ +export enum ScriptLanguage { + painless, + expression, + mustache, + java +} +``` + ### User defined value Represents a value that will be defined by the user and has no specific type. @@ -95,8 +119,8 @@ property: UserDefinedValue ### Numbers -The numeric type in TypeScript is `number`, but given that this specification target mutliple languages, -it offers a bunch of alias that represents the type that should be used if the language supports it: +The numeric type in TypeScript is `number`, but given that this specification targets mutliple languages, +it offers a bunch of aliases that represent the type that should be used if the language supports it: ```ts type short = number @@ -109,8 +133,8 @@ type double = number ### Strings -The string type in TypeScript is `string`. It's ok to use it in the spec, but to offer a more developer -friendly specification, we do offer a set of aliases based on which string we do expect, for example: +The string type in TypeScript is `string`. It's okay to use it in the spec, but to offer a more developer +friendly specification, we do offer a set of aliases based on which string we expect, for example: ```ts type ScrollId = string @@ -139,6 +163,38 @@ type TimeSpan = string type DateString = string ``` +### Binary + +Some APIs return a Binary stream of data instead of JSON. +Create an alias of the `ArrayBuffer` type for the appropriate name. + +```ts +export type MapboxVectorTiles = ArrayBuffer + +export class Response { + body: MapboxVectorTiles +} +``` + +In the output schema.json `MapboxVectorTiles` will be defined as: + +```json +{ + "kind": "type_alias", + "name": { + "name": "MapboxVectorTiles", + "namespace": "_types" + }, + "type": { + "kind": "instance_of", + "type": { + "name": "binary", + "namespace": "internal" + } + } +} +``` + ### Literal values The compiler supports literal values as well. This can be useful if a @@ -176,6 +232,11 @@ class Response { Variants is a special syntax that can be used by language generators to understand which type they will need to build based on the variant configuration. + +If the list of variants is not exhaustive (e.g. for types where new variants can be added by +Elasticsearch plugins), you can add the `@non_exhaustive` js doc tag to indicate that additional +variants can exist and should be accepted. + There are three type of variants: #### Internal @@ -190,7 +251,7 @@ class Foo { ``` If the variant type is internal you should configure the parent type with -the `@variants` js doc tag. teh syntax is: +the `@variants` js doc tag. The syntax is: ```ts /** @variants internal tag='' */ @@ -270,8 +331,8 @@ or: #### Container -The container variant is used for all the types that contains all the -variants inside the defintion. An example is `QueryContainer`. +The container variant is used for all the types that contain all the +variants inside the definition. An example is `QueryContainer`. The syntax is: @@ -290,7 +351,7 @@ class FooContainer { } ``` -Some containers have properties associated to the container that are not part of the list of variants, +Some containers have properties associated with the container that are not part of the list of variants, for example `AggregationContainer` and its `aggs` and `meta` properties. An annotation allows distinguishing these properties from container variants: @@ -322,7 +383,7 @@ class AggregationContainer { In many places Elasticsearch accepts a property value to be either a complete data structure or a single value, that value being a shortcut for a property in the data structure. -A typical example can be found in queries such as term query: `{"term": {"some_field": {"value": "some_text"}}}` can also be written as `{"term": {"some_field": "some_text"}}`. +A typical example can be found in queries such as term query. `{"term": {"some_field": {"value": "some_text"}}}` can also be written as `{"term": {"some_field": "some_text"}}`. This could be modelled as a union of `SomeClass | string`, but this notation doesn't capture the relation between the string variant and the corresponding field (`value` in the above example). @@ -336,6 +397,20 @@ export class TermQuery extends QueryBase { } ``` +### Tracking Elasticsearch quirks + +There are a few places where Elasticsearch has an uncommon behavior that does not deserve a specific feature in the API specification metamodel. These quirks still have to be captured so that code generators can act on them. The `eq_quirk` jsdoc tag is meant for that, and can be used on type definitions and properties. + +```ts +/** + * @es_quirk This enum is a boolean that evolved into a tri-state enum. True and False have + * to be (de)serialized as JSON booleans. + */ +enum Foo { true, false, bar } +``` + +Code generators should track the `es_quirk` they implement and fail if a new unhandled quirk is present on a type or a property. This behavior allows code generators to be updated whenever a new quirk is identified in the API specification. + ### Additional information If needed, you can specify additional information on each type with the approariate JSDoc tag. @@ -343,7 +418,7 @@ Following you can find a list of the supported tags: #### `@since` -Every API already has a `@since` tag, which describes when an API has been added. +Every API already has a `@since` tag, which describes when an API was added. You can specify an additional `@since` tag for every property that has been added afterwards. If the tag is not defined, it's assumed that the property has been added with the API the first time @@ -386,6 +461,17 @@ class Foo { } ``` +If you need to specify a server default value for an array, you must use the JavaScript array syntax: + +```ts +class Foo { + bar: string + /** @server_default ['hello'] */ + baz?: string[] + faz: string +} +``` + #### `@doc_url` The documentation url for the parameter. @@ -398,3 +484,124 @@ class Foo { faz: string } ``` + +#### `@doc_id` + +The documentation id that can be used for generating the doc url. +See [#714](https://github.com/elastic/elasticsearch-specification/issues/714) for context. + +```ts +/** + * @rest_spec_name api + * @doc_id foobar + */ +class Request { + ... +} +``` + +#### `@codegen_name` + +A custom name that can be used to display the property. Useful in Enums and +for request bodies where the document is the entire body. + +```ts +export class ConfusionMatrixThreshold { + /** + * True Positive + * @codegen_name true_positive + */ + tp: integer + /** + * False Positive + * @codegen_name false_positive + */ + fp: integer + /** + * True Negative + * @codegen_name true_negative + */ + tn: integer + /** + * False Negative + * @codegen_name false_negative + */ + fn: integer +} + +export interface Request extends RequestBase { + path_parts: {} + query_parameters: {} + /** @codegen_name document */ + body?: TDocument +} +``` + +#### `@index_privileges` + +If an endpoint has some index security prerequisites to satisfy, you can specify them here with a comma separated list. + +```ts +/** + * @rest_spec_name indices.create + * @since 0.0.0 + * @stability stable + * @index_privileges create_index, manage + */ +export interface Request extends RequestBase { + ... +} +``` + +#### `@cluster_privileges` + +If an endpoint has some cluster security prerequisites to satisfy, you can specify them here with a comma separated list. + +```ts +/** + * @rest_spec_name cluster.state + * @since 1.3.0 + * @stability stable + * @cluster_privileges monitor, manage + */ +export interface Request extends RequestBase { + ... +} +``` + +#### `@deprecated` + +Use if an endpoint or property is deprecated; you should add the version as well. + +```ts +class Foo { + bar: string + /** @deprecated 7.0.0 */ + baz?: string + faz: string +} +``` + +You can also add an optional description: + +```ts +class Foo { + bar: string + /** @deprecated 7.0.0 'baz' has been deprecated, use 'bar' instead */ + baz?: string + faz: string +} +``` + +#### `@stability` + +You can mark a class or property of a type as stable/beta/experimental with this tag (the default is stable). + +```ts +class Foo { + bar: string + /** @stability experimental */ + baz?: string + faz: string +} +``` diff --git a/docs/specification-structure.md b/docs/specification-structure.md index 48fa7e2ab6..d256e5527d 100644 --- a/docs/specification-structure.md +++ b/docs/specification-structure.md @@ -60,11 +60,11 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name get * @since 0.0.0 - * @stability TODO + * @stability stable | beta | experimental */ export interface Request extends RequestBase { path_parts: {} - query_parameters?: {} + query_parameters: {} } ``` ```ts @@ -75,7 +75,7 @@ import { Request as GetRequest } from '_global/get/GetRequest' /** * @rest_spec_name get_source * @since 0.0.0 - * @stability TODO + * @stability stable | beta | experimental */ export interface Request extends GetRequest {} ``` \ No newline at end of file diff --git a/docs/style-guide.md b/docs/style-guide.md index d66802f2c8..0864698f3f 100644 --- a/docs/style-guide.md +++ b/docs/style-guide.md @@ -56,13 +56,13 @@ represented in the specification. ## Where to store files The content of [`/specification`](../specification) follows the rest-api-spec structure. -Every folder represents the namespace, while every subfolder represente the API name. +Every folder represents the namespace, while every subfolder represent the API name. For top level APIs, you must use the `_global` namespace. ## Using unions -Using unions direclty in definitions is considereded code smell, it's recommended to create -a type alias that describes the union. These alises do not need to live in common files +Using unions directly in definitions is considered code smell, it's recommended to create +a type alias that describes the union. These aliases do not need to live in common files unless those are truly commonly used throughout the specification. ```ts @@ -81,7 +81,7 @@ type Id = string | number ## Arrays It's fine to use the short TypeScript array notation, unless the type -becomes more comples (eg: array of unions), in such case prefer the full definition. +becomes more complex (eg: array of unions), in such case prefer the full definition. ```ts class Foo { diff --git a/docs/validation-example.md b/docs/validation-example.md index 0c9c7ff31e..a1abb9f267 100644 --- a/docs/validation-example.md +++ b/docs/validation-example.md @@ -16,7 +16,7 @@ The example assumes that you have already performed the necessary steps to run a if not, take a look at the [README](./README.md). ```sh -STACK_VERSION=... ./run-validations --api index --request +make validate api=index type=request stack-version=8.1.0-SNAPSHOT ``` You will see an output like the following: @@ -56,13 +56,13 @@ open it with your favourite editor and perform the fix @rest_spec_name("index") @class_serializer("IndexRequestFormatter`1") class IndexRequest extends RequestBase { - path_parts?: { + path_parts: { - id?: string; + id?: string | number; index: string; type?: string; } - query_parameters?: { + query_parameters: { if_primary_term?: long; if_seq_no?: long; op_type?: OpType; @@ -82,7 +82,7 @@ open it with your favourite editor and perform the fix Finally run the validation again: ```sh -STACK_VERSION=... ./run-validations --api index --request +make validate api=index type=request stack-version=8.1.0-SNAPSHOT ``` If there are no more errors, open a pr with the fix. diff --git a/output/schema/schema.json b/output/schema/schema.json index 5b3212b857..0eb101b733 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -1,18 +1,13 @@ { "_info": { - "hash": "8f4d599", "license": { "name": "Apache 2.0", - "url": "https://github.com/elastic/elasticsearch-specification/blob/master/LICENSE" + "url": "https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE" }, - "title": "Elasticsearch Request & Response Specification", - "version": "main" + "title": "Elasticsearch Request & Response Specification" }, "endpoints": [ { - "accept": [ - "application/json" - ], "description": "Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "name": "async_search.delete", @@ -25,8 +20,11 @@ "name": "Response", "namespace": "async_search.delete" }, + "responseMediaType": [ + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -38,9 +36,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the results of a previously submitted async search request given its ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "name": "async_search.get", @@ -53,8 +48,11 @@ "name": "Response", "namespace": "async_search.get" }, + "responseMediaType": [ + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -66,9 +64,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the status of a previously submitted async search request given its ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "name": "async_search.status", @@ -81,8 +76,11 @@ "name": "Response", "namespace": "async_search.status" }, + "responseMediaType": [ + "application/json" + ], "since": "7.11.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -94,12 +92,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Executes a search request asynchronously.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", "name": "async_search.submit", @@ -108,12 +100,18 @@ "namespace": "async_search.submit" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "async_search.submit" }, + "responseMediaType": [ + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -131,23 +129,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html", "name": "autoscaling.delete_autoscaling_policy", "request": { "name": "Request", - "namespace": "autoscaling.policy_delete" + "namespace": "autoscaling.delete_autoscaling_policy" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "autoscaling.policy_delete" + "namespace": "autoscaling.delete_autoscaling_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.11.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -156,26 +154,26 @@ "path": "/_autoscaling/policy/{name}" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html", "name": "autoscaling.get_autoscaling_capacity", "request": { "name": "Request", - "namespace": "autoscaling.capacity_get" + "namespace": "autoscaling.get_autoscaling_capacity" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "autoscaling.capacity_get" + "namespace": "autoscaling.get_autoscaling_capacity" }, + "responseMediaType": [ + "application/json" + ], "since": "7.11.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -184,26 +182,26 @@ "path": "/_autoscaling/capacity" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html", "name": "autoscaling.get_autoscaling_policy", "request": { "name": "Request", - "namespace": "autoscaling.policy_get" + "namespace": "autoscaling.get_autoscaling_policy" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "autoscaling.policy_get" + "namespace": "autoscaling.get_autoscaling_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.11.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -212,29 +210,29 @@ "path": "/_autoscaling/policy/{name}" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html", "name": "autoscaling.put_autoscaling_policy", "request": { "name": "Request", - "namespace": "autoscaling.policy_put" + "namespace": "autoscaling.put_autoscaling_policy" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "autoscaling.policy_put" + "namespace": "autoscaling.put_autoscaling_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.11.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -243,15 +241,9 @@ "path": "/_autoscaling/policy/{name}" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson" - ], "description": "Allows to perform multiple index/update/delete operations in a single request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html", "name": "bulk", @@ -260,10 +252,16 @@ "namespace": "_global.bulk" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", "namespace": "_global.bulk" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", "stability": "stable", "urls": [ @@ -292,10 +290,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Shows information about currently configured aliases to indices including filter and routing infos.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html", "name": "cat.aliases", @@ -308,8 +302,12 @@ "name": "Response", "namespace": "cat.aliases" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -327,10 +325,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html", "name": "cat.allocation", @@ -343,8 +337,12 @@ "name": "Response", "namespace": "cat.allocation" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -362,10 +360,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Provides quick access to the document count of the entire cluster, or individual indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html", "name": "cat.count", @@ -378,8 +372,12 @@ "name": "Response", "namespace": "cat.count" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -397,10 +395,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html", "name": "cat.fielddata", @@ -413,8 +407,12 @@ "name": "Response", "namespace": "cat.fielddata" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -432,10 +430,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns a concise representation of the cluster health.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html", "name": "cat.health", @@ -448,8 +442,12 @@ "name": "Response", "namespace": "cat.health" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -461,9 +459,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain" - ], "description": "Returns help for the Cat APIs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html", "name": "cat.help", @@ -476,8 +471,11 @@ "name": "Response", "namespace": "cat.help" }, + "responseMediaType": [ + "text/plain" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -489,10 +487,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ...", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html", "name": "cat.indices", @@ -505,8 +499,12 @@ "name": "Response", "namespace": "cat.indices" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -524,10 +522,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about the master node.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html", "name": "cat.master", @@ -540,8 +534,12 @@ "name": "Response", "namespace": "cat.master" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -553,24 +551,24 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Gets configuration and usage information about data frame analytics jobs.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html", "name": "cat.ml_data_frame_analytics", "request": { "name": "Request", - "namespace": "cat.data_frame_analytics" + "namespace": "cat.ml_data_frame_analytics" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "cat.data_frame_analytics" + "namespace": "cat.ml_data_frame_analytics" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -588,24 +586,24 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Gets configuration and usage information about datafeeds.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html", "name": "cat.ml_datafeeds", "request": { "name": "Request", - "namespace": "cat.datafeeds" + "namespace": "cat.ml_datafeeds" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "cat.datafeeds" + "namespace": "cat.ml_datafeeds" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -623,24 +621,24 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Gets configuration and usage information about anomaly detection jobs.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html", "name": "cat.ml_jobs", "request": { "name": "Request", - "namespace": "cat.jobs" + "namespace": "cat.ml_jobs" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "cat.jobs" + "namespace": "cat.ml_jobs" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -658,24 +656,24 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Gets configuration and usage information about inference trained models.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html", "name": "cat.ml_trained_models", "request": { "name": "Request", - "namespace": "cat.trained_models" + "namespace": "cat.ml_trained_models" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "cat.trained_models" + "namespace": "cat.ml_trained_models" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -693,24 +691,24 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about custom node attributes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html", "name": "cat.nodeattrs", "request": { "name": "Request", - "namespace": "cat.node_attributes" + "namespace": "cat.nodeattrs" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "cat.node_attributes" + "namespace": "cat.nodeattrs" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -722,10 +720,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns basic statistics about performance of cluster nodes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html", "name": "cat.nodes", @@ -738,8 +732,12 @@ "name": "Response", "namespace": "cat.nodes" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -751,10 +749,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns a concise representation of the cluster pending tasks.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html", "name": "cat.pending_tasks", @@ -767,8 +761,12 @@ "name": "Response", "namespace": "cat.pending_tasks" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -780,10 +778,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about installed plugins across nodes node.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html", "name": "cat.plugins", @@ -796,8 +790,12 @@ "name": "Response", "namespace": "cat.plugins" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -809,10 +807,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about index shard recoveries, both on-going completed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html", "name": "cat.recovery", @@ -825,8 +819,12 @@ "name": "Response", "namespace": "cat.recovery" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -844,10 +842,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about snapshot repositories registered in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html", "name": "cat.repositories", @@ -860,8 +854,12 @@ "name": "Response", "namespace": "cat.repositories" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "2.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -873,10 +871,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Provides low-level information about the segments in the shards of an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html", "name": "cat.segments", @@ -889,8 +883,12 @@ "name": "Response", "namespace": "cat.segments" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -908,10 +906,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Provides a detailed view of shard allocation on nodes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html", "name": "cat.shards", @@ -924,8 +918,12 @@ "name": "Response", "namespace": "cat.shards" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -943,10 +941,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns all snapshots in a specific repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html", "name": "cat.snapshots", @@ -959,8 +953,12 @@ "name": "Response", "namespace": "cat.snapshots" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "2.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -978,10 +976,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about the tasks currently executing on one or more nodes in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "name": "cat.tasks", @@ -994,8 +988,12 @@ "name": "Response", "namespace": "cat.tasks" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1007,10 +1005,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns information about existing templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html", "name": "cat.templates", @@ -1023,8 +1017,12 @@ "name": "Response", "namespace": "cat.templates" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "5.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1042,10 +1040,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html", "name": "cat.thread_pool", @@ -1058,8 +1052,12 @@ "name": "Response", "namespace": "cat.thread_pool" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1077,10 +1075,6 @@ "visibility": "public" }, { - "accept": [ - "text/plain", - "application/json" - ], "description": "Gets configuration and usage information about transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html", "name": "cat.transforms", @@ -1093,8 +1087,12 @@ "name": "Response", "namespace": "cat.transforms" }, + "responseMediaType": [ + "text/plain", + "application/json" + ], "since": "7.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1112,9 +1110,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes auto-follow patterns.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html", "name": "ccr.delete_auto_follow_pattern", @@ -1127,8 +1122,11 @@ "name": "Response", "namespace": "ccr.delete_auto_follow_pattern" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1140,26 +1138,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new follower index configured to follow the referenced leader index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html", "name": "ccr.follow", "request": { "name": "Request", - "namespace": "ccr.create_follow_index" + "namespace": "ccr.follow" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ccr.create_follow_index" + "namespace": "ccr.follow" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1171,9 +1169,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about all follower indices, including parameters and status for each follower index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html", "name": "ccr.follow_info", @@ -1186,8 +1181,11 @@ "name": "Response", "namespace": "ccr.follow_info" }, + "responseMediaType": [ + "application/json" + ], "since": "6.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1199,23 +1197,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html", "name": "ccr.follow_stats", "request": { "name": "Request", - "namespace": "ccr.follow_index_stats" + "namespace": "ccr.follow_stats" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ccr.follow_index_stats" + "namespace": "ccr.follow_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1227,26 +1225,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Removes the follower retention leases from the leader.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html", "name": "ccr.forget_follower", "request": { "name": "Request", - "namespace": "ccr.forget_follower_index" + "namespace": "ccr.forget_follower" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ccr.forget_follower_index" + "namespace": "ccr.forget_follower" }, + "responseMediaType": [ + "application/json" + ], "since": "6.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1258,9 +1256,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html", "name": "ccr.get_auto_follow_pattern", @@ -1273,8 +1268,11 @@ "name": "Response", "namespace": "ccr.get_auto_follow_pattern" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1292,9 +1290,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Pauses an auto-follow pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html", "name": "ccr.pause_auto_follow_pattern", @@ -1307,8 +1302,11 @@ "name": "Response", "namespace": "ccr.pause_auto_follow_pattern" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1320,23 +1318,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html", "name": "ccr.pause_follow", "request": { "name": "Request", - "namespace": "ccr.pause_follow_index" + "namespace": "ccr.pause_follow" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ccr.pause_follow_index" + "namespace": "ccr.pause_follow" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1348,12 +1346,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html", "name": "ccr.put_auto_follow_pattern", @@ -1362,12 +1354,18 @@ "namespace": "ccr.put_auto_follow_pattern" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ccr.put_auto_follow_pattern" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1379,9 +1377,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Resumes an auto-follow pattern that has been paused", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html", "name": "ccr.resume_auto_follow_pattern", @@ -1394,8 +1389,11 @@ "name": "Response", "namespace": "ccr.resume_auto_follow_pattern" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1407,26 +1405,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Resumes a follower index that has been paused", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html", "name": "ccr.resume_follow", "request": { "name": "Request", - "namespace": "ccr.resume_follow_index" + "namespace": "ccr.resume_follow" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ccr.resume_follow_index" + "namespace": "ccr.resume_follow" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1438,9 +1436,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Gets all stats related to cross-cluster replication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html", "name": "ccr.stats", @@ -1453,8 +1448,11 @@ "name": "Response", "namespace": "ccr.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1466,23 +1464,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html", "name": "ccr.unfollow", "request": { "name": "Request", - "namespace": "ccr.unfollow_index" + "namespace": "ccr.unfollow" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ccr.unfollow_index" + "namespace": "ccr.unfollow" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1494,13 +1492,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json", - "text/plain" - ], "description": "Explicitly clears the search context for a scroll.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html", "name": "clear_scroll", @@ -1509,12 +1500,19 @@ "namespace": "_global.clear_scroll" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json", + "text/plain" + ], "response": { "name": "Response", "namespace": "_global.clear_scroll" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1536,9 +1534,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Close a point in time", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "name": "close_point_in_time", @@ -1547,12 +1542,18 @@ "namespace": "_global.close_point_in_time" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.close_point_in_time" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1564,12 +1565,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Provides explanations for shard allocations in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html", "name": "cluster.allocation_explain", @@ -1578,12 +1573,18 @@ "namespace": "cluster.allocation_explain" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "cluster.allocation_explain" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1596,9 +1597,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a component template", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "name": "cluster.delete_component_template", @@ -1611,8 +1609,11 @@ "name": "Response", "namespace": "cluster.delete_component_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.8.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1624,9 +1625,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Clears cluster voting config exclusions.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", "name": "cluster.delete_voting_config_exclusions", @@ -1639,8 +1637,11 @@ "name": "Response", "namespace": "cluster.delete_voting_config_exclusions" }, + "responseMediaType": [ + "application/json" + ], "since": "7.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1652,9 +1653,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a particular component template exist", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "name": "cluster.exists_component_template", @@ -1667,8 +1665,11 @@ "name": "Response", "namespace": "cluster.exists_component_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.8.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1680,9 +1681,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns one or more component templates", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "name": "cluster.get_component_template", @@ -1695,8 +1693,11 @@ "name": "Response", "namespace": "cluster.get_component_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.8.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1714,9 +1715,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns cluster settings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html", "name": "cluster.get_settings", @@ -1729,8 +1727,11 @@ "name": "Response", "namespace": "cluster.get_settings" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1742,9 +1743,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns basic information about the health of the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html", "name": "cluster.health", @@ -1757,8 +1755,11 @@ "name": "Response", "namespace": "cluster.health" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1776,9 +1777,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns a list of any cluster-level changes (e.g. create index, update mapping,\nallocate or fail shard) which have not yet been executed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html", "name": "cluster.pending_tasks", @@ -1791,8 +1789,11 @@ "name": "Response", "namespace": "cluster.pending_tasks" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1804,23 +1805,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Updates the cluster voting config exclusions by node ids or node names.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", "name": "cluster.post_voting_config_exclusions", "request": { "name": "Request", - "namespace": "cluster.put_voting_config_exclusions" + "namespace": "cluster.post_voting_config_exclusions" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "cluster.put_voting_config_exclusions" + "namespace": "cluster.post_voting_config_exclusions" }, + "responseMediaType": [ + "application/json" + ], "since": "7.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1832,12 +1833,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates a component template", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", "name": "cluster.put_component_template", @@ -1846,12 +1841,18 @@ "namespace": "cluster.put_component_template" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "cluster.put_component_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.8.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1864,12 +1865,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates the cluster settings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", "name": "cluster.put_settings", @@ -1878,12 +1873,18 @@ "namespace": "cluster.put_settings" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "cluster.put_settings" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1895,9 +1896,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the information about configured remote clusters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html", "name": "cluster.remote_info", @@ -1910,8 +1908,11 @@ "name": "Response", "namespace": "cluster.remote_info" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1923,12 +1924,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to manually change the allocation of individual shards in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html", "name": "cluster.reroute", @@ -1937,12 +1932,18 @@ "namespace": "cluster.reroute" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "cluster.reroute" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1954,12 +1955,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns a comprehensive information about the state of the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html", "name": "cluster.state", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", "namespace": "cluster.state" @@ -1969,8 +1973,11 @@ "name": "Response", "namespace": "cluster.state" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -1994,9 +2001,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns high-level overview of cluster statistics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html", "name": "cluster.stats", @@ -2009,8 +2013,11 @@ "name": "Response", "namespace": "cluster.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2028,12 +2035,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Returns number of documents matching a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "name": "count", @@ -2042,12 +2043,18 @@ "namespace": "_global.count" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.count" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2078,12 +2085,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "create", @@ -2092,10 +2093,16 @@ "namespace": "_global.create" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.create" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", "stability": "stable", "urls": [ @@ -2121,23 +2128,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes the specified dangling index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.delete_dangling_index", "request": { "name": "Request", - "namespace": "dangling_indices.index_delete" + "namespace": "dangling_indices.delete_dangling_index" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "dangling_indices.index_delete" + "namespace": "dangling_indices.delete_dangling_index" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2149,23 +2156,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Imports the specified dangling index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.import_dangling_index", "request": { "name": "Request", - "namespace": "dangling_indices.index_import" + "namespace": "dangling_indices.import_dangling_index" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "dangling_indices.index_import" + "namespace": "dangling_indices.import_dangling_index" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2177,23 +2184,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns all dangling indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.list_dangling_indices", "request": { "name": "Request", - "namespace": "dangling_indices.indices_list" + "namespace": "dangling_indices.list_dangling_indices" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "dangling_indices.indices_list" + "namespace": "dangling_indices.list_dangling_indices" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2205,15 +2212,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "name": "data_frame_transform_deprecated.delete_transform", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2230,15 +2237,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves configuration information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "name": "data_frame_transform_deprecated.get_transform", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2265,15 +2272,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "name": "data_frame_transform_deprecated.get_transform_stats", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2290,18 +2297,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Previews a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "name": "data_frame_transform_deprecated.preview_transform", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2318,18 +2325,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "name": "data_frame_transform_deprecated.put_transform", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2346,15 +2353,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Starts one or more transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "name": "data_frame_transform_deprecated.start_transform", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2371,15 +2378,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Stops one or more transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "name": "data_frame_transform_deprecated.stop_transform", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2396,18 +2403,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates certain properties of a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "name": "data_frame_transform_deprecated.update_transform", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "beta", "urls": [ { @@ -2424,9 +2431,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes a document from the index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "name": "delete", @@ -2439,8 +2443,11 @@ "name": "Response", "namespace": "_global.delete" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2462,12 +2469,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Deletes documents matching the provided query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "name": "delete_by_query", @@ -2476,12 +2477,18 @@ "namespace": "_global.delete_by_query" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.delete_by_query" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2503,9 +2510,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Changes the number of requests per second for a particular Delete By Query operation.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", "name": "delete_by_query_rethrottle", @@ -2518,8 +2522,11 @@ "name": "Response", "namespace": "_global.delete_by_query_rethrottle" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2531,9 +2538,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a script.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "delete_script", @@ -2546,8 +2550,11 @@ "name": "Response", "namespace": "_global.delete_script" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2559,9 +2566,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing enrich policy and its enrich index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", "name": "enrich.delete_policy", @@ -2574,8 +2578,11 @@ "name": "Response", "namespace": "enrich.delete_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2587,9 +2594,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Creates the enrich index for an existing enrich policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html", "name": "enrich.execute_policy", @@ -2602,8 +2606,11 @@ "name": "Response", "namespace": "enrich.execute_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2615,9 +2622,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Gets information about an enrich policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "name": "enrich.get_policy", @@ -2630,8 +2634,11 @@ "name": "Response", "namespace": "enrich.get_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2649,12 +2656,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new enrich policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html", "name": "enrich.put_policy", @@ -2663,12 +2664,18 @@ "namespace": "enrich.put_policy" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "enrich.put_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2680,9 +2687,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", "name": "enrich.stats", @@ -2695,8 +2699,11 @@ "name": "Response", "namespace": "enrich.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2708,9 +2715,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.delete", @@ -2723,8 +2727,11 @@ "name": "Response", "namespace": "eql.delete" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2736,9 +2743,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns async results from previously executed Event Query Language (EQL) search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.get", @@ -2751,8 +2755,11 @@ "name": "Response", "namespace": "eql.get" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2764,9 +2771,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.get_status", @@ -2779,8 +2783,11 @@ "name": "Response", "namespace": "eql.get_status" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2792,12 +2799,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Returns results matching a query expressed in Event Query Language (EQL)", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.search", @@ -2806,12 +2807,18 @@ "namespace": "eql.search" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "eql.search" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2821,12 +2828,9 @@ "path": "/{index}/_eql/search" } ], - "visibility": "feature_flag" + "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a document exists in an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists", @@ -2839,8 +2843,11 @@ "name": "Response", "namespace": "_global.exists" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2862,9 +2869,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a document source exists in an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists_source", @@ -2877,8 +2881,11 @@ "name": "Response", "namespace": "_global.exists_source" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2900,12 +2907,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Returns information about why a specific matches (or doesn't match) a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", "name": "explain", @@ -2914,12 +2915,18 @@ "namespace": "_global.explain" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.explain" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2943,9 +2950,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", "name": "features.get_features", @@ -2958,8 +2962,11 @@ "name": "Response", "namespace": "features.get_features" }, + "responseMediaType": [ + "application/json" + ], "since": "7.12.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -2971,9 +2978,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Resets the internal state of features, usually by deleting system indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "features.reset_features", @@ -2986,8 +2990,11 @@ "name": "Response", "namespace": "features.reset_features" }, + "responseMediaType": [ + "application/json" + ], "since": "7.12.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -2999,9 +3006,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the information about the capabilities of fields among multiple indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", "name": "field_caps", @@ -3010,12 +3014,18 @@ "namespace": "_global.field_caps" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.field_caps" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3035,33 +3045,94 @@ "visibility": "public" }, { - "accept": [ + "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", + "name": "fleet.global_checkpoints", + "request": { + "name": "Request", + "namespace": "fleet.global_checkpoints" + }, + "requestBodyRequired": false, + "requestMediaType": [ "application/json" ], - "contentType": [ + "response": { + "name": "Response", + "namespace": "fleet.global_checkpoints" + }, + "responseMediaType": [ "application/json" ], - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "since": "7.13.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/{index}/_fleet/global_checkpoints" + } + ], + "visibility": "public" + }, + { + "description": "Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.", "docUrl": null, - "name": "fleet.global_checkpoints", + "name": "fleet.msearch", "request": null, - "requestBodyRequired": false, + "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "experimental", "urls": [ { "methods": [ - "GET" + "GET", + "POST" ], - "path": "/{index}/_fleet/global_checkpoints" + "path": "/_fleet/_fleet_msearch" + }, + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_fleet/_fleet_msearch" } ], "visibility": "public" }, { - "accept": [ + "description": "Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.", + "docUrl": null, + "name": "fleet.search", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ "application/json" ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/{index}/_fleet/_fleet_search" + } + ], + "visibility": "public" + }, + { "description": "Returns a document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get", @@ -3074,8 +3145,11 @@ "name": "Response", "namespace": "_global.get" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3097,9 +3171,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns a script.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script", @@ -3112,8 +3183,11 @@ "name": "Response", "namespace": "_global.get_script" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3125,9 +3199,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns all script contexts.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "name": "get_script_context", @@ -3140,8 +3211,11 @@ "name": "Response", "namespace": "_global.get_script_context" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3153,9 +3227,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns available script types, languages and contexts", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script_languages", @@ -3168,8 +3239,11 @@ "name": "Response", "namespace": "_global.get_script_languages" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3181,9 +3255,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the source of a document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get_source", @@ -3196,8 +3267,11 @@ "name": "Response", "namespace": "_global.get_source" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3219,12 +3293,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Explore extracted and summarized information about the documents and terms in an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html", "name": "graph.explore", @@ -3233,12 +3301,18 @@ "namespace": "graph.explore" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "graph.explore" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3262,12 +3336,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", "name": "ilm.delete_lifecycle", + "privileges": { + "cluster": [ + "manage_ilm" + ] + }, "request": { "name": "Request", "namespace": "ilm.delete_lifecycle" @@ -3277,8 +3353,11 @@ "name": "Response", "namespace": "ilm.delete_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3290,12 +3369,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", "name": "ilm.explain_lifecycle", + "privileges": { + "index": [ + "view_index_metadata", + "manage_ilm" + ] + }, "request": { "name": "Request", "namespace": "ilm.explain_lifecycle" @@ -3305,8 +3387,11 @@ "name": "Response", "namespace": "ilm.explain_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3318,12 +3403,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the specified policy definition. Includes the policy version and last modified date.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", "name": "ilm.get_lifecycle", + "privileges": { + "cluster": [ + "manage_ilm", + "read_ilm" + ] + }, "request": { "name": "Request", "namespace": "ilm.get_lifecycle" @@ -3333,8 +3421,11 @@ "name": "Response", "namespace": "ilm.get_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3352,9 +3443,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the current index lifecycle management (ILM) status.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", "name": "ilm.get_status", @@ -3367,8 +3455,11 @@ "name": "Response", "namespace": "ilm.get_status" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3380,18 +3471,25 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", "name": "ilm.migrate_to_data_tiers", - "request": null, + "request": { + "name": "Request", + "namespace": "ilm.migrate_to_data_tiers" + }, "requestBodyRequired": false, - "response": null, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "ilm.migrate_to_data_tiers" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.14.0", "stability": "stable", "urls": [ { @@ -3404,12 +3502,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Manually moves an index into the specified step and executes that step.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", "name": "ilm.move_to_step", @@ -3418,12 +3510,18 @@ "namespace": "ilm.move_to_step" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ilm.move_to_step" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3435,26 +3533,34 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a lifecycle policy", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", "name": "ilm.put_lifecycle", + "privileges": { + "cluster": [ + "manage_ilm" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "ilm.put_lifecycle" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ilm.put_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3466,9 +3572,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes the assigned lifecycle policy and stops managing the specified index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", "name": "ilm.remove_policy", @@ -3481,8 +3584,11 @@ "name": "Response", "namespace": "ilm.remove_policy" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3494,9 +3600,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retries executing the policy for an index that is in the ERROR step.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", "name": "ilm.retry", @@ -3509,8 +3612,11 @@ "name": "Response", "namespace": "ilm.retry" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3522,9 +3628,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Start the index lifecycle management (ILM) plugin.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", "name": "ilm.start", @@ -3537,8 +3640,11 @@ "name": "Response", "namespace": "ilm.start" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3550,9 +3656,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", "name": "ilm.stop", @@ -3565,8 +3668,11 @@ "name": "Response", "namespace": "ilm.stop" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3578,12 +3684,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates a document in an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "index", @@ -3592,10 +3692,16 @@ "namespace": "_global.index" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.index" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", "stability": "stable", "urls": [ @@ -3637,9 +3743,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Adds a block to an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "name": "indices.add_block", @@ -3652,8 +3755,11 @@ "name": "Response", "namespace": "indices.add_block" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3665,12 +3771,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html", "name": "indices.analyze", @@ -3679,12 +3779,18 @@ "namespace": "indices.analyze" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.analyze" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3704,9 +3810,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Clears all or specific caches for one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", "name": "indices.clear_cache", @@ -3719,8 +3822,11 @@ "name": "Response", "namespace": "indices.clear_cache" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3738,12 +3844,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Clones an index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", "name": "indices.clone", @@ -3752,12 +3852,18 @@ "namespace": "indices.clone" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.clone" }, + "responseMediaType": [ + "application/json" + ], "since": "7.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3770,9 +3876,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Closes an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "name": "indices.close", @@ -3785,8 +3888,11 @@ "name": "Response", "namespace": "indices.close" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3798,26 +3904,32 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates an index with optional settings and mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html", "name": "indices.create", + "privileges": { + "index": [ + "create_index", + "manage" + ] + }, "request": { "name": "Request", "namespace": "indices.create" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.create" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3829,9 +3941,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Creates a data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.create_data_stream", @@ -3844,8 +3953,11 @@ "name": "Response", "namespace": "indices.create_data_stream" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3857,9 +3969,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Provides statistics on operations happening in a data stream.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", @@ -3872,8 +3981,11 @@ "name": "Response", "namespace": "indices.data_streams_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3891,9 +4003,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "name": "indices.delete", @@ -3906,8 +4015,11 @@ "name": "Response", "namespace": "indices.delete" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3919,9 +4031,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.delete_alias", @@ -3934,8 +4043,11 @@ "name": "Response", "namespace": "indices.delete_alias" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3953,9 +4065,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a data stream.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", @@ -3968,8 +4077,11 @@ "name": "Response", "namespace": "indices.delete_data_stream" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -3981,12 +4093,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.delete_index_template", + "privileges": { + "cluster": [ + "manage_index_templates", + "manage" + ] + }, "request": { "name": "Request", "namespace": "indices.delete_index_template" @@ -3996,8 +4111,11 @@ "name": "Response", "namespace": "indices.delete_index_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.8.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4009,9 +4127,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.delete_template", @@ -4024,8 +4139,11 @@ "name": "Response", "namespace": "indices.delete_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4037,15 +4155,22 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Analyzes the disk usage of each field of an index or data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html", "name": "indices.disk_usage", - "request": null, + "request": { + "name": "Request", + "namespace": "indices.disk_usage" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "indices.disk_usage" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.15.0", "stability": "experimental", "urls": [ { @@ -4058,9 +4183,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a particular index exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "name": "indices.exists", @@ -4073,8 +4195,11 @@ "name": "Response", "namespace": "indices.exists" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4086,9 +4211,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a particular alias exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.exists_alias", @@ -4101,8 +4223,11 @@ "name": "Response", "namespace": "indices.exists_alias" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4120,9 +4245,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a particular index template exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.exists_index_template", @@ -4135,8 +4257,11 @@ "name": "Response", "namespace": "indices.exists_index_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4148,9 +4273,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a particular index template exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.exists_template", @@ -4163,8 +4285,11 @@ "name": "Response", "namespace": "indices.exists_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4176,9 +4301,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about whether a particular document type exists. (DEPRECATED)", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html", "name": "indices.exists_type", @@ -4191,8 +4313,11 @@ "name": "Response", "namespace": "indices.exists_type" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4204,15 +4329,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the field usage stats for each field of an index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", "name": "indices.field_usage_stats", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "experimental", "urls": [ { @@ -4225,9 +4350,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Performs the flush operation on one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html", "name": "indices.flush", @@ -4240,8 +4362,11 @@ "name": "Response", "namespace": "indices.flush" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4261,9 +4386,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush-api.html", "name": "indices.flush_synced", @@ -4276,8 +4398,11 @@ "name": "Response", "namespace": "indices.flush_synced" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "deprecation": { @@ -4305,9 +4430,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Performs the force merge operation on one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", "name": "indices.forcemerge", @@ -4320,8 +4442,11 @@ "name": "Response", "namespace": "indices.forcemerge" }, + "responseMediaType": [ + "application/json" + ], "since": "2.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4339,9 +4464,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-index-api.html", "name": "indices.freeze", @@ -4354,8 +4476,11 @@ "name": "Response", "namespace": "indices.freeze" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "deprecation": { @@ -4371,9 +4496,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "name": "indices.get", @@ -4386,8 +4508,11 @@ "name": "Response", "namespace": "indices.get" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4399,9 +4524,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.get_alias", @@ -4414,8 +4536,11 @@ "name": "Response", "namespace": "indices.get_alias" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4445,9 +4570,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.get_data_stream", @@ -4460,8 +4582,11 @@ "name": "Response", "namespace": "indices.get_data_stream" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4479,9 +4604,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns mapping for one or more fields.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "name": "indices.get_field_mapping", @@ -4494,8 +4616,11 @@ "name": "Response", "namespace": "indices.get_field_mapping" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4533,9 +4658,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.get_index_template", @@ -4548,8 +4670,11 @@ "name": "Response", "namespace": "indices.get_index_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4567,9 +4692,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns mappings for one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "name": "indices.get_mapping", @@ -4582,8 +4704,11 @@ "name": "Response", "namespace": "indices.get_mapping" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4621,9 +4746,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns settings for one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "name": "indices.get_settings", @@ -4636,8 +4758,11 @@ "name": "Response", "namespace": "indices.get_settings" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4667,9 +4792,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.get_template", @@ -4682,8 +4804,11 @@ "name": "Response", "namespace": "indices.get_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4701,9 +4826,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "DEPRECATED Returns a progress status of current upgrade.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "name": "indices.get_upgrade", @@ -4716,8 +4838,11 @@ "name": "Response", "namespace": "indices.get_upgrade" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "deprecation": { @@ -4743,9 +4868,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Migrates an alias to a data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.migrate_to_data_stream", @@ -4758,8 +4880,11 @@ "name": "Response", "namespace": "indices.migrate_to_data_stream" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4771,9 +4896,30 @@ "visibility": "public" }, { - "accept": [ + "description": "Modifies a data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "name": "indices.modify_data_stream", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ "application/json" ], + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_data_stream/_modify" + } + ], + "visibility": "public" + }, + { "description": "Opens an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "name": "indices.open", @@ -4786,8 +4932,11 @@ "name": "Response", "namespace": "indices.open" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4799,9 +4948,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Promotes a data stream from a replicated data stream managed by CCR to a regular data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.promote_data_stream", @@ -4814,8 +4960,11 @@ "name": "Response", "namespace": "indices.promote_data_stream" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4827,12 +4976,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.put_alias", @@ -4841,12 +4984,18 @@ "namespace": "indices.put_alias" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.put_alias" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4866,12 +5015,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.put_index_template", @@ -4880,12 +5023,18 @@ "namespace": "indices.put_index_template" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.put_index_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -4898,12 +5047,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates the index mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "name": "indices.put_mapping", @@ -4912,12 +5055,18 @@ "namespace": "indices.put_mapping" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.put_mapping" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5007,12 +5156,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates the index settings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "name": "indices.put_settings", @@ -5021,12 +5164,18 @@ "namespace": "indices.put_settings" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.put_settings" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5044,12 +5193,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.put_template", @@ -5058,12 +5201,18 @@ "namespace": "indices.put_template" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.put_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5076,9 +5225,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about ongoing index shard recoveries.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", "name": "indices.recovery", @@ -5091,8 +5237,11 @@ "name": "Response", "namespace": "indices.recovery" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5110,9 +5259,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Performs the refresh operation in one or more indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "name": "indices.refresh", @@ -5125,8 +5271,11 @@ "name": "Response", "namespace": "indices.refresh" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5146,9 +5295,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Reloads an index's search analyzers and their resources.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", "name": "indices.reload_search_analyzers", @@ -5161,8 +5307,11 @@ "name": "Response", "namespace": "indices.reload_search_analyzers" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5175,9 +5324,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about any matching indices, aliases, and data streams", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "name": "indices.resolve_index", @@ -5190,8 +5336,11 @@ "name": "Response", "namespace": "indices.resolve_index" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5203,12 +5352,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html", "name": "indices.rollover", @@ -5217,12 +5360,18 @@ "namespace": "indices.rollover" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.rollover" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5240,9 +5389,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Provides low-level information about segments in a Lucene index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", "name": "indices.segments", @@ -5255,8 +5401,11 @@ "name": "Response", "namespace": "indices.segments" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5274,9 +5423,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Provides store information for shard copies of indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", "name": "indices.shard_stores", @@ -5289,8 +5435,11 @@ "name": "Response", "namespace": "indices.shard_stores" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5308,12 +5457,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allow to shrink an existing index into a new index with fewer primary shards.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html", "name": "indices.shrink", @@ -5322,12 +5465,18 @@ "namespace": "indices.shrink" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.shrink" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5340,12 +5489,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Simulate matching the given index name against the index templates in the system", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.simulate_index_template", @@ -5354,12 +5497,18 @@ "namespace": "indices.simulate_index_template" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.simulate_index_template" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5371,12 +5520,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Simulate resolving the given template name or body", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html", "name": "indices.simulate_template", @@ -5385,12 +5528,18 @@ "namespace": "indices.simulate_template" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.simulate_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5408,12 +5557,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows you to split an existing index into a new index with more primary shards.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html", "name": "indices.split", @@ -5422,12 +5565,18 @@ "namespace": "indices.split" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.split" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5440,9 +5589,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Provides statistics on operations happening in an index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", "name": "indices.stats", @@ -5455,8 +5601,11 @@ "name": "Response", "namespace": "indices.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5486,9 +5635,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", "name": "indices.unfreeze", @@ -5501,8 +5647,11 @@ "name": "Response", "namespace": "indices.unfreeze" }, + "responseMediaType": [ + "application/json" + ], "since": "6.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "deprecation": { @@ -5518,12 +5667,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates index aliases.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.update_aliases", @@ -5532,12 +5675,18 @@ "namespace": "indices.update_aliases" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.update_aliases" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5549,9 +5698,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "DEPRECATED Upgrades to the current version of Lucene.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html", "name": "indices.upgrade", @@ -5564,8 +5710,11 @@ "name": "Response", "namespace": "indices.upgrade" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "deprecation": { @@ -5591,12 +5740,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows a user to validate a potentially expensive query without executing it.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", "name": "indices.validate_query", @@ -5605,12 +5748,18 @@ "namespace": "indices.validate_query" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "indices.validate_query" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5641,9 +5790,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns basic information about the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "info", @@ -5656,8 +5802,11 @@ "name": "Response", "namespace": "_global.info" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5669,9 +5818,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", "name": "ingest.delete_pipeline", @@ -5684,8 +5830,11 @@ "name": "Response", "namespace": "ingest.delete_pipeline" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5697,9 +5846,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns statistical information about geoip databases", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", "name": "ingest.geo_ip_stats", @@ -5712,8 +5858,11 @@ "name": "Response", "namespace": "ingest.geo_ip_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5725,9 +5874,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns a pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", "name": "ingest.get_pipeline", @@ -5740,6 +5886,9 @@ "name": "Response", "namespace": "ingest.get_pipeline" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", "stability": "stable", "urls": [ @@ -5759,9 +5908,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns a list of the built-in patterns.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get", "name": "ingest.processor_grok", @@ -5774,8 +5920,11 @@ "name": "Response", "namespace": "ingest.processor_grok" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5787,12 +5936,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates a pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", "name": "ingest.put_pipeline", @@ -5801,12 +5944,18 @@ "namespace": "ingest.put_pipeline" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ingest.put_pipeline" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5818,26 +5967,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to simulate a pipeline with example documents.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "name": "ingest.simulate", "request": { "name": "Request", - "namespace": "ingest.simulate_pipeline" + "namespace": "ingest.simulate" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ingest.simulate_pipeline" + "namespace": "ingest.simulate" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5857,9 +6006,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes licensing information for the cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", "name": "license.delete", @@ -5872,8 +6018,11 @@ "name": "Response", "namespace": "license.delete" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5885,9 +6034,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves licensing information for the cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "name": "license.get", @@ -5900,8 +6046,11 @@ "name": "Response", "namespace": "license.get" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5913,9 +6062,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about the status of the basic license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "name": "license.get_basic_status", @@ -5928,8 +6074,11 @@ "name": "Response", "namespace": "license.get_basic_status" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5941,9 +6090,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about the status of the trial license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "name": "license.get_trial_status", @@ -5956,8 +6102,11 @@ "name": "Response", "namespace": "license.get_trial_status" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -5969,12 +6118,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates the license for the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "name": "license.post", @@ -5983,12 +6126,18 @@ "namespace": "license.post" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "license.post" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6001,9 +6150,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Starts an indefinite basic license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "name": "license.post_start_basic", @@ -6016,8 +6162,11 @@ "name": "Response", "namespace": "license.post_start_basic" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6029,9 +6178,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "starts a limited time trial license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "name": "license.post_start_trial", @@ -6044,8 +6190,11 @@ "name": "Response", "namespace": "license.post_start_trial" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6057,23 +6206,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes Logstash Pipelines used by Central Management", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", "name": "logstash.delete_pipeline", "request": { "name": "Request", - "namespace": "logstash.pipeline_delete" + "namespace": "logstash.delete_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "logstash.pipeline_delete" + "namespace": "logstash.delete_pipeline" }, + "responseMediaType": [ + "application/json" + ], "since": "7.12.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6085,23 +6234,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves Logstash Pipelines used by Central Management", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", "name": "logstash.get_pipeline", "request": { "name": "Request", - "namespace": "logstash.pipeline_get" + "namespace": "logstash.get_pipeline" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "logstash.pipeline_get" + "namespace": "logstash.get_pipeline" }, + "responseMediaType": [ + "application/json" + ], "since": "7.12.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6113,26 +6262,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Adds and updates Logstash Pipelines used for Central Management", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", "name": "logstash.put_pipeline", "request": { "name": "Request", - "namespace": "logstash.pipeline_put" + "namespace": "logstash.put_pipeline" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "logstash.pipeline_put" + "namespace": "logstash.put_pipeline" }, + "responseMediaType": [ + "application/json" + ], "since": "7.12.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6144,12 +6293,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to get multiple documents in one request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "name": "mget", @@ -6158,10 +6301,16 @@ "namespace": "_global.mget" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.mget" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", "stability": "stable", "urls": [ @@ -6194,23 +6343,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "name": "migration.deprecations", "request": { "name": "Request", - "namespace": "migration.deprecation_info" + "namespace": "migration.deprecations" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "migration.deprecation_info" + "namespace": "migration.deprecations" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6228,26 +6377,97 @@ "visibility": "public" }, { - "accept": [ + "description": "Find out whether system features need to be upgraded or not", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "name": "migration.get_feature_upgrade_status", + "privileges": { + "index": [ + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "migration.get_feature_upgrade_status" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "migration.get_feature_upgrade_status" + }, + "responseMediaType": [ "application/json" ], - "contentType": [ + "since": "7.16.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_migration/system_features" + } + ], + "visibility": "public" + }, + { + "description": "Begin upgrades for system features", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "name": "migration.post_feature_upgrade", + "privileges": { + "index": [ + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "migration.post_feature_upgrade" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "migration.post_feature_upgrade" + }, + "responseMediaType": [ "application/json" ], + "since": "7.16.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_migration/system_features" + } + ], + "visibility": "public" + }, + { "description": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html", "name": "ml.close_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.close_job" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.close_job" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6259,12 +6479,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", "name": "ml.delete_calendar", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_calendar" @@ -6274,8 +6496,11 @@ "name": "Response", "namespace": "ml.delete_calendar" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6287,9 +6512,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes scheduled events from a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html", "name": "ml.delete_calendar_event", @@ -6302,8 +6524,11 @@ "name": "Response", "namespace": "ml.delete_calendar_event" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6315,12 +6540,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes anomaly detection jobs from a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html", "name": "ml.delete_calendar_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_calendar_job" @@ -6330,8 +6557,11 @@ "name": "Response", "namespace": "ml.delete_calendar_job" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6343,12 +6573,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing data frame analytics job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", "name": "ml.delete_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_data_frame_analytics" @@ -6358,8 +6590,11 @@ "name": "Response", "namespace": "ml.delete_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6371,12 +6606,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing datafeed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html", "name": "ml.delete_datafeed", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_datafeed" @@ -6386,8 +6623,11 @@ "name": "Response", "namespace": "ml.delete_datafeed" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6399,23 +6639,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes expired and unused machine learning data.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "name": "ml.delete_expired_data", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_expired_data" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.delete_expired_data" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6433,12 +6681,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a filter.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "name": "ml.delete_filter", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_filter" @@ -6448,8 +6698,11 @@ "name": "Response", "namespace": "ml.delete_filter" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6461,12 +6714,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes forecasts from a machine learning job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "name": "ml.delete_forecast", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_forecast" @@ -6476,8 +6731,11 @@ "name": "Response", "namespace": "ml.delete_forecast" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6495,12 +6753,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", "name": "ml.delete_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_job" @@ -6510,8 +6770,11 @@ "name": "Response", "namespace": "ml.delete_job" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6523,12 +6786,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing model snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "name": "ml.delete_model_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_model_snapshot" @@ -6538,8 +6803,11 @@ "name": "Response", "namespace": "ml.delete_model_snapshot" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6551,12 +6819,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", "name": "ml.delete_trained_model", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_trained_model" @@ -6566,8 +6836,11 @@ "name": "Response", "namespace": "ml.delete_trained_model" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6579,26 +6852,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Deletes a model alias that refers to the trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", "name": "ml.delete_trained_model_alias", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_trained_model_alias" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.delete_trained_model_alias" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6610,24 +6888,29 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Estimates the model memory", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "name": "ml.estimate_model_memory", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.estimate_model_memory" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.estimate_model_memory" }, + "responseMediaType": [ + "application/json" + ], "since": "7.7.0", "stability": "stable", "urls": [ @@ -6641,26 +6924,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Evaluates the data frame analytics for an annotated index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "name": "ml.evaluate_data_frame", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.evaluate_data_frame" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.evaluate_data_frame" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6672,26 +6960,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Explains a data frame analytics config.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "name": "ml.explain_data_frame_analytics", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.explain_data_frame_analytics" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.explain_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6711,26 +7004,19 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson" - ], "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "name": "ml.find_file_structure", - "request": { - "name": "Request", - "namespace": "ml.find_file_structure" - }, + "request": null, "requestBodyRequired": true, - "response": { - "name": "Response", - "namespace": "ml.find_file_structure" - }, - "since": "5.4.0", - "stability": "TODO", + "requestMediaType": [ + "application/x-ndjson" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", "urls": [ { "deprecation": { @@ -6746,26 +7032,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Forces any buffered data to be processed by the job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", "name": "ml.flush_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.flush_job" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.flush_job" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6777,23 +7068,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Predicts the future behavior of a time series by using its historical behavior.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", "name": "ml.forecast", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", - "namespace": "ml.forecast_job" + "namespace": "ml.forecast" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.forecast_job" + "namespace": "ml.forecast" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6805,26 +7104,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves anomaly detection job results for one or more buckets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", "name": "ml.get_buckets", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_buckets" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.get_buckets" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6844,12 +7148,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about the scheduled events in calendars.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "name": "ml.get_calendar_events", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_calendar_events" @@ -6859,8 +7165,11 @@ "name": "Response", "namespace": "ml.get_calendar_events" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6872,26 +7181,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves configuration information for calendars.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "name": "ml.get_calendars", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_calendars" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.get_calendars" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6911,26 +7225,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves anomaly detection job results for one or more categories.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", "name": "ml.get_categories", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_categories" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.get_categories" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6950,12 +7269,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves configuration information for data frame analytics jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "name": "ml.get_data_frame_analytics", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_data_frame_analytics" @@ -6965,8 +7286,11 @@ "name": "Response", "namespace": "ml.get_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -6984,12 +7308,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information for data frame analytics jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "name": "ml.get_data_frame_analytics_stats", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_data_frame_analytics_stats" @@ -6999,8 +7325,11 @@ "name": "Response", "namespace": "ml.get_data_frame_analytics_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7018,12 +7347,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information for datafeeds.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "name": "ml.get_datafeed_stats", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_datafeed_stats" @@ -7033,6 +7364,9 @@ "name": "Response", "namespace": "ml.get_datafeed_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", "stability": "stable", "urls": [ @@ -7052,12 +7386,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves configuration information for datafeeds.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "name": "ml.get_datafeeds", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_datafeeds" @@ -7067,8 +7403,11 @@ "name": "Response", "namespace": "ml.get_datafeeds" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7086,12 +7425,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves filters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "name": "ml.get_filters", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_filters" @@ -7101,8 +7442,11 @@ "name": "Response", "namespace": "ml.get_filters" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7120,26 +7464,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves anomaly detection job results for one or more influencers.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", "name": "ml.get_influencers", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_influencers" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.get_influencers" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7152,12 +7501,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information for anomaly detection jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "name": "ml.get_job_stats", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_job_stats" @@ -7167,6 +7518,9 @@ "name": "Response", "namespace": "ml.get_job_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", "stability": "stable", "urls": [ @@ -7186,12 +7540,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves configuration information for anomaly detection jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "name": "ml.get_jobs", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_jobs" @@ -7201,6 +7557,9 @@ "name": "Response", "namespace": "ml.get_jobs" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", "stability": "stable", "urls": [ @@ -7220,24 +7579,62 @@ "visibility": "public" }, { - "accept": [ + "description": "Gets stats for anomaly detection job model snapshot upgrades that are in progress.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", + "name": "ml.get_model_snapshot_upgrade_stats", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, + "request": { + "name": "Request", + "namespace": "ml.get_model_snapshot_upgrade_stats" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "ml.get_model_snapshot_upgrade_stats" + }, + "responseMediaType": [ "application/json" ], - "contentType": [ - "application/json" + "since": "7.16.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats" + } ], + "visibility": "public" + }, + { "description": "Retrieves information about model snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "name": "ml.get_model_snapshots", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_model_snapshots" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.get_model_snapshots" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7259,26 +7656,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", "name": "ml.get_overall_buckets", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_overall_buckets" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.get_overall_buckets" }, + "responseMediaType": [ + "application/json" + ], "since": "6.1.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7291,26 +7693,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves anomaly records for an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "name": "ml.get_records", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", - "namespace": "ml.get_anomaly_records" + "namespace": "ml.get_records" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.get_anomaly_records" + "namespace": "ml.get_records" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7323,12 +7730,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves configuration information for a trained inference model.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "name": "ml.get_trained_models", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_trained_models" @@ -7338,8 +7747,11 @@ "name": "Response", "namespace": "ml.get_trained_models" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7357,12 +7769,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information for trained inference models.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "name": "ml.get_trained_models_stats", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.get_trained_models_stats" @@ -7372,8 +7786,11 @@ "name": "Response", "namespace": "ml.get_trained_models_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7391,12 +7808,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns defaults and limits used by machine learning.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "name": "ml.info", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.info" @@ -7406,8 +7825,11 @@ "name": "Response", "namespace": "ml.info" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7419,21 +7841,29 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Opens one or more anomaly detection jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "name": "ml.open_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.open_job" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.open_job" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7447,26 +7877,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Posts scheduled events in a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "name": "ml.post_calendar_events", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.post_calendar_events" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.post_calendar_events" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7478,13 +7913,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson", - "application/json" - ], "description": "Sends data to an anomaly detection job for analysis.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "name": "ml.post_data", @@ -7493,10 +7921,17 @@ "namespace": "ml.post_data" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson", + "application/json" + ], "response": { "name": "Response", "namespace": "ml.post_data" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7510,26 +7945,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Previews that will be analyzed given a data frame analytics config.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", "name": "ml.preview_data_frame_analytics", + "privileges": { + "cluster": [ + "monitor_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.preview_data_frame_analytics" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.preview_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7549,9 +7989,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Previews a datafeed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "name": "ml.preview_datafeed", @@ -7560,10 +7997,16 @@ "namespace": "ml.preview_datafeed" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.preview_datafeed" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7585,24 +8028,29 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "name": "ml.put_calendar", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.put_calendar" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_calendar" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", "stability": "stable", "urls": [ @@ -7616,12 +8064,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Adds an anomaly detection job to a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "name": "ml.put_calendar_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.put_calendar_job" @@ -7631,8 +8081,11 @@ "name": "Response", "namespace": "ml.put_calendar_job" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7644,26 +8097,38 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates a data frame analytics job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", "name": "ml.put_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ], + "index": [ + "create_index", + "index", + "manage", + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "ml.put_data_frame_analytics" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7675,12 +8140,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates a datafeed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "name": "ml.put_datafeed", @@ -7689,10 +8148,16 @@ "namespace": "ml.put_datafeed" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_datafeed" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7706,12 +8171,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates a filter.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "name": "ml.put_filter", @@ -7720,10 +8179,16 @@ "namespace": "ml.put_filter" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_filter" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7737,12 +8202,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "name": "ml.put_job", @@ -7751,12 +8210,18 @@ "namespace": "ml.put_job" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_job" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7768,26 +8233,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates an inference trained model.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "name": "ml.put_trained_model", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.put_trained_model" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_trained_model" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7799,26 +8269,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new model alias (or reassigns an existing one) to refer to the trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", "name": "ml.put_trained_model_alias", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.put_trained_model_alias" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.put_trained_model_alias" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7830,12 +8305,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Resets an existing anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "name": "ml.reset_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.reset_job" @@ -7845,6 +8322,9 @@ "name": "Response", "namespace": "ml.reset_job" }, + "responseMediaType": [ + "application/json" + ], "since": "7.14.0", "stability": "stable", "urls": [ @@ -7858,24 +8338,29 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Reverts to a specific snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "name": "ml.revert_model_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.revert_model_snapshot" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.revert_model_snapshot" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", "stability": "stable", "urls": [ @@ -7889,12 +8374,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", "name": "ml.set_upgrade_mode", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.set_upgrade_mode" @@ -7904,8 +8391,11 @@ "name": "Response", "namespace": "ml.set_upgrade_mode" }, + "responseMediaType": [ + "application/json" + ], "since": "6.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7917,25 +8407,37 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Starts a data frame analytics job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "name": "ml.start_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ], + "index": [ + "create_index", + "index", + "manage", + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "ml.start_data_frame_analytics" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.start_data_frame_analytics" }, - "since": "5.4.0", + "responseMediaType": [ + "application/json" + ], + "since": "7.3.0", "stability": "stable", "urls": [ { @@ -7948,12 +8450,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Starts one or more datafeeds.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "name": "ml.start_datafeed", @@ -7962,12 +8458,18 @@ "namespace": "ml.start_datafeed" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.start_datafeed" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -7979,26 +8481,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Stops one or more data frame analytics jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "name": "ml.stop_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.stop_data_frame_analytics" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.stop_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8010,9 +8517,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Stops one or more datafeeds.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "name": "ml.stop_datafeed", @@ -8021,12 +8525,18 @@ "namespace": "ml.stop_datafeed" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.stop_datafeed" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8038,26 +8548,38 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates certain properties of a data frame analytics job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "name": "ml.update_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ], + "index": [ + "read", + "create_index", + "manage", + "index", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "ml.update_data_frame_analytics" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.update_data_frame_analytics" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8069,18 +8591,30 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates certain properties of a datafeed.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "name": "ml.update_datafeed", - "request": null, + "privileges": { + "cluster": [ + "manage_ml" + ] + }, + "request": { + "name": "Request", + "namespace": "ml.update_datafeed" + }, "requestBodyRequired": true, - "response": null, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "ml.update_datafeed" + }, + "responseMediaType": [ + "application/json" + ], + "since": "6.4.0", "stability": "stable", "urls": [ { @@ -8093,12 +8627,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates the description of a filter, adds items, or removes items.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", "name": "ml.update_filter", @@ -8107,12 +8635,18 @@ "namespace": "ml.update_filter" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.update_filter" }, + "responseMediaType": [ + "application/json" + ], "since": "6.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8124,24 +8658,29 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates certain properties of an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "name": "ml.update_job", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.update_job" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.update_job" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", "stability": "stable", "urls": [ @@ -8155,26 +8694,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates certain properties of a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "name": "ml.update_model_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.update_model_snapshot" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.update_model_snapshot" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8186,12 +8730,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Upgrades a given job snapshot to the current major version.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", "name": "ml.upgrade_job_snapshot", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.upgrade_job_snapshot" @@ -8201,8 +8747,11 @@ "name": "Response", "namespace": "ml.upgrade_job_snapshot" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8214,26 +8763,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Validates an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate", "request": { "name": "Request", - "namespace": "ml.validate_job" + "namespace": "ml.validate" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "ml.validate_job" + "namespace": "ml.validate" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8242,15 +8791,9 @@ "path": "/_ml/anomaly_detectors/_validate" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Validates an anomaly detection detector.", "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate_detector", @@ -8259,12 +8802,18 @@ "namespace": "ml.validate_detector" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "ml.validate_detector" }, + "responseMediaType": [ + "application/json" + ], "since": "5.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8273,15 +8822,9 @@ "path": "/_ml/anomaly_detectors/_validate/detector" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson" - ], "description": "Used by the monitoring features to send monitoring data.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "name": "monitoring.bulk", @@ -8290,12 +8833,18 @@ "namespace": "monitoring.bulk" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", "namespace": "monitoring.bulk" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8316,27 +8865,32 @@ "path": "/_monitoring/{type}/bulk" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson" - ], "description": "Allows to execute several search operations in one request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "name": "msearch", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.msearch" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", "namespace": "_global.msearch" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", "stability": "stable", "urls": [ @@ -8369,26 +8923,31 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson" - ], "description": "Allows to execute several search template operations in one request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", "name": "msearch_template", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.msearch_template" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", "namespace": "_global.msearch_template" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8419,12 +8978,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Returns multiple termvectors in one request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "name": "mtermvectors", @@ -8433,12 +8986,18 @@ "namespace": "_global.mtermvectors" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.mtermvectors" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8469,15 +9028,28 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes the archived repositories metering information present in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", - "name": "nodes.clear_metering_archive", - "request": null, + "name": "nodes.clear_repositories_metering_archive", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "nodes.clear_repositories_metering_archive" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "nodes.clear_repositories_metering_archive" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.16.0", "stability": "experimental", "urls": [ { @@ -8490,15 +9062,28 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns cluster repositories metering information.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", - "name": "nodes.get_metering_info", - "request": null, + "name": "nodes.get_repositories_metering_info", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "nodes.get_repositories_metering_info" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "nodes.get_repositories_metering_info" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.16.0", "stability": "experimental", "urls": [ { @@ -8511,12 +9096,15 @@ "visibility": "public" }, { - "accept": [ - "text/plain" - ], "description": "Returns information about hot threads on each node in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html", "name": "nodes.hot_threads", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", "namespace": "nodes.hot_threads" @@ -8526,8 +9114,11 @@ "name": "Response", "namespace": "nodes.hot_threads" }, + "responseMediaType": [ + "text/plain" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8605,9 +9196,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about nodes in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html", "name": "nodes.info", @@ -8620,8 +9208,11 @@ "name": "Response", "namespace": "nodes.info" }, + "responseMediaType": [ + "application/json" + ], "since": "1.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8651,12 +9242,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Reloads secure settings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "name": "nodes.reload_secure_settings", @@ -8665,12 +9250,18 @@ "namespace": "nodes.reload_secure_settings" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "nodes.reload_secure_settings" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8688,9 +9279,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns statistical information about nodes in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html", "name": "nodes.stats", @@ -8703,8 +9291,11 @@ "name": "Response", "namespace": "nodes.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8746,9 +9337,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns low-level information about REST actions usage on nodes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html", "name": "nodes.usage", @@ -8761,8 +9349,11 @@ "name": "Response", "namespace": "nodes.usage" }, + "responseMediaType": [ + "application/json" + ], "since": "6.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8792,12 +9383,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Open a point in time that can be used in subsequent searches", + "docId": "point-in-time-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", "name": "open_point_in_time", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "_global.open_point_in_time" @@ -8807,15 +9401,12 @@ "name": "Response", "namespace": "_global.open_point_in_time" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_pit" - }, { "methods": [ "POST" @@ -8826,9 +9417,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns whether the cluster is running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "ping", @@ -8841,8 +9429,11 @@ "name": "Response", "namespace": "_global.ping" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8854,12 +9445,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates a script.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "put_script", @@ -8868,12 +9453,18 @@ "namespace": "_global.put_script" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.put_script" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8893,12 +9484,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "name": "rank_eval", @@ -8907,12 +9492,18 @@ "namespace": "_global.rank_eval" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.rank_eval" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8932,12 +9523,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex", @@ -8946,12 +9531,18 @@ "namespace": "_global.reindex" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.reindex" }, + "responseMediaType": [ + "application/json" + ], "since": "2.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8963,9 +9554,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Changes the number of requests per second for a particular Reindex operation.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex_rethrottle", @@ -8978,8 +9566,11 @@ "name": "Response", "namespace": "_global.reindex_rethrottle" }, + "responseMediaType": [ + "application/json" + ], "since": "2.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -8991,12 +9582,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to use the Mustache language to pre-render a search definition.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "name": "render_search_template", @@ -9005,12 +9590,18 @@ "namespace": "_global.render_search_template" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.render_search_template" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9030,23 +9621,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "name": "rollup.delete_job", "request": { "name": "Request", - "namespace": "rollup.delete_rollup_job" + "namespace": "rollup.delete_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.delete_rollup_job" + "namespace": "rollup.delete_job" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9058,23 +9649,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the configuration, stats, and status of rollup jobs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "name": "rollup.get_jobs", "request": { "name": "Request", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9092,23 +9683,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "name": "rollup.get_rollup_caps", "request": { "name": "Request", - "namespace": "rollup.get_rollup_capabilities" + "namespace": "rollup.get_rollup_caps" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.get_rollup_capabilities" + "namespace": "rollup.get_rollup_caps" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9126,23 +9717,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "name": "rollup.get_rollup_index_caps", "request": { "name": "Request", - "namespace": "rollup.get_rollup_index_capabilities" + "namespace": "rollup.get_rollup_index_caps" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.get_rollup_index_capabilities" + "namespace": "rollup.get_rollup_index_caps" }, + "responseMediaType": [ + "application/json" + ], "since": "6.4.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9154,26 +9745,26 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "name": "rollup.put_job", "request": { "name": "Request", - "namespace": "rollup.create_rollup_job" + "namespace": "rollup.put_job" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", - "namespace": "rollup.create_rollup_job" + "namespace": "rollup.put_job" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9185,12 +9776,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Rollup an index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html", "name": "rollup.rollup", @@ -9199,12 +9784,18 @@ "namespace": "rollup.rollup" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "rollup.rollup" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9216,12 +9807,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Enables searching rolled-up data using the standard query DSL.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "name": "rollup.rollup_search", @@ -9230,12 +9815,18 @@ "namespace": "rollup.rollup_search" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "rollup.rollup_search" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9259,23 +9850,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Starts an existing, stopped rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "name": "rollup.start_job", "request": { "name": "Request", - "namespace": "rollup.start_rollup_job" + "namespace": "rollup.start_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.start_rollup_job" + "namespace": "rollup.start_job" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9287,23 +9878,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Stops an existing, started rollup job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "name": "rollup.stop_job", "request": { "name": "Request", - "namespace": "rollup.stop_rollup_job" + "namespace": "rollup.stop_job" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "rollup.stop_rollup_job" + "namespace": "rollup.stop_job" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9315,12 +9906,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows an arbitrary script to be executed and a result to be returned", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", "name": "scripts_painless_execute", @@ -9329,12 +9914,18 @@ "namespace": "_global.scripts_painless_execute" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.scripts_painless_execute" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9347,12 +9938,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to retrieve a large numbers of results from a single search request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", "name": "scroll", @@ -9361,12 +9946,18 @@ "namespace": "_global.scroll" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.scroll" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9390,12 +9981,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Returns results matching a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "search", @@ -9404,12 +9989,18 @@ "namespace": "_global.search" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.search" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9440,9 +10031,38 @@ "visibility": "public" }, { - "accept": [ + "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", + "name": "search_mvt", + "request": { + "name": "Request", + "namespace": "_global.search_mvt" + }, + "requestBodyRequired": false, + "requestMediaType": [ "application/json" ], + "response": { + "name": "Response", + "namespace": "_global.search_mvt" + }, + "responseMediaType": [ + "application/vnd.mapbox-vector-tile" + ], + "since": "7.15.0", + "stability": "experimental", + "urls": [ + { + "methods": [ + "POST", + "GET" + ], + "path": "/{index}/_mvt/{field}/{zoom}/{x}/{y}" + } + ], + "visibility": "public" + }, + { "description": "Returns information about the indices and shards that a search request would be executed against.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", "name": "search_shards", @@ -9455,8 +10075,11 @@ "name": "Response", "namespace": "_global.search_shards" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9476,12 +10099,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Allows to use the Mustache language to pre-render a search definition.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", "name": "search_template", @@ -9490,12 +10107,18 @@ "namespace": "_global.search_template" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.search_template" }, + "responseMediaType": [ + "application/json" + ], "since": "2.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9526,15 +10149,22 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieve node-level cache statistics about searchable snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.cache_stats", - "request": null, + "request": { + "name": "Request", + "namespace": "searchable_snapshots.cache_stats" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "searchable_snapshots.cache_stats" + }, + "responseMediaType": [ + "application/json" + ], + "since": "7.13.0", "stability": "experimental", "urls": [ { @@ -9553,9 +10183,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Clear the cache of searchable snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "name": "searchable_snapshots.clear_cache", @@ -9568,8 +10195,11 @@ "name": "Response", "namespace": "searchable_snapshots.clear_cache" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -9587,12 +10217,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Mount a snapshot as a searchable index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html", "name": "searchable_snapshots.mount", @@ -9601,12 +10225,18 @@ "namespace": "searchable_snapshots.mount" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "searchable_snapshots.mount" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9618,23 +10248,16 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "DEPRECATED: This API is replaced by the Repositories Metering API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "name": "searchable_snapshots.repository_stats", - "request": { - "name": "Request", - "namespace": "searchable_snapshots.repository_stats" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "searchable_snapshots.repository_stats" - }, - "since": "7.10.0", - "stability": "TODO", + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", "urls": [ { "methods": [ @@ -9646,9 +10269,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieve shard-level statistics about searchable snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "name": "searchable_snapshots.stats", @@ -9661,8 +10281,11 @@ "name": "Response", "namespace": "searchable_snapshots.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9680,9 +10303,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Enables authentication as a user and retrieve information about the authenticated user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "name": "security.authenticate", @@ -9695,8 +10315,11 @@ "name": "Response", "namespace": "security.authenticate" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9708,12 +10331,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Changes the passwords of users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "name": "security.change_password", @@ -9722,12 +10339,18 @@ "namespace": "security.change_password" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.change_password" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9747,9 +10370,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Clear a subset or all entries from the API key cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "name": "security.clear_api_key_cache", @@ -9762,8 +10382,11 @@ "name": "Response", "namespace": "security.clear_api_key_cache" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9775,9 +10398,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Evicts application privileges from the native application privileges cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "name": "security.clear_cached_privileges", @@ -9790,8 +10410,11 @@ "name": "Response", "namespace": "security.clear_cached_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9803,9 +10426,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "name": "security.clear_cached_realms", @@ -9818,8 +10438,11 @@ "name": "Response", "namespace": "security.clear_cached_realms" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9831,9 +10454,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Evicts roles from the native role cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "name": "security.clear_cached_roles", @@ -9846,8 +10466,11 @@ "name": "Response", "namespace": "security.clear_cached_roles" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9859,9 +10482,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Evicts tokens from the service account token caches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "name": "security.clear_cached_service_tokens", @@ -9874,8 +10494,11 @@ "name": "Response", "namespace": "security.clear_cached_service_tokens" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9887,12 +10510,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates an API key for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", @@ -9901,12 +10518,18 @@ "namespace": "security.create_api_key" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.create_api_key" }, + "responseMediaType": [ + "application/json" + ], "since": "6.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9919,9 +10542,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Creates a service account token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "name": "security.create_service_token", @@ -9934,8 +10554,11 @@ "name": "Response", "namespace": "security.create_service_token" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9954,9 +10577,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", "name": "security.delete_privileges", @@ -9969,8 +10589,11 @@ "name": "Response", "namespace": "security.delete_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "6.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -9982,9 +10605,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", @@ -9997,8 +10617,11 @@ "name": "Response", "namespace": "security.delete_role" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10010,9 +10633,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes role mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "name": "security.delete_role_mapping", @@ -10025,8 +10645,11 @@ "name": "Response", "namespace": "security.delete_role_mapping" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10038,9 +10661,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a service account token.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "name": "security.delete_service_token", @@ -10053,8 +10673,11 @@ "name": "Response", "namespace": "security.delete_service_token" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10066,9 +10689,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes users from the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "name": "security.delete_user", @@ -10081,8 +10701,11 @@ "name": "Response", "namespace": "security.delete_user" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10094,9 +10717,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Disables users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "name": "security.disable_user", @@ -10109,8 +10729,11 @@ "name": "Response", "namespace": "security.disable_user" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10123,9 +10746,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Enables users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "name": "security.enable_user", @@ -10138,8 +10758,11 @@ "name": "Response", "namespace": "security.enable_user" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10152,9 +10775,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information for one or more API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "name": "security.get_api_key", @@ -10167,8 +10787,11 @@ "name": "Response", "namespace": "security.get_api_key" }, + "responseMediaType": [ + "application/json" + ], "since": "6.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10180,9 +10803,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", @@ -10195,8 +10815,11 @@ "name": "Response", "namespace": "security.get_builtin_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "7.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10208,9 +10831,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", "name": "security.get_privileges", @@ -10223,8 +10843,11 @@ "name": "Response", "namespace": "security.get_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "6.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10248,9 +10871,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", @@ -10263,8 +10883,11 @@ "name": "Response", "namespace": "security.get_role" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10282,9 +10905,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves role mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "name": "security.get_role_mapping", @@ -10297,8 +10917,11 @@ "name": "Response", "namespace": "security.get_role_mapping" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10316,9 +10939,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about service accounts.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "name": "security.get_service_accounts", @@ -10331,8 +10951,11 @@ "name": "Response", "namespace": "security.get_service_accounts" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10356,9 +10979,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information of all service credentials for a service account.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", "name": "security.get_service_credentials", @@ -10371,8 +10991,11 @@ "name": "Response", "namespace": "security.get_service_credentials" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10384,12 +11007,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a bearer token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "name": "security.get_token", @@ -10398,12 +11015,18 @@ "namespace": "security.get_token" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.get_token" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10415,9 +11038,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "name": "security.get_user", @@ -10430,8 +11050,11 @@ "name": "Response", "namespace": "security.get_user" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10449,9 +11072,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves security privileges for the logged in user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", "name": "security.get_user_privileges", @@ -10464,8 +11084,11 @@ "name": "Response", "namespace": "security.get_user_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10477,12 +11100,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates an API key on behalf of another user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", "name": "security.grant_api_key", @@ -10491,12 +11108,18 @@ "namespace": "security.grant_api_key" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.grant_api_key" }, + "responseMediaType": [ + "application/json" + ], "since": "7.9.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10508,12 +11131,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Determines whether the specified user has a specified list of privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", "name": "security.has_privileges", @@ -10522,12 +11139,18 @@ "namespace": "security.has_privileges" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.has_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "6.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10547,12 +11170,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Invalidates one or more API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "name": "security.invalidate_api_key", @@ -10561,12 +11178,18 @@ "namespace": "security.invalidate_api_key" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.invalidate_api_key" }, + "responseMediaType": [ + "application/json" + ], "since": "6.7.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10578,12 +11201,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Invalidates one or more access tokens or refresh tokens.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", "name": "security.invalidate_token", @@ -10592,12 +11209,18 @@ "namespace": "security.invalidate_token" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.invalidate_token" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10609,12 +11232,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Adds or updates application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", "name": "security.put_privileges", @@ -10623,12 +11240,18 @@ "namespace": "security.put_privileges" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.put_privileges" }, + "responseMediaType": [ + "application/json" + ], "since": "6.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10641,12 +11264,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Adds and updates roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", @@ -10655,12 +11272,18 @@ "namespace": "security.put_role" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.put_role" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10673,12 +11296,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates and updates role mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", "name": "security.put_role_mapping", @@ -10687,12 +11304,18 @@ "namespace": "security.put_role_mapping" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.put_role_mapping" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10705,12 +11328,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Adds and updates users in the native realm. These users are commonly referred to as native users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", "name": "security.put_user", @@ -10719,12 +11336,18 @@ "namespace": "security.put_user" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "security.put_user" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10737,18 +11360,43 @@ "visibility": "public" }, { - "accept": [ + "description": "Retrieves information for API keys using a subset of query DSL", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", + "name": "security.query_api_keys", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ "application/json" ], - "contentType": [ + "response": null, + "responseMediaType": [ "application/json" ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET", + "POST" + ], + "path": "/_security/_query/api_key" + } + ], + "visibility": "public" + }, + { "description": "Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", "name": "security.saml_authenticate", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -10761,18 +11409,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Verifies the logout response sent from the SAML IdP", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", "name": "security.saml_complete_logout", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -10785,18 +11433,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Consumes a SAML LogoutRequest", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "name": "security.saml_invalidate", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -10809,18 +11457,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Invalidates an access token and a refresh token that were generated via the SAML Authenticate API", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", "name": "security.saml_logout", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -10833,18 +11481,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a SAML authentication request", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "name": "security.saml_prepare_authentication", "request": null, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -10857,18 +11505,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", "name": "security.saml_service_provider_metadata", "request": null, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -10881,13 +11529,7 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], - "description": "Removes a node from the shutdown list", + "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.delete_node", "request": { @@ -10895,12 +11537,18 @@ "namespace": "shutdown.delete_node" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "shutdown.delete_node" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10909,16 +11557,10 @@ "path": "/_nodes/{node_id}/shutdown" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], - "description": "Retrieve status of a node or nodes that are currently marked as shutting down", + "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.get_node", "request": { @@ -10926,12 +11568,18 @@ "namespace": "shutdown.get_node" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "shutdown.get_node" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10946,16 +11594,10 @@ "path": "/_nodes/{node_id}/shutdown" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], - "description": "Adds a node to be shut down", + "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.put_node", "request": { @@ -10963,12 +11605,18 @@ "namespace": "shutdown.put_node" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "shutdown.put_node" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -10977,12 +11625,9 @@ "path": "/_nodes/{node_id}/shutdown" } ], - "visibility": "public" + "visibility": "private" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing snapshot lifecycle policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "name": "slm.delete_lifecycle", @@ -10995,8 +11640,11 @@ "name": "Response", "namespace": "slm.delete_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "7.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11008,9 +11656,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", "name": "slm.execute_lifecycle", @@ -11023,8 +11668,11 @@ "name": "Response", "namespace": "slm.execute_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "7.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11036,9 +11684,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes any snapshots that are expired according to the policy's retention rules.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", "name": "slm.execute_retention", @@ -11051,8 +11696,11 @@ "name": "Response", "namespace": "slm.execute_retention" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11064,9 +11712,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", "name": "slm.get_lifecycle", @@ -11079,8 +11724,11 @@ "name": "Response", "namespace": "slm.get_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "7.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11098,9 +11746,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", "name": "slm.get_stats", @@ -11113,8 +11758,11 @@ "name": "Response", "namespace": "slm.get_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11126,9 +11774,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the status of snapshot lifecycle management (SLM).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "name": "slm.get_status", @@ -11141,8 +11786,11 @@ "name": "Response", "namespace": "slm.get_status" }, + "responseMediaType": [ + "application/json" + ], "since": "7.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11154,12 +11802,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates or updates a snapshot lifecycle policy.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "name": "slm.put_lifecycle", @@ -11168,12 +11810,18 @@ "namespace": "slm.put_lifecycle" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "slm.put_lifecycle" }, + "responseMediaType": [ + "application/json" + ], "since": "7.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11185,9 +11833,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Turns on snapshot lifecycle management (SLM).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "name": "slm.start", @@ -11200,8 +11845,11 @@ "name": "Response", "namespace": "slm.start" }, + "responseMediaType": [ + "application/json" + ], "since": "7.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11213,9 +11861,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Turns off snapshot lifecycle management (SLM).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "name": "slm.stop", @@ -11228,8 +11873,11 @@ "name": "Response", "namespace": "slm.stop" }, + "responseMediaType": [ + "application/json" + ], "since": "7.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11241,9 +11889,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes stale data from repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", "name": "snapshot.cleanup_repository", @@ -11256,8 +11901,11 @@ "name": "Response", "namespace": "snapshot.cleanup_repository" }, + "responseMediaType": [ + "application/json" + ], "since": "7.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11269,12 +11917,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Clones indices from one snapshot into another snapshot in the same repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.clone", @@ -11283,12 +11925,18 @@ "namespace": "snapshot.clone" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "snapshot.clone" }, + "responseMediaType": [ + "application/json" + ], "since": "7.10.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11300,12 +11948,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a snapshot in a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.create", @@ -11314,12 +11956,18 @@ "namespace": "snapshot.create" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "snapshot.create" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11332,12 +11980,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.create_repository", @@ -11346,12 +11988,18 @@ "namespace": "snapshot.create_repository" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "snapshot.create_repository" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11364,9 +12012,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete", @@ -11379,8 +12024,11 @@ "name": "Response", "namespace": "snapshot.delete" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11392,9 +12040,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete_repository", @@ -11407,8 +12052,11 @@ "name": "Response", "namespace": "snapshot.delete_repository" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11420,9 +12068,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get", @@ -11435,8 +12080,11 @@ "name": "Response", "namespace": "snapshot.get" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11448,9 +12096,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get_repository", @@ -11463,8 +12108,11 @@ "name": "Response", "namespace": "snapshot.get_repository" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11482,15 +12130,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Analyzes a repository for correctness and performance", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.repository_analyze", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -11503,12 +12151,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Restores a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.restore", @@ -11517,12 +12159,18 @@ "namespace": "snapshot.restore" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "snapshot.restore" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11534,9 +12182,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about the status of a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.status", @@ -11549,8 +12194,11 @@ "name": "Response", "namespace": "snapshot.status" }, + "responseMediaType": [ + "application/json" + ], "since": "7.8.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11574,9 +12222,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Verifies a repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.verify_repository", @@ -11589,8 +12234,11 @@ "name": "Response", "namespace": "snapshot.verify_repository" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11602,12 +12250,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Clears the SQL cursor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "name": "sql.clear_cursor", @@ -11616,12 +12258,18 @@ "namespace": "sql.clear_cursor" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "sql.clear_cursor" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11633,15 +12281,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", "name": "sql.delete_async", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -11654,15 +12302,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the current status and available results for an async SQL search or stored synchronous SQL search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", "name": "sql.get_async", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -11675,15 +12323,15 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns the current status of an async SQL search or a stored synchronous SQL search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", "name": "sql.get_async_status", "request": null, "requestBodyRequired": false, "response": null, + "responseMediaType": [ + "application/json" + ], "stability": "stable", "urls": [ { @@ -11696,12 +12344,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Executes a SQL request", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "name": "sql.query", @@ -11710,12 +12352,18 @@ "namespace": "sql.query" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "sql.query" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11728,12 +12376,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Translates SQL into Elasticsearch queries", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "name": "sql.translate", @@ -11742,12 +12384,18 @@ "namespace": "sql.translate" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "sql.translate" }, + "responseMediaType": [ + "application/json" + ], "since": "6.3.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11760,23 +12408,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about the X.509 certificates used to encrypt communications in the cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", "name": "ssl.certificates", "request": { "name": "Request", - "namespace": "ssl.get_certificates" + "namespace": "ssl.certificates" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "ssl.get_certificates" + "namespace": "ssl.certificates" }, + "responseMediaType": [ + "application/json" + ], "since": "6.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11788,23 +12436,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Cancels a task, if it can be cancelled through an API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "name": "tasks.cancel", "request": { "name": "Request", - "namespace": "task.cancel" + "namespace": "tasks.cancel" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "task.cancel" + "namespace": "tasks.cancel" }, + "responseMediaType": [ + "application/json" + ], "since": "2.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -11822,23 +12470,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns information about a task.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "name": "tasks.get", "request": { "name": "Request", - "namespace": "task.get" + "namespace": "tasks.get" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "task.get" + "namespace": "tasks.get" }, + "responseMediaType": [ + "application/json" + ], "since": "5.0.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -11850,23 +12498,23 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Returns a list of tasks.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", "name": "tasks.list", "request": { "name": "Request", - "namespace": "task.list" + "namespace": "tasks.list" }, "requestBodyRequired": false, "response": { "name": "Response", - "namespace": "task.list" + "namespace": "tasks.list" }, + "responseMediaType": [ + "application/json" + ], "since": "2.3.0", - "stability": "TODO", + "stability": "experimental", "urls": [ { "methods": [ @@ -11878,12 +12526,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "name": "terms_enum", @@ -11892,12 +12534,18 @@ "namespace": "_global.terms_enum" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.terms_enum" }, + "responseMediaType": [ + "application/json" + ], "since": "7.14.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11910,12 +12558,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Returns information and statistics about terms in the fields of a particular document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "name": "termvectors", @@ -11924,12 +12566,18 @@ "namespace": "_global.termvectors" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.termvectors" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -11971,12 +12619,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/x-ndjson" - ], "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "name": "text_structure.find_structure", @@ -11985,12 +12627,18 @@ "namespace": "text_structure.find_structure" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/x-ndjson" + ], "response": { "name": "Response", "namespace": "text_structure.find_structure" }, + "responseMediaType": [ + "application/json" + ], "since": "7.13.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12002,12 +12650,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deletes an existing transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "name": "transform.delete_transform", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", "namespace": "transform.delete_transform" @@ -12017,8 +12667,11 @@ "name": "Response", "namespace": "transform.delete_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12030,12 +12683,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves configuration information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "name": "transform.get_transform", + "privileges": { + "cluster": [ + "monitor_transform" + ] + }, "request": { "name": "Request", "namespace": "transform.get_transform" @@ -12045,8 +12700,11 @@ "name": "Response", "namespace": "transform.get_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12064,12 +12722,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information for transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "name": "transform.get_transform_stats", + "privileges": { + "cluster": [ + "monitor_transform" + ], + "index": [ + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "transform.get_transform_stats" @@ -12079,8 +12743,11 @@ "name": "Response", "namespace": "transform.get_transform_stats" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12092,29 +12759,46 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Previews a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "name": "transform.preview_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "transform.preview_transform" }, - "requestBodyRequired": true, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "transform.preview_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ + "GET", + "POST" + ], + "path": "/_transform/{transform_id}/_preview" + }, + { + "methods": [ + "GET", "POST" ], "path": "/_transform/_preview" @@ -12123,26 +12807,37 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Instantiates a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "name": "transform.put_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "create_index", + "read", + "index", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "transform.put_transform" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "transform.put_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12154,12 +12849,18 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Starts one or more transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "name": "transform.start_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "read", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "transform.start_transform" @@ -12169,8 +12870,11 @@ "name": "Response", "namespace": "transform.start_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12182,12 +12886,14 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Stops one or more transforms.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "name": "transform.stop_transform", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, "request": { "name": "Request", "namespace": "transform.stop_transform" @@ -12197,8 +12903,11 @@ "name": "Response", "namespace": "transform.stop_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12210,26 +12919,36 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Updates certain properties of a transform.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "name": "transform.update_transform", + "privileges": { + "cluster": [ + "manage_transform" + ], + "index": [ + "read", + "index", + "view_index_metadata" + ] + }, "request": { "name": "Request", "namespace": "transform.update_transform" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "transform.update_transform" }, + "responseMediaType": [ + "application/json" + ], "since": "7.2.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12241,12 +12960,42 @@ "visibility": "public" }, { - "accept": [ + "description": "Upgrades all transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", + "name": "transform.upgrade_transforms", + "privileges": { + "cluster": [ + "manage_transform" + ] + }, + "request": { + "name": "Request", + "namespace": "transform.upgrade_transforms" + }, + "requestBodyRequired": false, + "requestMediaType": [ "application/json" ], - "contentType": [ + "response": { + "name": "Response", + "namespace": "transform.upgrade_transforms" + }, + "responseMediaType": [ "application/json" ], + "since": "7.16.0", + "stability": "stable", + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_transform/_upgrade" + } + ], + "visibility": "public" + }, + { "description": "Updates a document with a script or partial document.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "name": "update", @@ -12255,12 +13004,18 @@ "namespace": "_global.update" }, "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.update" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12282,13 +13037,7 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], - "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "name": "update_by_query", "request": { @@ -12296,12 +13045,18 @@ "namespace": "_global.update_by_query" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "_global.update_by_query" }, + "responseMediaType": [ + "application/json" + ], "since": "2.4.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12323,9 +13078,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Changes the number of requests per second for a particular Update By Query operation.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", "name": "update_by_query_rethrottle", @@ -12338,8 +13090,11 @@ "name": "Response", "namespace": "_global.update_by_query_rethrottle" }, + "responseMediaType": [ + "application/json" + ], "since": "6.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12351,9 +13106,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", "name": "watcher.ack_watch", @@ -12366,8 +13118,11 @@ "name": "Response", "namespace": "watcher.ack_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12387,9 +13142,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Activates a currently inactive watch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", "name": "watcher.activate_watch", @@ -12402,8 +13154,11 @@ "name": "Response", "namespace": "watcher.activate_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12416,9 +13171,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Deactivates a currently active watch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", "name": "watcher.deactivate_watch", @@ -12431,8 +13183,11 @@ "name": "Response", "namespace": "watcher.deactivate_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12445,9 +13200,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Removes a watch from Watcher.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", "name": "watcher.delete_watch", @@ -12460,8 +13212,11 @@ "name": "Response", "namespace": "watcher.delete_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12473,12 +13228,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Forces the execution of a stored watch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", "name": "watcher.execute_watch", @@ -12487,12 +13236,18 @@ "namespace": "watcher.execute_watch" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "watcher.execute_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12512,9 +13267,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves a watch by its ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", "name": "watcher.get_watch", @@ -12527,8 +13279,11 @@ "name": "Response", "namespace": "watcher.get_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "5.6.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12540,12 +13295,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Creates a new watch, or updates an existing one.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", "name": "watcher.put_watch", @@ -12554,12 +13303,18 @@ "namespace": "watcher.put_watch" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "watcher.put_watch" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12572,12 +13327,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], - "contentType": [ - "application/json" - ], "description": "Retrieves stored watches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", "name": "watcher.query_watches", @@ -12586,12 +13335,18 @@ "namespace": "watcher.query_watches" }, "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], "response": { "name": "Response", "namespace": "watcher.query_watches" }, + "responseMediaType": [ + "application/json" + ], "since": "7.11.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12604,9 +13359,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Starts Watcher if it is not already running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", "name": "watcher.start", @@ -12619,8 +13371,11 @@ "name": "Response", "namespace": "watcher.start" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12632,9 +13387,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves the current Watcher metrics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", "name": "watcher.stats", @@ -12647,8 +13399,11 @@ "name": "Response", "namespace": "watcher.stats" }, + "responseMediaType": [ + "application/json" + ], "since": "5.5.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12666,9 +13421,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Stops Watcher if it is running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", "name": "watcher.stop", @@ -12681,8 +13433,11 @@ "name": "Response", "namespace": "watcher.stop" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12694,9 +13449,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves information about the installed X-Pack features.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "name": "xpack.info", @@ -12709,8 +13461,11 @@ "name": "Response", "namespace": "xpack.info" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12722,9 +13477,6 @@ "visibility": "public" }, { - "accept": [ - "application/json" - ], "description": "Retrieves usage information about the installed X-Pack features.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "name": "xpack.usage", @@ -12737,8 +13489,11 @@ "name": "Response", "namespace": "xpack.usage" }, + "responseMediaType": [ + "application/json" + ], "since": "0.0.0", - "stability": "TODO", + "stability": "stable", "urls": [ { "methods": [ @@ -12754,7 +13509,7 @@ { "inherits": { "type": { - "name": "Operation", + "name": "WriteOperation", "namespace": "_global.bulk" } }, @@ -12763,26 +13518,13 @@ "name": "CreateOperation", "namespace": "_global.bulk" }, - "properties": [] + "properties": [], + "specLocation": "_global/bulk/types.ts#L76-L76" }, { "inherits": { "type": { - "name": "ResponseItemBase", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "CreateResponseItem", - "namespace": "_global.bulk" - }, - "properties": [] - }, - { - "inherits": { - "type": { - "name": "Operation", + "name": "OperationBase", "namespace": "_global.bulk" } }, @@ -12791,26 +13533,13 @@ "name": "DeleteOperation", "namespace": "_global.bulk" }, - "properties": [] + "properties": [], + "specLocation": "_global/bulk/types.ts#L80-L80" }, { "inherits": { "type": { - "name": "ResponseItemBase", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "DeleteResponseItem", - "namespace": "_global.bulk" - }, - "properties": [] - }, - { - "inherits": { - "type": { - "name": "Operation", + "name": "WriteOperation", "namespace": "_global.bulk" } }, @@ -12819,32 +13548,19 @@ "name": "IndexOperation", "namespace": "_global.bulk" }, - "properties": [] + "properties": [], + "specLocation": "_global/bulk/types.ts#L78-L78" }, { - "inherits": { - "type": { - "name": "ResponseItemBase", - "namespace": "_global.bulk" - } - }, "kind": "interface", "name": { - "name": "IndexResponseItem", - "namespace": "_global.bulk" - }, - "properties": [] - }, - { - "kind": "interface", - "name": { - "name": "Operation", + "name": "OperationBase", "namespace": "_global.bulk" }, "properties": [ { "name": "_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -12855,7 +13571,7 @@ }, { "name": "_index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -12865,30 +13581,41 @@ } }, { - "name": "retry_on_conflict", - "required": true, + "name": "routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Routing", "namespace": "_types" } } }, { - "name": "routing", - "required": true, + "name": "if_primary_term", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "if_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", "namespace": "_types" } } }, { "name": "version", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -12899,7 +13626,7 @@ }, { "name": "version_type", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -12908,7 +13635,8 @@ } } } - ] + ], + "specLocation": "_global/bulk/types.ts#L60-L68" }, { "kind": "interface", @@ -12962,15 +13690,39 @@ } } ], + "specLocation": "_global/bulk/types.ts#L87-L93", "variants": { "kind": "container" } }, + { + "kind": "enum", + "members": [ + { + "name": "index" + }, + { + "name": "create" + }, + { + "name": "update" + }, + { + "name": "delete" + } + ], + "name": { + "name": "OperationType", + "namespace": "_global.bulk" + }, + "specLocation": "_global/bulk/types.ts#L53-L58" + }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { + "codegenName": "operations", "kind": "value", "value": { "kind": "array_of", @@ -12983,10 +13735,33 @@ "namespace": "_global.bulk" } }, + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.bulk" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TPartialDocument", + "namespace": "_global.bulk" + } + } + ], + "kind": "instance_of", + "type": { + "name": "UpdateAction", + "namespace": "_global.bulk" + } + }, { "kind": "instance_of", "type": { - "name": "TSource", + "name": "TDocument", "namespace": "_global.bulk" } } @@ -12995,9 +13770,14 @@ } } }, + "description": "Allows to perform multiple index/update/delete operations in a single request.", "generics": [ { - "name": "TSource", + "name": "TDocument", + "namespace": "_global.bulk" + }, + { + "name": "TPartialDocument", "namespace": "_global.bulk" } ], @@ -13014,7 +13794,7 @@ }, "path": [ { - "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "description": "Default index for items which don't provide one", "name": "index", "required": false, "type": { @@ -13026,7 +13806,7 @@ } }, { - "description": "A comma-separated list of document types to search; leave empty to perform the operation on all types", + "description": "Default document type for items which don't provide one", "name": "type", "required": false, "type": { @@ -13040,17 +13820,19 @@ ], "query": [ { + "description": "The pipeline id to preprocess incoming documents with", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -13062,6 +13844,7 @@ } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -13073,29 +13856,19 @@ } }, { + "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request", "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } } }, { + "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request", "name": "_source_excludes", "required": false, "type": { @@ -13107,6 +13880,7 @@ } }, { + "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request", "name": "_source_includes", "required": false, "type": { @@ -13118,6 +13892,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -13129,17 +13904,19 @@ } }, { + "description": "Default document type for items which don't provide one", "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Type", + "namespace": "_types" } } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -13151,17 +13928,19 @@ } }, { + "description": "Sets require_alias for all incoming documents. Defaults to unset (false)", "name": "require_alias", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/bulk/BulkRequest.ts#L33-L64" }, { "body": { @@ -13174,7 +13953,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13184,10 +13963,21 @@ "type": { "kind": "array_of", "value": { - "kind": "instance_of", - "type": { - "name": "ResponseItemContainer", - "namespace": "_global.bulk" + "key": { + "kind": "instance_of", + "type": { + "name": "OperationType", + "namespace": "_global.bulk" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "ResponseItem", + "namespace": "_global.bulk" + } } } } @@ -13220,12 +14010,13 @@ "name": { "name": "Response", "namespace": "_global.bulk" - } + }, + "specLocation": "_global/bulk/BulkResponse.ts#L24-L31" }, { "kind": "interface", "name": { - "name": "ResponseItemBase", + "name": "ResponseItem", "namespace": "_global.bulk" }, "properties": [ @@ -13238,14 +14029,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "null", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -13259,7 +14050,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13303,7 +14094,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13336,7 +14127,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13358,7 +14149,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13372,7 +14163,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -13389,68 +14180,121 @@ } } } - ] + ], + "specLocation": "_global/bulk/types.ts#L37-L51" }, { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.bulk" + }, + { + "name": "TPartialDocument", + "namespace": "_global.bulk" + } + ], "kind": "interface", "name": { - "name": "ResponseItemContainer", + "name": "UpdateAction", "namespace": "_global.bulk" }, "properties": [ { - "name": "index", + "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", + "name": "detect_noop", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "IndexResponseItem", - "namespace": "_global.bulk" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "create", + "description": "A partial update to an existing document.", + "name": "doc", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CreateResponseItem", + "name": "TPartialDocument", "namespace": "_global.bulk" } } }, { - "name": "update", + "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", + "name": "doc_as_upsert", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "UpdateResponseItem", - "namespace": "_global.bulk" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "delete", + "description": "Script to execute to update the document.", + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "description": "Set to true to execute the script whether or not the document exists.", + "name": "scripted_upsert", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", + "name": "_source", "required": false, + "serverDefault": "true", "type": { "kind": "instance_of", "type": { - "name": "DeleteResponseItem", + "name": "SourceConfig", + "namespace": "_global.search._types" + } + } + }, + { + "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", + "name": "upsert", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TDocument", "namespace": "_global.bulk" } } } ], - "variants": { - "kind": "container" - } + "specLocation": "_global/bulk/types.ts#L95-L131" }, { "inherits": { "type": { - "name": "Operation", + "name": "OperationBase", "namespace": "_global.bulk" } }, @@ -13459,21 +14303,91 @@ "name": "UpdateOperation", "namespace": "_global.bulk" }, - "properties": [] + "properties": [ + { + "name": "require_alias", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "retry_on_conflict", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/bulk/types.ts#L82-L85" }, { "inherits": { "type": { - "name": "ResponseItemBase", + "name": "OperationBase", "namespace": "_global.bulk" } }, "kind": "interface", "name": { - "name": "UpdateResponseItem", + "name": "WriteOperation", "namespace": "_global.bulk" }, - "properties": [] + "properties": [ + { + "name": "dynamic_templates", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "require_alias", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/bulk/types.ts#L70-L74" }, { "attachedBehaviors": [ @@ -13495,6 +14409,7 @@ } ] }, + "description": "Explicitly clears the search context for a scroll.", "inherits": { "type": { "name": "RequestBase", @@ -13508,6 +14423,7 @@ }, "path": [ { + "description": "A comma-separated list of scroll IDs to clear", "name": "scroll_id", "required": false, "type": { @@ -13519,7 +14435,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L35" }, { "body": { @@ -13532,7 +14449,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13553,7 +14470,8 @@ "name": { "name": "Response", "namespace": "_global.clear_scroll" - } + }, + "specLocation": "_global/clear_scroll/ClearScrollResponse.ts#L22-L27" }, { "attachedBehaviors": [ @@ -13575,6 +14493,7 @@ } ] }, + "description": "Close a point in time", "inherits": { "type": { "name": "RequestBase", @@ -13587,7 +14506,8 @@ "namespace": "_global.close_point_in_time" }, "path": [], - "query": [] + "query": [], + "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L32" }, { "body": { @@ -13600,7 +14520,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -13621,7 +14541,8 @@ "name": { "name": "Response", "namespace": "_global.close_point_in_time" - } + }, + "specLocation": "_global/close_point_in_time/ClosePointInTimeResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -13643,6 +14564,7 @@ } ] }, + "description": "Returns number of documents matching a query.", "inherits": { "type": { "name": "RequestBase", @@ -13656,6 +14578,7 @@ }, "path": [ { + "description": "A comma-separated list of indices to restrict the results", "name": "index", "required": false, "type": { @@ -13667,6 +14590,7 @@ } }, { + "description": "A comma-separated list of types to restrict the results", "name": "type", "required": false, "type": { @@ -13680,61 +14604,67 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The analyzer to use for the query string", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", "name": "analyze_wildcard", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The default operator for query string query (AND or OR)", "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DefaultOperator", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { + "description": "The field to use as default where no field prefix is given in the query string", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -13746,39 +14676,43 @@ } }, { + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", "name": "ignore_throttled", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Include only documents with a specific `_score` value in the result", "name": "min_score", "required": false, "type": { @@ -13790,28 +14724,19 @@ } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "query_on_query_string", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A comma-separated list of specific routing values", "name": "routing", "required": false, "type": { @@ -13823,6 +14748,7 @@ } }, { + "description": "The maximum count for each shard, upon reaching which the query execution will terminate early", "name": "terminate_after", "required": false, "type": { @@ -13834,17 +14760,19 @@ } }, { + "description": "Query in the Lucene query string syntax", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/count/CountRequest.ts#L26-L55" }, { "body": { @@ -13878,13 +14806,15 @@ "name": { "name": "Response", "namespace": "_global.count" - } + }, + "specLocation": "_global/count/CountResponse.ts#L23-L25" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { + "codegenName": "document", "kind": "value", "value": { "kind": "instance_of", @@ -13894,6 +14824,7 @@ } } }, + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", "generics": [ { "name": "TDocument", @@ -13913,6 +14844,7 @@ }, "path": [ { + "description": "Document ID", "name": "id", "required": true, "type": { @@ -13924,6 +14856,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -13935,6 +14868,7 @@ } }, { + "description": "The type of the document", "name": "type", "required": false, "type": { @@ -13948,17 +14882,19 @@ ], "query": [ { + "description": "The pipeline id to preprocess incoming documents with", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -13970,6 +14906,7 @@ } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -13981,6 +14918,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -13992,6 +14930,7 @@ } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -14003,6 +14942,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -14014,6 +14954,7 @@ } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -14024,7 +14965,8 @@ } } } - ] + ], + "specLocation": "_global/create/CreateRequest.ts#L33-L56" }, { "body": { @@ -14041,7 +14983,8 @@ "name": { "name": "Response", "namespace": "_global.create" - } + }, + "specLocation": "_global/create/CreateResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -14050,6 +14993,7 @@ "body": { "kind": "no_body" }, + "description": "Removes a document from the index.", "inherits": { "type": { "name": "RequestBase", @@ -14063,6 +15007,7 @@ }, "path": [ { + "description": "The document ID", "name": "id", "required": true, "type": { @@ -14074,6 +15019,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -14085,6 +15031,7 @@ } }, { + "description": "The type of the document", "name": "type", "required": false, "type": { @@ -14098,6 +15045,7 @@ ], "query": [ { + "description": "only perform the delete operation if the last operation that has changed the document has the specified primary term", "name": "if_primary_term", "required": false, "type": { @@ -14109,6 +15057,7 @@ } }, { + "description": "only perform the delete operation if the last operation that has changed the document has the specified sequence number", "name": "if_seq_no", "required": false, "type": { @@ -14120,6 +15069,7 @@ } }, { + "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -14131,6 +15081,7 @@ } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -14142,6 +15093,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -14153,6 +15105,7 @@ } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -14164,6 +15117,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -14175,6 +15129,7 @@ } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -14185,7 +15140,8 @@ } } } - ] + ], + "specLocation": "_global/delete/DeleteRequest.ts#L35-L56" }, { "body": { @@ -14202,7 +15158,8 @@ "name": { "name": "Response", "namespace": "_global.delete" - } + }, + "specLocation": "_global/delete/DeleteResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -14246,6 +15203,7 @@ } ] }, + "description": "Deletes documents matching the provided query.", "inherits": { "type": { "name": "RequestBase", @@ -14259,6 +15217,7 @@ }, "path": [ { + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": true, "type": { @@ -14270,6 +15229,7 @@ } }, { + "description": "A comma-separated list of document types to search; leave empty to perform the operation on all types", "name": "type", "required": false, "type": { @@ -14283,39 +15243,43 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The analyzer to use for the query string", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", "name": "analyze_wildcard", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "What to do when the delete by query hits version conflicts?", "name": "conflicts", "required": false, "type": { @@ -14327,28 +15291,31 @@ } }, { + "description": "The default operator for query string query (AND or OR)", "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DefaultOperator", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { + "description": "The field to use as default where no field prefix is given in the query string", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -14360,6 +15327,7 @@ } }, { + "description": "Starting offset (default: 0)", "name": "from", "required": false, "type": { @@ -14371,28 +15339,31 @@ } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Maximum number of documents to process (default: all documents)", "name": "max_docs", "required": false, "type": { @@ -14404,39 +15375,43 @@ } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Should the effected indexes be refreshed?", "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify if request cache should be used for this request or not, defaults to index level setting", "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", "name": "requests_per_second", "required": false, "type": { @@ -14448,6 +15423,7 @@ } }, { + "description": "A comma-separated list of specific routing values", "name": "routing", "required": false, "type": { @@ -14459,17 +15435,19 @@ } }, { + "description": "Query in the Lucene query string syntax", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify how long a consistent view of the index should be maintained for scrolled search", "name": "scroll", "required": false, "type": { @@ -14481,6 +15459,7 @@ } }, { + "description": "Size on the scroll request powering the delete by query", "name": "scroll_size", "required": false, "type": { @@ -14492,6 +15471,7 @@ } }, { + "description": "Explicit timeout for each search request. Defaults to no timeout.", "name": "search_timeout", "required": false, "type": { @@ -14503,6 +15483,7 @@ } }, { + "description": "Search operation type", "name": "search_type", "required": false, "type": { @@ -14514,6 +15495,7 @@ } }, { + "description": "Deprecated, please use `max_docs` instead", "name": "size", "required": false, "type": { @@ -14525,17 +15507,19 @@ } }, { + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", "name": "slices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Slices", "namespace": "_types" } } }, { + "description": "A comma-separated list of : pairs", "name": "sort", "required": false, "type": { @@ -14544,57 +15528,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "_source", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "_source_excludes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "name": "_source_includes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { + "description": "Specific 'tag' of the request for logging and statistical purposes", "name": "stats", "required": false, "type": { @@ -14603,12 +15543,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "name": "terminate_after", "required": false, "type": { @@ -14620,6 +15561,7 @@ } }, { + "description": "Time each individual bulk request should wait for shards that are unavailable.", "name": "timeout", "required": false, "type": { @@ -14631,17 +15573,19 @@ } }, { + "description": "Specify whether to return document version as part of a hit", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -14653,17 +15597,19 @@ } }, { + "description": "Should the request should block until the delete by query is complete.", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L37-L84" }, { "body": { @@ -14789,7 +15735,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -14832,7 +15778,8 @@ "name": { "name": "Response", "namespace": "_global.delete_by_query" - } + }, + "specLocation": "_global/delete_by_query/DeleteByQueryResponse.ts#L25-L42" }, { "attachedBehaviors": [ @@ -14841,6 +15788,7 @@ "body": { "kind": "no_body" }, + "description": "Changes the number of requests per second for a particular Delete By Query operation.", "inherits": { "type": { "name": "RequestBase", @@ -14854,6 +15802,7 @@ }, "path": [ { + "description": "The task id to rethrottle", "name": "task_id", "required": true, "type": { @@ -14867,6 +15816,7 @@ ], "query": [ { + "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.", "name": "requests_per_second", "required": false, "type": { @@ -14877,7 +15827,8 @@ } } } - ] + ], + "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L36" }, { "body": { @@ -14887,14 +15838,15 @@ "inherits": { "type": { "name": "Response", - "namespace": "task.list" + "namespace": "tasks.list" } }, "kind": "response", "name": { "name": "Response", "namespace": "_global.delete_by_query_rethrottle" - } + }, + "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -14903,6 +15855,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a script.", "inherits": { "type": { "name": "RequestBase", @@ -14916,6 +15869,7 @@ }, "path": [ { + "description": "Script ID", "name": "id", "required": true, "type": { @@ -14929,6 +15883,7 @@ ], "query": [ { + "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, "type": { @@ -14940,6 +15895,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -14950,7 +15906,8 @@ } } } - ] + ], + "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L37" }, { "body": { @@ -14967,7 +15924,8 @@ "name": { "name": "Response", "namespace": "_global.delete_script" - } + }, + "specLocation": "_global/delete_script/DeleteScriptResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -14976,6 +15934,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about whether a document exists in an index.", "inherits": { "type": { "name": "RequestBase", @@ -14989,6 +15948,7 @@ }, "path": [ { + "description": "The document ID", "name": "id", "required": true, "type": { @@ -15000,6 +15960,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -15011,6 +15972,7 @@ } }, { + "description": "The type of the document (use `_all` to fetch the first document matching the ID across all types)", "name": "type", "required": false, "type": { @@ -15024,39 +15986,43 @@ ], "query": [ { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether to perform the operation in realtime or search mode", "name": "realtime", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Refresh the shard containing the document before performing the operation", "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -15068,18 +16034,20 @@ } }, { - "name": "source_enabled", + "description": "True or false to return the _source field or not, or a list of fields to return", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SourceConfigParam", + "namespace": "_global.search._types" } } }, { - "name": "source_excludes", + "description": "A list of fields to exclude from the returned _source field", + "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", @@ -15090,7 +16058,8 @@ } }, { - "name": "source_includes", + "description": "A list of fields to extract and return from the _source field", + "name": "_source_includes", "required": false, "type": { "kind": "instance_of", @@ -15101,6 +16070,7 @@ } }, { + "description": "A comma-separated list of stored fields to return in the response", "name": "stored_fields", "required": false, "type": { @@ -15112,6 +16082,7 @@ } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -15123,6 +16094,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -15133,7 +16105,8 @@ } } } - ] + ], + "specLocation": "_global/exists/DocumentExistsRequest.ts#L32-L55" }, { "body": { @@ -15143,7 +16116,8 @@ "name": { "name": "Response", "namespace": "_global.exists" - } + }, + "specLocation": "_global/exists/DocumentExistsResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -15152,6 +16126,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about whether a document source exists in an index.", "inherits": { "type": { "name": "RequestBase", @@ -15165,6 +16140,7 @@ }, "path": [ { + "description": "The document ID", "name": "id", "required": true, "type": { @@ -15176,6 +16152,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -15187,6 +16164,7 @@ } }, { + "description": "The type of the document; deprecated and optional starting with 7.0", "name": "type", "required": false, "type": { @@ -15200,39 +16178,43 @@ ], "query": [ { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether to perform the operation in realtime or search mode", "name": "realtime", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Refresh the shard containing the document before performing the operation", "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -15244,18 +16226,20 @@ } }, { - "name": "source_enabled", + "description": "True or false to return the _source field or not, or a list of fields to return", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SourceConfigParam", + "namespace": "_global.search._types" } } }, { - "name": "source_excludes", + "description": "A list of fields to exclude from the returned _source field", + "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", @@ -15266,7 +16250,8 @@ } }, { - "name": "source_includes", + "description": "A list of fields to extract and return from the _source field", + "name": "_source_includes", "required": false, "type": { "kind": "instance_of", @@ -15277,6 +16262,7 @@ } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -15288,6 +16274,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -15298,7 +16285,8 @@ } } } - ] + ], + "specLocation": "_global/exists_source/SourceExistsRequest.ts#L32-L54" }, { "body": { @@ -15308,7 +16296,8 @@ "name": { "name": "Response", "namespace": "_global.exists_source" - } + }, + "specLocation": "_global/exists_source/SourceExistsResponse.ts#L22-L24" }, { "kind": "interface", @@ -15324,7 +16313,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -15353,7 +16342,8 @@ } } } - ] + ], + "specLocation": "_global/explain/types.ts#L22-L26" }, { "kind": "interface", @@ -15369,7 +16359,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -15398,7 +16388,8 @@ } } } - ] + ], + "specLocation": "_global/explain/types.ts#L28-L32" }, { "attachedBehaviors": [ @@ -15420,6 +16411,7 @@ } ] }, + "description": "Returns information about why a specific matches (or doesn't match) a query.", "inherits": { "type": { "name": "RequestBase", @@ -15433,6 +16425,7 @@ }, "path": [ { + "description": "The document ID", "name": "id", "required": true, "type": { @@ -15444,6 +16437,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -15455,6 +16449,7 @@ } }, { + "description": "The type of the document", "name": "type", "required": false, "type": { @@ -15468,83 +16463,79 @@ ], "query": [ { + "description": "The analyzer for the query string query", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)", "name": "analyze_wildcard", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The default operator for query string query (AND or OR)", "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DefaultOperator", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { + "description": "The default field for query string query (default: _all)", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "query_on_query_string", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -15556,29 +16547,19 @@ } }, { + "description": "True or false to return the _source field or not, or a list of fields to return", "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } } }, { + "description": "A list of fields to exclude from the returned _source field", "name": "_source_excludes", "required": false, "type": { @@ -15590,6 +16571,7 @@ } }, { + "description": "A list of fields to extract and return from the _source field", "name": "_source_includes", "required": false, "type": { @@ -15601,6 +16583,7 @@ } }, { + "description": "A comma-separated list of stored fields to return in the response", "name": "stored_fields", "required": false, "type": { @@ -15612,17 +16595,19 @@ } }, { + "description": "Query in the Lucene query string syntax", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/explain/ExplainRequest.ts#L26-L54" }, { "body": { @@ -15668,7 +16653,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -15715,162 +16700,8 @@ "name": { "name": "Response", "namespace": "_global.explain" - } - }, - { - "kind": "interface", - "name": { - "name": "FieldCapabilitiesBodyIndexFilter", - "namespace": "_global.field_caps" - }, - "properties": [ - { - "name": "range", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldCapabilitiesBodyIndexFilterRange", - "namespace": "_global.field_caps" - } - } - }, - { - "name": "match_none", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } - } - }, - { - "name": "term", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldCapabilitiesBodyIndexFilterTerm", - "namespace": "_global.field_caps" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldCapabilitiesBodyIndexFilterRange", - "namespace": "_global.field_caps" - }, - "properties": [ - { - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldCapabilitiesBodyIndexFilterRangeTimestamp", - "namespace": "_global.field_caps" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldCapabilitiesBodyIndexFilterRangeTimestamp", - "namespace": "_global.field_caps" - }, - "properties": [ - { - "name": "gte", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "gt", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "lte", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "lt", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldCapabilitiesBodyIndexFilterTerm", - "namespace": "_global.field_caps" }, - "properties": [ - { - "name": "versionControl", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldCapabilitiesBodyIndexFilterTermVersionControl", - "namespace": "_global.field_caps" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldCapabilitiesBodyIndexFilterTermVersionControl", - "namespace": "_global.field_caps" - }, - "properties": [ - { - "name": "value", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "specLocation": "_global/explain/ExplainResponse.ts#L23-L32" }, { "kind": "interface", @@ -15886,7 +16717,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -15909,7 +16740,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -15920,7 +16751,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -15955,7 +16786,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -15966,11 +16797,23 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "metadata_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/field_caps/types.ts#L23-L32" }, { "attachedBehaviors": [ @@ -15980,18 +16823,33 @@ "kind": "properties", "properties": [ { + "description": "Allows to filter indices if the provided query rewrites to match_none on every shard.", "name": "index_filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldCapabilitiesBodyIndexFilter", - "namespace": "_global.field_caps" + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", + "name": "runtime_mappings", + "required": false, + "since": "7.12.0", + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" } } } ] }, + "description": "Returns the information about the capabilities of fields among multiple indices.", "inherits": { "type": { "name": "RequestBase", @@ -16005,6 +16863,7 @@ }, "path": [ { + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", "name": "index", "required": false, "type": { @@ -16018,19 +16877,23 @@ ], "query": [ { + "description": "If false, the request returns an error if any wildcard expression, index alias,\nor `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request\ntargeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar.", "name": "allow_no_indices", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -16040,6 +16903,7 @@ } }, { + "description": "Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "name": "fields", "required": false, "type": { @@ -16051,28 +16915,33 @@ } }, { + "description": "If `true`, missing or closed indices are not included in the response.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If true, unmapped fields are included in the response.", "name": "include_unmapped", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L77" }, { "body": { @@ -16107,7 +16976,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -16128,7 +16997,145 @@ "name": { "name": "Response", "namespace": "_global.field_caps" - } + }, + "specLocation": "_global/field_caps/FieldCapabilitiesResponse.ts#L24-L29" + }, + { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.get" + } + ], + "kind": "interface", + "name": { + "name": "GetResult", + "namespace": "_global.get" + }, + "properties": [ + { + "name": "_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "found", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + }, + { + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.get" + } + } + }, + { + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "name": "_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Type", + "namespace": "_types" + } + } + }, + { + "name": "_version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/get/types.ts#L31-L43" }, { "attachedBehaviors": [ @@ -16137,6 +17144,7 @@ "body": { "kind": "no_body" }, + "description": "Returns a document.", "inherits": { "type": { "name": "RequestBase", @@ -16174,6 +17182,7 @@ } }, { + "description": "The type of the document (use `_all` to fetch the first document matching the ID across all types)", "name": "type", "required": false, "type": { @@ -16194,12 +17203,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": " Boolean) If true, the request is real-time as opposed to near-real-time.", + "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", "name": "realtime", "required": false, @@ -16208,12 +17217,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": " If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": false, @@ -16221,7 +17230,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -16239,13 +17248,14 @@ } }, { - "name": "source_enabled", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SourceConfigParam", + "namespace": "_global.search._types" } } }, @@ -16274,6 +17284,7 @@ } }, { + "description": "A comma-separated list of stored fields to return in the response", "name": "stored_fields", "required": false, "type": { @@ -16307,158 +17318,29 @@ "namespace": "_types" } } - }, - { - "description": "True or false to return the _source field or not, or a list of fields to return.", - "name": "_source", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } } - ] + ], + "specLocation": "_global/get/GetRequest.ts#L32-L88" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "_index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "found", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "_primary_term", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "_routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "_seq_no", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SequenceNumber", - "namespace": "_types" - } - } - }, - { - "name": "_source", - "required": false, - "type": { + "kind": "value", + "value": { + "generics": [ + { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.get" } } - }, - { - "deprecation": { - "version": "7.0.0" - }, - "name": "_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Type", - "namespace": "_types" - } - } - }, - { - "name": "_version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } + ], + "kind": "instance_of", + "type": { + "name": "GetResult", + "namespace": "_global.get" } - ] + } }, "generics": [ { @@ -16470,7 +17352,8 @@ "name": { "name": "Response", "namespace": "_global.get" - } + }, + "specLocation": "_global/get/GetResponse.ts#L23-L25" }, { "attachedBehaviors": [ @@ -16479,6 +17362,7 @@ "body": { "kind": "no_body" }, + "description": "Returns a script.", "inherits": { "type": { "name": "RequestBase", @@ -16492,6 +17376,7 @@ }, "path": [ { + "description": "Script ID", "name": "id", "required": true, "type": { @@ -16516,7 +17401,8 @@ } } } - ] + ], + "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L37" }, { "body": { @@ -16540,7 +17426,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -16561,7 +17447,8 @@ "name": { "name": "Response", "namespace": "_global.get_script" - } + }, + "specLocation": "_global/get_script/GetScriptResponse.ts#L23-L29" }, { "kind": "interface", @@ -16595,7 +17482,8 @@ } } } - ] + ], + "specLocation": "_global/get_script_context/types.ts#L22-L25" }, { "kind": "interface", @@ -16622,7 +17510,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -16640,7 +17528,8 @@ } } } - ] + ], + "specLocation": "_global/get_script_context/types.ts#L27-L31" }, { "kind": "interface", @@ -16667,11 +17556,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/get_script_context/types.ts#L33-L36" }, { "attachedBehaviors": [ @@ -16680,6 +17570,7 @@ "body": { "kind": "no_body" }, + "description": "Returns all script contexts.", "inherits": { "type": { "name": "RequestBase", @@ -16692,7 +17583,8 @@ "namespace": "_global.get_script_context" }, "path": [], - "query": [] + "query": [], + "specLocation": "_global/get_script_context/GetScriptContextRequest.ts#L22-L27" }, { "body": { @@ -16718,7 +17610,8 @@ "name": { "name": "Response", "namespace": "_global.get_script_context" - } + }, + "specLocation": "_global/get_script_context/GetScriptContextResponse.ts#L22-L26" }, { "kind": "interface", @@ -16736,7 +17629,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -16752,7 +17645,8 @@ } } } - ] + ], + "specLocation": "_global/get_script_languages/types.ts#L22-L25" }, { "attachedBehaviors": [ @@ -16761,6 +17655,7 @@ "body": { "kind": "no_body" }, + "description": "Returns available script types, languages and contexts", "inherits": { "type": { "name": "RequestBase", @@ -16773,7 +17668,8 @@ "namespace": "_global.get_script_languages" }, "path": [], - "query": [] + "query": [], + "specLocation": "_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L27" }, { "body": { @@ -16802,7 +17698,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -16813,20 +17709,21 @@ "name": { "name": "Response", "namespace": "_global.get_script_languages" - } + }, + "specLocation": "_global/get_script_languages/GetScriptLanguagesResponse.ts#L22-L27" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [] + "kind": "no_body" }, + "description": "Returns the source of a document.", "inherits": { "type": { - "name": "Request", - "namespace": "_global.get" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", @@ -16834,8 +17731,174 @@ "name": "Request", "namespace": "_global.get_source" }, - "path": [], - "query": [] + "path": [ + { + "description": "Unique identifier of the document.", + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "Name of the index that contains the document.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "description": "The type of the document.", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "query": [ + { + "description": "Specifies the node or shard the operation should be performed on. Random by default.", + "name": "preference", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "name": "realtime", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", + "name": "refresh", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Target the specified primary shard.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "description": "True or false to return the _source field or not, or a list of fields to return.", + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } + } + }, + { + "description": "A comma-separated list of source fields to exclude in the response.", + "name": "_source_excludes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of source fields to include in the response.", + "name": "_source_includes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "name": "stored_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "description": "Specific version type: internal, external, external_gte.", + "name": "version_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/get_source/SourceRequest.ts#L31-L91" }, { "body": { @@ -16858,13 +17921,15 @@ "name": { "name": "Response", "namespace": "_global.get_source" - } + }, + "specLocation": "_global/get_source/SourceResponse.ts#L20-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { + "codegenName": "document", "kind": "value", "value": { "kind": "instance_of", @@ -16874,6 +17939,7 @@ } } }, + "description": "Creates or updates a document in an index.", "generics": [ { "name": "TDocument", @@ -16893,6 +17959,7 @@ }, "path": [ { + "description": "Document ID", "name": "id", "required": false, "type": { @@ -16904,6 +17971,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -16915,6 +17983,7 @@ } }, { + "description": "The type of the document", "name": "type", "required": false, "type": { @@ -16928,6 +17997,7 @@ ], "query": [ { + "description": "only perform the index operation if the last operation that has changed the document has the specified primary term", "name": "if_primary_term", "required": false, "type": { @@ -16939,6 +18009,7 @@ } }, { + "description": "only perform the index operation if the last operation that has changed the document has the specified sequence number", "name": "if_seq_no", "required": false, "type": { @@ -16950,6 +18021,7 @@ } }, { + "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID", "name": "op_type", "required": false, "type": { @@ -16961,17 +18033,19 @@ } }, { + "description": "The pipeline id to preprocess incoming documents with", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -16983,6 +18057,7 @@ } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -16994,6 +18069,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -17005,6 +18081,7 @@ } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -17016,6 +18093,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -17027,6 +18105,7 @@ } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -17038,17 +18117,19 @@ } }, { + "description": "When true, requires destination to be an alias. Default is false", "name": "require_alias", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/index/IndexRequest.ts#L36-L62" }, { "body": { @@ -17065,7 +18146,8 @@ "name": { "name": "Response", "namespace": "_global.index" - } + }, + "specLocation": "_global/index/IndexResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -17074,6 +18156,7 @@ "body": { "kind": "no_body" }, + "description": "Returns basic information about the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -17086,7 +18169,8 @@ "namespace": "_global.info" }, "path": [], - "query": [] + "query": [], + "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L27" }, { "body": { @@ -17132,7 +18216,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -17153,61 +18237,27 @@ "name": { "name": "Response", "namespace": "_global.info" - } + }, + "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L31" }, { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.mget" - } - ], "kind": "interface", "name": { - "name": "Hit", + "name": "MultiGetError", "namespace": "_global.mget" }, "properties": [ { "name": "error", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MainError", + "name": "ErrorCause", "namespace": "_types" } } }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "found", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, { "name": "_id", "required": true, @@ -17231,50 +18281,10 @@ } }, { - "name": "_primary_term", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "_routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } - }, - { - "name": "_seq_no", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SequenceNumber", - "namespace": "_types" - } - } - }, - { - "name": "_source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.mget" - } - } - }, - { + "deprecation": { + "description": "", + "version": "7.0.0" + }, "name": "_type", "required": false, "type": { @@ -17284,45 +18294,9 @@ "namespace": "_types" } } - }, - { - "name": "_version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "MultiGetId", - "namespace": "_global.mget" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } + ], + "specLocation": "_global/mget/types.ts#L64-L70" }, { "kind": "interface", @@ -17332,17 +18306,19 @@ }, "properties": [ { + "description": "The unique document ID.", "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiGetId", - "namespace": "_global.mget" + "name": "Id", + "namespace": "_types" } } }, { + "description": "The index that contains the document.", "name": "_index", "required": false, "type": { @@ -17354,6 +18330,7 @@ } }, { + "description": "The key for the primary shard the document resides on. Required if routing is used during indexing.", "name": "routing", "required": false, "type": { @@ -17365,36 +18342,19 @@ } }, { + "description": "If `false`, excludes all _source fields.", "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } } }, { + "description": "The stored fields you want to retrieve.", "name": "stored_fields", "required": false, "type": { @@ -17438,7 +18398,8 @@ } } } - ] + ], + "specLocation": "_global/mget/types.ts#L33-L57" }, { "attachedBehaviors": [ @@ -17448,6 +18409,7 @@ "kind": "properties", "properties": [ { + "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", "name": "docs", "required": false, "type": { @@ -17462,21 +18424,20 @@ } }, { + "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "name": "ids", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "MultiGetId", - "namespace": "_global.mget" - } + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" } } } ] }, + "description": "Allows to get multiple documents in one request.", "inherits": { "type": { "name": "RequestBase", @@ -17490,6 +18451,7 @@ }, "path": [ { + "description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", "name": "index", "required": false, "type": { @@ -17501,6 +18463,7 @@ } }, { + "description": "The type of the document", "name": "type", "required": false, "type": { @@ -17514,39 +18477,46 @@ ], "query": [ { + "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true`, the request is real-time as opposed to near-real-time.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", "name": "realtime", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true`, the request refreshes relevant shards before retrieving documents.", "name": "refresh", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -17558,29 +18528,20 @@ } }, { + "description": "True or false to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } } }, { + "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", "name": "_source_excludes", "required": false, "type": { @@ -17592,6 +18553,8 @@ } }, { + "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", "name": "_source_includes", "required": false, "type": { @@ -17603,8 +18566,10 @@ } }, { + "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", "name": "stored_fields", "required": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { @@ -17613,7 +18578,8 @@ } } } - ] + ], + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L92" }, { "body": { @@ -17636,7 +18602,7 @@ ], "kind": "instance_of", "type": { - "name": "Hit", + "name": "ResponseItem", "namespace": "_global.mget" } } @@ -17654,16 +18620,158 @@ "name": { "name": "Response", "namespace": "_global.mget" + }, + "specLocation": "_global/mget/MultiGetResponse.ts#L22-L26" + }, + { + "codegenNames": [ + "result", + "failure" + ], + "generics": [ + { + "name": "TDocument", + "namespace": "_global.mget" + } + ], + "kind": "type_alias", + "name": { + "name": "ResponseItem", + "namespace": "_global.mget" + }, + "specLocation": "_global/mget/types.ts#L59-L62", + "type": { + "items": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.mget" + } + } + ], + "kind": "instance_of", + "type": { + "name": "GetResult", + "namespace": "_global.get" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MultiGetError", + "namespace": "_global.mget" + } + } + ], + "kind": "union_of" } }, { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.msearch" + } + ], + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.msearch" + } + } + ], + "type": { + "name": "ResponseBody", + "namespace": "_global.search" + } + }, + "kind": "interface", + "name": { + "name": "MultiSearchItem", + "namespace": "_global.msearch" + }, + "properties": [ + { + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/msearch/types.ts#L207-L210" + }, + { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.msearch" + } + ], "kind": "interface", "name": { - "name": "Body", + "name": "MultiSearchResult", "namespace": "_global.msearch" }, "properties": [ { + "name": "took", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "responses", + "required": true, + "type": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.msearch" + } + } + ], + "kind": "instance_of", + "type": { + "name": "ResponseItem", + "namespace": "_global.msearch" + } + } + } + } + ], + "specLocation": "_global/msearch/types.ts#L197-L200" + }, + { + "kind": "interface", + "name": { + "name": "MultisearchBody", + "namespace": "_global.msearch" + }, + "properties": [ + { + "aliases": [ + "aggs" + ], "name": "aggregations", "required": false, "type": { @@ -17671,7 +18779,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -17686,52 +18794,92 @@ } }, { - "name": "aggs", + "name": "collapse", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldCollapse", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Defines the search definition using the Query DSL.", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "If true, returns detailed information about score computation as part of a hit.", + "name": "explain", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Configuration of search extensions defined by Elasticsearch plugins.", + "name": "ext", "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } + "kind": "user_defined_value" } } }, { - "name": "query", + "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", + "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "Fields", + "namespace": "_types" } } }, { - "name": "from", + "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", + "name": "docvalue_fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } } } }, { - "name": "size", + "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -17741,65 +18889,94 @@ } }, { - "name": "pit", + "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { - "name": "PointInTimeReference", + "name": "Highlight", "namespace": "_global.search._types" } } }, { - "name": "track_total_hits", + "description": "Boosts the _score of documents from specified indices.", + "name": "indices_boost", "required": false, "type": { - "items": [ - { + "kind": "array_of", + "value": { + "key": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } }, - { + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } - ], - "kind": "union_of" + } } }, { - "name": "suggest", + "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in the search results.", + "name": "min_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "post_filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "profile", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rescore", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SuggestContainer", + "name": "Rescore", "namespace": "_global.search._types" } }, { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "SuggestContainer", + "name": "Rescore", "namespace": "_global.search._types" } } @@ -17807,14 +18984,226 @@ ], "kind": "union_of" } + }, + { + "description": "Retrieve a script evaluation (based on different fields) for each hit.", + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "name": "search_after", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortResults", + "namespace": "_types" + } + } + }, + { + "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", + "name": "size", + "required": false, + "serverDefault": 10, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "docId": "sort-search-results", + "name": "sort", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Sort", + "namespace": "_types" + } + } + }, + { + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", + "name": "terminate_after", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", + "name": "stats", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", + "name": "track_scores", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", + "name": "track_total_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TrackHits", + "namespace": "_global.search._types" + } + } + }, + { + "description": "If true, returns document version as part of a hit.", + "name": "version", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", + "name": "seq_no_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", + "name": "pit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PointInTimeReference", + "namespace": "_global.search._types" + } + } + }, + { + "name": "suggest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Suggester", + "namespace": "_global.search._types" + } + } } - ] + ], + "specLocation": "_global/msearch/types.ts#L70-L195" }, { "description": "Contains parameters used to limit or change the subsequent search body request.", "kind": "interface", "name": { - "name": "Header", + "name": "MultisearchHeader", "namespace": "_global.msearch" }, "properties": [ @@ -17825,7 +19214,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -17847,7 +19236,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -17869,7 +19258,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -17880,7 +19269,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -17890,8 +19279,8 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Routing", + "namespace": "_types" } } }, @@ -17905,38 +19294,62 @@ "namespace": "_types" } } + }, + { + "name": "ccs_minimize_roundtrips", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "allow_partial_search_results", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "ignore_throttled", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_global/msearch/types.ts#L52-L67" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { + "codegenName": "searches", "kind": "value", "value": { "kind": "array_of", "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Header", - "namespace": "_global.msearch" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Body", - "namespace": "_global.msearch" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "RequestItem", + "namespace": "_global.msearch" + } } } }, + "description": "Allows to execute several search operations in one request.", "inherits": { "type": { "name": "RequestBase", @@ -17962,6 +19375,7 @@ } }, { + "description": "A comma-separated list of document types to use as default", "name": "type", "required": false, "type": { @@ -17982,7 +19396,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -17996,7 +19410,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18021,7 +19435,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18034,7 +19448,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18054,7 +19468,7 @@ "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", "name": "max_concurrent_shard_requests", "required": false, - "serverDefault": "5", + "serverDefault": 5, "type": { "kind": "instance_of", "type": { @@ -18076,27 +19490,39 @@ } }, { - "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", - "name": "search_type", + "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", + "name": "rest_total_hits_as_int", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "SearchType", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Custom routing value used to route search operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", "namespace": "_types" } } }, { - "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", - "name": "rest_total_hits_as_int", + "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", + "name": "search_type", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SearchType", + "namespace": "_types" } } }, @@ -18108,63 +19534,63 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/msearch/MultiSearchRequest.ts#L31-L103" }, { - "body": { - "kind": "properties", - "properties": [ + "codegenNames": [ + "header", + "body" + ], + "kind": "type_alias", + "name": { + "name": "RequestItem", + "namespace": "_global.msearch" + }, + "specLocation": "_global/msearch/types.ts#L47-L50", + "type": { + "items": [ { - "name": "took", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "MultisearchHeader", + "namespace": "_global.msearch" } }, { - "name": "responses", - "required": true, + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "items": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.msearch" - } - } - ], - "kind": "instance_of", - "type": { - "name": "SearchResult", - "namespace": "_global.msearch" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ErrorResponseBase", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "name": "MultisearchBody", + "namespace": "_global.msearch" + } + } + ], + "kind": "union_of" + } + }, + { + "body": { + "kind": "value", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.msearch" } } + ], + "kind": "instance_of", + "type": { + "name": "MultiSearchResult", + "namespace": "_global.msearch" } - ] + } }, "generics": [ { @@ -18176,66 +19602,74 @@ "name": { "name": "Response", "namespace": "_global.msearch" - } + }, + "specLocation": "_global/msearch/MultiSearchResponse.ts#L22-L24" }, { + "codegenNames": [ + "result", + "failure" + ], "generics": [ { "name": "TDocument", "namespace": "_global.msearch" } ], - "inherits": { - "generics": [ + "kind": "type_alias", + "name": { + "name": "ResponseItem", + "namespace": "_global.msearch" + }, + "specLocation": "_global/msearch/types.ts#L202-L205", + "type": { + "items": [ { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.msearch" + } + } + ], "kind": "instance_of", "type": { - "name": "TDocument", + "name": "MultiSearchItem", "namespace": "_global.msearch" } - } - ], - "type": { - "name": "Response", - "namespace": "_global.search" - } - }, - "kind": "interface", - "name": { - "name": "SearchResult", - "namespace": "_global.msearch" - }, - "properties": [ - { - "name": "status", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", + "name": "ErrorResponseBase", "namespace": "_types" } } - } - ] + ], + "kind": "union_of" + } }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { + "codegenName": "search_templates", "kind": "value", "value": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "TemplateItem", + "name": "RequestItem", "namespace": "_global.msearch_template" } } } }, + "description": "Runs multiple [templated searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#run-multiple-templated-searches) with a single request.", "inherits": { "type": { "name": "RequestBase", @@ -18249,6 +19683,7 @@ }, "path": [ { + "description": "A comma-separated list of index names to use as default", "name": "index", "required": false, "type": { @@ -18260,6 +19695,7 @@ } }, { + "description": "A comma-separated list of document types to use as default", "name": "type", "required": false, "type": { @@ -18273,17 +19709,19 @@ ], "query": [ { + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "name": "ccs_minimize_roundtrips", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Controls the maximum number of concurrent searches the multi search api will execute", "name": "max_concurrent_searches", "required": false, "type": { @@ -18295,6 +19733,7 @@ } }, { + "description": "Search operation type", "name": "search_type", "required": false, "type": { @@ -18306,68 +19745,82 @@ } }, { + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "name": "rest_total_hits_as_int", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "name": "typed_keys", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L46" }, { - "body": { - "kind": "properties", - "properties": [ + "codegenNames": [ + "header", + "body" + ], + "kind": "type_alias", + "name": { + "name": "RequestItem", + "namespace": "_global.msearch_template" + }, + "specLocation": "_global/msearch_template/types.ts#L25-L26", + "type": { + "items": [ { - "name": "responses", - "required": true, + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.msearch_template" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Response", - "namespace": "_global.search" - } - } + "name": "MultisearchHeader", + "namespace": "_global.msearch" } }, { - "name": "took", - "required": true, + "kind": "instance_of", "type": { + "name": "TemplateConfig", + "namespace": "_global.msearch_template" + } + } + ], + "kind": "union_of" + } + }, + { + "body": { + "kind": "value", + "value": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TDocument", + "namespace": "_global.msearch_template" } } + ], + "kind": "instance_of", + "type": { + "name": "MultiSearchResult", + "namespace": "_global.msearch" } - ] + } }, "generics": [ { @@ -18379,33 +19832,36 @@ "name": { "name": "Response", "namespace": "_global.msearch_template" - } + }, + "specLocation": "_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "TemplateItem", + "name": "TemplateConfig", "namespace": "_global.msearch_template" }, "properties": [ { - "name": "id", + "name": "explain", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index", + "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Id", "namespace": "_types" } } @@ -18418,7 +19874,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -18429,17 +19885,31 @@ } }, { + "name": "profile", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", "name": "source", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/msearch_template/types.ts#L28-L45" }, { "kind": "interface", @@ -18452,11 +19922,7 @@ "name": "doc", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "object", - "namespace": "internal" - } + "kind": "user_defined_value" } }, { @@ -18477,7 +19943,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18521,7 +19987,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18532,7 +19998,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18543,7 +20009,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18565,7 +20031,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18591,7 +20057,8 @@ } } } - ] + ], + "specLocation": "_global/mtermvectors/types.ts#L34-L48" }, { "attachedBehaviors": [ @@ -18630,6 +20097,7 @@ } ] }, + "description": "Returns multiple termvectors in one request.", "inherits": { "type": { "name": "RequestBase", @@ -18643,6 +20111,7 @@ }, "path": [ { + "description": "The index in which the document resides.", "name": "index", "required": false, "type": { @@ -18654,6 +20123,7 @@ } }, { + "description": "The type of the document.", "name": "type", "required": false, "type": { @@ -18667,6 +20137,22 @@ ], "query": [ { + "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", + "name": "ids", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "description": "A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "fields", "required": false, "type": { @@ -18678,72 +20164,79 @@ } }, { + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "field_statistics", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "offsets", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "payloads", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "positions", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if requests are real-time as opposed to near-real-time (default: true).", "name": "realtime", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specific routing value. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "routing", "required": false, "type": { @@ -18755,17 +20248,19 @@ } }, { + "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".", "name": "term_statistics", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -18777,6 +20272,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -18787,7 +20283,8 @@ } } } - ] + ], + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L32-L60" }, { "body": { @@ -18813,7 +20310,8 @@ "name": { "name": "Response", "namespace": "_global.mtermvectors" - } + }, + "specLocation": "_global/mtermvectors/MultiTermVectorsResponse.ts#L22-L24" }, { "kind": "interface", @@ -18829,7 +20327,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -18899,7 +20397,8 @@ } } } - ] + ], + "specLocation": "_global/mtermvectors/types.ts#L50-L57" }, { "attachedBehaviors": [ @@ -18908,6 +20407,7 @@ "body": { "kind": "no_body" }, + "description": "A search request by default executes against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", "inherits": { "type": { "name": "RequestBase", @@ -18921,6 +20421,7 @@ }, "path": [ { + "description": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": true, "type": { @@ -18934,8 +20435,9 @@ ], "query": [ { + "description": "Specific the time to live for the point in time", "name": "keep_alive", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -18943,8 +20445,21 @@ "namespace": "_types" } } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L24-L45" }, { "body": { @@ -18967,7 +20482,8 @@ "name": { "name": "Response", "namespace": "_global.open_point_in_time" - } + }, + "specLocation": "_global/open_point_in_time/OpenPointInTimeResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -18976,6 +20492,7 @@ "body": { "kind": "no_body" }, + "description": "Returns whether the cluster is running.", "inherits": { "type": { "name": "RequestBase", @@ -18988,7 +20505,8 @@ "namespace": "_global.ping" }, "path": [], - "query": [] + "query": [], + "specLocation": "_global/ping/PingRequest.ts#L22-L27" }, { "body": { @@ -18998,7 +20516,8 @@ "name": { "name": "Response", "namespace": "_global.ping" - } + }, + "specLocation": "_global/ping/PingResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -19009,7 +20528,7 @@ "properties": [ { "name": "script", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -19020,6 +20539,7 @@ } ] }, + "description": "Creates or updates a script.", "inherits": { "type": { "name": "RequestBase", @@ -19033,6 +20553,7 @@ }, "path": [ { + "description": "Script ID", "name": "id", "required": true, "type": { @@ -19044,6 +20565,7 @@ } }, { + "description": "Script context", "name": "context", "required": false, "type": { @@ -19057,6 +20579,7 @@ ], "query": [ { + "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, "type": { @@ -19068,6 +20591,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -19078,7 +20602,8 @@ } } } - ] + ], + "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L42" }, { "body": { @@ -19095,7 +20620,8 @@ "name": { "name": "Response", "namespace": "_global.put_script" - } + }, + "specLocation": "_global/put_script/PutScriptResponse.ts#L22-L22" }, { "kind": "interface", @@ -19140,7 +20666,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L116-L123" }, { "kind": "interface", @@ -19193,7 +20720,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L141-L146" }, { "kind": "interface", @@ -19217,14 +20745,27 @@ "name": "rating", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L136-L139" }, { "kind": "interface", @@ -19288,7 +20829,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L90-L96" }, { "kind": "interface", @@ -19301,7 +20843,7 @@ "description": "Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.", "name": "k", "required": false, - "serverDefault": "10", + "serverDefault": 10, "type": { "kind": "instance_of", "type": { @@ -19310,7 +20852,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L26-L32" }, { "kind": "interface", @@ -19370,7 +20913,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -19380,7 +20923,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -19391,7 +20934,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L125-L134" }, { "description": "Discounted cumulative gain (DCG)", @@ -19418,11 +20962,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L66-L77" }, { "description": "Expected Reciprocal Rank (ERR)", @@ -19451,7 +20996,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L79-L88" }, { "description": "Mean Reciprocal Rank", @@ -19467,7 +21013,8 @@ "name": "RankEvalMetricMeanReciprocalRank", "namespace": "_global.rank_eval" }, - "properties": [] + "properties": [], + "specLocation": "_global/rank_eval/types.ts#L60-L64" }, { "description": "Precision at K (P@k)", @@ -19493,11 +21040,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L42-L52" }, { "inherits": { @@ -19516,7 +21064,7 @@ "description": "Sets the rating threshold above which documents are considered to be \"relevant\".", "name": "relevant_rating_threshold", "required": false, - "serverDefault": "1", + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -19525,7 +21073,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L34-L40" }, { "description": "Recall at K (R@k)", @@ -19541,7 +21090,8 @@ "name": "RankEvalMetricRecall", "namespace": "_global.rank_eval" }, - "properties": [] + "properties": [], + "specLocation": "_global/rank_eval/types.ts#L54-L58" }, { "kind": "interface", @@ -19572,7 +21122,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L111-L114" }, { "kind": "interface", @@ -19641,7 +21192,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -19651,7 +21202,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L98-L109" }, { "attachedBehaviors": [ @@ -19690,6 +21242,7 @@ } ] }, + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", "inherits": { "type": { "name": "RequestBase", @@ -19725,11 +21278,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -19749,22 +21303,24 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Search operation type", "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L60" }, { "body": { @@ -19813,7 +21369,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -19829,7 +21385,8 @@ "name": { "name": "Response", "namespace": "_global.rank_eval" - } + }, + "specLocation": "_global/rank_eval/RankEvalResponse.ts#L26-L34" }, { "kind": "interface", @@ -19860,7 +21417,8 @@ } } } - ] + ], + "specLocation": "_global/rank_eval/types.ts#L148-L151" }, { "kind": "interface", @@ -19870,8 +21428,9 @@ }, "properties": [ { + "description": "The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform.", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -19892,13 +21451,14 @@ } }, { + "description": "The unique identifier for an ingest pipeline.", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -19924,7 +21484,8 @@ } } } - ] + ], + "specLocation": "_global/reindex/types.ts#L39-L47" }, { "kind": "interface", @@ -19935,7 +21496,7 @@ "properties": [ { "name": "connect_timeout", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -19944,6 +21505,28 @@ } } }, + { + "name": "headers", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, { "name": "host", "required": true, @@ -19957,7 +21540,7 @@ }, { "name": "username", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -19968,7 +21551,7 @@ }, { "name": "password", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -19979,7 +21562,7 @@ }, { "name": "socket_timeout", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -19988,7 +21571,8 @@ } } } - ] + ], + "specLocation": "_global/reindex/types.ts#L61-L68" }, { "attachedBehaviors": [ @@ -20010,7 +21594,7 @@ }, { "name": "dest", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -20054,7 +21638,7 @@ }, { "name": "source", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -20065,6 +21649,7 @@ } ] }, + "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", "inherits": { "type": { "name": "RequestBase", @@ -20079,17 +21664,19 @@ "path": [], "query": [ { + "description": "Should the affected indexes be refreshed?", "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle.", "name": "requests_per_second", "required": false, "type": { @@ -20101,6 +21688,7 @@ } }, { + "description": "Control how long to keep the search context alive", "name": "scroll", "required": false, "type": { @@ -20112,17 +21700,19 @@ } }, { + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", "name": "slices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Slices", "namespace": "_types" } } }, { + "description": "Time each individual bulk request should wait for shards that are unavailable.", "name": "timeout", "required": false, "type": { @@ -20134,6 +21724,7 @@ } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -20145,13 +21736,14 @@ } }, { + "description": "Should the request should block until the reindex is complete.", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20162,11 +21754,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/reindex/ReindexRequest.ts#L27-L51" }, { "body": { @@ -20303,7 +21896,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20357,7 +21950,8 @@ "name": { "name": "Response", "namespace": "_global.reindex" - } + }, + "specLocation": "_global/reindex/ReindexResponse.ts#L26-L45" }, { "kind": "interface", @@ -20428,12 +22022,12 @@ "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } }, { - "identifier": "source_fields", + "codegenName": "source_fields", "name": "_source", "required": false, "type": { @@ -20443,8 +22037,20 @@ "namespace": "_types" } } + }, + { + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } } - ] + ], + "specLocation": "_global/reindex/types.ts#L49-L59" }, { "inherits": { @@ -20481,7 +22087,8 @@ } } } - ] + ], + "specLocation": "_global/reindex_rethrottle/types.ts#L26-L28" }, { "kind": "interface", @@ -20611,7 +22218,8 @@ } } } - ] + ], + "specLocation": "_global/reindex_rethrottle/types.ts#L30-L42" }, { "kind": "interface", @@ -20627,7 +22235,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20638,7 +22246,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20649,7 +22257,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20715,7 +22323,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20730,7 +22338,8 @@ } } } - ] + ], + "specLocation": "_global/reindex_rethrottle/types.ts#L44-L55" }, { "attachedBehaviors": [ @@ -20739,6 +22348,7 @@ "body": { "kind": "no_body" }, + "description": "Changes the number of requests per second for a particular Reindex operation.", "inherits": { "type": { "name": "RequestBase", @@ -20752,6 +22362,7 @@ }, "path": [ { + "description": "The task id to rethrottle", "name": "task_id", "required": true, "type": { @@ -20765,6 +22376,7 @@ ], "query": [ { + "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.", "name": "requests_per_second", "required": false, "type": { @@ -20775,7 +22387,8 @@ } } } - ] + ], + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L36" }, { "body": { @@ -20789,7 +22402,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -20809,7 +22422,8 @@ "name": { "name": "Response", "namespace": "_global.reindex_rethrottle" - } + }, + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleResponse.ts#L23-L25" }, { "attachedBehaviors": [ @@ -20825,7 +22439,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -20837,7 +22451,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -20854,12 +22468,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Allows to use the Mustache language to pre-render a search definition.", "inherits": { "type": { "name": "RequestBase", @@ -20871,8 +22486,22 @@ "name": "Request", "namespace": "_global.render_search_template" }, - "path": [], - "query": [] + "path": [ + { + "description": "The id of the stored search template", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L39" }, { "body": { @@ -20886,7 +22515,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -20902,7 +22531,8 @@ "name": { "name": "Response", "namespace": "_global.render_search_template" - } + }, + "specLocation": "_global/render_search_template/RenderSearchTemplateResponse.ts#L23-L25" }, { "kind": "interface", @@ -20940,50 +22570,8 @@ } } } - ] - }, - { - "description": "If a painless script fails to execute this is returned on the serialized exception", - "kind": "interface", - "name": { - "name": "PainlessExecutionPosition", - "namespace": "_global.scripts_painless_execute" - }, - "properties": [ - { - "name": "offset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "start", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "end", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] + ], + "specLocation": "_global/scripts_painless_execute/types.ts#L25-L29" }, { "attachedBehaviors": [ @@ -20999,7 +22587,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -21027,6 +22615,7 @@ } ] }, + "description": "Allows an arbitrary script to be executed and a result to be returned", "inherits": { "type": { "name": "RequestBase", @@ -21039,7 +22628,8 @@ "namespace": "_global.scripts_painless_execute" }, "path": [], - "query": [] + "query": [], + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L35" }, { "body": { @@ -21068,7 +22658,8 @@ "name": { "name": "Response", "namespace": "_global.scripts_painless_execute" - } + }, + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptResponse.ts#L20-L24" }, { "attachedBehaviors": [ @@ -21102,22 +22693,10 @@ "namespace": "_types" } } - }, - { - "description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", - "name": "rest_total_hits_as_int", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } } ] }, + "description": "Allows to retrieve a large numbers of results from a single search request.", "inherits": { "type": { "name": "RequestBase", @@ -21132,14 +22711,16 @@ "path": [ { "deprecation": { + "description": "", "version": "7.0.0" }, + "description": "The scroll ID", "name": "scroll_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "ScrollId", "namespace": "_types" } } @@ -21162,8 +22743,10 @@ }, { "deprecation": { + "description": "", "version": "7.0.0" }, + "description": "The scroll ID for scrolled search", "name": "scroll_id", "required": false, "type": { @@ -21183,27 +22766,32 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "total_hits_as_integer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L59" }, { "body": { - "kind": "properties", - "properties": [] + "kind": "value", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.scroll" + } + } + ], + "kind": "instance_of", + "type": { + "name": "ResponseBody", + "namespace": "_global.search" + } + } }, "generics": [ { @@ -21211,26 +22799,12 @@ "namespace": "_global.scroll" } ], - "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.scroll" - } - } - ], - "type": { - "name": "Response", - "namespace": "_global.search" - } - }, "kind": "response", "name": { "name": "Response", "namespace": "_global.scroll" - } + }, + "specLocation": "_global/scroll/ScrollResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -21240,28 +22814,9 @@ "kind": "properties", "properties": [ { - "name": "aggs", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, - { + "aliases": [ + "aggs" + ], "name": "aggregations", "required": false, "type": { @@ -21269,7 +22824,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -21295,19 +22850,42 @@ } }, { + "description": "If true, returns detailed information about score computation as part of a hit.", "name": "explain", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Configuration of search extensions defined by Elasticsearch plugins.", + "name": "ext", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { + "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -21328,29 +22906,19 @@ } }, { + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", "name": "track_total_hits", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TrackHits", + "namespace": "_global.search._types" + } } }, { + "description": "Boosts the _score of documents from specified indices.", "name": "indices_boost", "required": false, "type": { @@ -21376,44 +22944,22 @@ } }, { + "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", "name": "docvalue_fields", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DocValueField", - "namespace": "_global.search._types" - } - }, - { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DocValueField", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" } - ], - "kind": "union_of" + } } }, { + "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in the search results.", "name": "min_score", "required": false, "type": { @@ -21442,11 +22988,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { @@ -21484,6 +23031,7 @@ } }, { + "description": "Retrieve a script evaluation (based on different fields) for each hit.", "name": "script_fields", "required": false, "type": { @@ -21491,7 +23039,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -21509,31 +23057,18 @@ "name": "search_after", "required": false, "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SortResults", + "namespace": "_types" } } }, { + "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", "name": "size", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { @@ -21554,69 +23089,41 @@ } }, { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } }, { + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } } }, { + "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", "name": "fields", "required": false, "type": { "kind": "array_of", "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateField", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } } } }, @@ -21624,39 +23131,18 @@ "name": "suggest", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SuggestContainer", - "namespace": "_global.search._types" - } - }, - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "SuggestContainer", - "namespace": "_global.search._types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Suggester", + "namespace": "_global.search._types" + } } }, { + "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", "name": "terminate_after", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -21666,50 +23152,57 @@ } }, { + "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", "name": "track_scores", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If true, returns document version as part of a hit.", "name": "version", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "name": "stored_fields", "required": false, "type": { @@ -21721,6 +23214,7 @@ } }, { + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", "name": "pit", "required": false, "type": { @@ -21732,6 +23226,7 @@ } }, { + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "name": "runtime_mappings", "required": false, "type": { @@ -21743,6 +23238,7 @@ } }, { + "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", "name": "stats", "required": false, "type": { @@ -21751,13 +23247,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } ] }, + "description": "Returns results matching a query.", "inherits": { "type": { "name": "RequestBase", @@ -21771,6 +23268,7 @@ }, "path": [ { + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": false, "type": { @@ -21782,6 +23280,7 @@ } }, { + "description": "A comma-separated list of document types to search; leave empty to perform the operation on all types", "name": "type", "required": false, "type": { @@ -21795,50 +23294,55 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Indicate if an error should be returned if there is a partial search failure or timeout", "name": "allow_partial_search_results", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The analyzer to use for the query string", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", "name": "analyze_wildcard", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "name": "batched_reduce_size", "required": false, "type": { @@ -21850,39 +23354,43 @@ } }, { + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "name": "ccs_minimize_roundtrips", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The default operator for query string query (AND or OR)", "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DefaultOperator", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { + "description": "The field to use as default where no field prefix is given in the query string", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", "name": "docvalue_fields", "required": false, "type": { @@ -21894,6 +23402,7 @@ } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -21905,50 +23414,55 @@ } }, { + "description": "Specify whether to return detailed information about score computation as part of a hit", "name": "explain", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", "name": "ignore_throttled", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "name": "max_concurrent_shard_requests", "required": false, "type": { @@ -21960,6 +23474,7 @@ } }, { + "description": "The minimum compatible version that all shards involved in search should have for this request to be successful", "name": "min_compatible_shard_node", "required": false, "type": { @@ -21971,17 +23486,19 @@ } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", "name": "pre_filter_shard_size", "required": false, "type": { @@ -21993,17 +23510,19 @@ } }, { + "description": "Specify if request cache should be used for this request or not, defaults to index level setting", "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A comma-separated list of specific routing values", "name": "routing", "required": false, "type": { @@ -22015,6 +23534,7 @@ } }, { + "description": "Specify how long a consistent view of the index should be maintained for scrolled search", "name": "scroll", "required": false, "type": { @@ -22026,6 +23546,7 @@ } }, { + "description": "Search operation type", "name": "search_type", "required": false, "type": { @@ -22037,6 +23558,7 @@ } }, { + "description": "Specific 'tag' of the request for logging and statistical purposes", "name": "stats", "required": false, "type": { @@ -22045,12 +23567,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "A comma-separated list of stored fields to return as part of a hit", "name": "stored_fields", "required": false, "type": { @@ -22062,6 +23585,7 @@ } }, { + "description": "Specifies which field to use for suggestions.", "name": "suggest_field", "required": false, "type": { @@ -22073,6 +23597,7 @@ } }, { + "description": "Specify suggest mode", "name": "suggest_mode", "required": false, "type": { @@ -22084,6 +23609,7 @@ } }, { + "description": "How many suggestions to return in response", "name": "suggest_size", "required": false, "type": { @@ -22095,17 +23621,19 @@ } }, { + "description": "The source text for which the suggestions should be returned.", "name": "suggest_text", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "name": "terminate_after", "required": false, "type": { @@ -22117,6 +23645,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -22128,96 +23657,79 @@ } }, { + "description": "Indicate if the number of documents that match the query should be tracked", "name": "track_total_hits", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TrackHits", + "namespace": "_global.search._types" + } } }, { + "description": "Whether to calculate and return scores even if they are not used for sorting", "name": "track_scores", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "name": "typed_keys", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "name": "rest_total_hits_as_int", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether to return document version as part of a hit", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "True or false to return the _source field or not, or a list of fields to return", "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } } }, { + "description": "A list of fields to exclude from the returned _source field", "name": "_source_excludes", "required": false, "type": { @@ -22229,6 +23741,7 @@ } }, { + "description": "A list of fields to extract and return from the _source field", "name": "_source_includes", "required": false, "type": { @@ -22240,28 +23753,31 @@ } }, { + "description": "Specify whether to return sequence number and primary term of the last modification of each hit", "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Query in the Lucene query string syntax", "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Number of hits to return (default: 10)", "name": "size", "required": false, "type": { @@ -22273,6 +23789,7 @@ } }, { + "description": "Starting offset (default: 0)", "name": "from", "required": false, "type": { @@ -22284,6 +23801,7 @@ } }, { + "description": "A comma-separated list of : pairs", "name": "sort", "required": false, "type": { @@ -22292,7 +23810,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -22301,7 +23819,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -22309,243 +23827,261 @@ "kind": "union_of" } } - ] + ], + "specLocation": "_global/search/SearchRequest.ts#L51-L240" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "took", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "timed_out", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "_shards", - "required": true, - "type": { + "kind": "value", + "value": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "TDocument", + "namespace": "_global.search" } } - }, - { - "name": "hits", - "required": true, + ], + "kind": "instance_of", + "type": { + "name": "ResponseBody", + "namespace": "_global.search" + } + } + }, + "generics": [ + { + "name": "TDocument", + "namespace": "_global.search" + } + ], + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.search" + }, + "specLocation": "_global/search/SearchResponse.ts#L34-L36" + }, + { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.search" + } + ], + "kind": "interface", + "name": { + "name": "ResponseBody", + "namespace": "_global.search" + }, + "properties": [ + { + "name": "took", + "required": true, + "type": { + "kind": "instance_of", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "aggregations", - "required": false, + } + }, + { + "name": "timed_out", + "required": true, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "_clusters", - "required": false, + } + }, + { + "name": "_shards", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStatistics", - "namespace": "_types" - } + "name": "ShardStatistics", + "namespace": "_types" } - }, - { - "name": "documents", - "required": false, - "type": { - "kind": "array_of", - "value": { + } + }, + { + "name": "hits", + "required": true, + "type": { + "generics": [ + { "kind": "instance_of", "type": { "name": "TDocument", "namespace": "_global.search" } } - } - }, - { - "name": "fields", - "required": false, + ], + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + "name": "HitsMetadata", + "namespace": "_global.search._types" } - }, - { - "name": "max_score", - "required": false, - "type": { + } + }, + { + "name": "aggregations", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "double", + "name": "AggregateName", "namespace": "_types" } - } - }, - { - "name": "num_reduce_phases", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Aggregate", + "namespace": "_types.aggregations" } } - }, - { - "name": "profile", - "required": false, + } + }, + { + "name": "_clusters", + "required": false, + "type": { + "kind": "instance_of", "type": { + "name": "ClusterStatistics", + "namespace": "_types" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "Profile", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } - }, - { - "name": "pit_id", - "required": false, + } + }, + { + "name": "max_score", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "double", + "namespace": "_types" } - }, - { - "name": "_scroll_id", - "required": false, + } + }, + { + "name": "num_reduce_phases", + "required": false, + "type": { + "kind": "instance_of", "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "profile", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Profile", + "namespace": "_global.search._types" + } + } + }, + { + "name": "pit_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "_scroll_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScrollId", + "namespace": "_types" + } + } + }, + { + "name": "suggest", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "ScrollId", + "name": "SuggestionName", "namespace": "_types" } - } - }, - { - "name": "suggest", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "SuggestionName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", "value": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search" - } + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search" } - ], - "kind": "instance_of", - "type": { - "name": "Suggest", - "namespace": "_global.search._types" } + ], + "kind": "instance_of", + "type": { + "name": "Suggest", + "namespace": "_global.search._types" } } } - }, - { - "name": "terminated_early", - "required": false, + } + }, + { + "name": "terminated_early", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "generics": [ - { - "name": "TDocument", - "namespace": "_global.search" } ], - "kind": "response", - "name": { - "name": "Response", - "namespace": "_global.search" - } + "specLocation": "_global/search/SearchResponse.ts#L38-L54" }, { "kind": "interface", @@ -22686,7 +24222,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L22-L35" }, { "kind": "interface", @@ -22713,7 +24250,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -22735,7 +24272,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -22758,13 +24295,14 @@ "value": { "kind": "instance_of", "type": { - "name": "AggregationProfileDebug", + "name": "AggregationProfile", "namespace": "_global.search._types" } } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L78-L85" }, { "kind": "interface", @@ -22772,7 +24310,387 @@ "name": "AggregationProfileDebug", "namespace": "_global.search._types" }, - "properties": [] + "properties": [ + { + "name": "segments_with_multi_valued_ords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "collection_strategy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "segments_with_single_valued_ords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "total_buckets", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "built_buckets", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "result_strategy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "has_filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "delegate", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "delegate_debug", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AggregationProfileDelegateDebug", + "namespace": "_global.search._types" + } + } + }, + { + "name": "chars_fetched", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "extract_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "extract_ns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "values_fetched", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "collect_analyzed_ns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "collect_analyzed_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "surviving_buckets", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "ordinals_collectors_used", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "ordinals_collectors_overhead_too_high", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "string_hashing_collectors_used", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "numeric_collectors_used", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "empty_collectors_used", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "deferred_aggregators", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_global/search/_types/profile.ts#L37-L60" + }, + { + "kind": "interface", + "name": { + "name": "AggregationProfileDelegateDebug", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "segments_with_doc_count_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "segments_with_deleted_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "filters", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationProfileDelegateDebugFilter", + "namespace": "_global.search._types" + } + } + } + }, + { + "name": "segments_counted", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "segments_collected", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "map_reducer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/search/_types/profile.ts#L62-L69" + }, + { + "kind": "interface", + "name": { + "name": "AggregationProfileDelegateDebugFilter", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "results_from_metadata", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "specialized_for", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "segments_counted_in_constant_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/search/_types/profile.ts#L71-L76" }, { "kind": "enum", @@ -22790,7 +24708,28 @@ "name": { "name": "BoundaryScanner", "namespace": "_global.search._types" - } + }, + "specLocation": "_global/search/_types/highlighting.ts#L27-L31" + }, + { + "kind": "enum", + "members": [ + { + "name": "plain" + }, + { + "codegenName": "fast_vector", + "name": "fvh" + }, + { + "name": "unified" + } + ], + "name": { + "name": "BuiltinHighlighterType", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L83-L88" }, { "kind": "interface", @@ -22806,7 +24745,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -22817,7 +24756,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -22846,7 +24785,144 @@ } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L87-L92" + }, + { + "kind": "interface", + "name": { + "name": "CompletionContext", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "boost", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "context", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Context", + "namespace": "_global.search._types" + } + } + }, + { + "name": "neighbours", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GeoHashPrecision", + "namespace": "_types" + } + } + } + }, + { + "name": "precision", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoHashPrecision", + "namespace": "_types" + } + } + }, + { + "name": "prefix", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "shortcutProperty": "context", + "specLocation": "_global/search/_types/suggester.ts#L158-L165" + }, + { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.search._types" + } + ], + "inherits": { + "type": { + "name": "SuggestBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "CompletionSuggest", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "options", + "required": true, + "type": { + "items": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search._types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "CompletionSuggestOption", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search._types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "CompletionSuggestOption", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_global/search/_types/suggester.ts#L49-L56", + "variantName": "completion" }, { "generics": [ @@ -22868,7 +24944,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -22880,7 +24956,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -22905,7 +24981,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -22917,18 +24993,18 @@ }, { "name": "_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "_index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -22961,7 +25037,7 @@ }, { "name": "_score", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -22972,7 +25048,7 @@ }, { "name": "_source", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -22988,11 +25064,23 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L74-L86" }, { "inherits": { @@ -23014,8 +25102,8 @@ "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } }, "kind": "dictionary_of", @@ -23025,25 +25113,8 @@ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "CompletionContext", + "namespace": "_global.search._types" } }, { @@ -23051,7 +25122,7 @@ "value": { "kind": "instance_of", "type": { - "name": "SuggestContextQuery", + "name": "CompletionContext", "namespace": "_global.search._types" } } @@ -23079,7 +25150,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -23090,7 +25161,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -23101,34 +25172,40 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L132-L138" }, { - "description": "Text that we want similar documents for or a lookup to a document's field for the text.", + "codegenNames": [ + "category", + "location" + ], + "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", "kind": "type_alias", "name": { "name": "Context", "namespace": "_global.search._types" }, + "specLocation": "_global/search/_types/suggester.ts#L150-L156", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "GeoLocation", - "namespace": "_types.query_dsl" + "namespace": "_types" } } ], @@ -23215,7 +25292,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -23226,7 +25303,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -23263,351 +25340,209 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L169-L181" }, { "kind": "interface", "name": { - "name": "DocValueField", + "name": "FetchProfile", "namespace": "_global.search._types" }, "properties": [ { - "name": "field", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "format", - "required": false, + "name": "description", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldAndFormat", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "name": "field", + "name": "time_in_nanos", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "name": "format", - "required": false, + "name": "breakdown", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FetchProfileBreakdown", + "namespace": "_global.search._types" } } }, { - "name": "include_unmapped", + "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ], - "shortcutProperty": "field" - }, - { - "kind": "interface", - "name": { - "name": "FieldCollapse", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "name": "FetchProfileDebug", + "namespace": "_global.search._types" } } }, { - "name": "inner_hits", + "name": "children", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "InnerHits", - "namespace": "_global.search._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "InnerHits", - "namespace": "_global.search._types" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FetchProfile", + "namespace": "_global.search._types" } - ], - "kind": "union_of" - } - }, - { - "name": "max_concurrent_group_searches", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L140-L147" }, { "kind": "interface", "name": { - "name": "FieldSort", + "name": "FetchProfileBreakdown", "namespace": "_global.search._types" }, "properties": [ { - "name": "missing", + "name": "load_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Missing", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "name": "mode", + "name": "load_source_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortMode", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "nested", + "name": "load_stored_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NestedSortValue", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "order", + "name": "load_stored_fields_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "unmapped_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldType", - "namespace": "_types.mapping" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "kind": "interface", - "name": { - "name": "GeoDistanceSort", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "mode", + "name": "next_reader", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortMode", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "distance_type", + "name": "next_reader_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoDistanceType", + "name": "integer", "namespace": "_types" } } }, { - "name": "order", + "name": "process_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "unit", + "name": "process", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DistanceUnit", + "name": "integer", "namespace": "_types" } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L149-L158" }, { "kind": "interface", "name": { - "name": "Highlight", + "name": "FetchProfileDebug", "namespace": "_global.search._types" }, "properties": [ { - "name": "fields", - "required": true, + "name": "stored_fields", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "HighlightField", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "HighlighterType", - "namespace": "_global.search._types" - } - } - }, - { - "name": "boundary_chars", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "boundary_max_scan", + "name": "fast_path", "required": false, "type": { "kind": "instance_of", @@ -23616,210 +25551,218 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L160-L163" + }, + { + "kind": "interface", + "name": { + "name": "FieldCollapse", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "boundary_scanner", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "BoundaryScanner", - "namespace": "_global.search._types" + "name": "Field", + "namespace": "_types" } } }, { - "name": "boundary_scanner_locale", + "name": "inner_hits", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" } }, { - "name": "encoder", + "name": "max_concurrent_group_searches", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterEncoder", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L28" + }, + { + "kind": "interface", + "name": { + "name": "FieldSuggester", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "fragmenter", + "name": "completion", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterFragmenter", + "name": "CompletionSuggester", "namespace": "_global.search._types" } } }, { - "name": "fragment_offset", + "name": "phrase", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "PhraseSuggester", + "namespace": "_global.search._types" } } }, { - "name": "fragment_size", + "name": "term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TermSuggester", + "namespace": "_global.search._types" } } }, { - "name": "max_fragment_length", + "containerProperty": true, + "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "no_match_size", + "containerProperty": true, + "name": "regex", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "number_of_fragments", + "containerProperty": true, + "name": "text", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L108-L122", + "variants": { + "kind": "container", + "nonExhaustive": true + } + }, + { + "inherits": { + "type": { + "name": "HighlightBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "Highlight", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "order", + "name": "encoder", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterOrder", + "name": "HighlighterEncoder", "namespace": "_global.search._types" } } }, { - "name": "post_tags", - "required": false, + "name": "fields", + "required": true, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } - } - } - }, - { - "name": "pre_tags", - "required": false, - "type": { - "kind": "array_of", + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "HighlightField", + "namespace": "_global.search._types" } } } - }, - { - "name": "require_field_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, + } + ], + "specLocation": "_global/search/_types/highlighting.ts#L57-L60" + }, + { + "kind": "interface", + "name": { + "name": "HighlightBase", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "tags_schema", + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterTagsSchema", + "name": "HighlighterType", "namespace": "_global.search._types" } } }, - { - "name": "highlight_query", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "max_analyzed_offset", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "HighlightField", - "namespace": "_global.search._types" - }, - "properties": [ { "name": "boundary_chars", "required": false, @@ -23827,7 +25770,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -23860,18 +25803,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "namespace": "_builtins" } } }, @@ -23882,7 +25814,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -23898,7 +25830,7 @@ } }, { - "name": "fragment_offset", + "name": "fragment_size", "required": false, "type": { "kind": "instance_of", @@ -23909,13 +25841,13 @@ } }, { - "name": "fragment_size", + "name": "highlight_filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, @@ -23931,18 +25863,18 @@ } }, { - "name": "matched_fields", + "name": "max_fragment_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "integer", "namespace": "_types" } } }, { - "name": "max_fragment_length", + "name": "max_analyzed_offset", "required": false, "type": { "kind": "instance_of", @@ -23974,6 +25906,24 @@ } } }, + { + "name": "options", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, { "name": "order", "required": false, @@ -24005,7 +25955,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -24019,7 +25969,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -24031,7 +25981,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24045,31 +25995,58 @@ "namespace": "_global.search._types" } } - }, + } + ], + "specLocation": "_global/search/_types/highlighting.ts#L33-L55" + }, + { + "inherits": { + "type": { + "name": "HighlightBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "HighlightField", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "type", + "name": "fragment_offset", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "HighlighterType", - "namespace": "_global.search._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "matched_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Analyzer", + "namespace": "_types.analysis" + } } } - ] + ], + "specLocation": "_global/search/_types/highlighting.ts#L90-L94" }, { "kind": "enum", @@ -24084,7 +26061,8 @@ "name": { "name": "HighlighterEncoder", "namespace": "_global.search._types" - } + }, + "specLocation": "_global/search/_types/highlighting.ts#L62-L65" }, { "kind": "enum", @@ -24099,7 +26077,8 @@ "name": { "name": "HighlighterFragmenter", "namespace": "_global.search._types" - } + }, + "specLocation": "_global/search/_types/highlighting.ts#L67-L70" }, { "kind": "enum", @@ -24111,7 +26090,8 @@ "name": { "name": "HighlighterOrder", "namespace": "_global.search._types" - } + }, + "specLocation": "_global/search/_types/highlighting.ts#L72-L74" }, { "kind": "enum", @@ -24123,24 +26103,38 @@ "name": { "name": "HighlighterTagsSchema", "namespace": "_global.search._types" - } + }, + "specLocation": "_global/search/_types/highlighting.ts#L76-L78" }, { - "kind": "enum", - "members": [ - { - "name": "plain" - }, - { - "name": "fvh" - }, - { - "name": "unified" - } + "codegenNames": [ + "builtin", + "custom" ], + "kind": "type_alias", "name": { "name": "HighlighterType", "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L80-L81", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "BuiltinHighlighterType", + "namespace": "_global.search._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { @@ -24168,6 +26162,7 @@ } }, { + "esQuirk": "'_id' is not available when using 'stored_fields: _none_'\non a search request. Otherwise the field is always present on hits.", "name": "_id", "required": true, "type": { @@ -24219,7 +26214,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -24237,7 +26232,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -24248,7 +26243,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -24262,7 +26257,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -24285,7 +26280,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -24310,7 +26305,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -24322,7 +26317,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24333,7 +26328,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24344,7 +26339,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24399,11 +26394,12 @@ "kind": "instance_of", "type": { "name": "SortResults", - "namespace": "_global.search._types" + "namespace": "_types" } } } - ] + ], + "specLocation": "_global/search/_types/hits.ts#L41-L68" }, { "generics": [ @@ -24419,8 +26415,9 @@ }, "properties": [ { + "description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.", "name": "total", - "required": true, + "required": false, "type": { "items": [ { @@ -24475,7 +26472,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/hits.ts#L70-L76" }, { "kind": "interface", @@ -24537,7 +26535,7 @@ "kind": "instance_of", "type": { "name": "FieldAndFormat", - "namespace": "_global.search._types" + "namespace": "_types.query_dsl" } } } @@ -24549,7 +26547,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24571,7 +26569,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24604,7 +26602,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24626,7 +26624,7 @@ "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } }, @@ -24634,23 +26632,11 @@ "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } } }, { @@ -24672,7 +26658,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24683,104 +26669,38 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/hits.ts#L111-L129" }, { "kind": "interface", "name": { - "name": "InnerHitsMetadata", + "name": "InnerHitsResult", "namespace": "_global.search._types" }, "properties": [ { - "name": "total", + "name": "hits", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "TotalHits", - "namespace": "_global.search._types" - } - }, + "generics": [ { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "user_defined_value" } ], - "kind": "union_of" - } - }, - { - "name": "hits", - "required": true, - "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Hit", - "namespace": "_global.search._types" - } - } - } - }, - { - "name": "max_score", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "InnerHitsResult", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "hits", - "required": true, - "type": { "kind": "instance_of", "type": { - "name": "InnerHitsMetadata", + "name": "HitsMetadata", "namespace": "_global.search._types" } } } - ] + ], + "specLocation": "_global/search/_types/hits.ts#L89-L91" }, { "kind": "interface", @@ -24800,7 +26720,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L215-L217" }, { "kind": "interface", @@ -24842,7 +26763,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L219-L223" }, { "kind": "interface", @@ -24884,49 +26806,51 @@ } } } - ] + ], + "specLocation": "_global/search/_types/hits.ts#L93-L97" }, { + "inherits": { + "type": { + "name": "SuggestBase", + "namespace": "_global.search._types" + } + }, "kind": "interface", "name": { - "name": "NestedSortValue", + "name": "PhraseSuggest", "namespace": "_global.search._types" }, "properties": [ { - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "max_children", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "path", + "name": "options", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "PhraseSuggestOption", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PhraseSuggestOption", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L58-L63", + "variantName": "phrase" }, { "kind": "interface", @@ -24943,7 +26867,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -24960,7 +26884,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -24975,7 +26899,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L183-L187" }, { "kind": "interface", @@ -25002,11 +26927,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L189-L192" }, { "kind": "interface", @@ -25022,7 +26948,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25033,11 +26959,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L210-L213" }, { "kind": "interface", @@ -25053,33 +26980,45 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "highlighted", + "name": "score", "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "highlighted", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "score", - "required": true, + "name": "collate_match", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L88-L93" }, { "inherits": { @@ -25137,7 +27076,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25192,7 +27131,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25225,7 +27164,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25240,7 +27179,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L194-L208" }, { "kind": "interface", @@ -25271,7 +27211,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/PointInTimeReference.ts#L23-L26" }, { "kind": "interface", @@ -25294,7 +27235,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L94-L96" }, { "kind": "interface", @@ -25501,7 +27443,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L98-L117" }, { "kind": "interface", @@ -25528,7 +27471,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25550,7 +27493,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25568,7 +27511,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L119-L125" }, { "kind": "interface", @@ -25599,7 +27543,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/rescoring.ts#L23-L26" }, { "kind": "interface", @@ -25609,7 +27554,7 @@ }, "properties": [ { - "identifier": "Query", + "codegenName": "Query", "name": "rescore_query", "required": true, "type": { @@ -25653,7 +27598,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/rescoring.ts#L28-L34" }, { "kind": "enum", @@ -25677,80 +27623,8 @@ "name": { "name": "ScoreMode", "namespace": "_global.search._types" - } - }, - { - "kind": "interface", - "name": { - "name": "ScoreSort", - "namespace": "_global.search._types" }, - "properties": [ - { - "name": "mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SortMode", - "namespace": "_global.search._types" - } - } - }, - { - "name": "order", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SortOrder", - "namespace": "_global.search._types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ScriptSort", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "order", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SortOrder", - "namespace": "_global.search._types" - } - } - }, - { - "name": "script", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } - }, - { - "name": "type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "specLocation": "_global/search/_types/rescoring.ts#L36-L42" }, { "kind": "interface", @@ -25798,7 +27672,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L127-L131" }, { "kind": "interface", @@ -25828,7 +27703,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -25845,8 +27720,20 @@ } } } + }, + { + "name": "fetch", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FetchProfile", + "namespace": "_global.search._types" + } + } } - ] + ], + "specLocation": "_global/search/_types/profile.ts#L133-L138" }, { "kind": "interface", @@ -25889,33 +27776,37 @@ } } ], + "specLocation": "_global/search/_types/suggester.ts#L227-L234", "variants": { "kind": "container" } }, { + "codegenNames": [ + "fetch", + "filter" + ], + "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.", "kind": "type_alias", "name": { - "name": "Sort", + "name": "SourceConfig", "namespace": "_global.search._types" }, + "specLocation": "_global/search/_types/SourceFilter.ts#L33-L37", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SortCombinations", - "namespace": "_global.search._types" + "name": "boolean", + "namespace": "_builtins" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SortCombinations", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "SourceFilter", + "namespace": "_global.search._types" } } ], @@ -25923,216 +27814,37 @@ } }, { + "codegenNames": [ + "fetch", + "fields" + ], + "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.\nUsed as a query parameter along with the `_source_includes` and `_source_excludes` parameters.", "kind": "type_alias", "name": { - "name": "SortCombinations", + "name": "SourceConfigParam", "namespace": "_global.search._types" }, + "specLocation": "_global/search/_types/SourceFilter.ts#L39-L45", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SortContainer", - "namespace": "_global.search._types" + "name": "boolean", + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "Fields", + "namespace": "_types" } } ], "kind": "union_of" } }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "FieldSort", - "namespace": "_global.search._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SortOrder", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "kind": "interface", - "name": { - "name": "SortContainer", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "_score", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ScoreSort", - "namespace": "_global.search._types" - } - } - }, - { - "name": "_doc", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ScoreSort", - "namespace": "_global.search._types" - } - } - }, - { - "name": "_geo_distance", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoDistanceSort", - "namespace": "_global.search._types" - } - } - }, - { - "name": "_script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ScriptSort", - "namespace": "_global.search._types" - } - } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "min" - }, - { - "name": "max" - }, - { - "name": "sum" - }, - { - "name": "avg" - }, - { - "name": "median" - } - ], - "name": { - "name": "SortMode", - "namespace": "_global.search._types" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "asc" - }, - { - "name": "desc" - }, - { - "identifier": "Document", - "name": "_doc" - } - ], - "name": { - "name": "SortOrder", - "namespace": "_global.search._types" - } - }, - { - "kind": "type_alias", - "name": { - "name": "SortResults", - "namespace": "_global.search._types" - }, - "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - } - }, { "kind": "interface", "name": { @@ -26141,6 +27853,9 @@ }, "properties": [ { + "aliases": [ + "exclude" + ], "name": "excludes", "required": false, "type": { @@ -26152,6 +27867,9 @@ } }, { + "aliases": [ + "include" + ], "name": "includes", "required": false, "type": { @@ -26161,30 +27879,10 @@ "namespace": "_types" } } - }, - { - "name": "exclude", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "name": "include", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } } - ] + ], + "shortcutProperty": "includes", + "specLocation": "_global/search/_types/SourceFilter.ts#L23-L31" }, { "kind": "enum", @@ -26208,7 +27906,8 @@ "name": { "name": "StringDistance", "namespace": "_global.search._types" - } + }, + "specLocation": "_global/search/_types/suggester.ts#L242-L248" }, { "kind": "interface", @@ -26228,250 +27927,103 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L236-L238" }, { "generics": [ { - "name": "T", + "name": "TDocument", "namespace": "_global.search._types" } ], - "kind": "interface", + "kind": "type_alias", "name": { "name": "Suggest", "namespace": "_global.search._types" }, - "properties": [ - { - "name": "length", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "offset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "options", - "required": true, - "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "T", - "namespace": "_global.search._types" - } + "specLocation": "_global/search/_types/suggester.ts#L35-L41", + "type": { + "items": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search._types" } - ], - "kind": "instance_of", - "type": { - "name": "SuggestOption", - "namespace": "_global.search._types" } - } - } - }, - { - "name": "text", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "SuggestContainer", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "completion", - "required": false, - "type": { + ], "kind": "instance_of", "type": { - "name": "CompletionSuggester", + "name": "CompletionSuggest", "namespace": "_global.search._types" } - } - }, - { - "name": "phrase", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "PhraseSuggester", + "name": "PhraseSuggest", "namespace": "_global.search._types" } - } - }, - { - "name": "prefix", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "regex", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "term", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "TermSuggester", + "name": "TermSuggest", "namespace": "_global.search._types" } } - }, - { - "name": "text", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], + ], + "kind": "union_of" + }, "variants": { - "kind": "container" + "kind": "external_tag" } }, { "kind": "interface", "name": { - "name": "SuggestContextQuery", + "name": "SuggestBase", "namespace": "_global.search._types" }, "properties": [ { - "name": "boost", - "required": false, + "name": "length", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "context", + "name": "offset", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Context", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "neighbours", - "required": false, - "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Distance", - "namespace": "_types" - } - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "precision", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Distance", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "prefix", - "required": false, + "name": "text", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L43-L47" }, { "kind": "interface", @@ -26482,7 +28034,7 @@ "properties": [ { "name": "fuzziness", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -26493,7 +28045,7 @@ }, { "name": "min_length", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -26504,7 +28056,7 @@ }, { "name": "prefix_length", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -26515,90 +28067,93 @@ }, { "name": "transpositions", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "unicode_aware", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L140-L146" }, { - "generics": [ + "kind": "enum", + "members": [ { - "name": "TDocument", - "namespace": "_global.search._types" + "name": "score" + }, + { + "name": "frequency" } ], - "kind": "type_alias", "name": { - "name": "SuggestOption", + "name": "SuggestSort", "namespace": "_global.search._types" }, - "type": { - "items": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search._types" - } + "specLocation": "_global/search/_types/suggester.ts#L250-L253" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FieldSuggester", + "namespace": "_global.search._types" } - ], - "kind": "instance_of", - "type": { - "name": "CompletionSuggestOption", - "namespace": "_global.search._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PhraseSuggestOption", - "namespace": "_global.search._types" } - }, - { + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "kind": "interface", + "name": { + "name": "Suggester", + "namespace": "_global.search._types" + }, + "properties": [ + { + "description": "Global suggest text, to avoid repetition when the same text is used in several suggesters", + "name": "text", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TermSuggestOption", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "score" - }, - { - "name": "frequency" } ], - "name": { - "name": "SuggestSort", - "namespace": "_global.search._types" - } + "specLocation": "_global/search/_types/suggester.ts#L103-L106" }, { "kind": "interface", @@ -26625,7 +28180,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -26640,7 +28195,51 @@ } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L124-L128" + }, + { + "inherits": { + "type": { + "name": "SuggestBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "TermSuggest", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "options", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TermSuggestOption", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TermSuggestOption", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_global/search/_types/suggester.ts#L65-L70", + "variantName": "term" }, { "kind": "interface", @@ -26656,33 +28255,56 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "freq", - "required": false, + "name": "score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "double", "namespace": "_types" } } }, { - "name": "score", + "name": "freq", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } + }, + { + "name": "highlighted", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "collate_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L95-L101" }, { "inherits": { @@ -26704,7 +28326,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -26825,11 +28447,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search/_types/suggester.ts#L255-L268" }, { "kind": "interface", @@ -26860,7 +28483,8 @@ } } } - ] + ], + "specLocation": "_global/search/_types/hits.ts#L99-L102" }, { "kind": "enum", @@ -26877,6 +28501,395 @@ "name": { "name": "TotalHitsRelation", "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/hits.ts#L104-L109" + }, + { + "codegenNames": [ + "enabled", + "count" + ], + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", + "kind": "type_alias", + "name": { + "name": "TrackHits", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/hits.ts#L131-L139", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Sub-aggregations for the geotile_grid.\n\nSupports the following aggregation types:\n- avg\n- cardinality\n- max\n- min\n- sum", + "name": "aggs", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } + } + }, + { + "description": "If false, the meta layer’s feature is the bounding box of the tile.\nIf true, the meta layer’s feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", + "name": "exact_bounds", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "name": "extent", + "required": false, + "serverDefault": 4096, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Fields to return in the `hits` layer. Supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", + "name": "fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon’t include the aggs layer.", + "name": "grid_precision", + "required": false, + "serverDefault": 8, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a geotile_grid cell. If 'grid' each feature is a Polygon\nof the cells bounding box. If 'point' each feature is a Point that is the centroid\nof the cell.", + "name": "grid_type", + "required": false, + "serverDefault": "grid", + "type": { + "kind": "instance_of", + "type": { + "name": "GridType", + "namespace": "_global.search_mvt._types" + } + } + }, + { + "description": "Query DSL used to filter documents for the search.", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don’t include the hits layer.", + "name": "size", + "required": false, + "serverDefault": 10000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Sorts features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box’s diagonal length,\nfrom longest to shortest.", + "name": "sort", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Sort", + "namespace": "_types" + } + } + } + ] + }, + "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.search_mvt" + }, + "path": [ + { + "description": "Comma-separated list of data streams, indices, or aliases to search", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "Field containing geospatial data to return", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Zoom level for the vector tile to search", + "name": "zoom", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ZoomLevel", + "namespace": "_global.search_mvt._types" + } + } + }, + { + "description": "X coordinate for the vector tile to search", + "name": "x", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Coordinate", + "namespace": "_global.search_mvt._types" + } + } + }, + { + "description": "Y coordinate for the vector tile to search", + "name": "y", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Coordinate", + "namespace": "_global.search_mvt._types" + } + } + } + ], + "query": [ + { + "description": "If false, the meta layer’s feature is the bounding box of the tile.\nIf true, the meta layer’s feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", + "name": "exact_bounds", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "name": "extent", + "required": false, + "serverDefault": 4096, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon’t include the aggs layer.", + "name": "grid_precision", + "required": false, + "serverDefault": 8, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a geotile_grid cell. If 'grid' each feature is a Polygon\nof the cells bounding box. If 'point' each feature is a Point that is the centroid\nof the cell.", + "name": "grid_type", + "required": false, + "serverDefault": "grid", + "type": { + "kind": "instance_of", + "type": { + "name": "GridType", + "namespace": "_global.search_mvt._types" + } + } + }, + { + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don’t include the hits layer.", + "name": "size", + "required": false, + "serverDefault": 10000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L32-L156" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "MapboxVectorTiles", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.search_mvt" + }, + "specLocation": "_global/search_mvt/SearchMvtResponse.ts#L22-L24" + }, + { + "kind": "type_alias", + "name": { + "name": "Coordinate", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/Coordinate.ts#L22-L22", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "kind": "enum", + "members": [ + { + "name": "grid" + }, + { + "name": "point" + }, + { + "name": "centroid", + "since": "7.16.0" + } + ], + "name": { + "name": "GridType", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/GridType.ts#L20-L25" + }, + { + "kind": "type_alias", + "name": { + "name": "ZoomLevel", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/ZoomLevel.ts#L22-L22", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } }, { @@ -26886,6 +28899,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about the indices and shards that a search request would be executed against.", "inherits": { "type": { "name": "RequestBase", @@ -26899,6 +28913,7 @@ }, "path": [ { + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": false, "type": { @@ -26912,17 +28927,19 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -26934,39 +28951,43 @@ } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Return local information, do not retrieve the state from master node (default: false)", "name": "local", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specific routing value", "name": "routing", "required": false, "type": { @@ -26977,7 +28998,8 @@ } } } - ] + ], + "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L40" }, { "body": { @@ -26991,7 +29013,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -27050,7 +29072,8 @@ "name": { "name": "Response", "namespace": "_global.search_shards" - } + }, + "specLocation": "_global/search_shards/SearchShardsResponse.ts#L25-L31" }, { "kind": "interface", @@ -27084,7 +29107,8 @@ } } } - ] + ], + "specLocation": "_global/search_shards/SearchShardsResponse.ts#L33-L36" }, { "attachedBehaviors": [ @@ -27094,6 +29118,19 @@ "kind": "properties", "properties": [ { + "name": "explain", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", "name": "id", "required": false, "type": { @@ -27112,7 +29149,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -27123,18 +29160,32 @@ } }, { + "name": "profile", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", "name": "source", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Allows to use the Mustache language to pre-render a search definition.", "inherits": { "type": { "name": "RequestBase", @@ -27148,6 +29199,7 @@ }, "path": [ { + "description": "Comma-separated list of data streams, indices,\nand aliases to search. Supports wildcards (*).", "name": "index", "required": false, "type": { @@ -27159,6 +29211,7 @@ } }, { + "description": "A comma-separated list of document types to search; leave empty to perform the operation on all types", "name": "type", "required": false, "type": { @@ -27172,6 +29225,7 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "serverDefault": true, @@ -27179,11 +29233,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": false, @@ -27191,11 +29246,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -27207,18 +29263,20 @@ } }, { - "description": "server_default false", + "description": "Specify whether to return detailed information about score computation as part of a hit", "name": "explain", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", "name": "ignore_throttled", "required": false, "serverDefault": true, @@ -27226,11 +29284,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "serverDefault": false, @@ -27238,22 +29297,24 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether to profile the query execution", "name": "profile", "required": false, "serverDefault": false, @@ -27261,11 +29322,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -27277,6 +29339,7 @@ } }, { + "description": "Specifies how long a consistent view of the index\nshould be maintained for scrolled search.", "name": "scroll", "required": false, "type": { @@ -27288,6 +29351,7 @@ } }, { + "description": "The type of the search operation.", "name": "search_type", "required": false, "type": { @@ -27300,7 +29364,7 @@ }, { "description": "If true, hits.total are rendered as an integer in the response.", - "name": "total_hits_as_integer", + "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, "since": "7.0.0", @@ -27308,11 +29372,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "name": "typed_keys", "required": false, "serverDefault": false, @@ -27320,23 +29385,24 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/search_template/SearchTemplateRequest.ts#L33-L98" }, { "body": { "kind": "properties", "properties": [ { - "name": "_shards", + "name": "took", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "long", "namespace": "_types" } } @@ -27348,17 +29414,17 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "took", + "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ShardStatistics", "namespace": "_types" } } @@ -27382,6 +29448,157 @@ "namespace": "_global.search._types" } } + }, + { + "name": "aggregations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "AggregateName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Aggregate", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "_clusters", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterStatistics", + "namespace": "_types" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "max_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "num_reduce_phases", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "profile", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Profile", + "namespace": "_global.search._types" + } + } + }, + { + "name": "pit_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "_scroll_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScrollId", + "namespace": "_types" + } + } + }, + { + "name": "suggest", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "SuggestionName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search_template" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Suggest", + "namespace": "_global.search._types" + } + } + } + } + }, + { + "name": "terminated_early", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ] }, @@ -27395,7 +29612,8 @@ "name": { "name": "Response", "namespace": "_global.search_template" - } + }, + "specLocation": "_global/search_template/SearchTemplateResponse.ts#L30-L48" }, { "attachedBehaviors": [ @@ -27420,7 +29638,7 @@ "description": "How many matching terms to return.", "name": "size", "required": false, - "serverDefault": "10", + "serverDefault": 10, "type": { "kind": "instance_of", "type": { @@ -27451,7 +29669,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -27476,7 +29694,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -27487,12 +29705,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", "inherits": { "type": { "name": "RequestBase", @@ -27518,7 +29737,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L65" }, { "body": { @@ -27544,7 +29764,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -27556,7 +29776,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -27566,7 +29786,8 @@ "name": { "name": "Response", "namespace": "_global.terms_enum" - } + }, + "specLocation": "_global/terms_enum/TermsEnumResponse.ts#L22-L28" }, { "kind": "interface", @@ -27608,7 +29829,8 @@ } } } - ] + ], + "specLocation": "_global/termvectors/types.ts#L28-L32" }, { "kind": "interface", @@ -27694,7 +29916,8 @@ } } } - ] + ], + "specLocation": "_global/termvectors/types.ts#L49-L57" }, { "attachedBehaviors": [ @@ -27742,13 +29965,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } ] }, + "description": "Returns information and statistics about terms in the fields of a particular document.", "generics": [ { "name": "TDocument", @@ -27768,6 +29992,7 @@ }, "path": [ { + "description": "The index in which the document resides.", "name": "index", "required": true, "type": { @@ -27779,6 +30004,7 @@ } }, { + "description": "The id of the document, when not specified a doc param should be supplied.", "name": "id", "required": false, "type": { @@ -27790,6 +30016,7 @@ } }, { + "description": "The type of the document.", "name": "type", "required": false, "type": { @@ -27803,6 +30030,7 @@ ], "query": [ { + "description": "A comma-separated list of fields to return.", "name": "fields", "required": false, "type": { @@ -27814,72 +30042,79 @@ } }, { + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", "name": "field_statistics", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if term offsets should be returned.", "name": "offsets", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if term payloads should be returned.", "name": "payloads", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if term positions should be returned.", "name": "positions", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify the node or shard the operation should be performed on (default: random).", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specifies if request is real-time as opposed to near-real-time (default: true).", "name": "realtime", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specific routing value.", "name": "routing", "required": false, "type": { @@ -27891,17 +30126,19 @@ } }, { + "description": "Specifies if total term frequency and document frequency should be returned.", "name": "term_statistics", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -27913,6 +30150,7 @@ } }, { + "description": "Specific version type", "name": "version_type", "required": false, "type": { @@ -27923,7 +30161,8 @@ } } } - ] + ], + "specLocation": "_global/termvectors/TermVectorsRequest.ts#L34-L63" }, { "body": { @@ -27936,7 +30175,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -28023,7 +30262,8 @@ "name": { "name": "Response", "namespace": "_global.termvectors" - } + }, + "specLocation": "_global/termvectors/TermVectorsResponse.ts#L25-L35" }, { "kind": "interface", @@ -28067,7 +30307,7 @@ }, { "name": "tokens", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -28090,7 +30330,8 @@ } } } - ] + ], + "specLocation": "_global/termvectors/types.ts#L34-L40" }, { "kind": "interface", @@ -28118,7 +30359,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -28132,7 +30373,8 @@ } } } - ] + ], + "specLocation": "_global/termvectors/types.ts#L23-L26" }, { "kind": "interface", @@ -28159,7 +30401,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -28185,7 +30427,8 @@ } } } - ] + ], + "specLocation": "_global/termvectors/types.ts#L42-L47" }, { "attachedBehaviors": [ @@ -28195,17 +30438,20 @@ "kind": "properties", "properties": [ { + "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", "name": "detect_noop", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A partial update to an existing document.", "name": "doc", "required": false, "type": { @@ -28217,17 +30463,20 @@ } }, { + "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", "name": "doc_as_upsert", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Script to execute to update the document.", "name": "script", "required": false, "type": { @@ -28239,40 +30488,33 @@ } }, { + "description": "Set to true to execute the script whether or not the document exists.", "name": "scripted_upsert", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", "name": "_source", "required": false, + "serverDefault": "true", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } } }, { + "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", "name": "upsert", "required": false, "type": { @@ -28285,6 +30527,7 @@ } ] }, + "description": "Updates a document with a script or partial document.", "generics": [ { "name": "TDocument", @@ -28308,6 +30551,7 @@ }, "path": [ { + "description": "Document ID", "name": "id", "required": true, "type": { @@ -28319,6 +30563,7 @@ } }, { + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -28330,6 +30575,7 @@ } }, { + "description": "The type of the document", "name": "type", "required": false, "type": { @@ -28343,6 +30589,7 @@ ], "query": [ { + "description": "Only perform the operation if the document has this primary term.", "name": "if_primary_term", "required": false, "type": { @@ -28354,6 +30601,7 @@ } }, { + "description": "Only perform the operation if the document has this sequence number.", "name": "if_seq_no", "required": false, "type": { @@ -28365,19 +30613,23 @@ } }, { + "description": "The script language.", "name": "lang", "required": false, + "serverDefault": "painless", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search, if 'wait_for' then wait for a refresh to make this operation\nvisible to search, if 'false' do nothing with refreshes.", "name": "refresh", "required": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { @@ -28387,28 +30639,33 @@ } }, { + "description": "If true, the destination must be an index alias.", "name": "require_alias", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify how many times should the operation be retried when a conflict occurs.", "name": "retry_on_conflict", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -28420,19 +30677,10 @@ } }, { - "name": "source_enabled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { + "description": "Period to wait for dynamic mapping updates and active shards.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", "name": "timeout", "required": false, + "serverDefault": "1m", "type": { "kind": "instance_of", "type": { @@ -28442,8 +30690,10 @@ } }, { + "description": "The number of shard copies that must be active before proceeding with the operations.\nSet to 'all' or any positive integer up to the total number of shards in the index\n(number_of_replicas+1). Defaults to 1 meaning the primary shard.", "name": "wait_for_active_shards", "required": false, + "serverDefault": "1", "type": { "kind": "instance_of", "type": { @@ -28453,29 +30703,20 @@ } }, { + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", "name": "_source", "required": false, + "serverDefault": "true", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } } }, { + "description": "Specify the source fields you want to exclude.", "name": "_source_excludes", "required": false, "type": { @@ -28487,6 +30728,7 @@ } }, { + "description": "Specify the source fields you want to retrieve.", "name": "_source_includes", "required": false, "type": { @@ -28497,7 +30739,8 @@ } } } - ] + ], + "specLocation": "_global/update/UpdateRequest.ts#L39-L153" }, { "body": { @@ -28541,7 +30784,8 @@ "name": { "name": "Response", "namespace": "_global.update" - } + }, + "specLocation": "_global/update/UpdateResponse.ts#L23-L27" }, { "attachedBehaviors": [ @@ -28607,6 +30851,7 @@ } ] }, + "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", "inherits": { "type": { "name": "RequestBase", @@ -28620,6 +30865,7 @@ }, "path": [ { + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": true, "type": { @@ -28631,6 +30877,7 @@ } }, { + "description": "A comma-separated list of document types to search; leave empty to perform the operation on all types", "name": "type", "required": false, "type": { @@ -28644,39 +30891,43 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The analyzer to use for the query string", "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", "name": "analyze_wildcard", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "What to do when the update by query hits version conflicts?", "name": "conflicts", "required": false, "type": { @@ -28688,28 +30939,31 @@ } }, { + "description": "The default operator for query string query (AND or OR)", "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DefaultOperator", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { + "description": "The field to use as default where no field prefix is given in the query string", "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -28721,6 +30975,7 @@ } }, { + "description": "Starting offset (default: 0)", "name": "from", "required": false, "type": { @@ -28732,83 +30987,79 @@ } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Ingest pipeline to set on index requests made by this action. (default: none)", "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify the node or shard the operation should be performed on (default: random)", "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "query_on_query_string", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Should the affected indexes be refreshed?", "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify if request cache should be used for this request or not, defaults to index level setting", "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle.", "name": "requests_per_second", "required": false, "type": { @@ -28820,6 +31071,7 @@ } }, { + "description": "A comma-separated list of specific routing values", "name": "routing", "required": false, "type": { @@ -28831,6 +31083,7 @@ } }, { + "description": "Specify how long a consistent view of the index should be maintained for scrolled search", "name": "scroll", "required": false, "type": { @@ -28842,6 +31095,7 @@ } }, { + "description": "Size on the scroll request powering the update by query", "name": "scroll_size", "required": false, "type": { @@ -28853,6 +31107,7 @@ } }, { + "description": "Explicit timeout for each search request. Defaults to no timeout.", "name": "search_timeout", "required": false, "type": { @@ -28864,6 +31119,7 @@ } }, { + "description": "Search operation type", "name": "search_type", "required": false, "type": { @@ -28875,6 +31131,7 @@ } }, { + "description": "Deprecated, please use `max_docs` instead", "name": "size", "required": false, "type": { @@ -28886,17 +31143,19 @@ } }, { + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", "name": "slices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Slices", "namespace": "_types" } } }, { + "description": "A comma-separated list of : pairs", "name": "sort", "required": false, "type": { @@ -28905,45 +31164,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "source_enabled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "source_excludes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "name": "source_includes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { + "description": "Specific 'tag' of the request for logging and statistical purposes", "name": "stats", "required": false, "type": { @@ -28952,12 +31179,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "name": "terminate_after", "required": false, "type": { @@ -28969,6 +31197,7 @@ } }, { + "description": "Time each individual bulk request should wait for shards that are unavailable.", "name": "timeout", "required": false, "type": { @@ -28980,28 +31209,31 @@ } }, { + "description": "Specify whether to return document version as part of a hit", "name": "version", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Should the document increment the version number (internal) on hit or not (reindex)", "name": "version_type", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", "name": "wait_for_active_shards", "required": false, "type": { @@ -29013,17 +31245,19 @@ } }, { + "description": "Should the request should block until the update by query operation is complete.", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L38-L87" }, { "body": { @@ -29116,7 +31350,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29192,7 +31426,8 @@ "name": { "name": "Response", "namespace": "_global.update_by_query" - } + }, + "specLocation": "_global/update_by_query/UpdateByQueryResponse.ts#L25-L42" }, { "attachedBehaviors": [ @@ -29201,6 +31436,7 @@ "body": { "kind": "no_body" }, + "description": "Changes the number of requests per second for a particular Update By Query operation.", "inherits": { "type": { "name": "RequestBase", @@ -29214,6 +31450,7 @@ }, "path": [ { + "description": "The task id to rethrottle", "name": "task_id", "required": true, "type": { @@ -29227,6 +31464,7 @@ ], "query": [ { + "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.", "name": "requests_per_second", "required": false, "type": { @@ -29237,7 +31475,8 @@ } } } - ] + ], + "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L36" }, { "body": { @@ -29251,7 +31490,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -29271,7 +31510,8 @@ "name": { "name": "Response", "namespace": "_global.update_by_query_rethrottle" - } + }, + "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleResponse.ts#L23-L25" }, { "inherits": { @@ -29303,12 +31543,13 @@ "kind": "instance_of", "type": { "name": "Info", - "namespace": "task._types" + "namespace": "tasks._types" } } } } - ] + ], + "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts#L25-L27" }, { "kind": "interface", @@ -29325,7 +31566,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -29334,7 +31575,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -29394,7 +31635,58 @@ } } } - ] + ], + "specLocation": "_spec_utils/BaseNode.ts#L25-L32" + }, + { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "generics": [ + { + "name": "T", + "namespace": "_spec_utils" + } + ], + "kind": "type_alias", + "name": { + "name": "Stringified", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/Stringified.ts#L20-L27", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_spec_utils" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The absence of any type. This is commonly used in APIs that don't return a body.\n\nAlthough \"void\" is generally used for the unit type that has only one value, this is to be interpreted as\nthe bottom type that has no value at all. Most languages have a unit type, but few have a bottom type.\n\nSee https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type", + "kind": "type_alias", + "name": { + "name": "Void", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/VoidValue.ts#L20-L28", + "type": { + "kind": "instance_of", + "type": { + "name": "void", + "namespace": "_builtins" + } + } }, { "kind": "interface", @@ -29411,11 +31703,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Base.ts#L49-L52" }, { "description": "The aggregation name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", @@ -29424,14 +31717,37 @@ "name": "AggregateName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L128-L132", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, + { + "kind": "enum", + "members": [ + { + "name": "painless" + }, + { + "name": "expression" + }, + { + "name": "mustache" + }, + { + "name": "java" + } + ], + "name": { + "name": "BuiltinScriptLanguage", + "namespace": "_types" + }, + "specLocation": "_types/Scripting.ts#L30-L35" + }, { "kind": "interface", "name": { @@ -29445,7 +31761,7 @@ "type": { "kind": "instance_of", "type": { - "name": "MainError", + "name": "ErrorCause", "namespace": "_types" } } @@ -29490,11 +31806,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Errors.ts#L58-L64" }, { "kind": "interface", @@ -29521,7 +31838,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29565,7 +31882,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29602,7 +31919,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L40-L50" }, { "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#byte-units", @@ -29611,6 +31929,7 @@ "name": "ByteSize", "namespace": "_types" }, + "specLocation": "_types/common.ts#L91-L92", "type": { "items": [ { @@ -29624,7 +31943,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -29635,43 +31954,35 @@ "kind": "enum", "members": [ { + "codegenName": "bytes", "name": "b" }, { - "name": "k" - }, - { + "codegenName": "kilo_bytes", "name": "kb" }, { - "name": "m" - }, - { + "codegenName": "mega_bytes", "name": "mb" }, { - "name": "g" - }, - { + "codegenName": "giga_bytes", "name": "gb" }, { - "name": "t" - }, - { + "codegenName": "tera_bytes", "name": "tb" }, { - "name": "p" - }, - { + "codegenName": "peta_bytes", "name": "pb" } ], "name": { "name": "Bytes", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L152-L170" }, { "kind": "type_alias", @@ -29679,37 +31990,15 @@ "name": "CategoryId", "namespace": "_types" }, + "specLocation": "_types/common.ts#L52-L52", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, - { - "kind": "interface", - "name": { - "name": "ChainTransform", - "namespace": "_types" - }, - "properties": [ - { - "name": "transforms", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TransformContainer", - "namespace": "_types" - } - } - } - } - ] - }, { "kind": "interface", "name": { @@ -29750,7 +32039,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L26-L30" }, { "kind": "interface", @@ -29803,7 +32093,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L52-L56" }, { "kind": "enum", @@ -29818,65 +32109,108 @@ "name": { "name": "Conflicts", "namespace": "_types" - } - }, - { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html#indices-create-data-stream-api-path-params", - "kind": "type_alias", - "name": { - "name": "DataStreamName", - "namespace": "_types" }, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "specLocation": "_types/common.ts#L172-L175" }, { - "description": "A reference to a date field with formatting instructions on how to return the date", "kind": "interface", "name": { - "name": "DateField", + "name": "CoordsGeoBounds", "namespace": "_types" }, "properties": [ { - "name": "field", + "name": "top", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "double", "namespace": "_types" } } }, { - "name": "format", - "required": false, + "name": "bottom", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "include_unmapped", - "required": false, + "name": "left", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } + }, + { + "name": "right", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/Geo.ts#L135-L140" + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html#indices-create-data-stream-api-path-params", + "kind": "type_alias", + "name": { + "name": "DataStreamName", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L86-L87", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ] + } + }, + { + "kind": "type_alias", + "name": { + "name": "DataStreamNames", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L89-L89", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamName", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataStreamName", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } }, { "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/7.x/mapping-date-format.html", @@ -29885,11 +32219,12 @@ "name": "DateFormat", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L37-L38", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29899,11 +32234,12 @@ "name": "DateMath", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L31-L31", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29913,11 +32249,12 @@ "name": "DateMathTime", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L33-L33", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29927,29 +32264,15 @@ "name": "DateString", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L27-L27", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, - { - "kind": "enum", - "members": [ - { - "name": "AND" - }, - { - "name": "OR" - } - ], - "name": { - "name": "DefaultOperator", - "namespace": "_types" - } - }, { "generics": [ { @@ -29966,7 +32289,8 @@ "name": "DictionaryResponseBase", "namespace": "_types" }, - "properties": [] + "properties": [], + "specLocation": "_types/Base.ts#L54-L54" }, { "kind": "type_alias", @@ -29974,11 +32298,12 @@ "name": "Distance", "namespace": "_types" }, + "specLocation": "_types/Geo.ts#L28-L28", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -29986,37 +32311,47 @@ "kind": "enum", "members": [ { + "codegenName": "inches", "name": "in" }, { + "codegenName": "feet", "name": "ft" }, { + "codegenName": "yards", "name": "yd" }, { + "codegenName": "miles", "name": "mi" }, { + "codegenName": "nautic_miles", "name": "nmi" }, { + "codegenName": "kilometers", "name": "km" }, { + "codegenName": "meters", "name": "m" }, { + "codegenName": "centimeters", "name": "cm" }, { + "codegenName": "millimeters", "name": "mm" } ], "name": { "name": "DistanceUnit", "namespace": "_types" - } + }, + "specLocation": "_types/Geo.ts#L30-L49" }, { "kind": "interface", @@ -30038,7 +32373,7 @@ }, { "name": "deleted", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -30047,7 +32382,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L63-L66" }, { "kind": "interface", @@ -30074,7 +32410,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -30085,7 +32421,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -30096,7 +32432,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -30107,7 +32443,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -30151,11 +32487,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Base.ts#L58-L68" }, { "description": "For empty Class assignments", @@ -30164,7 +32501,8 @@ "name": "EmptyObject", "namespace": "_types" }, - "properties": [] + "properties": [], + "specLocation": "_types/common.ts#L143-L144" }, { "kind": "type_alias", @@ -30172,13 +32510,14 @@ "name": "EpochMillis", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L30-L30", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -30193,6 +32532,30 @@ } }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "description": "Cause and details about a request failure. This class defines the properties common to all error types.\nAdditional details are also provided, that depend on the error type.", "kind": "interface", "name": { "name": "ErrorCause", @@ -30200,69 +32563,49 @@ }, "properties": [ { + "description": "The type of error", "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A human-readable explanation of the error, in english", "name": "reason", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "caused_by", + "description": "The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.", + "name": "stack_trace", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "shard", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "stack_trace", + "name": "caused_by", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ErrorCause", + "namespace": "_types" } } }, @@ -30281,30 +32624,44 @@ } }, { - "name": "bytes_limit", + "name": "suppressed", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } } } - }, + } + ], + "specLocation": "_types/Errors.ts#L25-L48" + }, + { + "description": "The response returned by Elasticsearch when request execution did not succeed.", + "kind": "interface", + "name": { + "name": "ErrorResponseBase", + "namespace": "_types" + }, + "properties": [ { - "name": "bytes_wanted", - "required": false, + "name": "error", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ErrorCause", "namespace": "_types" } } }, { - "name": "column", - "required": false, + "name": "status", + "required": true, "type": { "kind": "instance_of", "type": { @@ -30312,416 +32669,319 @@ "namespace": "_types" } } + } + ], + "specLocation": "_types/Base.ts#L70-L79" + }, + { + "kind": "enum", + "members": [ + { + "description": "Match any data stream or index, including hidden ones.", + "name": "all" }, { - "name": "col", - "required": false, - "type": { + "description": "Match open, non-hidden indices. Also matches any non-hidden data stream.", + "name": "open" + }, + { + "description": "Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.", + "name": "closed" + }, + { + "description": "Match hidden data streams and hidden indices. Must be combined with open, closed, or both.", + "name": "hidden" + }, + { + "description": "Wildcard expressions are not accepted.", + "name": "none" + } + ], + "name": { + "name": "ExpandWildcard", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L184-L198" + }, + { + "kind": "type_alias", + "name": { + "name": "ExpandWildcards", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L200-L200", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "integer", + "name": "ExpandWildcard", "namespace": "_types" } - } - }, - { - "name": "failed_shards", - "required": false, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ShardFailure", + "name": "ExpandWildcard", "namespace": "_types" } } } - }, - { - "name": "grouped", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, + ], + "kind": "union_of" + } + }, + { + "description": "Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.", + "kind": "type_alias", + "name": { + "name": "Field", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L121-L122", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "interface", + "name": { + "name": "FieldMemoryUsage", + "namespace": "_types" + }, + "properties": [ { - "name": "index", + "name": "memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "index_uuid", - "required": false, + "name": "memory_size_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "long", "namespace": "_types" } } - }, - { - "name": "language", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "licensed_expired_feature", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, + } + ], + "specLocation": "_types/Stats.ts#L75-L78" + }, + { + "kind": "interface", + "name": { + "name": "FieldSizeUsage", + "namespace": "_types" + }, + "properties": [ { - "name": "line", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "max_buckets", - "required": false, + "name": "size_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, - { - "name": "phase", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, + } + ], + "specLocation": "_types/Stats.ts#L58-L61" + }, + { + "kind": "interface", + "name": { + "name": "FieldSort", + "namespace": "_types" + }, + "properties": [ { - "name": "property_name", + "name": "missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Missing", + "namespace": "_types.aggregations" } } }, { - "name": "processor_type", + "name": "mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SortMode", + "namespace": "_types" } } }, { - "aliases": [ - "resource.id" - ], - "description": "resource id", - "name": "resource_id", + "name": "nested", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "NestedSortValue", "namespace": "_types" } } }, { - "aliases": [ - "resource.type" - ], - "description": "resource type", - "name": "resource_type", + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SortOrder", + "namespace": "_types" } } }, { - "name": "script", + "name": "unmapped_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "script_stack", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "FieldType", + "namespace": "_types.mapping" } } }, { - "name": "header", + "name": "numeric_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HttpHeaders", + "name": "FieldSortNumericType", "namespace": "_types" } } }, { - "name": "lang", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "position", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PainlessExecutionPosition", - "namespace": "_global.scripts_painless_execute" + "namespace": "_builtins" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "ErrorResponseBase", - "namespace": "_types" - }, - "properties": [ - { - "name": "error", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "MainError", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "status", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] + ], + "shortcutProperty": "order", + "specLocation": "_types/sort.ts#L44-L53" }, { "kind": "enum", "members": [ { - "description": "Match any data stream or index, including hidden ones.", - "name": "all" - }, - { - "description": "Match open, non-hidden indices. Also matches any non-hidden data stream.", - "name": "open" + "name": "long" }, { - "description": "Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.", - "name": "closed" + "name": "double" }, { - "description": "Match hidden data streams and hidden indices. Must be combined with open, closed, or both.", - "name": "hidden" + "name": "date" }, { - "description": "Wildcard expressions are not accepted.", - "name": "none" + "name": "date_nanos" } ], "name": { - "name": "ExpandWildcardOptions", + "name": "FieldSortNumericType", "namespace": "_types" - } + }, + "specLocation": "_types/sort.ts#L37-L42" }, { + "codegenNames": [ + "long", + "double", + "string", + "boolean", + "null", + "any" + ], + "description": "A field value.", "kind": "type_alias", "name": { - "name": "ExpandWildcards", + "name": "FieldValue", "namespace": "_types" }, + "specLocation": "_types/common.ts#L25-L37", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "ExpandWildcardOptions", + "name": "long", "namespace": "_types" } }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcardOptions", - "namespace": "_types" - } - } - }, { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.", - "kind": "type_alias", - "name": { - "name": "Field", - "namespace": "_types" - }, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "interface", - "name": { - "name": "FieldMemoryUsage", - "namespace": "_types" - }, - "properties": [ - { - "name": "memory_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", + "name": "double", "namespace": "_types" } - } - }, - { - "name": "memory_size_in_bytes", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldSizeUsage", - "namespace": "_types" - }, - "properties": [ - { - "name": "size", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } - } - }, - { - "name": "size_in_bytes", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "null", + "namespace": "_builtins" } + }, + { + "kind": "user_defined_value" } - } - ] + ], + "kind": "union_of" + } }, { "kind": "interface", @@ -30785,7 +33045,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L68-L73" }, { "kind": "type_alias", @@ -30793,6 +33054,7 @@ "name": "Fields", "namespace": "_types" }, + "specLocation": "_types/common.ts#L123-L123", "type": { "items": [ { @@ -30852,7 +33114,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -30867,7 +33129,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L80-L85" }, { "kind": "type_alias", @@ -30875,13 +33138,14 @@ "name": "Fuzziness", "namespace": "_types" }, + "specLocation": "_types/common.ts#L117-L117", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -30895,6 +33159,161 @@ "kind": "union_of" } }, + { + "codegenNames": [ + "coords", + "tlbr", + "trbl", + "wkt" + ], + "description": "A geo bounding box. It can be represented in various ways:\n- as 4 top/bottom/left/right coordinates\n- as 2 top_left / bottom_right points\n- as 2 top_right / bottom_left points\n- as a WKT bounding box", + "kind": "type_alias", + "name": { + "name": "GeoBounds", + "namespace": "_types" + }, + "specLocation": "_types/Geo.ts#L116-L129", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CoordsGeoBounds", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TopLeftBottomRightGeoBounds", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TopRightBottomLeftGeoBounds", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WktGeoBounds", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], + "kind": "interface", + "name": { + "name": "GeoDistanceSort", + "namespace": "_types" + }, + "properties": [ + { + "name": "mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortMode", + "namespace": "_types" + } + } + }, + { + "name": "distance_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoDistanceType", + "namespace": "_types" + } + } + }, + { + "name": "ignore_unmapped", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } + } + }, + { + "name": "unit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DistanceUnit", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/sort.ts#L58-L66" + }, { "kind": "enum", "members": [ @@ -30908,20 +33327,167 @@ "name": { "name": "GeoDistanceType", "namespace": "_types" - } + }, + "specLocation": "_types/Geo.ts#L51-L54" }, { "kind": "type_alias", "name": { - "name": "GeoHashPrecision", + "name": "GeoHash", "namespace": "_types" }, + "specLocation": "_types/Geo.ts#L81-L81", "type": { "kind": "instance_of", "type": { - "name": "number", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "interface", + "name": { + "name": "GeoHashLocation", + "namespace": "_types" + }, + "properties": [ + { + "name": "geohash", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoHash", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/Geo.ts#L112-L114" + }, + { + "codegenNames": [ + "geohash_length", + "distance" + ], + "description": "A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like \"1km\", \"10m\".", + "kind": "type_alias", + "name": { + "name": "GeoHashPrecision", + "namespace": "_types" + }, + "specLocation": "_types/Geo.ts#L76-L80", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "A GeoJson GeoLine.", + "kind": "interface", + "name": { + "name": "GeoLine", + "namespace": "_types" + }, + "properties": [ + { + "description": "Always `\"LineString\"`", + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Array of `[lon, lat]` coordinates", + "name": "coordinates", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + } } + ], + "specLocation": "_types/Geo.ts#L59-L65" + }, + { + "codegenNames": [ + "latlon", + "geohash", + "coords", + "text" + ], + "description": "A latitude/longitude as a 2 dimensional point. It can be represented in various ways:\n- as a `{lat, long}` object\n- as a geo hash value\n- as a `[lon, lat]` array\n- as a string in `\", \"` or WKT point formats", + "kind": "type_alias", + "name": { + "name": "GeoLocation", + "namespace": "_types" + }, + "specLocation": "_types/Geo.ts#L91-L105", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "LatLonGeoLocation", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoHashLocation", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { @@ -30931,6 +33497,7 @@ "name": "GeoShape", "namespace": "_types" }, + "specLocation": "_types/Geo.ts#L56-L57", "type": { "kind": "user_defined_value" } @@ -30954,6 +33521,23 @@ "name": { "name": "GeoShapeRelation", "namespace": "_types" + }, + "specLocation": "_types/Geo.ts#L67-L72" + }, + { + "description": "A map tile reference, represented as `{zoom}/{x}/{y}`", + "kind": "type_alias", + "name": { + "name": "GeoTile", + "namespace": "_types" + }, + "specLocation": "_types/Geo.ts#L83-L84", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { @@ -30962,11 +33546,12 @@ "name": "GeoTilePrecision", "namespace": "_types" }, + "specLocation": "_types/Geo.ts#L74-L74", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -30995,7 +33580,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31028,7 +33613,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31061,7 +33646,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31087,46 +33672,39 @@ } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "nodes" - }, - { - "name": "parents" - }, - { - "name": "none" - } ], - "name": { - "name": "GroupBy", - "namespace": "_types" - } + "specLocation": "_types/Stats.ts#L87-L98" }, { "kind": "enum", "members": [ { + "aliases": [ + "GREEN" + ], "description": "All shards are assigned.", "name": "green" }, { + "aliases": [ + "YELLOW" + ], "description": "All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.", "name": "yellow" }, { + "aliases": [ + "RED" + ], "description": "One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.", "name": "red" } ], "name": { - "name": "Health", + "name": "HealthStatus", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L202-L222" }, { "kind": "type_alias", @@ -31134,11 +33712,12 @@ "name": "Host", "namespace": "_types" }, + "specLocation": "_types/Networking.ts#L21-L21", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31148,12 +33727,13 @@ "name": "HttpHeaders", "namespace": "_types" }, + "specLocation": "_types/common.ts#L141-L141", "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -31164,7 +33744,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -31173,7 +33753,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -31188,11 +33768,12 @@ "name": "Id", "namespace": "_types" }, + "specLocation": "_types/common.ts#L55-L55", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31202,6 +33783,7 @@ "name": "Ids", "namespace": "_types" }, + "specLocation": "_types/common.ts#L56-L56", "type": { "items": [ { @@ -31231,11 +33813,12 @@ "name": "IndexAlias", "namespace": "_types" }, + "specLocation": "_types/common.ts#L62-L62", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31245,11 +33828,12 @@ "name": "IndexName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L60-L60", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31259,11 +33843,12 @@ "name": "IndexPattern", "namespace": "_types" }, + "specLocation": "_types/common.ts#L63-L63", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31273,6 +33858,7 @@ "name": "IndexPatterns", "namespace": "_types" }, + "specLocation": "_types/common.ts#L64-L64", "type": { "kind": "array_of", "value": { @@ -31284,32 +33870,6 @@ } } }, - { - "inherits": { - "type": { - "name": "ScriptBase", - "namespace": "_types" - } - }, - "kind": "interface", - "name": { - "name": "IndexedScript", - "namespace": "_types" - }, - "properties": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ] - }, { "kind": "interface", "name": { @@ -31346,7 +33906,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31379,7 +33939,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31401,7 +33961,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31423,7 +33983,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31468,7 +34028,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -31482,7 +34042,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L100-L115" }, { "kind": "type_alias", @@ -31490,13 +34051,14 @@ "name": "Indices", "namespace": "_types" }, + "specLocation": "_types/common.ts#L61-L61", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } }, { @@ -31504,8 +34066,8 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } } @@ -31513,6 +34075,67 @@ "kind": "union_of" } }, + { + "description": "Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded\nto actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.", + "kind": "interface", + "name": { + "name": "IndicesOptions", + "namespace": "_types" + }, + "properties": [ + { + "description": "If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only\nmissing or closed indices. This behavior applies even if the request targets other open indices. For example,\na request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "If true, missing or closed indices are not included in the response.", + "name": "ignore_unavailable", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", + "name": "ignore_throttled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/common.ts#L298-L325" + }, { "inherits": { "type": { @@ -31537,9 +34160,33 @@ } } } - ] + ], + "specLocation": "_types/Base.ts#L81-L83" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], "generics": [ { "name": "TDocument", @@ -31560,7 +34207,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -31577,13 +34224,13 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "_seq_no", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -31594,7 +34241,7 @@ }, { "name": "_primary_term", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -31625,7 +34272,8 @@ } } } - ] + ], + "specLocation": "_types/common.ts#L287-L296" }, { "inherits": { @@ -31640,6 +34288,39 @@ "namespace": "_types" }, "properties": [ + { + "name": "lang", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScriptLanguage", + "namespace": "_types" + } + } + }, + { + "name": "options", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, { "name": "source", "required": true, @@ -31647,11 +34328,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "shortcutProperty": "source", + "specLocation": "_types/Scripting.ts#L47-L52" }, { "kind": "type_alias", @@ -31659,18 +34342,19 @@ "name": "Ip", "namespace": "_types" }, + "specLocation": "_types/Networking.ts#L20-L20", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "kind": "interface", "name": { - "name": "LatLon", + "name": "LatLonGeoLocation", "namespace": "_types" }, "properties": [ @@ -31696,7 +34380,8 @@ } } } - ] + ], + "specLocation": "_types/Geo.ts#L107-L110" }, { "kind": "enum", @@ -31714,7 +34399,8 @@ "name": { "name": "Level", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L232-L236" }, { "kind": "enum", @@ -31732,44 +34418,23 @@ "name": { "name": "LifecycleOperationMode", "namespace": "_types" - } + }, + "specLocation": "_types/Lifecycle.ts#L20-L24" }, { - "inherits": { - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "MainError", + "name": "MapboxVectorTiles", "namespace": "_types" }, - "properties": [ - { - "name": "headers", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } + "specLocation": "_types/Binary.ts#L21-L21", + "type": { + "kind": "instance_of", + "type": { + "name": "binary", + "namespace": "_builtins" } - ] + } }, { "kind": "interface", @@ -31807,7 +34472,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31840,7 +34505,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31873,7 +34538,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31895,7 +34560,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31917,7 +34582,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31939,7 +34604,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -31954,7 +34619,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L117-L134" }, { "kind": "type_alias", @@ -31962,12 +34628,13 @@ "name": "Metadata", "namespace": "_types" }, + "specLocation": "_types/common.ts#L94-L94", "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -31983,13 +34650,14 @@ "name": "Metrics", "namespace": "_types" }, + "specLocation": "_types/common.ts#L73-L73", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -31998,7 +34666,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -32014,6 +34682,7 @@ "name": "MinimumShouldMatch", "namespace": "_types" }, + "specLocation": "_types/common.ts#L146-L150", "type": { "items": [ { @@ -32027,7 +34696,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -32041,11 +34710,12 @@ "name": "MultiTermQueryRewrite", "namespace": "_types" }, + "specLocation": "_types/common.ts#L118-L119", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32055,11 +34725,12 @@ "name": "Name", "namespace": "_types" }, + "specLocation": "_types/common.ts#L75-L75", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32069,13 +34740,14 @@ "name": "Names", "namespace": "_types" }, + "specLocation": "_types/common.ts#L76-L76", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } }, { @@ -32083,8 +34755,8 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } } @@ -32098,14 +34770,69 @@ "name": "Namespace", "namespace": "_types" }, + "specLocation": "_types/common.ts#L78-L78", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, + { + "kind": "interface", + "name": { + "name": "NestedSortValue", + "namespace": "_types" + }, + "properties": [ + { + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "max_children", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "nested", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NestedSortValue", + "namespace": "_types" + } + } + }, + { + "name": "path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/sort.ts#L30-L35" + }, { "kind": "interface", "name": { @@ -32122,7 +34849,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -32131,7 +34858,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -32155,7 +34882,7 @@ "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "NodeId", "namespace": "_types" } } @@ -32194,8 +34921,21 @@ "namespace": "_types" } } + }, + { + "name": "external_id", + "required": true, + "since": "8.3.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_types/Node.ts#L38-L54" }, { "kind": "type_alias", @@ -32203,11 +34943,12 @@ "name": "NodeId", "namespace": "_types" }, + "specLocation": "_types/common.ts#L57-L57", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32217,12 +34958,28 @@ "name": "NodeIds", "namespace": "_types" }, + "specLocation": "_types/common.ts#L58-L58", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" } }, { @@ -32232,11 +34989,12 @@ "name": "NodeName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L83-L84", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32289,7 +35047,8 @@ "name": { "name": "NodeRole", "namespace": "_types" - } + }, + "specLocation": "_types/Node.ts#L68-L86" }, { "description": "* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html#node-roles", @@ -32298,6 +35057,7 @@ "name": "NodeRoles", "namespace": "_types" }, + "specLocation": "_types/Node.ts#L88-L91", "type": { "kind": "array_of", "value": { @@ -32334,7 +35094,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32379,7 +35139,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -32401,7 +35161,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -32425,8 +35185,32 @@ "namespace": "cluster.allocation_explain" } } + }, + { + "name": "relocating_node", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } - ] + ], + "specLocation": "_types/Node.ts#L56-L66" }, { "kind": "interface", @@ -32485,7 +35269,8 @@ } } } - ] + ], + "specLocation": "_types/Node.ts#L28-L36" }, { "kind": "enum", @@ -32500,7 +35285,8 @@ "name": { "name": "OpType", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L238-L241" }, { "kind": "type_alias", @@ -32508,11 +35294,12 @@ "name": "Password", "namespace": "_types" }, + "specLocation": "_types/common.ts#L178-L178", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32522,13 +35309,14 @@ "name": "Percentage", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L28-L28", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -32548,11 +35336,12 @@ "name": "PipelineName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L81-L81", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32570,7 +35359,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32581,7 +35370,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32605,7 +35394,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -32617,7 +35406,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32661,7 +35450,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32672,11 +35461,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Stats.ts#L136-L147" }, { "kind": "type_alias", @@ -32684,11 +35474,12 @@ "name": "PropertyName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L114-L114", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32787,7 +35578,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L149-L158" }, { "kind": "interface", @@ -32825,7 +35617,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32840,45 +35632,28 @@ } } } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "Refresh", - "namespace": "_types" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RefreshOptions", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } + ], + "specLocation": "_types/Stats.ts#L160-L165" }, { + "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.", "kind": "enum", "members": [ + { + "name": "true" + }, + { + "name": "false" + }, { "name": "wait_for" } ], "name": { - "name": "RefreshOptions", + "name": "Refresh", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L243-L250" }, { "kind": "interface", @@ -32938,7 +35713,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32953,7 +35728,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L167-L174" }, { "kind": "type_alias", @@ -32961,11 +35737,12 @@ "name": "RelationName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L115-L115", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -32986,7 +35763,8 @@ "name": "RequestBase", "namespace": "_types" }, - "properties": [] + "properties": [], + "specLocation": "_types/Base.ts#L35-L35" }, { "kind": "interface", @@ -33024,7 +35802,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -33050,14 +35828,12 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L176-L182" }, { "kind": "enum", "members": [ - { - "name": "Error" - }, { "name": "created" }, @@ -33071,13 +35847,15 @@ "name": "not_found" }, { + "codegenName": "no_op", "name": "noop" } ], "name": { "name": "Result", "namespace": "_types" - } + }, + "specLocation": "_types/Result.ts#L20-L27" }, { "kind": "interface", @@ -33108,7 +35886,8 @@ } } } - ] + ], + "specLocation": "_types/Retries.ts#L22-L25" }, { "kind": "type_alias", @@ -33116,20 +35895,47 @@ "name": "Routing", "namespace": "_types" }, + "specLocation": "_types/common.ts#L69-L69", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "kind": "interface", + "name": { + "name": "ScoreSort", + "namespace": "_types" + }, + "properties": [ + { + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/sort.ts#L55-L57" + }, + { + "codegenNames": [ + "inline", + "stored" + ], "kind": "type_alias", "name": { "name": "Script", "namespace": "_types" }, + "specLocation": "_types/Scripting.ts#L58-L59", "type": { "items": [ { @@ -33142,16 +35948,9 @@ { "kind": "instance_of", "type": { - "name": "IndexedScript", + "name": "StoredScriptId", "namespace": "_types" } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } } ], "kind": "union_of" @@ -33164,17 +35963,6 @@ "namespace": "_types" }, "properties": [ - { - "name": "lang", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ScriptLanguage", - "namespace": "_types" - } - } - }, { "name": "params", "required": false, @@ -33183,7 +35971,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -33193,7 +35981,8 @@ } } } - ] + ], + "specLocation": "_types/Scripting.ts#L43-L45" }, { "kind": "interface", @@ -33220,32 +36009,128 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Scripting.ts#L61-L64" }, { - "kind": "enum", - "members": [ + "codegenNames": [ + "builtin", + "custom" + ], + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "kind": "type_alias", + "name": { + "name": "ScriptLanguage", + "namespace": "_types" + }, + "specLocation": "_types/Scripting.ts#L24-L28", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "BuiltinScriptLanguage", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "ScriptSort", + "namespace": "_types" + }, + "properties": [ { - "name": "painless" + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } + } }, { - "name": "expression" + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } }, { - "name": "mustache" + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScriptSortType", + "namespace": "_types" + } + } }, { - "name": "java" + "name": "mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortMode", + "namespace": "_types" + } + } + }, + { + "name": "nested", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NestedSortValue", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/sort.ts#L68-L74" + }, + { + "kind": "enum", + "members": [ + { + "name": "string" + }, + { + "name": "number" + }, + { + "name": "version" } ], "name": { - "name": "ScriptLanguage", + "name": "ScriptSortType", "namespace": "_types" - } + }, + "specLocation": "_types/sort.ts#L76-L80" }, { "kind": "interface", @@ -33261,7 +36146,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -33273,7 +36158,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -33283,7 +36168,8 @@ } } } - ] + ], + "specLocation": "_types/Transform.ts#L36-L39" }, { "kind": "type_alias", @@ -33291,11 +36177,12 @@ "name": "ScrollId", "namespace": "_types" }, + "specLocation": "_types/common.ts#L49-L49", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -33457,7 +36344,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -33471,7 +36358,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L184-L199" }, { "kind": "interface", @@ -33502,7 +36390,8 @@ } } } - ] + ], + "specLocation": "_types/Transform.ts#L41-L44" }, { "kind": "enum", @@ -33519,7 +36408,8 @@ "name": { "name": "SearchType", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L252-L257" }, { "kind": "interface", @@ -33569,7 +36459,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -33644,7 +36534,7 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -33803,7 +36693,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L201-L226" }, { "kind": "type_alias", @@ -33811,10 +36702,11 @@ "name": "SequenceNumber", "namespace": "_types" }, + "specLocation": "_types/common.ts#L112-L112", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } @@ -33825,30 +36717,13 @@ "name": "Service", "namespace": "_types" }, + "specLocation": "_types/common.ts#L79-L79", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "intersects" - }, - { - "name": "disjoint" - }, - { - "name": "within" + "namespace": "_builtins" } - ], - "name": { - "name": "ShapeRelation", - "namespace": "_types" } }, { @@ -33876,7 +36751,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -33909,11 +36784,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Errors.ts#L50-L56" }, { "kind": "interface", @@ -33980,7 +36856,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L32-L38" }, { "kind": "interface", @@ -34000,76 +36877,302 @@ } } } - ] + ], + "specLocation": "_types/Base.ts#L85-L87" + }, + { + "kind": "interface", + "name": { + "name": "SlicedScroll", + "namespace": "_types" + }, + "properties": [ + { + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/SlicedScroll.ts#L23-L27" + }, + { + "codegenNames": [ + "value", + "computed" + ], + "description": "Slices configuration used to parallelize a process.", + "kind": "type_alias", + "name": { + "name": "Slices", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L327-L332", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SlicesCalculation", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } }, { "kind": "enum", "members": [ { - "name": "Raw" - }, + "description": "Let Elasticsearch choose a reasonable number for most data streams and indices.", + "name": "auto" + } + ], + "name": { + "name": "SlicesCalculation", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L334-L342" + }, + { + "kind": "type_alias", + "name": { + "name": "Sort", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L99-L99", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SortCombinations", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SortCombinations", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "codegenNames": [ + "field", + "options" + ], + "kind": "type_alias", + "name": { + "name": "SortCombinations", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L93-L97", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SortOptions", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ { - "name": "k" + "name": "min" }, { - "name": "m" + "name": "max" }, { - "name": "g" + "name": "sum" }, { - "name": "t" + "name": "avg" }, { - "name": "p" + "name": "median" } ], "name": { - "name": "Size", + "name": "SortMode", "namespace": "_types" - } + }, + "specLocation": "_types/sort.ts#L103-L112" }, { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FieldSort", + "namespace": "_types" + } + } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", "kind": "interface", "name": { - "name": "SlicedScroll", + "name": "SortOptions", "namespace": "_types" }, "properties": [ { - "name": "field", + "name": "_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "ScoreSort", "namespace": "_types" } } }, { - "name": "id", - "required": true, + "name": "_doc", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ScoreSort", "namespace": "_types" } } }, { - "name": "max", - "required": true, + "name": "_geo_distance", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "GeoDistanceSort", + "namespace": "_types" + } + } + }, + { + "name": "_script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScriptSort", "namespace": "_types" } } } - ] + ], + "specLocation": "_types/sort.ts#L82-L91", + "variants": { + "kind": "container" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "asc" + }, + { + "name": "desc" + } + ], + "name": { + "name": "SortOrder", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L114-L117" + }, + { + "kind": "type_alias", + "name": { + "name": "SortResults", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L101-L101", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + } }, { "kind": "interface", @@ -34144,7 +37247,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L228-L235" }, { "kind": "interface", @@ -34155,7 +37259,7 @@ "properties": [ { "name": "lang", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -34164,6 +37268,28 @@ } } }, + { + "name": "options", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, { "name": "source", "required": true, @@ -34171,11 +37297,39 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/Scripting.ts#L37-L41" + }, + { + "inherits": { + "type": { + "name": "ScriptBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "StoredScriptId", + "namespace": "_types" + }, + "properties": [ + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/Scripting.ts#L54-L56" }, { "kind": "enum", @@ -34193,7 +37347,8 @@ "name": { "name": "SuggestMode", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L259-L263" }, { "description": "The suggestion name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", @@ -34202,11 +37357,12 @@ "name": "SuggestionName", "namespace": "_types" }, + "specLocation": "_types/common.ts#L134-L138", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34216,13 +37372,14 @@ "name": "TaskId", "namespace": "_types" }, + "specLocation": "_types/common.ts#L116-L116", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -34252,23 +37409,29 @@ "name": { "name": "ThreadType", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L265-L269" }, { + "codegenNames": [ + "time", + "offset" + ], "description": "Whenever durations need to be specified, e.g. for a timeout parameter, the duration must specify the unit, like 2d for 2 days.", - "docUrl": "https://github.com/elastic/elasticsearch/blob/master/libs/core/src/main/java/org/elasticsearch/common/unit/TimeValue.java\nhttps://github.com/elastic/elasticsearch/blob/master/libs/core/src/main/java/org/elasticsearch/common/unit/TimeValue.java\nOnly support 0 and -1 but we have no way to encode these as constants at the moment", + "docUrl": "https://github.com/elastic/elasticsearch/blob/master/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java", "kind": "type_alias", "name": { "name": "Time", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L62-L68", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -34288,25 +37451,65 @@ "name": "TimeSpan", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L29-L29", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, + { + "kind": "enum", + "members": [ + { + "codegenName": "nanoseconds", + "name": "nanos" + }, + { + "codegenName": "microseconds", + "name": "micros" + }, + { + "codegenName": "milliseconds", + "name": "ms" + }, + { + "codegenName": "seconds", + "name": "s" + }, + { + "codegenName": "minutes", + "name": "m" + }, + { + "codegenName": "hours", + "name": "h" + }, + { + "codegenName": "days", + "name": "d" + } + ], + "name": { + "name": "TimeUnit", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L70-L85" + }, { "kind": "type_alias", "name": { "name": "TimeZone", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L35-L35", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34316,21 +37519,78 @@ "name": "Timestamp", "namespace": "_types" }, + "specLocation": "_types/Time.ts#L28-L28", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "kind": "interface", "name": { - "name": "Transform", + "name": "TopLeftBottomRightGeoBounds", + "namespace": "_types" + }, + "properties": [ + { + "name": "top_left", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + }, + { + "name": "bottom_right", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/Geo.ts#L142-L145" + }, + { + "kind": "interface", + "name": { + "name": "TopRightBottomLeftGeoBounds", "namespace": "_types" }, - "properties": [] + "properties": [ + { + "name": "top_right", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + }, + { + "name": "bottom_left", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/Geo.ts#L147-L150" }, { "kind": "interface", @@ -34343,10 +37603,13 @@ "name": "chain", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "ChainTransform", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TransformContainer", + "namespace": "_types" + } } } }, @@ -34373,6 +37636,7 @@ } } ], + "specLocation": "_types/Transform.ts#L27-L34", "variants": { "kind": "container" } @@ -34413,7 +37677,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34446,7 +37710,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34461,7 +37725,8 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L237-L245" }, { "kind": "type_alias", @@ -34469,11 +37734,12 @@ "name": "TransportAddress", "namespace": "_types" }, + "specLocation": "_types/Networking.ts#L22-L22", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34483,11 +37749,12 @@ "name": "Type", "namespace": "_types" }, + "specLocation": "_types/common.ts#L66-L66", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34497,6 +37764,7 @@ "name": "Types", "namespace": "_types" }, + "specLocation": "_types/common.ts#L67-L67", "type": { "items": [ { @@ -34526,11 +37794,12 @@ "name": "Username", "namespace": "_types" }, + "specLocation": "_types/common.ts#L177-L177", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34540,11 +37809,12 @@ "name": "Uuid", "namespace": "_types" }, + "specLocation": "_types/common.ts#L109-L109", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34554,6 +37824,7 @@ "name": "VersionNumber", "namespace": "_types" }, + "specLocation": "_types/common.ts#L97-L97", "type": { "kind": "instance_of", "type": { @@ -34568,11 +37839,12 @@ "name": "VersionString", "namespace": "_types" }, + "specLocation": "_types/common.ts#L99-L99", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34595,26 +37867,36 @@ "name": { "name": "VersionType", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L101-L106" }, { "kind": "enum", "members": [ { "name": "all" + }, + { + "name": "index-setting" } ], "name": { "name": "WaitForActiveShardOptions", "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L272-L275" }, { + "codegenNames": [ + "count", + "option" + ], "kind": "type_alias", "name": { "name": "WaitForActiveShards", "namespace": "_types" }, + "specLocation": "_types/common.ts#L125-L126", "type": { "items": [ { @@ -34660,25 +37942,8 @@ "name": { "name": "WaitForEvents", "namespace": "_types" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "green" - }, - { - "name": "yellow" - }, - { - "name": "red" - } - ], - "name": { - "name": "WaitForStatus", - "namespace": "_types" - } + }, + "specLocation": "_types/common.ts#L277-L284" }, { "kind": "interface", @@ -34716,7 +37981,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34731,7 +37996,29 @@ } } } - ] + ], + "specLocation": "_types/Stats.ts#L247-L252" + }, + { + "kind": "interface", + "name": { + "name": "WktGeoBounds", + "namespace": "_types" + }, + "properties": [ + { + "name": "wkt", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/Geo.ts#L131-L133" }, { "kind": "interface", @@ -34835,11 +38122,27 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/Base.ts#L37-L47" + }, + { + "kind": "type_alias", + "name": { + "name": "byte", + "namespace": "_types" + }, + "specLocation": "_types/Numeric.ts#L21-L21", + "type": { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" + } + } }, { "kind": "type_alias", @@ -34847,11 +38150,12 @@ "name": "double", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L27-L27", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34861,11 +38165,12 @@ "name": "float", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L26-L26", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34875,11 +38180,12 @@ "name": "integer", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L22-L22", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34889,11 +38195,27 @@ "name": "long", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L24-L24", + "type": { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "short", + "namespace": "_types" + }, + "specLocation": "_types/Numeric.ts#L20-L20", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34903,11 +38225,12 @@ "name": "uint", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L23-L23", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -34917,14 +38240,40 @@ "name": "ulong", "namespace": "_types" }, + "specLocation": "_types/Numeric.ts#L25-L25", "type": { "kind": "instance_of", "type": { "name": "number", - "namespace": "internal" + "namespace": "_builtins" } } }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "AdjacencyMatrixBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AdjacencyMatrixAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L556-L558", + "variantName": "adjacency_matrix" + }, { "inherits": { "type": { @@ -34946,7 +38295,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -34960,7 +38309,38 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L48-L50" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AdjacencyMatrixBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L560-L562" }, { "kind": "type_alias", @@ -34968,12 +38348,174 @@ "name": "Aggregate", "namespace": "_types.aggregations" }, + "specLocation": "_types/aggregations/Aggregate.ts#L31-L113", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SingleBucketAggregate", + "name": "CardinalityAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HdrPercentilesAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HdrPercentileRanksAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TDigestPercentilesAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TDigestPercentileRanksAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PercentilesBucketAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MedianAbsoluteDeviationAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MinAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MaxAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SumAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "AvgAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WeightedAvgAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ValueCountAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SimpleValueAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DerivativeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "BucketMetricValueAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StatsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StatsBucketAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ExtendedStatsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ExtendedStatsBucketAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoBoundsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoCentroidAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HistogramAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateHistogramAggregate", "namespace": "_types.aggregations" } }, @@ -34984,6 +38526,174 @@ "namespace": "_types.aggregations" } }, + { + "kind": "instance_of", + "type": { + "name": "VariableWidthHistogramAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StringTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LongTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DoubleTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UnmappedTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LongRareTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StringRareTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UnmappedRareTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MultiTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MissingAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NestedAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ReverseNestedAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GlobalAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FilterAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ChildrenAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ParentAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SamplerAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UnmappedSamplerAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoHashGridAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoTileGridAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateRangeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoDistanceAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IpRangeAggregate", + "namespace": "_types.aggregations" + } + }, { "kind": "instance_of", "type": { @@ -34992,82 +38702,123 @@ } }, { - "generics": [ - { - "kind": "user_defined_value" - } - ], "kind": "instance_of", "type": { - "name": "SignificantTermsAggregate", + "name": "AdjacencyMatrixAggregate", "namespace": "_types.aggregations" } }, { - "generics": [ - { - "kind": "user_defined_value" - } - ], "kind": "instance_of", "type": { - "name": "TermsAggregate", + "name": "SignificantLongTermsAggregate", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "BucketAggregate", + "name": "SignificantStringTermsAggregate", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "CompositeBucketAggregate", + "name": "UnmappedSignificantTermsAggregate", "namespace": "_types.aggregations" } }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Bucket", - "namespace": "_types.aggregations" - } - } - ], "kind": "instance_of", "type": { - "name": "MultiBucketAggregate", + "name": "CompositeAggregate", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "MatrixStatsAggregate", + "name": "ScriptedMetricAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TopHitsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "InferenceAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StringStatsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "BoxPlotAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TopMetricsAggregate", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "KeyedValueAggregate", + "name": "TTestAggregate", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "MetricAggregate", + "name": "RateAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CumulativeCardinalityAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MatrixStatsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoLineAggregate", "namespace": "_types.aggregations" } } ], "kind": "union_of" + }, + "variants": { + "kind": "external_tag", + "nonExhaustive": true } }, { @@ -35085,7 +38836,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -35095,7 +38846,60 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L124-L126" + }, + { + "kind": "type_alias", + "name": { + "name": "AggregateOrder", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L370-L372", + "type": { + "items": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } + } + }, + { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } + } + } + } + ], + "kind": "union_of" + } }, { "kind": "interface", @@ -35112,7 +38916,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -35129,11 +38933,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregation.ts#L23-L26" }, { "kind": "interface", @@ -35143,15 +38948,19 @@ }, "properties": [ { + "aliases": [ + "aggs" + ], "containerProperty": true, - "name": "aggs", + "description": "Sub-aggregations for this aggregation. Only applies to bucket aggregations.", + "name": "aggregations", "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -35174,7 +38983,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -35195,28 +39004,6 @@ } } }, - { - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, { "name": "auto_date_histogram", "required": false, @@ -35977,8 +39764,10 @@ } } ], + "specLocation": "_types/aggregations/AggregationContainer.ts#L99-L186", "variants": { - "kind": "container" + "kind": "container", + "nonExhaustive": true } }, { @@ -36004,7 +39793,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -36018,7 +39807,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -36038,37 +39827,84 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], "kind": "union_of" } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L268-L272" }, { - "inherits": { - "generics": [ - { - "generics": [ + "kind": "interface", + "name": { + "name": "ArrayPercentilesItem", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "value", + "required": true, + "type": { + "items": [ { "kind": "instance_of", "type": { - "name": "long", + "name": "double", "namespace": "_types" } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } ], + "kind": "union_of" + } + }, + { + "name": "value_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L150-L154" + }, + { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "KeyedBucket", + "name": "DateHistogramBucket", "namespace": "_types.aggregations" } } ], "type": { - "name": "MultiBucketAggregate", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, @@ -36089,7 +39925,9 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L346-L350", + "variantName": "auto_date_histogram" }, { "inherits": { @@ -36133,7 +39971,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -36166,7 +40004,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -36178,7 +40016,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -36206,11 +40044,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L52-L62" }, { "inherits": { @@ -36224,7 +40063,8 @@ "name": "AverageAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L48-L48" }, { "inherits": { @@ -36238,7 +40078,24 @@ "name": "AverageBucketAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L58-L58" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AvgAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L199-L200", + "variantName": "avg" }, { "inherits": { @@ -36307,25 +40164,10 @@ "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "BoxplotAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "compression", - "required": false, + "name": "lower", + "required": true, "type": { "kind": "instance_of", "type": { @@ -36333,192 +40175,128 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "Bucket", - "namespace": "_types.aggregations" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CompositeBucket", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateHistogramBucket", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FiltersBucketItem", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "IpRangeBucket", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RangeBucket", - "namespace": "_types.aggregations" - } - }, - { - "generics": [ - { - "kind": "user_defined_value" - } - ], - "kind": "instance_of", - "type": { - "name": "RareTermsBucket", - "namespace": "_types.aggregations" - } - }, - { - "generics": [ - { - "kind": "user_defined_value" - } - ], + }, + { + "name": "upper", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "SignificantTermsBucket", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } - }, - { - "generics": [ - { - "kind": "user_defined_value" - } - ], + } + }, + { + "name": "min_as_string", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KeyedBucket", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "BucketAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "after_key", - "required": true, + "name": "max_as_string", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "bg_count", - "required": true, + "name": "q1_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "doc_count", - "required": true, + "name": "q2_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "doc_count_error_upper_bound", - "required": true, + "name": "q3_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "sum_other_doc_count", - "required": true, + "name": "lower_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "interval", - "required": true, + "name": "upper_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateMathTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L671-L687", + "variantName": "box_plot" + }, + { + "inherits": { + "type": { + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BoxplotAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "items", - "required": true, + "name": "compression", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bucket", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L50-L52" }, { + "description": "Base type for bucket aggregations. These aggregations also accept sub-aggregations.", "inherits": { "type": { "name": "Aggregation", @@ -36530,30 +40308,39 @@ "name": "BucketAggregationBase", "namespace": "_types.aggregations" }, + "properties": [], + "specLocation": "_types/aggregations/bucket.ts#L41-L46" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BucketMetricValueAggregate", + "namespace": "_types.aggregations" + }, "properties": [ { - "name": "aggregations", - "required": false, + "name": "keys", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L223-L226", + "variantName": "bucket_metric_value" }, { "inherits": { @@ -36579,7 +40366,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L60-L62" }, { "inherits": { @@ -36605,7 +40393,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L64-L66" }, { "inherits": { @@ -36660,19 +40449,204 @@ "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L68-L73" }, { - "kind": "interface", + "codegenNames": [ + "keyed", + "array" + ], + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "generics": [ + { + "name": "TBucket", + "namespace": "_types.aggregations" + } + ], + "kind": "type_alias", + "name": { + "name": "Buckets", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/Aggregate.ts#L306-L315", + "type": { + "items": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "TBucket", + "namespace": "_types.aggregations" + } + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TBucket", + "namespace": "_types.aggregations" + } + } + } + ], + "kind": "union_of" + } + }, + { + "codegenNames": [ + "single", + "array", + "dict" + ], + "description": "Buckets path can be expressed in different ways, and an aggregation may accept some or all of these\nforms depending on its type. Please refer to each aggregation's documentation to know what buckets\npath forms they accept.", + "kind": "type_alias", "name": { "name": "BucketsPath", "namespace": "_types.aggregations" }, - "properties": [] + "specLocation": "_types/aggregations/pipeline.ts#L33-L39", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "1s" + ], + "name": "second" + }, + { + "aliases": [ + "1m" + ], + "name": "minute" + }, + { + "aliases": [ + "1h" + ], + "name": "hour" + }, + { + "aliases": [ + "1d" + ], + "name": "day" + }, + { + "aliases": [ + "1w" + ], + "name": "week" + }, + { + "aliases": [ + "1M" + ], + "name": "month" + }, + { + "aliases": [ + "1q" + ], + "name": "quarter" + }, + { + "aliases": [ + "1Y" + ], + "name": "year" + } + ], + "name": { + "name": "CalendarInterval", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L111-L128" + }, + { + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "CardinalityAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "value", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L128-L131", + "variantName": "cardinality" }, { "inherits": { @@ -36705,11 +40679,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L54-L57" }, { "kind": "interface", @@ -36725,7 +40700,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -36736,11 +40711,31 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L292-L295" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ChildrenAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L741-L742", + "variantName": "children" }, { "inherits": { @@ -36766,7 +40761,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L73-L75" }, { "kind": "interface", @@ -36808,7 +40804,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -36820,7 +40816,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -36832,11 +40828,75 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L107-L121" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "CompositeBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "CompositeAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "after_key", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L601-L606", + "variantName": "composite" + }, + { + "kind": "type_alias", + "name": { + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L77-L77", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + } }, { "inherits": { @@ -36855,40 +40915,10 @@ "name": "after", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" } } }, @@ -36913,7 +40943,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -36928,7 +40958,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L79-L84" }, { "kind": "interface", @@ -36981,91 +41012,78 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L86-L91" }, { "attachedBehaviors": [ "AdditionalProperties" ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { "name": "CompositeBucket", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L608-L610" }, { + "description": "Result of the `cumulative_cardinality` aggregation", "inherits": { - "generics": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - ], "type": { - "name": "MultiBucketAggregate", + "name": "AggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "CompositeBucketAggregate", + "name": "CumulativeCardinalityAggregate", "namespace": "_types.aggregations" }, "properties": [ { - "name": "after_key", + "name": "value", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "value_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L712-L720", + "variantName": "simple_long_value" }, { "inherits": { @@ -37079,7 +41097,8 @@ "name": "CumulativeCardinalityAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L75-L75" }, { "inherits": { @@ -37093,7 +41112,33 @@ "name": "CumulativeSumAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L77-L77" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "DateHistogramBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DateHistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L338-L339", + "variantName": "date_histogram" }, { "inherits": { @@ -37112,23 +41157,11 @@ "name": "calendar_interval", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateInterval", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "CalendarInterval", + "namespace": "_types.aggregations" + } } }, { @@ -37137,23 +41170,11 @@ "type": { "generics": [ { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "FieldDateMath", + "namespace": "_types.aggregations" + } } ], "kind": "instance_of", @@ -37169,23 +41190,11 @@ "type": { "generics": [ { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "FieldDateMath", + "namespace": "_types.aggregations" + } } ], "kind": "instance_of", @@ -37210,23 +41219,11 @@ "name": "fixed_interval", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateInterval", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } }, { @@ -37236,7 +41233,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -37244,23 +41241,11 @@ "name": "interval", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateInterval", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } }, { @@ -37302,7 +41287,7 @@ "type": { "kind": "instance_of", "type": { - "name": "HistogramOrder", + "name": "AggregateOrder", "namespace": "_types.aggregations" } } @@ -37315,7 +41300,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -37343,79 +41328,81 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L93-L109" }, { "attachedBehaviors": [ "AdditionalProperties" ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { "name": "DateHistogramBucket", "namespace": "_types.aggregations" }, - "properties": [] - }, - { - "kind": "enum", - "members": [ - { - "name": "second" - }, - { - "name": "minute" - }, - { - "name": "hour" - }, - { - "name": "day" - }, - { - "name": "week" - }, - { - "name": "month" - }, + "properties": [ { - "name": "quarter" + "name": "key_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "year" + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } } ], + "specLocation": "_types/aggregations/Aggregate.ts#L341-L344" + }, + { + "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", + "inherits": { + "type": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", "name": { - "name": "DateInterval", + "name": "DateRangeAggregate", "namespace": "_types.aggregations" - } + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L526-L531", + "variantName": "date_range" }, { "inherits": { @@ -37448,7 +41435,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -37484,11 +41471,23 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L130-L137" }, { "kind": "interface", @@ -37500,94 +41499,77 @@ { "name": "from", "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "from_as_string", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FieldDateMath", + "namespace": "_types.aggregations" } } }, { - "name": "to_as_string", + "name": "key", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "key", + "name": "to", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FieldDateMath", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/bucket.ts#L148-L152" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DerivativeAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "to", + "name": "normalized_value", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } }, { - "name": "doc_count", + "name": "normalized_value_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L217-L221", + "variantName": "derivative" }, { "inherits": { @@ -37601,7 +41583,8 @@ "name": "DerivativeAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L79-L79" }, { "inherits": { @@ -37671,7 +41654,75 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L154-L160" + }, + { + "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.", + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "DoubleTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DoubleTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L401-L406", + "variantName": "dterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "TermsBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DoubleTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "key_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L408-L411" }, { "kind": "interface", @@ -37691,7 +41742,43 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L166-L168" + }, + { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "EwmaMovingAverageAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "ewma" + } + }, + { + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EwmaModelSettings", + "namespace": "_types.aggregations" + } + } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L151-L154" }, { "generics": [ @@ -37728,7 +41815,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L201-L204" }, { "inherits": { @@ -37744,94 +41832,246 @@ }, "properties": [ { - "name": "std_deviation_bounds", + "name": "sum_of_squares", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "StandardDeviationBounds", - "namespace": "_types.aggregations" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "sum_of_squares", + "name": "variance", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "variance_population", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "variance_sampling", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "std_deviation", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "std_deviation_population", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "std_deviation_sampling", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "std_deviation_bounds", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "StandardDeviationBounds", + "namespace": "_types.aggregations" } } }, { - "name": "variance", + "name": "sum_of_squares_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "variance_population", + "name": "variance_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "variance_sampling", + "name": "variance_population_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "std_deviation", + "name": "variance_sampling_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "std_deviation_population", + "name": "std_deviation_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "std_deviation_sampling", + "name": "std_deviation_bounds_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "StandardDeviationBoundsAsString", + "namespace": "_types.aggregations" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L268-L286", + "variantName": "extended_stats" }, { "inherits": { @@ -37857,7 +42097,24 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L59-L61" + }, + { + "inherits": { + "type": { + "name": "ExtendedStatsAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ExtendedStatsBucketAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L288-L289", + "variantName": "extended_stats_bucket" }, { "inherits": { @@ -37883,59 +42140,84 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L81-L83" + }, + { + "codegenNames": [ + "expr", + "value" + ], + "description": "A date range limit, represented either as a DateMath expression or a number expressed\naccording to the target field's precision.", + "kind": "type_alias", + "name": { + "name": "FieldDateMath", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L139-L146", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DateMath", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], "inherits": { "type": { - "name": "AggregateBase", + "name": "SingleBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "FiltersAggregate", + "name": "FilterAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "buckets", - "required": true, - "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FiltersBucketItem", - "namespace": "_types.aggregations" - } - } - }, - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "FiltersBucketItem", - "namespace": "_types.aggregations" - } - } - } - ], - "kind": "union_of" + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L485-L486", + "variantName": "filter" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "FiltersBucket", + "namespace": "_types.aggregations" + } } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" } - ] + }, + "kind": "interface", + "name": { + "name": "FiltersAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L551-L552", + "variantName": "filters" }, { "inherits": { @@ -37954,37 +42236,20 @@ "name": "filters", "required": false, "type": { - "items": [ + "generics": [ { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Buckets", + "namespace": "_types.aggregations" + } } }, { @@ -37994,7 +42259,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -38005,58 +42270,41 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L168-L173" }, { "attachedBehaviors": [ "AdditionalProperties" ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { - "name": "FiltersBucketItem", + "name": "FiltersBucket", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "doc_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ] + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L554-L554" }, { "inherits": { @@ -38078,11 +42326,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L40-L42" }, { "inherits": { @@ -38104,57 +42353,34 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L44-L46" }, { "kind": "enum", "members": [ { + "description": "Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.", "name": "skip" }, { + "description": "Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.", "name": "insert_zeros" + }, + { + "description": "Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.", + "name": "keep_values" } ], "name": { "name": "GapPolicy", "namespace": "_types.aggregations" - } - }, - { - "kind": "interface", - "name": { - "name": "GeoBounds", - "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "bottom_right", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "LatLon", - "namespace": "_types" - } - } - }, - { - "name": "top_left", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "LatLon", - "namespace": "_types" - } - } - } - ] + "specLocation": "_types/aggregations/pipeline.ts#L41-L56" }, { "inherits": { @@ -38171,16 +42397,18 @@ "properties": [ { "name": "bounds", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "GeoBounds", - "namespace": "_types.aggregations" + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L293-L296", + "variantName": "geo_bounds" }, { "inherits": { @@ -38202,11 +42430,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L63-L65" }, { "inherits": { @@ -38234,16 +42463,18 @@ }, { "name": "location", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "GeoLocation", - "namespace": "_types.query_dsl" + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L298-L302", + "variantName": "geo_centroid" }, { "inherits": { @@ -38276,11 +42507,29 @@ "kind": "instance_of", "type": { "name": "GeoLocation", - "namespace": "_types.query_dsl" + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L67-L70" + }, + { + "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", + "inherits": { + "type": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoDistanceAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L533-L537", + "variantName": "geo_distance" }, { "inherits": { @@ -38321,23 +42570,11 @@ "name": "origin", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } } }, { @@ -38365,7 +42602,33 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L175-L181" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "GeoHashGridBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoHashGridAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L496-L498", + "variantName": "geohash_grid" }, { "inherits": { @@ -38386,8 +42649,8 @@ "type": { "kind": "instance_of", "type": { - "name": "BoundingBox", - "namespace": "_types.query_dsl" + "name": "GeoBounds", + "namespace": "_types" } } }, @@ -38435,7 +42698,38 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L183-L189" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoHashGridBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoHash", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L500-L502" }, { "inherits": { @@ -38457,7 +42751,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -38467,8 +42761,8 @@ "type": { "kind": "instance_of", "type": { - "name": "LineStringGeoShape", - "namespace": "_types.aggregations" + "name": "GeoLine", + "namespace": "_types" } } }, @@ -38476,14 +42770,12 @@ "name": "properties", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "GeoLineProperties", - "namespace": "_types.aggregations" - } + "kind": "user_defined_value" } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L749-L756", + "variantName": "geo_line" }, { "kind": "interface", @@ -38521,7 +42813,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -38532,7 +42824,7 @@ "kind": "instance_of", "type": { "name": "SortOrder", - "namespace": "_global.search._types" + "namespace": "_types" } } }, @@ -38547,7 +42839,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L72-L78" }, { "kind": "interface", @@ -38567,61 +42860,54 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L84-L86" }, { "kind": "interface", "name": { - "name": "GeoLineProperties", + "name": "GeoLineSort", "namespace": "_types.aggregations" }, "properties": [ { - "name": "complete", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "sort_values", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "name": "Field", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L80-L82" }, { - "kind": "interface", - "name": { - "name": "GeoLineSort", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "name": "field", - "required": true, - "type": { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "GeoTileGridBucket", + "namespace": "_types.aggregations" } } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" } - ] + }, + "kind": "interface", + "name": { + "name": "GeoTileGridAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L504-L506", + "variantName": "geotile_grid" }, { "inherits": { @@ -38687,11 +42973,61 @@ "kind": "instance_of", "type": { "name": "GeoBounds", - "namespace": "_types.aggregations" + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L191-L197" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoTileGridBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoTile", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L508-L510" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GlobalAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L482-L483", + "variantName": "global" }, { "inherits": { @@ -38705,7 +43041,8 @@ "name": "GlobalAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/bucket.ts#L199-L199" }, { "kind": "interface", @@ -38716,16 +43053,17 @@ "properties": [ { "name": "background_is_superset", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L297-L299" }, { "kind": "interface", @@ -38745,43 +43083,29 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L110-L112" }, { + "inherits": { + "type": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "HdrPercentileItem", + "name": "HdrPercentileRanksAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "key", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } - ] + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L159-L160", + "variantName": "hdr_percentile_ranks" }, { "inherits": { "type": { - "name": "AggregateBase", + "name": "PercentilesAggregateBase", "namespace": "_types.aggregations" } }, @@ -38790,22 +43114,34 @@ "name": "HdrPercentilesAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "values", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "HdrPercentileItem", - "namespace": "_types.aggregations" - } + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L156-L157", + "variantName": "hdr_percentiles" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "HistogramBucket", + "namespace": "_types.aggregations" } } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" } - ] + }, + "kind": "interface", + "name": { + "name": "HistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L330-L331", + "variantName": "histogram" }, { "inherits": { @@ -38921,7 +43257,7 @@ "type": { "kind": "instance_of", "type": { - "name": "HistogramOrder", + "name": "AggregateOrder", "namespace": "_types.aggregations" } } @@ -38944,42 +43280,64 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L206-L218" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "HistogramOrder", + "name": "HistogramBucket", "namespace": "_types.aggregations" }, "properties": [ { - "name": "_count", + "name": "key_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_key", - "required": false, + "name": "key", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L333-L336" }, { "kind": "interface", @@ -39010,7 +43368,43 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L170-L173" + }, + { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "HoltMovingAverageAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "holt" + } + }, + { + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "HoltLinearModelSettings", + "namespace": "_types.aggregations" + } + } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L156-L159" }, { "kind": "interface", @@ -39059,7 +43453,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -39085,24 +43479,151 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L174-L181" + }, + { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "HoltWintersMovingAverageAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "holt_winters" + } + }, + { + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "HoltWintersModelSettings", + "namespace": "_types.aggregations" + } + } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L161-L164" }, { "kind": "enum", "members": [ { - "identifier": "Additive", + "codegenName": "Additive", "name": "add" }, { - "identifier": "Multiplicative", + "codegenName": "Multiplicative", "name": "mult" } ], "name": { "name": "HoltWintersType", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/pipeline.ts#L182-L187" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "InferenceAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + }, + { + "name": "feature_importance", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceFeatureImportance", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "top_classes", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceTopClassEntry", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "warning", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L624-L635", + "variantName": "inference" }, { "inherits": { @@ -39139,7 +43660,40 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L85-L88" + }, + { + "kind": "interface", + "name": { + "name": "InferenceClassImportance", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "class_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "importance", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L649-L652" }, { "kind": "interface", @@ -39172,7 +43726,122 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L90-L95" + }, + { + "kind": "interface", + "name": { + "name": "InferenceFeatureImportance", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "feature_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "importance", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "classes", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceClassImportance", + "namespace": "_types.aggregations" + } + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L643-L647" + }, + { + "kind": "interface", + "name": { + "name": "InferenceTopClassEntry", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "class_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + }, + { + "name": "class_probability", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "class_score", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L637-L641" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "IpRangeBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "IpRangeAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L539-L541", + "variantName": "ip_range" }, { "inherits": { @@ -39212,7 +43881,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L220-L223" }, { "kind": "interface", @@ -39228,7 +43898,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -39239,7 +43909,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -39250,173 +43920,278 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L225-L229" }, { "attachedBehaviors": [ "AdditionalProperties" ], - "behaviors": [ + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "IpRangeBucket", + "namespace": "_types.aggregations" + }, + "properties": [ { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } + "name": "key", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], + } + }, + { + "name": "from", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "to", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], - "kind": "interface", + "specLocation": "_types/aggregations/Aggregate.ts#L543-L547" + }, + { + "kind": "type_alias", "name": { - "name": "IpRangeBucket", + "name": "KeyedPercentiles", "namespace": "_types.aggregations" }, - "properties": [] - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ + "specLocation": "_types/aggregations/Aggregate.ts#L148-L148", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ { "kind": "instance_of", "type": { - "name": "AggregateName", + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } }, { "kind": "instance_of", "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" + "name": "null", + "namespace": "_builtins" } } ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } + "kind": "union_of" } - ], - "generics": [ - { - "name": "TKey", + } + }, + { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { - "name": "KeyedBucket", + "name": "LinearMovingAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "doc_count", + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "linear" + } + }, + { + "name": "settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "EmptyObject", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L141-L144" + }, + { + "description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "LongRareTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "LongRareTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L421-L426", + "variantName": "lrareterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "LongRareTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ { "name": "key", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TKey", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } }, { "name": "key_as_string", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L428-L431" }, { + "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "LongTermsBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "ValueAggregate", + "name": "TermsAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "KeyedValueAggregate", + "name": "LongTermsAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "keys", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - } - ] + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L389-L394", + "variantName": "lterms" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "TermsBucketBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "LineStringGeoShape", + "name": "LongTermsBucket", "namespace": "_types.aggregations" }, "properties": [ { - "name": "coordinates", + "name": "key", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GeoCoordinate", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "key_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L396-L399" }, { "inherits": { @@ -39464,7 +44239,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/matrix.ts#L26-L29" }, { "inherits": { @@ -39480,48 +44256,78 @@ }, "properties": [ { - "name": "correlation", + "name": "doc_count", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "covariance", + "name": "fields", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "MatrixStatsFields", + "namespace": "_types.aggregations" } } } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L722-L726", + "variantName": "matrix_stats" + }, + { + "inherits": { + "type": { + "name": "MatrixAggregation", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MatrixStatsAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortMode", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/matrix.ts#L31-L33" + }, + { + "kind": "interface", + "name": { + "name": "MatrixStatsFields", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } }, { "name": "count", @@ -39529,13 +44335,13 @@ "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "kurtosis", + "name": "mean", "required": true, "type": { "kind": "instance_of", @@ -39546,7 +44352,7 @@ } }, { - "name": "mean", + "name": "variance", "required": true, "type": { "kind": "instance_of", @@ -39568,7 +44374,7 @@ } }, { - "name": "variance", + "name": "kurtosis", "required": true, "type": { "kind": "instance_of", @@ -39579,95 +44385,113 @@ } }, { - "name": "name", + "name": "covariance", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + }, + { + "name": "correlation", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L728-L737" }, { "inherits": { "type": { - "name": "MatrixAggregation", + "name": "SingleMetricAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MatrixStatsAggregation", + "name": "MaxAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MatrixStatsMode", - "namespace": "_types.aggregations" - } - } - } - ] + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L190-L191", + "variantName": "max" }, { - "kind": "enum", - "members": [ - { - "name": "avg" - }, - { - "name": "min" - }, - { - "name": "max" - }, - { - "name": "sum" - }, - { - "name": "median" + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" } - ], + }, + "kind": "interface", "name": { - "name": "MatrixStatsMode", + "name": "MaxAggregation", "namespace": "_types.aggregations" - } + }, + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L88-L88" }, { "inherits": { "type": { - "name": "FormatMetricAggregationBase", + "name": "PipelineAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MaxAggregation", + "name": "MaxBucketAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L123-L123" }, { "inherits": { "type": { - "name": "PipelineAggregationBase", + "name": "SingleMetricAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MaxBucketAggregation", + "name": "MedianAbsoluteDeviationAggregate", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L184-L185", + "variantName": "median_absolute_deviation" }, { "inherits": { @@ -39693,117 +44517,8 @@ } } } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "MetricAggregate", - "namespace": "_types.aggregations" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ValueAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "BoxPlotAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoBoundsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoCentroidAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoLineAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PercentilesAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ScriptedMetricAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StatsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StringStatsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TopHitsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TopMetricsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ExtendedStatsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TDigestPercentilesAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "HdrPercentilesAggregate", - "namespace": "_types.aggregations" - } - } - ], - "kind": "union_of" - } + ], + "specLocation": "_types/aggregations/metric.ts#L90-L92" }, { "kind": "interface", @@ -39845,7 +44560,24 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L34-L38" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MinAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L187-L188", + "variantName": "min" }, { "inherits": { @@ -39859,7 +44591,8 @@ "name": "MinAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L94-L94" }, { "inherits": { @@ -39873,7 +44606,8 @@ "name": "MinBucketAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L125-L125" }, { "kind": "enum", @@ -39900,7 +44634,8 @@ "name": { "name": "MinimumInterval", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/bucket.ts#L64-L71" }, { "kind": "type_alias", @@ -39908,13 +44643,14 @@ "name": "Missing", "namespace": "_types.aggregations" }, + "specLocation": "_types/aggregations/AggregationContainer.ts#L188-L188", "type": { "items": [ { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -39935,7 +44671,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -39943,167 +44679,131 @@ } }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "SingleBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MissingAggregation", + "name": "MissingAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "missing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Missing", - "namespace": "_types.aggregations" - } - } - } - ] + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L473-L474", + "variantName": "missing" }, { "inherits": { "type": { - "name": "PipelineAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MovingAverageAggregation", + "name": "MissingAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "minimize", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "model", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MovingAverageModel", - "namespace": "_types.aggregations" - } - } - }, - { - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "MovingAverageSettings", - "namespace": "_types.aggregations" - } - } - }, - { - "name": "predict", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } }, { - "name": "window", + "name": "missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Missing", + "namespace": "_types.aggregations" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L231-L234" }, { "kind": "enum", "members": [ { - "name": "linear" - }, - { - "name": "simple" - }, - { - "name": "ewma" + "name": "first" }, { - "name": "holt" + "name": "last" }, { - "name": "holt_winters" + "name": "default" } ], "name": { - "name": "MovingAverageModel", + "name": "MissingOrder", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/AggregationContainer.ts#L189-L193" }, { "kind": "type_alias", "name": { - "name": "MovingAverageSettings", + "name": "MovingAverageAggregation", "namespace": "_types.aggregations" }, + "specLocation": "_types/aggregations/pipeline.ts#L127-L133", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "EwmaModelSettings", + "name": "LinearMovingAverageAggregation", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "HoltLinearModelSettings", + "name": "SimpleMovingAverageAggregation", "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "HoltWintersModelSettings", + "name": "EwmaMovingAverageAggregation", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HoltMovingAverageAggregation", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HoltWintersMovingAverageAggregation", "namespace": "_types.aggregations" } } ], "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "model" } }, { @@ -40115,18 +44815,67 @@ }, "kind": "interface", "name": { - "name": "MovingFunctionAggregation", + "name": "MovingAverageAggregationBase", "namespace": "_types.aggregations" }, "properties": [ { - "name": "script", + "name": "minimize", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "predict", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "window", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L135-L139" + }, + { + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MovingFunctionAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -40152,7 +44901,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L189-L193" }, { "inherits": { @@ -40188,8 +44938,20 @@ "namespace": "_types" } } + }, + { + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L195-L199" }, { "generics": [ @@ -40206,7 +44968,7 @@ }, "kind": "interface", "name": { - "name": "MultiBucketAggregate", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" }, "properties": [ @@ -40214,17 +44976,73 @@ "name": "buckets", "required": true, "type": { - "kind": "array_of", - "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TBucket", + "namespace": "_types.aggregations" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Buckets", + "namespace": "_types.aggregations" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L317-L319" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { "kind": "instance_of", "type": { - "name": "TBucket", + "name": "AggregateName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "Aggregate", "namespace": "_types.aggregations" } } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "description": "Base type for multi-bucket aggregation results that can hold sub-aggregations results.", + "kind": "interface", + "name": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "doc_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L321-L328" }, { "kind": "interface", @@ -40243,8 +45061,45 @@ "namespace": "_types" } } + }, + { + "name": "missing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Missing", + "namespace": "_types.aggregations" + } + } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L247-L250" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "MultiTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MultiTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L451-L453", + "variantName": "multi_terms" }, { "inherits": { @@ -40259,6 +45114,83 @@ "namespace": "_types.aggregations" }, "properties": [ + { + "name": "collect_mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermsAggregationCollectMode", + "namespace": "_types.aggregations" + } + } + }, + { + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AggregateOrder", + "namespace": "_types.aggregations" + } + } + }, + { + "name": "min_doc_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "shard_min_doc_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "shard_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "show_term_doc_count_error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { "name": "terms", "required": true, @@ -40273,7 +45205,63 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L236-L245" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MultiTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + } + }, + { + "name": "key_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "doc_count_error_upper_bound", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L455-L459" }, { "kind": "interface", @@ -40284,27 +45272,47 @@ "properties": [ { "name": "background_is_superset", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "include_negatives", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L301-L304" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "NestedAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L476-L477", + "variantName": "nested" }, { "inherits": { @@ -40330,7 +45338,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L252-L254" }, { "inherits": { @@ -40356,7 +45365,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L201-L203" }, { "kind": "enum", @@ -40374,7 +45384,8 @@ "name": "mean" }, { - "name": "zscore" + "codegenName": "z_score", + "name": "z-score" }, { "name": "softmax" @@ -40383,7 +45394,27 @@ "name": { "name": "NormalizeMethod", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/pipeline.ts#L205-L213" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ParentAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L744-L745", + "variantName": "parent" }, { "inherits": { @@ -40409,7 +45440,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L256-L258" }, { "kind": "interface", @@ -40417,38 +45449,8 @@ "name": "PercentageScoreHeuristic", "namespace": "_types.aggregations" }, - "properties": [] - }, - { - "kind": "interface", - "name": { - "name": "PercentileItem", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "name": "percentile", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } - ] + "properties": [], + "specLocation": "_types/aggregations/bucket.ts#L306-L306" }, { "inherits": { @@ -40470,7 +45472,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -40478,14 +45480,26 @@ "name": "values", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } }, { @@ -40510,7 +45524,42 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L96-L101" + }, + { + "codegenNames": [ + "keyed", + "array" + ], + "kind": "type_alias", + "name": { + "name": "Percentiles", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/Aggregate.ts#L140-L141", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "KeyedPercentiles", + "namespace": "_types.aggregations" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ArrayPercentilesItem", + "namespace": "_types.aggregations" + } + } + } + ], + "kind": "union_of" + } }, { "inherits": { @@ -40521,25 +45570,23 @@ }, "kind": "interface", "name": { - "name": "PercentilesAggregate", + "name": "PercentilesAggregateBase", "namespace": "_types.aggregations" }, "properties": [ { - "name": "items", + "name": "values", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PercentileItem", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "Percentiles", + "namespace": "_types.aggregations" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L136-L138" }, { "inherits": { @@ -40561,7 +45608,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -40601,7 +45648,24 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L103-L108" + }, + { + "inherits": { + "type": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "PercentilesBucketAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L168-L169", + "variantName": "percentiles_bucket" }, { "inherits": { @@ -40630,7 +45694,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L215-L217" }, { "inherits": { @@ -40663,7 +45728,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -40678,7 +45743,33 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L27-L31" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "RangeBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L514-L515", + "variantName": "range" }, { "inherits": { @@ -40704,6 +45795,17 @@ } } }, + { + "name": "missing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { "name": "ranges", "required": false, @@ -40728,43 +45830,95 @@ "namespace": "_types" } } + }, + { + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L260-L266" }, { "attachedBehaviors": [ "AdditionalProperties" ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { "name": "RangeBucket", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [ + { + "name": "from", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "to", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "from_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "to_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The bucket key. Present if the aggregation is _not_ keyed", + "name": "key", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L517-L524" }, { "inherits": { @@ -40783,26 +45937,11 @@ "name": "exclude", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsExclude", + "namespace": "_types.aggregations" + } } }, { @@ -40820,33 +45959,11 @@ "name": "include", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TermsInclude", - "namespace": "_types.aggregations" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + } } }, { @@ -40889,52 +46006,51 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L274-L282" }, { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "generics": [ - { - "name": "TKey", + "inherits": { + "type": { + "name": "AggregateBase", "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { - "name": "RareTermsBucket", + "name": "RateAggregate", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [ + { + "name": "value", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "value_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L706-L710", + "variantName": "rate" }, { "inherits": { @@ -40955,7 +46071,7 @@ "type": { "kind": "instance_of", "type": { - "name": "DateInterval", + "name": "CalendarInterval", "namespace": "_types.aggregations" } } @@ -40971,7 +46087,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L118-L121" }, { "kind": "enum", @@ -40986,7 +46103,8 @@ "name": { "name": "RateMode", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/metric.ts#L123-L126" }, { "kind": "interface", @@ -40998,7 +46116,7 @@ { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "name": "results_field", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -41020,7 +46138,27 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L97-L105" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ReverseNestedAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L479-L480", + "variantName": "reverse_nested" }, { "inherits": { @@ -41046,7 +46184,27 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L284-L286" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SamplerAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L488-L489", + "variantName": "sampler" }, { "inherits": { @@ -41072,7 +46230,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L288-L290" }, { "kind": "enum", @@ -41090,7 +46249,8 @@ "name": { "name": "SamplerAggregationExecutionHint", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/bucket.ts#L162-L166" }, { "kind": "interface", @@ -41110,7 +46270,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L308-L310" }, { "inherits": { @@ -41132,7 +46293,9 @@ "kind": "user_defined_value" } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L614-L617", + "variantName": "scripted_metric" }, { "inherits": { @@ -41188,7 +46351,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -41209,7 +46372,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L128-L134" }, { "inherits": { @@ -41235,12 +46399,134 @@ } } } - ] + ], + "specLocation": "_types/aggregations/pipeline.ts#L219-L221" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "SignificantLongTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "SignificantTermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SignificantLongTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L571-L573", + "variantName": "siglterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SignificantTermsBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SignificantLongTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "key_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L580-L583" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "SignificantStringTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "SignificantTermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SignificantStringTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L585-L587", + "variantName": "sigsterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SignificantTermsBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SignificantStringTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L589-L591" }, { "generics": [ { - "name": "TKey", + "name": "T", "namespace": "_types.aggregations" } ], @@ -41249,25 +46535,25 @@ { "kind": "instance_of", "type": { - "name": "TKey", + "name": "T", "namespace": "_types.aggregations" } } ], "type": { - "name": "MultiBucketAggregate", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SignificantTermsAggregate", + "name": "SignificantTermsAggregateBase", "namespace": "_types.aggregations" }, "properties": [ { "name": "bg_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -41278,7 +46564,7 @@ }, { "name": "doc_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -41287,7 +46573,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L564-L569" }, { "inherits": { @@ -41328,26 +46615,11 @@ "name": "exclude", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsExclude", + "namespace": "_types.aggregations" + } } }, { @@ -41387,26 +46659,11 @@ "name": "include", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + } } }, { @@ -41486,48 +46743,49 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L312-L327" }, { "attachedBehaviors": [ "AdditionalProperties" ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "generics": [ - { - "name": "TKey", + "inherits": { + "type": { + "name": "MultiBucketBase", "namespace": "_types.aggregations" } - ], + }, "kind": "interface", "name": { - "name": "SignificantTermsBucket", + "name": "SignificantTermsBucketBase", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [ + { + "name": "score", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "bg_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L575-L578" }, { "inherits": { @@ -41568,26 +46826,11 @@ "name": "exclude", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsExclude", + "namespace": "_types.aggregations" + } } }, { @@ -41619,7 +46862,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -41638,26 +46881,11 @@ "name": "include", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + } } }, { @@ -41748,7 +46976,59 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L329-L346" + }, + { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SimpleMovingAverageAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "simple" + } + }, + { + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EmptyObject", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L146-L149" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SimpleValueAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L214-L215", + "variantName": "simple_value" }, { "attachedBehaviors": [ @@ -41778,6 +47058,7 @@ } } ], + "description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.", "inherits": { "type": { "name": "AggregateBase", @@ -41786,7 +47067,7 @@ }, "kind": "interface", "name": { - "name": "SingleBucketAggregate", + "name": "SingleBucketAggregateBase", "namespace": "_types.aggregations" }, "properties": [ @@ -41796,89 +47077,291 @@ "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L463-L471" }, { + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "StandardDeviationBounds", + "name": "SingleMetricAggregateBase", "namespace": "_types.aggregations" }, "properties": [ { - "name": "lower", - "required": false, + "description": "The metric value. A missing value generally means that there was no data to aggregate,\nunless specified otherwise.", + "name": "value", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "upper", + "name": "value_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L173-L182" + }, + { + "kind": "interface", + "name": { + "name": "StandardDeviationBounds", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "upper", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "lower", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "upper_population", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { "name": "lower_population", - "required": false, + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "upper_sampling", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "lower_sampling", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L250-L257" + }, + { + "kind": "interface", + "name": { + "name": "StandardDeviationBoundsAsString", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "upper", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "lower", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { "name": "upper_population", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "lower_sampling", - "required": false, + "name": "lower_population", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "name": "upper_sampling", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "lower_sampling", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L259-L266" }, { + "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", "inherits": { "type": { "name": "AggregateBase", @@ -41897,11 +47380,80 @@ "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, + { + "name": "min", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "max", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "avg", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, { "name": "sum", "required": true, @@ -41914,39 +47466,52 @@ } }, { - "name": "avg", + "name": "min_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max", + "name": "max_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min", + "name": "avg_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "sum_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L230-L245", + "variantName": "stats" }, { "inherits": { @@ -41960,7 +47525,24 @@ "name": "StatsAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L136-L136" + }, + { + "inherits": { + "type": { + "name": "StatsAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StatsBucketAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L247-L248", + "variantName": "stats_bucket" }, { "inherits": { @@ -41974,7 +47556,64 @@ "name": "StatsBucketAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L223-L223" + }, + { + "description": "Result of the `rare_terms` aggregation when the field is a string.", + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "StringRareTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringRareTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L433-L437", + "variantName": "srareterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringRareTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L439-L441" }, { "inherits": { @@ -42004,69 +47643,164 @@ "name": "min_length", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "name": "max_length", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "name": "avg_length", "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "entropy", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "distribution", + "required": false, + "type": { + "items": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "min_length_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "entropy", - "required": true, + "name": "max_length_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "distribution", + "name": "avg_length_as_string", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L658-L669", + "variantName": "string_stats" }, { "inherits": { @@ -42088,11 +47822,85 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/metric.ts#L138-L140" + }, + { + "description": "Result of a `terms` aggregation when the field is a string.", + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "StringTermsBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L374-L379", + "variantName": "sterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "TermsBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringTermsBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L385-L387" + }, + { + "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SumAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L193-L197", + "variantName": "sum" }, { "inherits": { @@ -42106,7 +47914,8 @@ "name": "SumAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L142-L142" }, { "inherits": { @@ -42120,7 +47929,8 @@ "name": "SumBucketAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L225-L225" }, { "kind": "interface", @@ -42140,12 +47950,29 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L114-L116" }, { "inherits": { "type": { - "name": "AggregateBase", + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "TDigestPercentileRanksAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L165-L166", + "variantName": "tdigest_percentile_ranks" + }, + { + "inherits": { + "type": { + "name": "PercentilesAggregateBase", "namespace": "_types.aggregations" } }, @@ -42154,30 +47981,60 @@ "name": "TDigestPercentilesAggregate", "namespace": "_types.aggregations" }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L162-L163", + "variantName": "tdigest_percentiles" + }, + { + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "TTestAggregate", + "namespace": "_types.aggregations" + }, "properties": [ { - "name": "values", + "name": "value", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } + ], + "kind": "union_of" + } + }, + { + "name": "value_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L700-L704", + "variantName": "t_test" }, { "inherits": { @@ -42225,7 +48082,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L144-L148" }, { "kind": "enum", @@ -42243,12 +48101,13 @@ "name": { "name": "TTestType", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/metric.ts#L156-L160" }, { "generics": [ { - "name": "TKey", + "name": "TBucket", "namespace": "_types.aggregations" } ], @@ -42257,25 +48116,25 @@ { "kind": "instance_of", "type": { - "name": "TKey", + "name": "TBucket", "namespace": "_types.aggregations" } } ], "type": { - "name": "MultiBucketAggregate", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "TermsAggregate", + "name": "TermsAggregateBase", "namespace": "_types.aggregations" }, "properties": [ { "name": "doc_count_error_upper_bound", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -42286,7 +48145,7 @@ }, { "name": "sum_other_doc_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -42295,7 +48154,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L367-L372" }, { "inherits": { @@ -42325,26 +48185,11 @@ "name": "exclude", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsExclude", + "namespace": "_types.aggregations" + } } }, { @@ -42373,33 +48218,11 @@ "name": "include", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TermsInclude", - "namespace": "_types.aggregations" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + } } }, { @@ -42424,6 +48247,17 @@ } } }, + { + "name": "missing_order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MissingOrder", + "namespace": "_types.aggregations" + } + } + }, { "name": "missing_bucket", "required": false, @@ -42431,7 +48265,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -42442,7 +48276,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -42452,7 +48286,7 @@ "type": { "kind": "instance_of", "type": { - "name": "TermsAggregationOrder", + "name": "AggregateOrder", "namespace": "_types.aggregations" } } @@ -42486,7 +48320,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -42501,7 +48335,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L348-L364" }, { "kind": "enum", @@ -42516,7 +48351,8 @@ "name": { "name": "TermsAggregationCollectMode", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/bucket.ts#L374-L377" }, { "kind": "enum", @@ -42537,60 +48373,109 @@ "name": { "name": "TermsAggregationExecutionHint", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/bucket.ts#L379-L384" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "TermsBucketBase", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "doc_count_error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L381-L383" }, { + "codegenNames": [ + "regexp", + "terms" + ], "kind": "type_alias", "name": { - "name": "TermsAggregationOrder", + "name": "TermsExclude", "namespace": "_types.aggregations" }, + "specLocation": "_types/aggregations/bucket.ts#L389-L390", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } }, { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": false, + } + } + ], + "kind": "union_of" + } + }, + { + "codegenNames": [ + "regexp", + "terms", + "partition" + ], + "kind": "type_alias", + "name": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L386-L387", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "SortOrder", - "namespace": "_global.search._types" - } - } + "kind": "instance_of", + "type": { + "name": "TermsPartition", + "namespace": "_types.aggregations" } } ], @@ -42600,7 +48485,7 @@ { "kind": "interface", "name": { - "name": "TermsInclude", + "name": "TermsPartition", "namespace": "_types.aggregations" }, "properties": [ @@ -42626,7 +48511,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L392-L395" }, { "kind": "interface", @@ -42668,7 +48554,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L150-L154" }, { "inherits": { @@ -42689,18 +48576,7 @@ "type": { "generics": [ { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + "kind": "user_defined_value" } ], "kind": "instance_of", @@ -42710,7 +48586,9 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L619-L622", + "variantName": "top_hits" }, { "inherits": { @@ -42743,7 +48621,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -42777,7 +48655,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -42809,7 +48687,7 @@ "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } }, @@ -42817,30 +48695,11 @@ "name": "_source", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } } }, { @@ -42861,7 +48720,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -42872,7 +48731,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -42883,11 +48742,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L162-L175" }, { "kind": "interface", @@ -42906,22 +48766,15 @@ { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "double", + "name": "FieldValue", "namespace": "_types" } }, { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "null", + "namespace": "_builtins" } } ], @@ -42937,7 +48790,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -42947,22 +48800,15 @@ { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "double", + "name": "FieldValue", "namespace": "_types" } }, { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "null", + "namespace": "_builtins" } } ], @@ -42970,7 +48816,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L694-L698" }, { "inherits": { @@ -42999,7 +48846,9 @@ } } } - ] + ], + "specLocation": "_types/aggregations/Aggregate.ts#L689-L692", + "variantName": "top_metrics" }, { "inherits": { @@ -43058,11 +48907,12 @@ "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L177-L181" }, { "kind": "interface", @@ -43082,44 +48932,122 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L183-L185" }, { + "description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Void", + "namespace": "_spec_utils" + } + } + ], "type": { - "name": "AggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ValueAggregate", + "name": "UnmappedRareTermsAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "value", - "required": true, - "type": { + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L443-L449", + "variantName": "umrareterms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "UnmappedSamplerAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L491-L492", + "variantName": "unmapped_sampler" + }, + { + "description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.", + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "Void", + "namespace": "_spec_utils" } } - }, - { - "name": "value_as_string", - "required": false, - "type": { + ], + "type": { + "name": "SignificantTermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "UnmappedSignificantTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L593-L599", + "variantName": "umsigterms" + }, + { + "description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.", + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Void", + "namespace": "_spec_utils" } } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "UnmappedTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L413-L419", + "variantName": "umterms" + }, + { + "description": "Value count aggregation result. `value` is always present.", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" } - ] + }, + "kind": "interface", + "name": { + "name": "ValueCountAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L208-L212", + "variantName": "value_count" }, { "inherits": { @@ -43133,7 +49061,8 @@ "name": "ValueCountAggregation", "namespace": "_types.aggregations" }, - "properties": [] + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L187-L187" }, { "kind": "enum", @@ -43172,7 +49101,33 @@ "name": { "name": "ValueType", "namespace": "_types.aggregations" - } + }, + "specLocation": "_types/aggregations/metric.ts#L189-L200" + }, + { + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "VariableWidthHistogramBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "VariableWidthHistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L352-L354", + "variantName": "variable_width_histogram" }, { "kind": "interface", @@ -43225,7 +49180,93 @@ } } } - ] + ], + "specLocation": "_types/aggregations/bucket.ts#L397-L402" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "MultiBucketBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "VariableWidthHistogramBucket", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "min", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "min_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "key_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L356-L363" }, { "inherits": { @@ -43247,7 +49288,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -43284,7 +49325,8 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L202-L207" }, { "kind": "interface", @@ -43326,71 +49368,153 @@ } } } - ] + ], + "specLocation": "_types/aggregations/metric.ts#L209-L213" }, { + "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", "inherits": { "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "AsciiFoldingTokenFilter", + "name": "WeightedAvgAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L202-L206", + "variantName": "weighted_avg" + }, + { + "kind": "type_alias", + "name": { + "name": "Analyzer", "namespace": "_types.analysis" }, - "properties": [ - { - "name": "preserve_original", - "required": true, - "type": { + "specLocation": "_types/analysis/analyzers.ts#L113-L131", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "CustomAnalyzer", + "namespace": "_types.analysis" } - } - } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "CharFilter", - "namespace": "_types.analysis" - }, - "type": { - "items": [ + }, { "kind": "instance_of", "type": { - "name": "HtmlStripCharFilter", + "name": "FingerprintAnalyzer", "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "MappingCharFilter", + "name": "KeywordAnalyzer", "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "PatternReplaceTokenFilter", + "name": "LanguageAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NoriAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PatternAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SimpleAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StandardAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StopAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WhitespaceAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SnowballAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DutchAnalyzer", "namespace": "_types.analysis" } } ], "kind": "union_of" + }, + "variants": { + "defaultTag": "custom", + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" } }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "CharFilterBase", + "name": "AsciiFoldingTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -43398,13 +49522,62 @@ "name": "type", "required": true, "type": { + "kind": "literal_value", + "value": "asciifolding" + } + }, + { + "name": "preserve_original", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L167-L170" + }, + { + "codegenNames": [ + "name", + "definition" + ], + "kind": "type_alias", + "name": { + "name": "CharFilter", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/char_filters.ts#L28-L30", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CharFilterDefinition", + "namespace": "_types.analysis" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + }, + "properties": [ { "name": "version", "required": false, @@ -43416,7 +49589,61 @@ } } } - ] + ], + "specLocation": "_types/analysis/char_filters.ts#L24-L26" + }, + { + "kind": "type_alias", + "name": { + "name": "CharFilterDefinition", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/char_filters.ts#L32-L41", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "HtmlStripCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MappingCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PatternReplaceCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiIterationMarkCharFilter", + "namespace": "_types.analysis" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } }, { "inherits": { @@ -43431,6 +49658,14 @@ "namespace": "_types.analysis" }, "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "char_group" + } + }, { "name": "tokenize_on_chars", "required": true, @@ -43440,12 +49675,24 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } + }, + { + "name": "max_token_length", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } - ] + ], + "specLocation": "_types/analysis/tokenizers.ts#L55-L59" }, { "inherits": { @@ -43461,53 +49708,62 @@ }, "properties": [ { - "name": "common_words", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "common_grams" + } + }, + { + "name": "common_words", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { "name": "common_words_path", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "ignore_case", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "query_mode", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L172-L178" }, { "inherits": { @@ -43524,18 +49780,18 @@ "properties": [ { "name": "hyphenation_patterns_path", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "max_subword_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43546,7 +49802,7 @@ }, { "name": "min_subword_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43557,7 +49813,7 @@ }, { "name": "min_word_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43568,41 +49824,42 @@ }, { "name": "only_longest_match", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "word_list", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { "name": "word_list_path", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L43-L51" }, { "inherits": { @@ -43617,6 +49874,14 @@ "namespace": "_types.analysis" }, "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "condition" + } + }, { "name": "filter", "required": true, @@ -43626,7 +49891,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -43642,7 +49907,133 @@ } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L180-L184" + }, + { + "kind": "interface", + "name": { + "name": "CustomAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "custom" + } + }, + { + "name": "char_filter", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "filter", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "position_increment_gap", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "position_offset_gap", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "tokenizer", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L28-L35" + }, + { + "kind": "interface", + "name": { + "name": "CustomNormalizer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "custom" + } + }, + { + "name": "char_filter", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "filter", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/normalizers.ts#L30-L34" }, { "kind": "enum", @@ -43660,7 +50051,8 @@ "name": { "name": "DelimitedPayloadEncoding", "namespace": "_types.analysis" - } + }, + "specLocation": "_types/analysis/token_filters.ts#L61-L65" }, { "inherits": { @@ -43676,19 +50068,27 @@ }, "properties": [ { - "name": "delimiter", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "delimited_payload" + } + }, + { + "name": "delimiter", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "encoding", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43697,7 +50097,61 @@ } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L67-L71" + }, + { + "inherits": { + "type": { + "name": "CompoundWordTokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "DictionaryDecompounderTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "dictionary_decompounder" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L53-L55" + }, + { + "kind": "interface", + "name": { + "name": "DutchAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "dutch" + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L61-L64" }, { "kind": "enum", @@ -43712,7 +50166,8 @@ "name": { "name": "EdgeNGramSide", "namespace": "_types.analysis" - } + }, + "specLocation": "_types/analysis/token_filters.ts#L73-L76" }, { "inherits": { @@ -43728,8 +50183,16 @@ }, "properties": [ { - "name": "max_gram", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "edge_ngram" + } + }, + { + "name": "max_gram", + "required": false, "type": { "kind": "instance_of", "type": { @@ -43740,7 +50203,7 @@ }, { "name": "min_gram", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43751,7 +50214,7 @@ }, { "name": "side", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -43759,8 +50222,20 @@ "namespace": "_types.analysis" } } + }, + { + "name": "preserve_original", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L78-L84" }, { "inherits": { @@ -43776,13 +50251,21 @@ }, "properties": [ { - "name": "custom_token_chars", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "edge_ngram" + } + }, + { + "name": "custom_token_chars", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -43822,7 +50305,8 @@ } } } - ] + ], + "specLocation": "_types/analysis/tokenizers.ts#L30-L36" }, { "inherits": { @@ -43838,31 +50322,135 @@ }, "properties": [ { - "name": "articles", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "elision" + } + }, + { + "name": "articles", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, + { + "name": "articles_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "name": "articles_case", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L186-L191" + }, + { + "kind": "interface", + "name": { + "name": "FingerprintAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "fingerprint" + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, + { + "name": "max_output_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "preserve_original", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "separator", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L37-L45" }, { "inherits": { @@ -43878,8 +50466,16 @@ }, "properties": [ { - "name": "max_output_size", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "fingerprint" + } + }, + { + "name": "max_output_size", + "required": false, "type": { "kind": "instance_of", "type": { @@ -43890,16 +50486,17 @@ }, { "name": "separator", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L193-L197" }, { "inherits": { @@ -43913,7 +50510,17 @@ "name": "HtmlStripCharFilter", "namespace": "_types.analysis" }, - "properties": [] + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "html_strip" + } + } + ], + "specLocation": "_types/analysis/char_filters.ts#L43-L45" }, { "inherits": { @@ -43929,24 +50536,32 @@ }, "properties": [ { - "name": "dedup", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "hunspell" + } + }, + { + "name": "dedup", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "dictionary", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -43957,22 +50572,23 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "longest_only", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L199-L205" }, { "inherits": { @@ -43986,36 +50602,130 @@ "name": "HyphenationDecompounderTokenFilter", "namespace": "_types.analysis" }, - "properties": [] + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "hyphenation_decompounder" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L57-L59" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "kind": "interface", + "name": { + "name": "IcuAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_analyzer" + } + }, + { + "name": "method", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" + } + } + }, + { + "name": "mode", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" + } + } + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L67-L71" + }, + { + "kind": "enum", + "members": [ + { + "name": "shifted" + }, + { + "name": "non-ignorable" } + ], + "name": { + "name": "IcuCollationAlternate", + "namespace": "_types.analysis" }, - "kind": "interface", + "specLocation": "_types/analysis/icu-plugin.ts#L89-L92" + }, + { + "kind": "enum", + "members": [ + { + "name": "lower" + }, + { + "name": "upper" + } + ], "name": { - "name": "KStemTokenFilter", + "name": "IcuCollationCaseFirst", "namespace": "_types.analysis" }, - "properties": [] + "specLocation": "_types/analysis/icu-plugin.ts#L94-L97" }, { "kind": "enum", "members": [ { - "name": "include" + "name": "no" }, { - "name": "exclude" + "name": "identical" } ], "name": { - "name": "KeepTypesMode", + "name": "IcuCollationDecomposition", "namespace": "_types.analysis" - } + }, + "specLocation": "_types/analysis/icu-plugin.ts#L99-L102" + }, + { + "kind": "enum", + "members": [ + { + "name": "primary" + }, + { + "name": "secondary" + }, + { + "name": "tertiary" + }, + { + "name": "quaternary" + }, + { + "name": "identical" + } + ], + "name": { + "name": "IcuCollationStrength", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L104-L110" }, { "inherits": { @@ -44026,226 +50736,249 @@ }, "kind": "interface", "name": { - "name": "KeepTypesTokenFilter", + "name": "IcuCollationTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "mode", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "icu_collation" + } + }, + { + "name": "alternate", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "KeepTypesMode", + "name": "IcuCollationAlternate", "namespace": "_types.analysis" } } }, { - "name": "types", - "required": true, + "name": "caseFirst", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "IcuCollationCaseFirst", + "namespace": "_types.analysis" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "KeepWordsTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "keep_words", - "required": true, + "name": "caseLevel", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "keep_words_case", - "required": true, + "name": "country", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "decomposition", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationDecomposition", + "namespace": "_types.analysis" + } + } + }, + { + "name": "hiraganaQuaternaryMode", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "keep_words_path", - "required": true, + "name": "language", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "KeywordMarkerTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "ignore_case", - "required": true, + "name": "numeric", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "keywords", - "required": true, + "name": "rules", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "keywords_path", - "required": true, + "name": "strength", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationStrength", + "namespace": "_types.analysis" + } + } + }, + { + "name": "variableTop", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "keywords_pattern", - "required": true, + "name": "variant", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/icu-plugin.ts#L51-L65" }, { "inherits": { "type": { - "name": "TokenizerBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "KeywordTokenizer", + "name": "IcuFoldingTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "buffer_size", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_folding" + } + }, + { + "name": "unicode_set_filter", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/icu-plugin.ts#L46-L49" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "CharFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "LengthTokenFilter", + "name": "IcuNormalizationCharFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "max", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "icu_normalizer" + } + }, + { + "name": "mode", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" } } }, { - "name": "min", - "required": true, + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IcuNormalizationType", + "namespace": "_types.analysis" } } } - ] + ], + "specLocation": "_types/analysis/icu-plugin.ts#L40-L44" }, { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "kind": "enum", + "members": [ + { + "name": "decompose" + }, + { + "name": "compose" } - }, - "kind": "interface", + ], "name": { - "name": "LetterTokenizer", + "name": "IcuNormalizationMode", "namespace": "_types.analysis" }, - "properties": [] + "specLocation": "_types/analysis/icu-plugin.ts#L78-L81" }, { "inherits": { @@ -44256,113 +50989,147 @@ }, "kind": "interface", "name": { - "name": "LimitTokenCountTokenFilter", + "name": "IcuNormalizationTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "consume_all_tokens", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "icu_normalizer" } }, { - "name": "max_token_count", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IcuNormalizationType", + "namespace": "_types.analysis" } } } - ] + ], + "specLocation": "_types/analysis/icu-plugin.ts#L35-L38" + }, + { + "kind": "enum", + "members": [ + { + "name": "nfc" + }, + { + "name": "nfkc" + }, + { + "name": "nfkc_cf" + } + ], + "name": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L83-L87" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "LowercaseTokenFilter", + "name": "IcuTokenizer", "namespace": "_types.analysis" }, "properties": [ { - "name": "language", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_tokenizer" + } + }, + { + "name": "rule_files", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/icu-plugin.ts#L30-L33" }, { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "kind": "enum", + "members": [ + { + "name": "forward" + }, + { + "name": "reverse" } - }, - "kind": "interface", + ], "name": { - "name": "LowercaseTokenizer", + "name": "IcuTransformDirection", "namespace": "_types.analysis" }, - "properties": [] + "specLocation": "_types/analysis/icu-plugin.ts#L73-L76" }, { "inherits": { "type": { - "name": "CharFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "MappingCharFilter", + "name": "IcuTransformTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "mappings", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "icu_transform" + } + }, + { + "name": "dir", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuTransformDirection", + "namespace": "_types.analysis" } } }, { - "name": "mappings_path", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/icu-plugin.ts#L24-L28" }, { "inherits": { @@ -44373,36 +51140,36 @@ }, "kind": "interface", "name": { - "name": "MultiplexerTokenFilter", + "name": "KStemTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "filters", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "kind": "literal_value", + "value": "kstem" } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L238-L240" + }, + { + "kind": "enum", + "members": [ + { + "name": "include" }, { - "name": "preserve_original", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "exclude" } - ] + ], + "name": { + "name": "KeepTypesMode", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/token_filters.ts#L212-L215" }, { "inherits": { @@ -44413,204 +51180,205 @@ }, "kind": "interface", "name": { - "name": "NGramTokenFilter", + "name": "KeepTypesTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "max_gram", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "keep_types" + } + }, + { + "name": "mode", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "KeepTypesMode", + "namespace": "_types.analysis" } } }, { - "name": "min_gram", - "required": true, + "name": "types", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L217-L221" }, { "inherits": { "type": { - "name": "TokenizerBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "NGramTokenizer", + "name": "KeepWordsTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "custom_token_chars", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "keep" } }, { - "name": "max_gram", - "required": true, + "name": "keep_words", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "min_gram", - "required": true, + "name": "keep_words_case", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "token_chars", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TokenChar", - "namespace": "_types.analysis" - } + "name": "keep_words_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "discard" - }, - { - "name": "none" - }, - { - "name": "mixed" - } ], - "name": { - "name": "NoriDecompoundMode", - "namespace": "_types.analysis" - } + "specLocation": "_types/analysis/token_filters.ts#L223-L228" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, "kind": "interface", "name": { - "name": "NoriPartOfSpeechTokenFilter", + "name": "KeywordAnalyzer", "namespace": "_types.analysis" }, "properties": [ { - "name": "stoptags", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "keyword" + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L47-L50" }, { "inherits": { "type": { - "name": "TokenizerBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "NoriTokenizer", + "name": "KeywordMarkerTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "decompound_mode", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "NoriDecompoundMode", - "namespace": "_types.analysis" - } + "kind": "literal_value", + "value": "keyword_marker" } }, { - "name": "discard_punctuation", - "required": true, + "name": "ignore_case", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "user_dictionary", - "required": true, + "name": "keywords", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "keywords_path", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "user_dictionary_rules", - "required": true, + "name": "keywords_pattern", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L230-L236" }, { "inherits": { @@ -44621,106 +51389,117 @@ }, "kind": "interface", "name": { - "name": "PathHierarchyTokenizer", + "name": "KeywordTokenizer", "namespace": "_types.analysis" }, "properties": [ { - "name": "buffer_size", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "literal_value", + "value": "keyword" } }, { - "name": "delimiter", + "name": "buffer_size", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L61-L64" + }, + { + "kind": "interface", + "name": { + "name": "KuromojiAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "replacement", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "kuromoji" } }, { - "name": "reverse", + "name": "mode", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "KuromojiTokenizationMode", + "namespace": "_types.analysis" } } }, { - "name": "skip", - "required": true, + "name": "user_dictionary", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L25-L29" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "CharFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "PatternCaptureTokenFilter", + "name": "KuromojiIterationMarkCharFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "patterns", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "kuromoji_iteration_mark" + } + }, + { + "name": "normalize_kana", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "preserve_original", + "name": "normalize_kanji", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L31-L35" }, { "inherits": { @@ -44731,44 +51510,34 @@ }, "kind": "interface", "name": { - "name": "PatternReplaceTokenFilter", + "name": "KuromojiPartOfSpeechTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "flags", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "pattern", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "kuromoji_part_of_speech" } }, { - "name": "replacement", + "name": "stoptags", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - ] + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L37-L40" }, { "inherits": { @@ -44779,10 +51548,31 @@ }, "kind": "interface", "name": { - "name": "PorterStemTokenFilter", + "name": "KuromojiReadingFormTokenFilter", "namespace": "_types.analysis" }, - "properties": [] + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "kuromoji_readingform" + } + }, + { + "name": "use_romaji", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L42-L45" }, { "inherits": { @@ -44793,89 +51583,97 @@ }, "kind": "interface", "name": { - "name": "PredicateTokenFilter", + "name": "KuromojiStemmerTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "script", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "kuromoji_stemmer" + } + }, + { + "name": "minimum_length", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } } - ] - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "RemoveDuplicatesTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [] + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L47-L50" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "kind": "enum", + "members": [ + { + "name": "normal" + }, + { + "name": "search" + }, + { + "name": "extended" } - }, - "kind": "interface", + ], "name": { - "name": "ReverseTokenFilter", + "name": "KuromojiTokenizationMode", "namespace": "_types.analysis" }, - "properties": [] + "specLocation": "_types/analysis/kuromoji-plugin.ts#L52-L56" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "ShingleTokenFilter", + "name": "KuromojiTokenizer", "namespace": "_types.analysis" }, "properties": [ { - "name": "filler_token", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "kuromoji_tokenizer" + } + }, + { + "name": "discard_punctuation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_shingle_size", + "name": "mode", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "KuromojiTokenizationMode", + "namespace": "_types.analysis" } } }, { - "name": "min_shingle_size", - "required": true, + "name": "nbest_cost", + "required": false, "type": { "kind": "instance_of", "type": { @@ -44885,52 +51683,85 @@ } }, { - "name": "output_unigrams", - "required": true, + "name": "nbest_examples", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "output_unigrams_if_no_shingles", - "required": true, + "name": "user_dictionary", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "token_separator", - "required": true, + "name": "user_dictionary_rules", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "discard_compound_token", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L58-L67" }, { "kind": "enum", "members": [ + { + "name": "Arabic" + }, { "name": "Armenian" }, { "name": "Basque" }, + { + "name": "Brazilian" + }, + { + "name": "Bulgarian" + }, { "name": "Catalan" }, + { + "name": "Chinese" + }, + { + "name": "Cjk" + }, + { + "name": "Czech" + }, { "name": "Danish" }, @@ -44940,35 +51771,47 @@ { "name": "English" }, + { + "name": "Estonian" + }, { "name": "Finnish" }, { "name": "French" }, + { + "name": "Galician" + }, { "name": "German" }, { - "name": "German2" + "name": "Greek" + }, + { + "name": "Hindi" }, { "name": "Hungarian" }, { - "name": "Italian" + "name": "Indonesian" }, { - "name": "Kp" + "name": "Irish" }, { - "name": "Lovins" + "name": "Italian" + }, + { + "name": "Latvian" }, { "name": "Norwegian" }, { - "name": "Porter" + "name": "Persian" }, { "name": "Portuguese" @@ -44979,6 +51822,9 @@ { "name": "Russian" }, + { + "name": "Sorani" + }, { "name": "Spanish" }, @@ -44987,64 +51833,92 @@ }, { "name": "Turkish" + }, + { + "name": "Thai" } ], "name": { - "name": "SnowballLanguage", + "name": "Language", "namespace": "_types.analysis" - } + }, + "specLocation": "_types/analysis/languages.ts#L20-L55" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, "kind": "interface", "name": { - "name": "SnowballTokenFilter", + "name": "LanguageAnalyzer", "namespace": "_types.analysis" }, "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "language" + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, { "name": "language", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SnowballLanguage", + "name": "Language", "namespace": "_types.analysis" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "StandardTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "max_token_length", + "name": "stem_exclusion", "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "stopwords", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L52-L59" }, { "inherits": { @@ -45055,62 +51929,66 @@ }, "kind": "interface", "name": { - "name": "StemmerOverrideTokenFilter", + "name": "LengthTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "rules", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "length" + } + }, + { + "name": "max", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "rules_path", - "required": true, + "name": "min", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L242-L246" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "StemmerTokenFilter", + "name": "LetterTokenizer", "namespace": "_types.analysis" }, "properties": [ { - "name": "language", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "letter" } } - ] + ], + "specLocation": "_types/analysis/tokenizers.ts#L66-L68" }, { "inherits": { @@ -45121,137 +51999,192 @@ }, "kind": "interface", "name": { - "name": "StopTokenFilter", + "name": "LimitTokenCountTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "ignore_case", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "limit" + } + }, + { + "name": "consume_all_tokens", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "remove_trailing", + "name": "max_token_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L248-L252" + }, + { + "kind": "interface", + "name": { + "name": "LowercaseNormalizer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "stopwords", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } + "kind": "literal_value", + "value": "lowercase" + } + } + ], + "specLocation": "_types/analysis/normalizers.ts#L26-L28" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "LowercaseTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "lowercase" } }, { - "name": "stopwords_path", + "name": "language", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L254-L257" }, { - "description": "Language value, such as _arabic_ or _thai_. Defaults to _english_.\nEach language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words.\nAlso accepts an array of stop words.", - "kind": "type_alias", + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", "name": { - "name": "StopWords", + "name": "LowercaseTokenizer", "namespace": "_types.analysis" }, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", + "properties": [ + { + "name": "type", + "required": true, "type": { - "name": "string", - "namespace": "internal" + "kind": "literal_value", + "value": "lowercase" } } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "solr" - }, - { - "name": "wordnet" - } ], - "name": { - "name": "SynonymFormat", - "namespace": "_types.analysis" - } + "specLocation": "_types/analysis/tokenizers.ts#L70-L72" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "CharFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "SynonymGraphTokenFilter", + "name": "MappingCharFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "expand", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "mapping" } }, { - "name": "format", - "required": true, + "name": "mappings", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SynonymFormat", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "lenient", - "required": true, + "name": "mappings_path", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } + } + ], + "specLocation": "_types/analysis/char_filters.ts#L47-L51" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "MultiplexerTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "multiplexer" + } }, { - "name": "synonyms", + "name": "filters", "required": true, "type": { "kind": "array_of", @@ -45259,450 +52192,540 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "synonyms_path", + "name": "preserve_original", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L259-L263" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "NGramTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "ngram" + } + }, + { + "name": "max_gram", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "tokenizer", - "required": true, + "name": "min_gram", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "updateable", - "required": true, + "name": "preserve_original", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L265-L270" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "SynonymTokenFilter", + "name": "NGramTokenizer", "namespace": "_types.analysis" }, "properties": [ { - "name": "expand", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "ngram" + } + }, + { + "name": "custom_token_chars", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "format", + "name": "max_gram", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SynonymFormat", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } }, { - "name": "lenient", + "name": "min_gram", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "synonyms", + "name": "token_chars", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TokenChar", + "namespace": "_types.analysis" } } } - }, + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L38-L44" + }, + { + "kind": "interface", + "name": { + "name": "NoriAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "synonyms_path", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "nori" + } + }, + { + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "tokenizer", - "required": true, + "name": "decompound_mode", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NoriDecompoundMode", + "namespace": "_types.analysis" } } }, { - "name": "updateable", - "required": true, + "name": "stoptags", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "user_dictionary", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L66-L72" }, { "kind": "enum", "members": [ { - "name": "letter" - }, - { - "name": "digit" + "name": "discard" }, { - "name": "whitespace" + "name": "none" }, { - "name": "punctuation" - }, + "name": "mixed" + } + ], + "name": { + "name": "NoriDecompoundMode", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/tokenizers.ts#L74-L78" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "NoriPartOfSpeechTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "symbol" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "nori_part_of_speech" + } }, { - "name": "custom" + "name": "stoptags", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], - "name": { - "name": "TokenChar", - "namespace": "_types.analysis" - } + "specLocation": "_types/analysis/token_filters.ts#L272-L275" }, { - "kind": "type_alias", + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", "name": { - "name": "TokenFilter", + "name": "NoriTokenizer", "namespace": "_types.analysis" }, - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "nori_tokenizer" + } + }, + { + "name": "decompound_mode", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AsciiFoldingTokenFilter", + "name": "NoriDecompoundMode", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "discard_punctuation", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CommonGramsTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "user_dictionary", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ConditionTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, + } + }, + { + "name": "user_dictionary_rules", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L80-L86" + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "kind": "type_alias", + "name": { + "name": "Normalizer", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/normalizers.ts#L20-L24", + "type": { + "items": [ { "kind": "instance_of", "type": { - "name": "DelimitedPayloadTokenFilter", + "name": "LowercaseNormalizer", "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "EdgeNGramTokenFilter", + "name": "CustomNormalizer", "namespace": "_types.analysis" } - }, - { + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "type" + } + }, + { + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "PathHierarchyTokenizer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "path_hierarchy" + } + }, + { + "name": "buffer_size", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "ElisionTokenFilter", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "name": "delimiter", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "FingerprintTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "replacement", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "HunspellTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "reverse", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "HyphenationDecompounderTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "skip", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "KeepTypesTokenFilter", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } - }, - { + } + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L88-L95" + }, + { + "kind": "interface", + "name": { + "name": "PatternAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "pattern" + } + }, + { + "name": "version", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KeepWordsTokenFilter", - "namespace": "_types.analysis" + "name": "VersionString", + "namespace": "_types" } - }, - { + } + }, + { + "name": "flags", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KeywordMarkerTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "lowercase", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KStemTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "pattern", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "LengthTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LimitTokenCountTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LowercaseTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MultiplexerTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NGramTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NoriPartOfSpeechTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PatternCaptureTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PatternReplaceTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PorterStemTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PredicateTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RemoveDuplicatesTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ReverseTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ShingleTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SnowballTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StemmerOverrideTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StemmerTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StopTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SynonymGraphTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SynonymTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TrimTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TruncateTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UniqueTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UppercaseTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "WordDelimiterGraphTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "WordDelimiterTokenFilter", + "name": "StopWords", "namespace": "_types.analysis" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L74-L81" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "TokenFilterBase", + "name": "PatternCaptureTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -45710,159 +52733,346 @@ "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "literal_value", + "value": "pattern_capture" + } + }, + { + "name": "patterns", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "version", + "name": "preserve_original", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L277-L281" }, { - "kind": "type_alias", + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", "name": { - "name": "Tokenizer", + "name": "PatternReplaceCharFilter", "namespace": "_types.analysis" }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CharGroupTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "EdgeNGramTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KeywordTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LetterTokenizer", - "namespace": "_types.analysis" - } - }, - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "pattern_replace" + } + }, + { + "name": "flags", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LowercaseTokenizer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "pattern", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "NGramTokenizer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "replacement", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NoriTokenizer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/char_filters.ts#L53-L58" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "PatternReplaceTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "pattern_replace" + } + }, + { + "name": "all", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PathHierarchyTokenizer", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "flags", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "StandardTokenizer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "pattern", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "UaxEmailUrlTokenizer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "replacement", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WhitespaceTokenizer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L283-L289" }, { + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "TokenizerBase", + "name": "PatternTokenizer", "namespace": "_types.analysis" }, "properties": [ { "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "pattern" + } + }, + { + "name": "flags", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "version", - "required": false, + "name": "group", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "integer", "namespace": "_types" } } + }, + { + "name": "pattern", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "_types/analysis/tokenizers.ts#L97-L102" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "kind": "enum", + "members": [ + { + "name": "metaphone" + }, + { + "name": "double_metaphone" + }, + { + "name": "soundex" + }, + { + "name": "refined_soundex" + }, + { + "name": "caverphone1" + }, + { + "name": "caverphone2" + }, + { + "name": "cologne" + }, + { + "name": "nysiis" + }, + { + "name": "koelnerphonetik" + }, + { + "name": "haasephonetik" + }, + { + "name": "beider_morse" + }, + { + "name": "daitch_mokotoff" } + ], + "name": { + "name": "PhoneticEncoder", + "namespace": "_types.analysis" }, - "kind": "interface", + "specLocation": "_types/analysis/phonetic-plugin.ts#L23-L36" + }, + { + "kind": "enum", + "members": [ + { + "name": "any" + }, + { + "name": "common" + }, + { + "name": "cyrillic" + }, + { + "name": "english" + }, + { + "name": "french" + }, + { + "name": "german" + }, + { + "name": "hebrew" + }, + { + "name": "hungarian" + }, + { + "name": "polish" + }, + { + "name": "romanian" + }, + { + "name": "russian" + }, + { + "name": "spanish" + } + ], "name": { - "name": "TrimTokenFilter", + "name": "PhoneticLanguage", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/phonetic-plugin.ts#L38-L51" + }, + { + "kind": "enum", + "members": [ + { + "name": "generic" + }, + { + "name": "ashkenazi" + }, + { + "name": "sephardic" + } + ], + "name": { + "name": "PhoneticNameType", "namespace": "_types.analysis" }, - "properties": [] + "specLocation": "_types/analysis/phonetic-plugin.ts#L53-L57" + }, + { + "kind": "enum", + "members": [ + { + "name": "approx" + }, + { + "name": "exact" + } + ], + "name": { + "name": "PhoneticRuleType", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/phonetic-plugin.ts#L59-L62" }, { "inherits": { @@ -45873,13 +53083,46 @@ }, "kind": "interface", "name": { - "name": "TruncateTokenFilter", + "name": "PhoneticTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "length", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "phonetic" + } + }, + { + "name": "encoder", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "PhoneticEncoder", + "namespace": "_types.analysis" + } + } + }, + { + "name": "languageset", "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PhoneticLanguage", + "namespace": "_types.analysis" + } + } + } + }, + { + "name": "max_code_len", + "required": false, "type": { "kind": "instance_of", "type": { @@ -45887,34 +53130,66 @@ "namespace": "_types" } } + }, + { + "name": "name_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "PhoneticNameType", + "namespace": "_types.analysis" + } + } + }, + { + "name": "replace", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rule_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "PhoneticRuleType", + "namespace": "_types.analysis" + } + } } - ] + ], + "specLocation": "_types/analysis/phonetic-plugin.ts#L64-L72" }, { "inherits": { "type": { - "name": "TokenizerBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "UaxEmailUrlTokenizer", + "name": "PorterStemTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "max_token_length", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "literal_value", + "value": "porter_stem" } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L291-L293" }, { "inherits": { @@ -45925,22 +53200,31 @@ }, "kind": "interface", "name": { - "name": "UniqueTokenFilter", + "name": "PredicateTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "only_on_same_position", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "predicate_token_filter" + } + }, + { + "name": "script", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Script", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L295-L298" }, { "inherits": { @@ -45951,36 +53235,44 @@ }, "kind": "interface", "name": { - "name": "UppercaseTokenFilter", + "name": "RemoveDuplicatesTokenFilter", "namespace": "_types.analysis" }, - "properties": [] + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "remove_duplicates" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L300-L302" }, { "inherits": { "type": { - "name": "TokenizerBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "WhitespaceTokenizer", + "name": "ReverseTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "max_token_length", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "literal_value", + "value": "reverse" } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L304-L306" }, { "inherits": { @@ -45991,171 +53283,266 @@ }, "kind": "interface", "name": { - "name": "WordDelimiterGraphTokenFilter", + "name": "ShingleTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "adjust_offsets", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "shingle" } }, { - "name": "catenate_all", - "required": true, + "name": "filler_token", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "catenate_numbers", - "required": true, + "name": "max_shingle_size", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "catenate_words", - "required": true, + "name": "min_shingle_size", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "generate_number_parts", - "required": true, + "name": "output_unigrams", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "generate_word_parts", - "required": true, + "name": "output_unigrams_if_no_shingles", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "preserve_original", - "required": true, + "name": "token_separator", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L86-L94" + }, + { + "kind": "interface", + "name": { + "name": "SimpleAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "protected_words", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "kind": "literal_value", + "value": "simple" } }, { - "name": "protected_words_path", - "required": true, + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/analyzers.ts#L83-L86" + }, + { + "kind": "interface", + "name": { + "name": "SnowballAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "split_on_case_change", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "snowball" } }, { - "name": "split_on_numerics", - "required": true, + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "stem_english_possessive", + "name": "language", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "type_table", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "SnowballLanguage", + "namespace": "_types.analysis" } } }, { - "name": "type_table_path", - "required": true, + "name": "stopwords", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "StopWords", + "namespace": "_types.analysis" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L88-L93" + }, + { + "kind": "enum", + "members": [ + { + "name": "Armenian" + }, + { + "name": "Basque" + }, + { + "name": "Catalan" + }, + { + "name": "Danish" + }, + { + "name": "Dutch" + }, + { + "name": "English" + }, + { + "name": "Finnish" + }, + { + "name": "French" + }, + { + "name": "German" + }, + { + "name": "German2" + }, + { + "name": "Hungarian" + }, + { + "name": "Italian" + }, + { + "name": "Kp" + }, + { + "name": "Lovins" + }, + { + "name": "Norwegian" + }, + { + "name": "Porter" + }, + { + "name": "Portuguese" + }, + { + "name": "Romanian" + }, + { + "name": "Russian" + }, + { + "name": "Spanish" + }, + { + "name": "Swedish" + }, + { + "name": "Turkish" + } + ], + "name": { + "name": "SnowballLanguage", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/languages.ts#L57-L80" }, { "inherits": { @@ -46166,291 +53553,371 @@ }, "kind": "interface", "name": { - "name": "WordDelimiterTokenFilter", + "name": "SnowballTokenFilter", "namespace": "_types.analysis" }, "properties": [ { - "name": "catenate_all", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "snowball" } }, { - "name": "catenate_numbers", + "name": "language", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SnowballLanguage", + "namespace": "_types.analysis" } } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L308-L311" + }, + { + "kind": "interface", + "name": { + "name": "StandardAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "catenate_words", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "standard" } }, { - "name": "generate_number_parts", - "required": true, + "name": "max_token_length", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "generate_word_parts", - "required": true, + "name": "stopwords", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "StopWords", + "namespace": "_types.analysis" } } - }, + } + ], + "specLocation": "_types/analysis/analyzers.ts#L95-L99" + }, + { + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "StandardTokenizer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "preserve_original", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "standard" + } + }, + { + "name": "max_token_length", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L104-L107" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "StemmerOverrideTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "protected_words", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "stemmer_override" + } + }, + { + "name": "rules", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "protected_words_path", - "required": true, + "name": "rules_path", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L313-L317" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "StemmerTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "split_on_case_change", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "stemmer" } }, { - "name": "split_on_numerics", - "required": true, + "aliases": [ + "name" + ], + "name": "language", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L319-L323" + }, + { + "kind": "interface", + "name": { + "name": "StopAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "stem_english_possessive", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "stop" + } + }, + { + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "type_table", - "required": true, + "name": "stopwords", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" } } }, { - "name": "type_table_path", - "required": true, + "name": "stopwords_path", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L101-L106" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "AllField", - "namespace": "_types.mapping" + "name": "StopTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { - "name": "analyzer", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "stop" } }, { - "name": "enabled", - "required": true, + "name": "ignore_case", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "omit_norms", - "required": true, + "name": "remove_trailing", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "search_analyzer", - "required": true, + "name": "stopwords", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "StopWords", + "namespace": "_types.analysis" } } }, { - "name": "similarity", - "required": true, + "name": "stopwords_path", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "store", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - }, - { - "name": "store_term_vector_offsets", - "required": true, - "type": { + } + ], + "specLocation": "_types/analysis/token_filters.ts#L96-L102" + }, + { + "description": "Language value, such as _arabic_ or _thai_. Defaults to _english_.\nEach language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words.\nAlso accepts an array of stop words.", + "kind": "type_alias", + "name": { + "name": "StopWords", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/StopWords.ts#L20-L26", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "store_term_vector_payloads", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ { - "name": "store_term_vector_positions", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "solr" }, { - "name": "store_term_vectors", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "wordnet" } - ] + ], + "name": { + "name": "SynonymFormat", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/token_filters.ts#L104-L107" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "BinaryProperty", - "namespace": "_types.mapping" + "name": "SynonymGraphTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { @@ -46458,693 +53925,809 @@ "required": true, "type": { "kind": "literal_value", - "value": "binary" + "value": "synonym_graph" } - } - ] - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "BooleanProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "boost", + "name": "expand", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "fielddata", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NumericFielddata", - "namespace": "indices._types" + "name": "SynonymFormat", + "namespace": "_types.analysis" } } }, { - "name": "index", + "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "null_value", + "name": "synonyms", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "synonyms_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "tokenizer", + "required": false, "type": { - "kind": "literal_value", - "value": "boolean" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "updateable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L109-L118" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "CompletionProperty", - "namespace": "_types.mapping" + "name": "SynonymTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { - "name": "analyzer", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "synonym" + } + }, + { + "name": "expand", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "contexts", + "name": "format", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SuggestContext", - "namespace": "_types.mapping" - } + "kind": "instance_of", + "type": { + "name": "SynonymFormat", + "namespace": "_types.analysis" } } }, { - "name": "max_input_length", + "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "preserve_position_increments", + "name": "synonyms", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "preserve_separators", + "name": "synonyms_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "search_analyzer", + "name": "tokenizer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "updateable", + "required": false, "type": { - "kind": "literal_value", - "value": "completion" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L120-L129" }, { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" + "kind": "enum", + "members": [ + { + "name": "letter" + }, + { + "name": "digit" + }, + { + "name": "whitespace" + }, + { + "name": "punctuation" + }, + { + "name": "symbol" + }, + { + "name": "custom" } + ], + "name": { + "name": "TokenChar", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/tokenizers.ts#L46-L53" + }, + { + "codegenNames": [ + "name", + "definition" + ], + "kind": "type_alias", + "name": { + "name": "TokenFilter", + "namespace": "_types.analysis" }, + "specLocation": "_types/analysis/token_filters.ts#L343-L345", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TokenFilterDefinition", + "namespace": "_types.analysis" + } + } + ], + "kind": "union_of" + } + }, + { "kind": "interface", "name": { - "name": "ConstantKeywordProperty", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" }, "properties": [ { - "name": "value", + "name": "version", "required": false, "type": { - "kind": "user_defined_value" - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "constant_keyword" + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L39-L41" }, { "kind": "type_alias", "name": { - "name": "CoreProperty", - "namespace": "_types.mapping" + "name": "TokenFilterDefinition", + "namespace": "_types.analysis" }, + "specLocation": "_types/analysis/token_filters.ts#L347-L400", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "ObjectProperty", - "namespace": "_types.mapping" + "name": "AsciiFoldingTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "NestedProperty", - "namespace": "_types.mapping" + "name": "CommonGramsTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "SearchAsYouTypeProperty", - "namespace": "_types.mapping" + "name": "ConditionTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "TextProperty", - "namespace": "_types.mapping" + "name": "DelimitedPayloadTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "DocValuesProperty", - "namespace": "_types.mapping" + "name": "EdgeNGramTokenFilter", + "namespace": "_types.analysis" } - } - ], - "kind": "union_of" - } - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "copy_to", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "ElisionTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "similarity", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FingerprintTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "store", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "HunspellTokenFilter", + "namespace": "_types.analysis" } - } - } - ] - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "DateNanosProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "boost", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "HyphenationDecompounderTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "format", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "KeepTypesTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "ignore_malformed", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "KeepWordsTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "index", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "KeywordMarkerTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "null_value", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "KStemTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "precision_step", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "LengthTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "date_nanos" - } - } - ] - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "DateProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "boost", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "LimitTokenCountTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "fielddata", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "NumericFielddata", - "namespace": "indices._types" + "name": "LowercaseTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "format", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "MultiplexerTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "ignore_malformed", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "NGramTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "index", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "NoriPartOfSpeechTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "null_value", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "PatternCaptureTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "precision_step", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "PatternReplaceTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "date" - } - } - ] - }, - { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "DateRangeProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "format", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "PorterStemTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "date_range" - } - } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "DocValuesProperty", - "namespace": "_types.mapping" - }, - "type": { - "items": [ + }, { "kind": "instance_of", "type": { - "name": "BinaryProperty", - "namespace": "_types.mapping" + "name": "PredicateTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "BooleanProperty", - "namespace": "_types.mapping" + "name": "RemoveDuplicatesTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "DateProperty", - "namespace": "_types.mapping" + "name": "ReverseTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "DateNanosProperty", - "namespace": "_types.mapping" + "name": "ShingleTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "KeywordProperty", - "namespace": "_types.mapping" + "name": "SnowballTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "NumberProperty", - "namespace": "_types.mapping" + "name": "StemmerOverrideTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "RangeProperty", - "namespace": "_types.mapping" + "name": "StemmerTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "GeoPointProperty", - "namespace": "_types.mapping" + "name": "StopTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "GeoShapeProperty", - "namespace": "_types.mapping" + "name": "SynonymGraphTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "CompletionProperty", - "namespace": "_types.mapping" + "name": "SynonymTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "GenericProperty", - "namespace": "_types.mapping" + "name": "TrimTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "IpProperty", - "namespace": "_types.mapping" + "name": "TruncateTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "Murmur3HashProperty", - "namespace": "_types.mapping" + "name": "UniqueTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "ShapeProperty", - "namespace": "_types.mapping" + "name": "UppercaseTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "TokenCountProperty", - "namespace": "_types.mapping" + "name": "WordDelimiterGraphTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "VersionProperty", - "namespace": "_types.mapping" + "name": "WordDelimiterTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "WildcardProperty", - "namespace": "_types.mapping" + "name": "KuromojiStemmerTokenFilter", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "PointProperty", - "namespace": "_types.mapping" + "name": "KuromojiReadingFormTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiPartOfSpeechTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuCollationTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuFoldingTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuTransformTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PhoneticTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DictionaryDecompounderTokenFilter", + "namespace": "_types.analysis" } } ], "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" } }, { - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } + "codegenNames": [ + "name", + "definition" + ], + "kind": "type_alias", + "name": { + "name": "Tokenizer", + "namespace": "_types.analysis" }, + "specLocation": "_types/analysis/tokenizers.ts#L119-L121", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TokenizerDefinition", + "namespace": "_types.analysis" + } + } + ], + "kind": "union_of" + } + }, + { "kind": "interface", "name": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" + "name": "TokenizerBase", + "namespace": "_types.analysis" }, "properties": [ { - "name": "doc_values", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/analysis/tokenizers.ts#L26-L28" + }, + { + "kind": "type_alias", + "name": { + "name": "TokenizerDefinition", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/tokenizers.ts#L123-L141", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CharGroupTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "EdgeNGramTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KeywordTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LetterTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LowercaseTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NGramTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NoriTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PathHierarchyTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StandardTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UaxEmailUrlTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WhitespaceTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PatternTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuTokenizer", + "namespace": "_types.analysis" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } }, { "inherits": { "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "DoubleRangeProperty", - "namespace": "_types.mapping" + "name": "TrimTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { @@ -47152,439 +54735,411 @@ "required": true, "type": { "kind": "literal_value", - "value": "double_range" + "value": "trim" } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "strict" - }, - { - "name": "runtime" - }, - { - "name": "true" - }, - { - "name": "false" - } ], - "name": { - "name": "DynamicMapping", - "namespace": "_types.mapping" - } + "specLocation": "_types/analysis/token_filters.ts#L325-L327" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" + "name": "TruncateTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { - "name": "mapping", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - } - }, - { - "name": "match", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "truncate" } }, { - "name": "match_mapping_type", + "name": "length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L329-L332" + }, + { + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "UaxEmailUrlTokenizer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "match_pattern", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "MatchType", - "namespace": "_types.mapping" - } + "kind": "literal_value", + "value": "uax_url_email" } }, { - "name": "path_match", + "name": "max_token_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L109-L112" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "UniqueTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "path_unmatch", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "unique" } }, { - "name": "unmatch", + "name": "only_on_same_position", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L334-L337" }, { "inherits": { "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "FieldAliasProperty", - "namespace": "_types.mapping" + "name": "UppercaseTokenFilter", + "namespace": "_types.analysis" }, "properties": [ - { - "name": "path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "alias" + "value": "uppercase" } } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldMapping", - "namespace": "_types.mapping" - }, - "properties": [] + ], + "specLocation": "_types/analysis/token_filters.ts#L339-L341" }, { "kind": "interface", "name": { - "name": "FieldNamesField", - "namespace": "_types.mapping" + "name": "WhitespaceAnalyzer", + "namespace": "_types.analysis" }, "properties": [ { - "name": "enabled", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "whitespace" + } + }, + { + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/analysis/analyzers.ts#L108-L111" }, { - "kind": "enum", - "members": [ - { - "name": "none" - }, - { - "name": "geo_point" - }, - { - "name": "geo_shape" - }, - { - "name": "ip" - }, - { - "name": "binary" - }, - { - "name": "keyword" - }, - { - "name": "text" - }, - { - "name": "search_as_you_type" - }, - { - "name": "date" - }, - { - "name": "date_nanos" - }, - { - "name": "boolean" - }, - { - "name": "completion" - }, - { - "name": "nested" - }, - { - "name": "object" - }, - { - "name": "murmur3" - }, - { - "name": "token_count" - }, - { - "name": "percolator" - }, - { - "name": "integer" - }, - { - "name": "long" - }, - { - "name": "short" - }, - { - "name": "byte" - }, - { - "name": "float" - }, - { - "name": "half_float" - }, - { - "name": "scaled_float" - }, - { - "name": "double" - }, - { - "name": "integer_range" - }, - { - "name": "float_range" - }, - { - "name": "long_range" - }, - { - "name": "double_range" - }, - { - "name": "date_range" - }, - { - "name": "ip_range" - }, - { - "name": "alias" - }, - { - "name": "join" - }, - { - "name": "rank_feature" - }, - { - "name": "rank_features" - }, - { - "name": "flattened" - }, - { - "name": "shape" - }, + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "WhitespaceTokenizer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "histogram" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "whitespace" + } }, { - "name": "constant_keyword" + "name": "max_token_length", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "name": { - "name": "FieldType", - "namespace": "_types.mapping" - } + "specLocation": "_types/analysis/tokenizers.ts#L114-L117" }, { "inherits": { "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "FlattenedProperty", - "namespace": "_types.mapping" + "name": "WordDelimiterGraphTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { - "name": "boost", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "word_delimiter_graph" + } + }, + { + "name": "adjust_offsets", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "depth_limit", + "name": "catenate_all", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "doc_values", + "name": "catenate_numbers", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "eager_global_ordinals", + "name": "catenate_words", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "index", + "name": "generate_number_parts", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "index_options", + "name": "generate_word_parts", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "null_value", + "name": "ignore_keywords", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "similarity", + "name": "preserve_original", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "protected_words", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "protected_words_path", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "split_queries_on_whitespace", + "name": "split_on_case_change", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "split_on_numerics", + "required": false, "type": { - "kind": "literal_value", - "value": "flattened" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_english_possessive", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "type_table", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "type_table_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - ] + ], + "specLocation": "_types/analysis/token_filters.ts#L148-L165" }, { "inherits": { "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" + "name": "TokenFilterBase", + "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "FloatRangeProperty", - "namespace": "_types.mapping" + "name": "WordDelimiterTokenFilter", + "namespace": "_types.analysis" }, "properties": [ { @@ -47592,437 +55147,340 @@ "required": true, "type": { "kind": "literal_value", - "value": "float_range" + "value": "word_delimiter" } - } - ] - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "GenericProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "analyzer", - "required": true, + "name": "catenate_all", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "boost", - "required": true, + "name": "catenate_numbers", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "fielddata", - "required": true, + "name": "catenate_words", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "StringFielddata", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "ignore_malformed", - "required": true, + "name": "generate_number_parts", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "index", - "required": true, + "name": "generate_word_parts", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "index_options", - "required": true, + "name": "preserve_original", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "norms", - "required": true, + "name": "protected_words", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "null_value", - "required": true, + "name": "protected_words_path", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "position_increment_gap", - "required": true, + "name": "split_on_case_change", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "search_analyzer", - "required": true, + "name": "split_on_numerics", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "term_vector", - "required": true, + "name": "stem_english_possessive", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermVectorOption", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "type_table", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "type_table_path", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "right" - }, - { - "name": "RIGHT" - }, - { - "name": "counterclockwise" - }, - { - "name": "COUNTERCLOCKWISE" - }, - { - "name": "ccw" - }, - { - "name": "CCW" - }, - { - "name": "left" - }, - { - "name": "LEFT" - }, - { - "name": "clockwise" - }, - { - "name": "CLOCKWISE" - }, - { - "name": "cw" - }, - { - "name": "CW" - } ], - "name": { - "name": "GeoOrientation", - "namespace": "_types.mapping" - } + "specLocation": "_types/analysis/token_filters.ts#L131-L146" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "PropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "GeoPointProperty", + "name": "AggregateMetricDoubleProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "ignore_z_value", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "aggregate_metric_double" } }, { - "name": "null_value", - "required": false, + "name": "default_metric", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "type", + "name": "metrics", "required": true, "type": { - "kind": "literal_value", - "value": "geo_point" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - ] + ], + "specLocation": "_types/mapping/complex.ts#L58-L62" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "GeoShapeProperty", + "name": "AllField", "namespace": "_types.mapping" }, "properties": [ { - "name": "coerce", - "required": false, + "name": "analyzer", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ignore_malformed", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "ignore_z_value", - "required": false, + "name": "omit_norms", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "orientation", - "required": false, + "name": "search_analyzer", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoOrientation", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "strategy", - "required": false, + "name": "similarity", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoStrategy", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "type", + "name": "store", "required": true, "type": { - "kind": "literal_value", - "value": "geo_shape" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "recursive" }, { - "name": "term" - } - ], - "name": { - "name": "GeoStrategy", - "namespace": "_types.mapping" - } - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "HistogramProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "ignore_malformed", - "required": false, + "name": "store_term_vector_offsets", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "type", + "name": "store_term_vector_payloads", "required": true, "type": { - "kind": "literal_value", - "value": "histogram" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndexField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "enabled", + "name": "store_term_vector_positions", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "docs" - }, - { - "name": "freqs" - }, - { - "name": "positions" }, { - "name": "offsets" + "name": "store_term_vectors", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "IndexOptions", - "namespace": "_types.mapping" - } + "specLocation": "_types/mapping/meta-fields.ts#L29-L40" }, { "inherits": { "type": { - "name": "RangePropertyBase", + "name": "DocValuesPropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "IntegerRangeProperty", + "name": "BinaryProperty", "namespace": "_types.mapping" }, "properties": [ @@ -48031,10 +55489,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "integer_range" + "value": "binary" } } - ] + ], + "specLocation": "_types/mapping/core.ts#L89-L91" }, { "inherits": { @@ -48045,7 +55504,7 @@ }, "kind": "interface", "name": { - "name": "IpProperty", + "name": "BooleanProperty", "namespace": "_types.mapping" }, "properties": [ @@ -48060,6 +55519,17 @@ } } }, + { + "name": "fielddata", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NumericFielddata", + "namespace": "indices._types" + } + } + }, { "name": "index", "required": false, @@ -48067,7 +55537,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -48077,8 +55547,8 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, @@ -48087,21 +55557,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "ip" + "value": "boolean" } } - ] + ], + "specLocation": "_types/mapping/core.ts#L93-L99" }, { "inherits": { "type": { - "name": "RangePropertyBase", + "name": "StandardNumberProperty", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "IpRangeProperty", + "name": "ByteNumberProperty", "namespace": "_types.mapping" }, "properties": [ @@ -48110,70 +55581,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "ip_range" + "value": "byte" } - } - ] - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "JoinProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "relations", + "name": "null_value", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "RelationName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "RelationName", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RelationName", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "byte", + "namespace": "_types" } } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "join" - } } - ] + ], + "specLocation": "_types/mapping/core.ts#L186-L189" }, { "inherits": { @@ -48184,95 +55607,76 @@ }, "kind": "interface", "name": { - "name": "KeywordProperty", + "name": "CompletionProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "boost", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "eager_global_ordinals", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index", + "name": "contexts", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SuggestContext", + "namespace": "_types.mapping" + } } } }, { - "name": "index_options", + "name": "max_input_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } } }, { - "name": "normalizer", + "name": "preserve_position_increments", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "norms", + "name": "preserve_separators", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "null_value", + "name": "search_analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "split_queries_on_whitespace", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -48281,115 +55685,223 @@ "required": true, "type": { "kind": "literal_value", - "value": "keyword" + "value": "completion" } } - ] + ], + "specLocation": "_types/mapping/specialized.ts#L26-L34" }, { "inherits": { "type": { - "name": "RangePropertyBase", + "name": "PropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "LongRangeProperty", + "name": "ConstantKeywordProperty", "namespace": "_types.mapping" }, "properties": [ + { + "name": "value", + "required": false, + "type": { + "kind": "user_defined_value" + } + }, { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "long_range" + "value": "constant_keyword" } } - ] + ], + "specLocation": "_types/mapping/specialized.ts#L43-L46" }, { - "kind": "enum", - "members": [ - { - "name": "simple" - }, - { - "name": "regex" - } - ], + "kind": "type_alias", "name": { - "name": "MatchType", + "name": "CoreProperty", "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/core.ts#L58-L64", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ObjectProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NestedProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SearchAsYouTypeProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TextProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DocValuesProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MatchOnlyTextProperty", + "namespace": "_types.mapping" + } + } + ], + "kind": "union_of" } }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "PropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "Murmur3HashProperty", + "name": "CorePropertyBase", "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, + "name": "copy_to", + "required": false, "type": { - "kind": "literal_value", - "value": "murmur3" + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "name": "similarity", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - ] + ], + "specLocation": "_types/mapping/core.ts#L52-L56" }, { "inherits": { "type": { - "name": "CorePropertyBase", + "name": "DocValuesPropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "NestedProperty", + "name": "DateNanosProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "enabled", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "include_in_parent", + "name": "format", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "include_in_root", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "null_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "name": "precision_step", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, @@ -48398,10 +55910,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "nested" + "value": "date_nanos" } } - ] + ], + "specLocation": "_types/mapping/core.ts#L113-L121" }, { "inherits": { @@ -48412,7 +55925,7 @@ }, "kind": "interface", "name": { - "name": "NumberProperty", + "name": "DateProperty", "namespace": "_types.mapping" }, "properties": [ @@ -48428,24 +55941,24 @@ } }, { - "name": "coerce", + "name": "fielddata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "NumericFielddata", + "namespace": "indices._types" } } }, { - "name": "fielddata", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NumericFielddata", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, @@ -48456,7 +55969,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -48467,7 +55980,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -48477,115 +55990,83 @@ "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "DateString", "namespace": "_types" } } }, { - "name": "scaling_factor", + "name": "precision_step", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "type", - "required": true, + "name": "locale", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "NumberType", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "float" - }, - { - "name": "half_float" - }, - { - "name": "scaled_float" }, { - "name": "double" - }, - { - "name": "integer" - }, - { - "name": "long" - }, - { - "name": "short" - }, - { - "name": "byte" - }, - { - "name": "unsigned_long" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "date" + } } ], - "name": { - "name": "NumberType", - "namespace": "_types.mapping" - } + "specLocation": "_types/mapping/core.ts#L101-L111" }, { "inherits": { "type": { - "name": "CorePropertyBase", + "name": "RangePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "ObjectProperty", + "name": "DateRangeProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "enabled", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { "name": "type", - "required": false, + "required": true, "type": { "kind": "literal_value", - "value": "object" + "value": "date_range" } } - ] + ], + "specLocation": "_types/mapping/range.ts#L37-L40" }, { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "PercolatorProperty", + "name": "DenseVectorIndexOptions", "namespace": "_types.mapping" }, "properties": [ @@ -48593,325 +56074,231 @@ "name": "type", "required": true, "type": { - "kind": "literal_value", - "value": "percolator" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "m", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "ef_construction", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - ] + ], + "specLocation": "_types/mapping/DenseVectorIndexOptions.ts#L22-L26" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "PropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "PointProperty", + "name": "DenseVectorProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "ignore_malformed", - "required": false, + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "dense_vector" + } + }, + { + "name": "dims", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "ignore_z_value", + "name": "similarity", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "null_value", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "index_options", + "required": false, "type": { - "kind": "literal_value", - "value": "point" + "kind": "instance_of", + "type": { + "name": "DenseVectorIndexOptions", + "namespace": "_types.mapping" + } } } - ] + ], + "specLocation": "_types/mapping/complex.ts#L50-L56" }, { "kind": "type_alias", "name": { - "name": "Property", + "name": "DocValuesProperty", "namespace": "_types.mapping" }, + "specLocation": "_types/mapping/core.ts#L70-L87", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "FlattenedProperty", + "name": "BinaryProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "JoinProperty", + "name": "BooleanProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "PercolatorProperty", + "name": "DateProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "RankFeatureProperty", + "name": "DateNanosProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "RankFeaturesProperty", + "name": "KeywordProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "ConstantKeywordProperty", + "name": "NumberProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "FieldAliasProperty", + "name": "RangeProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "HistogramProperty", + "name": "GeoPointProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "CoreProperty", + "name": "GeoShapeProperty", "namespace": "_types.mapping" } - } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "tag": "type" - } - }, - { - "kind": "interface", - "name": { - "name": "PropertyBase", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "local_metadata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } - }, - { - "name": "meta", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "name", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "PropertyName", - "namespace": "_types" - } - } - }, - { - "name": "properties", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } + "name": "CompletionProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "ignore_above", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "dynamic", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DynamicMapping", - "namespace": "_types.mapping" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } + "name": "IpProperty", + "namespace": "_types.mapping" } - } - } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "RangeProperty", - "namespace": "_types.mapping" - }, - "type": { - "items": [ + }, { "kind": "instance_of", "type": { - "name": "LongRangeProperty", + "name": "Murmur3HashProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "IpRangeProperty", + "name": "ShapeProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "IntegerRangeProperty", + "name": "TokenCountProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "FloatRangeProperty", + "name": "VersionProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "DoubleRangeProperty", + "name": "WildcardProperty", "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "DateRangeProperty", + "name": "PointProperty", "namespace": "_types.mapping" } } @@ -48922,95 +56309,75 @@ { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "CorePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "RangePropertyBase", + "name": "DocValuesPropertyBase", "namespace": "_types.mapping" }, "properties": [ { - "name": "boost", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "coerce", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "index", + "name": "doc_values", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/mapping/core.ts#L66-L68" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "StandardNumberProperty", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "RankFeatureProperty", + "name": "DoubleNumberProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "positive_score_impact", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "double" } }, { - "name": "type", - "required": true, + "name": "null_value", + "required": false, "type": { - "kind": "literal_value", - "value": "rank_feature" + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } - ] + ], + "specLocation": "_types/mapping/core.ts#L166-L169" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "RangePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "RankFeaturesProperty", + "name": "DoubleRangeProperty", "namespace": "_types.mapping" }, "properties": [ @@ -49019,141 +56386,133 @@ "required": true, "type": { "kind": "literal_value", - "value": "rank_features" + "value": "double_range" } } - ] + ], + "specLocation": "_types/mapping/range.ts#L42-L44" + }, + { + "esQuirk": "This is a boolean that evolved into an enum. Boolean values should be accepted on reading, and\ntrue and false must be serialized as JSON booleans, or it may break Kibana (see elasticsearch-java#139)", + "kind": "enum", + "members": [ + { + "name": "strict" + }, + { + "name": "runtime" + }, + { + "name": "true" + }, + { + "name": "false" + } + ], + "name": { + "name": "DynamicMapping", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/dynamic-template.ts#L37-L46" }, { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "RoutingField", + "name": "DynamicProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "required", + "name": "type", "required": true, + "type": { + "kind": "literal_value", + "value": "{dynamic_property}" + } + }, + { + "name": "enabled", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RuntimeField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "format", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FieldValue", + "namespace": "_types" } } }, { - "name": "script", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "double", "namespace": "_types" } } }, { - "name": "type", - "required": true, + "name": "coerce", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "RuntimeFieldType", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "boolean" - }, - { - "name": "date" - }, - { - "name": "double" - }, - { - "name": "geo_point" - }, - { - "name": "ip" }, { - "name": "keyword" + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } }, { - "name": "long" - } - ], - "name": { - "name": "RuntimeFieldType", - "namespace": "_types.mapping" - } - }, - { - "kind": "type_alias", - "name": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - }, - "type": { - "key": { - "kind": "instance_of", + "name": "on_script_error", + "required": false, "type": { - "name": "Field", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "OnScriptError", + "namespace": "_types.mapping" + } } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", + { + "name": "ignore_malformed", + "required": false, "type": { - "name": "RuntimeField", - "namespace": "_types.mapping" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - } - }, - { - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "SearchAsYouTypeProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { "name": "analyzer", "required": false, @@ -49161,7 +56520,18 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "eager_global_ordinals", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, @@ -49172,7 +56542,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -49188,13 +56558,24 @@ } }, { - "name": "max_shingle_size", + "name": "index_phrases", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index_prefixes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TextIndexPrefixes", + "namespace": "_types.mapping" } } }, @@ -49205,7 +56586,18 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "position_increment_gap", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, @@ -49216,7 +56608,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -49227,7 +56619,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -49243,334 +56635,376 @@ } }, { - "name": "type", - "required": true, + "name": "format", + "required": false, "type": { - "kind": "literal_value", - "value": "search_as_you_type" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "right" - }, - { - "name": "counterclockwise" - }, - { - "name": "ccw" - }, - { - "name": "left" }, { - "name": "clockwise" + "name": "precision_step", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "cw" + "name": "locale", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "ShapeOrientation", - "namespace": "_types.mapping" - } + "specLocation": "_types/mapping/core.ts#L312-L342" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "ShapeProperty", + "name": "DynamicTemplate", "namespace": "_types.mapping" }, "properties": [ { - "name": "coerce", + "name": "mapping", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Property", + "namespace": "_types.mapping" } } }, { - "name": "ignore_malformed", + "name": "match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ignore_z_value", + "name": "match_mapping_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "orientation", + "name": "match_pattern", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShapeOrientation", + "name": "MatchType", "namespace": "_types.mapping" } } }, { - "name": "type", - "required": true, + "name": "path_match", + "required": false, "type": { - "kind": "literal_value", - "value": "shape" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "SizeField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "enabled", - "required": true, + "name": "path_unmatch", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "unmatch", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/mapping/dynamic-template.ts#L22-L30" }, { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "SourceField", + "name": "FieldAliasProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "compress", + "name": "path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "name": "compress_threshold", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "alias" } - }, + } + ], + "specLocation": "_types/mapping/specialized.ts#L48-L51" + }, + { + "kind": "interface", + "name": { + "name": "FieldMapping", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "enabled", + "name": "full_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "excludes", - "required": false, + "name": "mapping", + "required": true, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } - } - } - }, - { - "name": "includes", - "required": false, - "type": { - "kind": "array_of", + }, + "kind": "dictionary_of", + "singleKey": true, "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Property", + "namespace": "_types.mapping" } } } } - ] + ], + "specLocation": "_types/mapping/meta-fields.ts#L24-L27" }, { "kind": "interface", "name": { - "name": "SuggestContext", + "name": "FieldNamesField", "namespace": "_types.mapping" }, "properties": [ { - "name": "name", + "name": "enabled", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L42-L44" + }, + { + "kind": "enum", + "members": [ + { + "name": "none" }, { - "name": "path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "name": "geo_point" }, { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "name": "geo_shape" }, { - "name": "precision", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "enum", - "members": [ + "name": "ip" + }, { - "name": "no" + "name": "binary" }, { - "name": "yes" + "name": "keyword" }, { - "name": "with_offsets" + "name": "text" }, { - "name": "with_positions" + "name": "search_as_you_type" }, { - "name": "with_positions_offsets" + "name": "date" }, { - "name": "with_positions_offsets_payloads" + "name": "date_nanos" + }, + { + "name": "boolean" + }, + { + "name": "completion" + }, + { + "name": "nested" + }, + { + "name": "object" + }, + { + "name": "murmur3" + }, + { + "name": "token_count" + }, + { + "name": "percolator" + }, + { + "name": "integer" + }, + { + "name": "long" + }, + { + "name": "short" + }, + { + "name": "byte" + }, + { + "name": "float" + }, + { + "name": "half_float" + }, + { + "name": "scaled_float" + }, + { + "name": "double" + }, + { + "name": "integer_range" + }, + { + "name": "float_range" + }, + { + "name": "long_range" + }, + { + "name": "double_range" + }, + { + "name": "date_range" + }, + { + "name": "ip_range" + }, + { + "name": "alias" + }, + { + "name": "join" + }, + { + "name": "rank_feature" + }, + { + "name": "rank_features" + }, + { + "name": "flattened" + }, + { + "name": "shape" + }, + { + "name": "histogram" + }, + { + "name": "constant_keyword" + }, + { + "name": "aggregate_metric_double" + }, + { + "name": "dense_vector" + }, + { + "name": "match_only_text" } ], "name": { - "name": "TermVectorOption", - "namespace": "_types.mapping" - } - }, - { - "kind": "interface", - "name": { - "name": "TextIndexPrefixes", + "name": "FieldType", "namespace": "_types.mapping" }, - "properties": [ - { - "name": "max_chars", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "min_chars", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] + "specLocation": "_types/mapping/Property.ts#L73-L116" }, { "inherits": { "type": { - "name": "CorePropertyBase", + "name": "PropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "TextProperty", + "name": "FlattenedProperty", "namespace": "_types.mapping" }, "properties": [ - { - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, { "name": "boost", "required": false, @@ -49583,35 +57017,35 @@ } }, { - "name": "eager_global_ordinals", + "name": "depth_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "fielddata", + "name": "doc_values", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "fielddata_frequency_filter", + "name": "eager_global_ordinals", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FielddataFrequencyFilter", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, @@ -49622,7 +57056,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -49638,79 +57072,177 @@ } }, { - "name": "index_phrases", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index_prefixes", + "name": "similarity", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TextIndexPrefixes", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "norms", + "name": "split_queries_on_whitespace", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "position_increment_gap", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "flattened" + } + } + ], + "specLocation": "_types/mapping/complex.ts#L25-L36" + }, + { + "inherits": { + "type": { + "name": "StandardNumberProperty", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "FloatNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "float" + } + }, + { + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "float", "namespace": "_types" } } + } + ], + "specLocation": "_types/mapping/core.ts#L156-L159" + }, + { + "inherits": { + "type": { + "name": "RangePropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "FloatRangeProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "float_range" + } + } + ], + "specLocation": "_types/mapping/range.ts#L46-L48" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "RIGHT", + "counterclockwise", + "ccw" + ], + "name": "right" }, { - "name": "search_analyzer", + "aliases": [ + "LEFT", + "clockwise", + "cw" + ], + "name": "left" + } + ], + "name": { + "name": "GeoOrientation", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/geo.ts#L30-L35" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "GeoPointProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "search_quote_analyzer", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "term_vector", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermVectorOption", - "namespace": "_types.mapping" + "name": "GeoLocation", + "namespace": "_types" } } }, @@ -49719,12 +57251,15 @@ "required": true, "type": { "kind": "literal_value", - "value": "text" + "value": "geo_point" } } - ] + ], + "specLocation": "_types/mapping/geo.ts#L23-L28" }, { + "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -49733,62 +57268,62 @@ }, "kind": "interface", "name": { - "name": "TokenCountProperty", + "name": "GeoShapeProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "analyzer", + "name": "coerce", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "boost", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "null_value", + "name": "orientation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "GeoOrientation", + "namespace": "_types.mapping" } } }, { - "name": "enable_position_increments", + "name": "strategy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "GeoStrategy", + "namespace": "_types.mapping" } } }, @@ -49797,259 +57332,151 @@ "required": true, "type": { "kind": "literal_value", - "value": "token_count" + "value": "geo_shape" } } - ] + ], + "specLocation": "_types/mapping/geo.ts#L37-L50" + }, + { + "kind": "enum", + "members": [ + { + "name": "recursive" + }, + { + "name": "term" + } + ], + "name": { + "name": "GeoStrategy", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/geo.ts#L52-L55" }, { + "inherits": { + "type": { + "name": "StandardNumberProperty", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "TypeMapping", + "name": "HalfFloatNumberProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "all_field", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "half_float" + } + }, + { + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AllField", - "namespace": "_types.mapping" + "name": "float", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/mapping/core.ts#L161-L164" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "HistogramProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "date_detection", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "dynamic", - "required": false, + "name": "type", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DynamicMapping", - "namespace": "_types.mapping" - } - } - ], - "kind": "union_of" + "kind": "literal_value", + "value": "histogram" } - }, + } + ], + "specLocation": "_types/mapping/specialized.ts#L53-L56" + }, + { + "kind": "interface", + "name": { + "name": "IndexField", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "dynamic_date_formats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "dynamic_templates", - "required": false, - "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - } - } - }, - { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - } - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "_field_names", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldNamesField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "index_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexField", - "namespace": "_types.mapping" - } - } - }, - { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } - }, - { - "name": "numeric_detection", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "properties", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L46-L48" + }, + { + "kind": "enum", + "members": [ { - "name": "_routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RoutingField", - "namespace": "_types.mapping" - } - } + "name": "docs" }, { - "name": "_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SizeField", - "namespace": "_types.mapping" - } - } + "name": "freqs" }, { - "name": "_source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceField", - "namespace": "_types.mapping" - } - } + "name": "positions" }, { - "name": "runtime", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "RuntimeField", - "namespace": "_types.mapping" - } - } - } + "name": "offsets" } - ] + ], + "name": { + "name": "IndexOptions", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/core.ts#L272-L277" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "StandardNumberProperty", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "VersionProperty", + "name": "IntegerNumberProperty", "namespace": "_types.mapping" }, "properties": [ @@ -50058,21 +57485,33 @@ "required": true, "type": { "kind": "literal_value", - "value": "version" + "value": "integer" + } + }, + { + "name": "null_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - ] + ], + "specLocation": "_types/mapping/core.ts#L171-L174" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "RangePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "WildcardProperty", + "name": "IntegerRangeProperty", "namespace": "_types.mapping" }, "properties": [ @@ -50081,899 +57520,1010 @@ "required": true, "type": { "kind": "literal_value", - "value": "wildcard" + "value": "integer_range" } } - ] + ], + "specLocation": "_types/mapping/range.ts#L50-L52" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "BoolQuery", - "namespace": "_types.query_dsl" + "name": "IpProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "filter", + "name": "boost", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } }, { - "name": "minimum_should_match", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "must", + "name": "null_value", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "must_not", + "name": "ignore_malformed", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "name": "should", - "required": false, + "name": "type", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" + "kind": "literal_value", + "value": "ip" } } - ] + ], + "specLocation": "_types/mapping/specialized.ts#L58-L64" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "RangePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "BoostingQuery", - "namespace": "_types.query_dsl" + "name": "IpRangeProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "negative_boost", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "literal_value", + "value": "ip_range" } - }, + } + ], + "specLocation": "_types/mapping/range.ts#L54-L56" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "JoinProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "negative", - "required": true, + "name": "relations", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" } } }, { - "name": "positive", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } + "kind": "literal_value", + "value": "join" } } - ] + ], + "specLocation": "_types/mapping/core.ts#L123-L126" }, { - "description": "A geo bounding box. The various coordinates can be mixed. When set, `wkt` takes precedence over all other fields.", + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "BoundingBox", - "namespace": "_types.query_dsl" + "name": "KeywordProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "bottom_right", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } }, { - "name": "top_left", + "name": "eager_global_ordinals", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "top_right", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "bottom_left", + "name": "index_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "IndexOptions", + "namespace": "_types.mapping" } } }, { - "name": "top", + "name": "normalizer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "left", + "name": "norms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "right", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "bottom", + "name": "split_queries_on_whitespace", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "wkt", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "keyword" } } - ] + ], + "specLocation": "_types/mapping/core.ts#L128-L138" }, { - "kind": "enum", - "members": [ - { - "name": "none" - }, - { - "name": "avg" - }, - { - "name": "sum" - }, - { - "name": "max" - }, - { - "name": "min" + "inherits": { + "type": { + "name": "StandardNumberProperty", + "namespace": "_types.mapping" } - ], + }, + "kind": "interface", "name": { - "name": "ChildScoreMode", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "enum", - "members": [ + "name": "LongNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "or" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "long" + } }, { - "name": "and" + "name": "null_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } } ], - "name": { - "name": "CombinedFieldsOperator", - "namespace": "_types.query_dsl" - } + "specLocation": "_types/mapping/core.ts#L176-L179" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "RangePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "CombinedFieldsQuery", - "namespace": "_types.query_dsl" + "name": "LongRangeProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "fields", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "kind": "literal_value", + "value": "long_range" } - }, + } + ], + "specLocation": "_types/mapping/range.ts#L58-L60" + }, + { + "description": "A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field\neffectively stores data the same way as a text field that only indexes documents (index_options: docs) and\ndisables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries\nthat need positions such as the match_phrase query perform slower as they need to look at the _source document\nto verify whether a phrase matches. All queries return constant scores that are equal to 1.0.", + "kind": "interface", + "name": { + "name": "MatchOnlyTextProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "query", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "match_only_text" } }, { - "name": "auto_generate_synonyms_phrase_query", + "description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.", + "docId": "multi-fields", + "name": "fields", "required": false, - "serverDefault": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } } } }, { - "name": "operator", + "description": "Metadata about the field.", + "docId": "mapping-meta-field", + "name": "meta", "required": false, - "serverDefault": "or", "type": { - "kind": "instance_of", - "type": { - "name": "CombinedFieldsOperator", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "mimimum_should_match", + "description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.", + "name": "copy_to", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", + "name": "Fields", "namespace": "_types" } } - }, - { - "name": "zero_terms_query", - "required": false, - "serverDefault": "none", - "type": { - "kind": "instance_of", - "type": { - "name": "CombinedFieldsZeroTerms", - "namespace": "_types.query_dsl" - } - } } - ] + ], + "specLocation": "_types/mapping/core.ts#L245-L270" }, { "kind": "enum", "members": [ { - "name": "none" + "name": "simple" }, { - "name": "all" + "name": "regex" } ], "name": { - "name": "CombinedFieldsZeroTerms", - "namespace": "_types.query_dsl" - } + "name": "MatchType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/dynamic-template.ts#L32-L35" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "CommonTermsQuery", - "namespace": "_types.query_dsl" + "name": "Murmur3HashProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "analyzer", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "murmur3" + } + } + ], + "specLocation": "_types/mapping/specialized.ts#L66-L68" + }, + { + "inherits": { + "type": { + "name": "CorePropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "NestedProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "cutoff_frequency", + "name": "include_in_parent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "high_freq_operator", + "name": "include_in_root", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Operator", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "low_freq_operator", - "required": false, + "name": "type", + "required": true, "type": { + "kind": "literal_value", + "value": "nested" + } + } + ], + "specLocation": "_types/mapping/complex.ts#L38-L43" + }, + { + "kind": "type_alias", + "name": { + "name": "NumberProperty", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/core.ts#L203-L212", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Operator", - "namespace": "_types.query_dsl" + "name": "FloatNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HalfFloatNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DoubleNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IntegerNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LongNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ShortNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ByteNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UnsignedLongNumberProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ScaledFloatNumberProperty", + "namespace": "_types.mapping" } } - }, + ], + "kind": "union_of" + } + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "minimum_should_match", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "query", - "required": true, + "name": "ignore_malformed", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } ], - "shortcutProperty": "query" + "specLocation": "_types/mapping/core.ts#L140-L143" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "CorePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "ConstantScoreQuery", - "namespace": "_types.query_dsl" + "name": "ObjectProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "filter", - "required": true, + "name": "enabled", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DecayPlacement", - "namespace": "_types.query_dsl" - } - } - ], + "name": "type", + "required": false, "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" + "kind": "literal_value", + "value": "object" } } ], - "inherits": { - "type": { - "name": "DecayFunctionBase", - "namespace": "_types.query_dsl" + "specLocation": "_types/mapping/complex.ts#L45-L48" + }, + { + "kind": "enum", + "members": [ + { + "name": "fail" + }, + { + "name": "continue" } - }, - "kind": "interface", + ], "name": { - "name": "DateDecayFunction", - "namespace": "_types.query_dsl" + "name": "OnScriptError", + "namespace": "_types.mapping" }, - "properties": [] + "specLocation": "_types/mapping/core.ts#L145-L148" }, { "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - ], "type": { - "name": "DistanceFeatureQueryBase", - "namespace": "_types.query_dsl" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "DateDistanceFeatureQuery", - "namespace": "_types.query_dsl" + "name": "PercolatorProperty", + "namespace": "_types.mapping" }, - "properties": [] + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "percolator" + } + } + ], + "specLocation": "_types/mapping/core.ts#L214-L216" }, { "inherits": { "type": { - "name": "RangeQueryBase", - "namespace": "_types.query_dsl" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "DateRangeQuery", - "namespace": "_types.query_dsl" + "name": "PointProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "gt", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - } - }, - { - "name": "gte", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - } - }, - { - "name": "lt", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateMath", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "lte", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateMath", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "format", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateFormat", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "time_zone", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "TimeZone", - "namespace": "_types" - } + "kind": "literal_value", + "value": "point" } } ], - "variantName": "date" + "specLocation": "_types/mapping/geo.ts#L62-L67" }, { "kind": "type_alias", "name": { - "name": "DecayFunction", - "namespace": "_types.query_dsl" + "name": "Property", + "namespace": "_types.mapping" }, + "specLocation": "_types/mapping/Property.ts#L55-L71", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "DateDecayFunction", - "namespace": "_types.query_dsl" + "name": "FlattenedProperty", + "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "NumericDecayFunction", - "namespace": "_types.query_dsl" + "name": "JoinProperty", + "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "GeoDecayFunction", - "namespace": "_types.query_dsl" + "name": "PercolatorProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RankFeatureProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RankFeaturesProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ConstantKeywordProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FieldAliasProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HistogramProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DenseVectorProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "AggregateMetricDoubleProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CoreProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DynamicProperty", + "namespace": "_types.mapping" } } ], "kind": "union_of" + }, + "variants": { + "defaultTag": "object", + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" } }, { - "inherits": { - "type": { - "name": "ScoreFunctionBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "DecayFunctionBase", - "namespace": "_types.query_dsl" + "name": "PropertyBase", + "namespace": "_types.mapping" }, "properties": [ { - "name": "multi_value_mode", + "description": "Metadata about the field.", + "docId": "mapping-meta-field", + "name": "meta", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "MultiValueMode", - "namespace": "_types.query_dsl" - } - } - } - ] - }, - { - "generics": [ - { - "name": "TOrigin", - "namespace": "_types.query_dsl" - }, - { - "name": "TScale", - "namespace": "_types.query_dsl" - } - ], - "kind": "interface", - "name": { - "name": "DecayPlacement", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "decay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "offset", + "name": "properties", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "TScale", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } } } }, { - "name": "scale", + "name": "ignore_above", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TScale", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "name": "origin", + "name": "dynamic", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TOrigin", - "namespace": "_types.query_dsl" + "name": "DynamicMapping", + "namespace": "_types.mapping" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "DisMaxQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "queries", - "required": true, + "name": "fields", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "Property", + "namespace": "_types.mapping" } } } - }, - { - "name": "tie_breaker", - "required": false, - "serverDefault": "0.0", - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } } - ] + ], + "specLocation": "_types/mapping/Property.ts#L43-L53" }, { "kind": "type_alias", "name": { - "name": "DistanceFeatureQuery", - "namespace": "_types.query_dsl" + "name": "RangeProperty", + "namespace": "_types.mapping" }, + "specLocation": "_types/mapping/range.ts#L29-L35", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "GeoDistanceFeatureQuery", - "namespace": "_types.query_dsl" + "name": "LongRangeProperty", + "namespace": "_types.mapping" } }, { "kind": "instance_of", "type": { - "name": "DateDistanceFeatureQuery", - "namespace": "_types.query_dsl" + "name": "IpRangeProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IntegerRangeProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FloatRangeProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DoubleRangeProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateRangeProperty", + "namespace": "_types.mapping" } } ], @@ -50981,218 +58531,268 @@ } }, { - "generics": [ - { - "name": "TOrigin", - "namespace": "_types.query_dsl" - }, - { - "name": "TDistance", - "namespace": "_types.query_dsl" - } - ], "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "DistanceFeatureQueryBase", - "namespace": "_types.query_dsl" + "name": "RangePropertyBase", + "namespace": "_types.mapping" }, "properties": [ { - "name": "origin", - "required": true, + "name": "boost", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TOrigin", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } }, { - "name": "pivot", - "required": true, + "name": "coerce", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TDistance", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "field", - "required": true, + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/mapping/range.ts#L23-L27" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "ExistsQuery", - "namespace": "_types.query_dsl" + "name": "RankFeatureProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "field", - "required": true, + "name": "positive_score_impact", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "rank_feature" + } + } + ], + "specLocation": "_types/mapping/core.ts#L218-L221" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "RankFeaturesProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "rank_features" + } } - ] + ], + "specLocation": "_types/mapping/core.ts#L223-L225" }, { "kind": "interface", "name": { - "name": "FieldLookup", - "namespace": "_types.query_dsl" + "name": "RoutingField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "id", + "name": "required", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L50-L52" + }, + { + "kind": "interface", + "name": { + "name": "RuntimeField", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "index", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "path", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Script", "namespace": "_types" } } }, { - "name": "routing", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "RuntimeFieldType", + "namespace": "_types.mapping" } } } - ] + ], + "specLocation": "_types/mapping/RuntimeFields.ts#L26-L30" }, { "kind": "enum", "members": [ { - "name": "none" - }, - { - "name": "log" - }, - { - "name": "log1p" - }, - { - "name": "log2p" + "name": "boolean" }, { - "name": "ln" + "name": "date" }, { - "name": "ln1p" + "name": "double" }, { - "name": "ln2p" + "name": "geo_point" }, { - "name": "square" + "name": "ip" }, { - "name": "sqrt" + "name": "keyword" }, { - "name": "reciprocal" + "name": "long" } ], "name": { - "name": "FieldValueFactorModifier", - "namespace": "_types.query_dsl" + "name": "RuntimeFieldType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/RuntimeFields.ts#L32-L40" + }, + { + "kind": "type_alias", + "name": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/RuntimeFields.ts#L24-L24", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RuntimeField", + "namespace": "_types.mapping" + } + } } }, { "inherits": { "type": { - "name": "ScoreFunctionBase", - "namespace": "_types.query_dsl" + "name": "NumberPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "FieldValueFactorScoreFunction", - "namespace": "_types.query_dsl" + "name": "ScaledFloatNumberProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "field", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "kind": "literal_value", + "value": "scaled_float" } }, { - "name": "factor", + "name": "coerce", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "missing", + "name": "null_value", "required": false, "type": { "kind": "instance_of", @@ -51203,1522 +58803,1293 @@ } }, { - "name": "modifier", + "name": "scaling_factor", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldValueFactorModifier", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "multiply" - }, - { - "name": "replace" - }, - { - "name": "sum" - }, - { - "name": "avg" - }, - { - "name": "max" - }, - { - "name": "min" - } ], - "name": { - "name": "FunctionBoostMode", - "namespace": "_types.query_dsl" - } + "specLocation": "_types/mapping/core.ts#L196-L201" }, { + "inherits": { + "type": { + "name": "CorePropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "FunctionScoreContainer", - "namespace": "_types.query_dsl" + "name": "SearchAsYouTypeProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "exp", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DecayFunction", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "gauss", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DecayFunction", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "linear", + "name": "index_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DecayFunction", - "namespace": "_types.query_dsl" + "name": "IndexOptions", + "namespace": "_types.mapping" } } }, { - "name": "field_value_factor", + "name": "max_shingle_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldValueFactorScoreFunction", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "name": "random_score", + "name": "norms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RandomScoreFunction", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "script_score", + "name": "search_analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptScoreFunction", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "containerProperty": true, - "name": "filter", + "name": "search_quote_analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "containerProperty": true, - "name": "weight", + "name": "term_vector", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "TermVectorOption", + "namespace": "_types.mapping" } } - } - ], - "variants": { - "kind": "container" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "multiply" - }, - { - "name": "sum" - }, - { - "name": "avg" - }, - { - "name": "first" - }, - { - "name": "max" }, { - "name": "min" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "search_as_you_type" + } } ], - "name": { - "name": "FunctionScoreMode", - "namespace": "_types.query_dsl" - } + "specLocation": "_types/mapping/core.ts#L227-L237" }, { + "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "FunctionScoreQuery", - "namespace": "_types.query_dsl" + "name": "ShapeProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "boost_mode", + "name": "coerce", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FunctionBoostMode", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "functions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FunctionScoreContainer", - "namespace": "_types.query_dsl" - } + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_boost", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "min_score", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "query", + "name": "orientation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "GeoOrientation", + "namespace": "_types.mapping" } } }, { - "name": "score_mode", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "FunctionScoreMode", - "namespace": "_types.query_dsl" - } + "kind": "literal_value", + "value": "shape" } } - ] + ], + "specLocation": "_types/mapping/geo.ts#L69-L81" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "StandardNumberProperty", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "FuzzyQuery", - "namespace": "_types.query_dsl" + "name": "ShortNumberProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "max_expansions", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "literal_value", + "value": "short" } }, { - "name": "prefix_length", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "short", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/mapping/core.ts#L181-L184" + }, + { + "kind": "interface", + "name": { + "name": "SizeField", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "rewrite", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L54-L56" + }, + { + "kind": "interface", + "name": { + "name": "SourceField", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "transpositions", + "name": "compress", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "fuzziness", + "name": "compress_threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "value", - "required": true, + "name": "enabled", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "shortcutProperty": "value" - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { + "name": "excludes", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + }, + { + "name": "includes", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "BoundingBox", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } - ], - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" } } ], + "specLocation": "_types/mapping/meta-fields.ts#L58-L64" + }, + { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "NumberPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "GeoBoundingBoxQuery", - "namespace": "_types.query_dsl" + "name": "StandardNumberProperty", + "namespace": "_types.mapping" }, "properties": [ { - "deprecation": { - "version": "7.14.0" - }, - "name": "type", + "name": "coerce", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoExecution", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "validation_method", + "name": "script", "required": false, - "serverDefault": "'strict'", "type": { "kind": "instance_of", "type": { - "name": "GeoValidationMethod", - "namespace": "_types.query_dsl" - } - } - } - ] - }, - { - "description": "Represents a Latitude/Longitude and optional Z value as a 2 or 3 dimensional point", - "kind": "type_alias", - "name": { - "name": "GeoCoordinate", - "namespace": "_types.query_dsl" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "ThreeDimensionalPoint", - "namespace": "_types.query_dsl" + "name": "Script", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Distance", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DecayPlacement", - "namespace": "_types.query_dsl" - } - } - ], + "name": "on_script_error", + "required": false, "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" - } - } - ], - "inherits": { - "type": { - "name": "DecayFunctionBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "GeoDecayFunction", - "namespace": "_types.query_dsl" - }, - "properties": [] - }, - { - "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "GeoCoordinate", - "namespace": "_types.query_dsl" - } - }, - { "kind": "instance_of", "type": { - "name": "Distance", - "namespace": "_types" + "name": "OnScriptError", + "namespace": "_types.mapping" } } - ], - "type": { - "name": "DistanceFeatureQueryBase", - "namespace": "_types.query_dsl" } - }, - "kind": "interface", - "name": { - "name": "GeoDistanceFeatureQuery", - "namespace": "_types.query_dsl" - }, - "properties": [] + ], + "specLocation": "_types/mapping/core.ts#L150-L154" }, { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" - } - } - ], - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" - } - } - ], - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "GeoDistanceQuery", - "namespace": "_types.query_dsl" + "name": "SuggestContext", + "namespace": "_types.mapping" }, "properties": [ { - "name": "distance", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Distance", + "name": "Name", "namespace": "_types" } } }, { - "name": "distance_type", + "name": "path", "required": false, - "serverDefault": "'arc'", "type": { "kind": "instance_of", "type": { - "name": "GeoDistanceType", + "name": "Field", "namespace": "_types" } } }, { - "name": "validation_method", - "required": false, - "serverDefault": "'strict'", + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoValidationMethod", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } + }, + { + "name": "precision", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } - ] + ], + "specLocation": "_types/mapping/specialized.ts#L36-L41" }, { "kind": "enum", "members": [ { - "name": "memory" + "name": "no" }, { - "name": "indexed" + "name": "yes" + }, + { + "name": "with_offsets" + }, + { + "name": "with_positions" + }, + { + "name": "with_positions_offsets" + }, + { + "name": "with_positions_offsets_payloads" + }, + { + "name": "with_positions_payloads" } ], "name": { - "name": "GeoExecution", - "namespace": "_types.query_dsl" - } - }, - { - "description": "Represents a Latitude/Longitude as a 2 dimensional point", - "kind": "type_alias", - "name": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" + "name": "TermVectorOption", + "namespace": "_types.mapping" }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TwoDimensionalPoint", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "union_of" - } + "specLocation": "_types/mapping/TermVectorOption.ts#L20-L28" }, { "kind": "interface", "name": { - "name": "GeoPolygonPoints", - "namespace": "_types.query_dsl" + "name": "TextIndexPrefixes", + "namespace": "_types.mapping" }, "properties": [ { - "name": "points", + "name": "max_chars", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoPolygonPoints", - "namespace": "_types.query_dsl" - } - } - ], + "name": "min_chars", + "required": true, "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } ], - "deprecation": { - "version": "7.12.0 Use geo-shape instead." - }, + "specLocation": "_types/mapping/core.ts#L279-L282" + }, + { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "CorePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "GeoPolygonQuery", - "namespace": "_types.query_dsl" + "name": "TextProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "validation_method", + "name": "analyzer", "required": false, - "serverDefault": "'strict'", "type": { "kind": "instance_of", "type": { - "name": "GeoValidationMethod", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "GeoShapeFieldQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "shape", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoShape", + "name": "double", "namespace": "_types" } } }, { - "name": "indexed_shape", + "name": "eager_global_ordinals", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldLookup", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "relation", + "name": "fielddata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoShapeRelation", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoShapeFieldQuery", - "namespace": "_types.query_dsl" - } - } - ], - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" - } - } - ], - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "GeoShapeQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "ignore_unmapped", - "required": false, + "name": "fielddata_frequency_filter", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "FielddataFrequencyFilter", + "namespace": "indices._types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "coerce" - }, - { - "name": "ignore_malformed" }, { - "name": "strict" - } - ], - "name": { - "name": "GeoValidationMethod", - "namespace": "_types.query_dsl" - } - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "HasChildQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "ignore_unmapped", + "name": "index", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "inner_hits", + "name": "index_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "IndexOptions", + "namespace": "_types.mapping" } } }, { - "name": "max_children", + "name": "index_phrases", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "min_children", + "name": "index_prefixes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "TextIndexPrefixes", + "namespace": "_types.mapping" } } }, { - "name": "score_mode", + "name": "norms", "required": false, - "serverDefault": "'none'", "type": { "kind": "instance_of", "type": { - "name": "ChildScoreMode", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "position_increment_gap", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "RelationName", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "HasParentQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "ignore_unmapped", + "name": "search_analyzer", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "inner_hits", + "name": "search_quote_analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "parent_type", - "required": true, + "name": "term_vector", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "RelationName", - "namespace": "_types" + "name": "TermVectorOption", + "namespace": "_types.mapping" } } }, { - "name": "query", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "score", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "text" } } - ] + ], + "specLocation": "_types/mapping/core.ts#L284-L300" }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "IdsQuery", - "namespace": "_types.query_dsl" + "name": "TokenCountProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "values", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IntervalsAllOf", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "intervals", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" - } + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_gaps", + "name": "boost", "required": false, - "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "ordered", + "name": "index", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "filter", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsFilter", - "namespace": "_types.query_dsl" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IntervalsAnyOf", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "intervals", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" - } + "name": "double", + "namespace": "_types" } } }, { - "name": "filter", + "name": "enable_position_increments", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsFilter", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "token_count" + } } - ] + ], + "specLocation": "_types/mapping/specialized.ts#L70-L77" }, { "kind": "interface", "name": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "TypeMapping", + "namespace": "_types.mapping" }, "properties": [ { - "name": "all_of", + "name": "all_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsAllOf", - "namespace": "_types.query_dsl" + "name": "AllField", + "namespace": "_types.mapping" } } }, { - "name": "any_of", + "name": "date_detection", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsAnyOf", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "fuzzy", + "name": "dynamic", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsFuzzy", - "namespace": "_types.query_dsl" + "name": "DynamicMapping", + "namespace": "_types.mapping" } } }, { - "name": "match", + "name": "dynamic_date_formats", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsMatch", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "prefix", + "name": "dynamic_templates", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsPrefix", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "DynamicTemplate", + "namespace": "_types.mapping" + } + } } } }, { - "name": "wildcard", + "name": "_field_names", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsWildcard", - "namespace": "_types.query_dsl" + "name": "FieldNamesField", + "namespace": "_types.mapping" } } - } - ], - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "IntervalsFilter", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "after", + "name": "index_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "IndexField", + "namespace": "_types.mapping" } } }, { - "name": "before", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "Metadata", + "namespace": "_types" } } }, { - "name": "contained_by", + "name": "numeric_detection", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "containing", + "name": "properties", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } } } }, { - "name": "not_contained_by", + "name": "_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "RoutingField", + "namespace": "_types.mapping" } } }, { - "name": "not_containing", + "name": "_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "SizeField", + "namespace": "_types.mapping" } } }, { - "name": "not_overlapping", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "SourceField", + "namespace": "_types.mapping" } } }, { - "name": "overlapping", + "name": "runtime", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RuntimeField", + "namespace": "_types.mapping" + } } } }, { - "name": "script", + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "variants": { - "kind": "container" - } + "specLocation": "_types/mapping/TypeMapping.ts#L34-L51" }, { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "IntervalsFuzzy", - "namespace": "_types.query_dsl" + "name": "UnsignedLongNumberProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "fuzziness", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Fuzziness", - "namespace": "_types" - } + "kind": "literal_value", + "value": "unsigned_long" } }, { - "name": "prefix_length", + "name": "null_value", "required": false, - "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ulong", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/mapping/core.ts#L191-L194" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "VersionProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "term", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "literal_value", + "value": "version" } - }, + } + ], + "specLocation": "_types/mapping/core.ts#L302-L304" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "WildcardProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "transpositions", - "required": false, - "serverDefault": true, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "kind": "literal_value", + "value": "wildcard" } }, { - "name": "use_field", + "name": "null_value", "required": false, + "since": "7.15.0", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/mapping/core.ts#L306-L310" }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsMatch", + "name": "BoolQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", + "name": "filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" } }, { - "name": "max_gaps", + "name": "minimum_should_match", "required": false, - "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "MinimumShouldMatch", "namespace": "_types" } } }, { - "name": "ordered", + "name": "must", "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "query", - "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" } }, { - "name": "use_field", + "name": "must_not", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" } }, { - "name": "filter", + "name": "should", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsFilter", - "namespace": "_types.query_dsl" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" } } - ] + ], + "specLocation": "_types/query_dsl/compound.ts#L28-L34" }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsPrefix", + "name": "BoostingQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", - "required": false, + "name": "negative_boost", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "prefix", + "name": "negative", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "use_field", - "required": false, + "name": "positive", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } } - ] + ], + "specLocation": "_types/query_dsl/compound.ts#L36-L40" + }, + { + "kind": "enum", + "members": [ + { + "name": "none" + }, + { + "name": "avg" + }, + { + "name": "sum" + }, + { + "name": "max" + }, + { + "name": "min" + } + ], + "name": { + "name": "ChildScoreMode", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/joining.ts#L25-L39" + }, + { + "kind": "enum", + "members": [ + { + "name": "or" + }, + { + "name": "and" + } + ], + "name": { + "name": "CombinedFieldsOperator", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/abstractions.ts#L201-L204" }, { "inherits": { @@ -52729,85 +60100,111 @@ }, "kind": "interface", "name": { - "name": "IntervalsQuery", + "name": "CombinedFieldsQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "all_of", - "required": false, + "name": "fields", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsAllOf", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } } } }, { - "name": "any_of", - "required": false, + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IntervalsAnyOf", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "fuzzy", + "name": "auto_generate_synonyms_phrase_query", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "IntervalsFuzzy", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "match", + "name": "operator", "required": false, + "serverDefault": "or", "type": { "kind": "instance_of", "type": { - "name": "IntervalsMatch", + "name": "CombinedFieldsOperator", "namespace": "_types.query_dsl" } } }, { - "name": "prefix", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsPrefix", - "namespace": "_types.query_dsl" + "name": "MinimumShouldMatch", + "namespace": "_types" } } }, { - "name": "wildcard", + "name": "zero_terms_query", "required": false, + "serverDefault": "none", "type": { "kind": "instance_of", "type": { - "name": "IntervalsWildcard", + "name": "CombinedFieldsZeroTerms", "namespace": "_types.query_dsl" } } } ], - "variants": { - "kind": "container" - } + "specLocation": "_types/query_dsl/abstractions.ts#L180-L194" + }, + { + "kind": "enum", + "members": [ + { + "name": "none" + }, + { + "name": "all" + } + ], + "name": { + "name": "CombinedFieldsZeroTerms", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/abstractions.ts#L206-L209" }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsWildcard", + "name": "CommonTermsQuery", "namespace": "_types.query_dsl" }, "properties": [ @@ -52818,394 +60215,436 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "pattern", - "required": true, + "name": "cutoff_frequency", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "use_field", + "name": "high_freq_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ] - }, - { - "description": "Text that we want similar documents for or a lookup to a document's field for the text.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", - "kind": "type_alias", - "name": { - "name": "Like", - "namespace": "_types.query_dsl" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LikeDocument", + "name": "Operator", "namespace": "_types.query_dsl" } } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "LikeDocument", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "doc", - "required": false, - "type": { - "kind": "user_defined_value" - } }, { - "name": "fields", + "name": "low_freq_operator", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { - "name": "_id", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "MinimumShouldMatch", "namespace": "_types" } } }, { - "name": "_type", - "required": false, + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Type", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L33-L43" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "ConstantScoreQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "_index", - "required": false, + "name": "filter", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/compound.ts#L42-L44" + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ { - "name": "per_field_analyzer", - "required": false, - "type": { - "key": { + "generics": [ + { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "DateMath", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DecayPlacement", + "namespace": "_types.query_dsl" } } - } - }, - { - "name": "routing", - "required": false, + ], "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } + "name": "AdditionalProperty", + "namespace": "_spec_utils" } - }, - { - "name": "version", - "required": false, - "type": { + } + ], + "inherits": { + "type": { + "name": "DecayFunctionBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "DateDecayFunction", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/compound.ts#L92-L94" + }, + { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "DateMath", "namespace": "_types" } - } - }, - { - "name": "version_type", - "required": false, - "serverDefault": "'internal'", - "type": { + }, + { "kind": "instance_of", "type": { - "name": "VersionType", + "name": "Time", "namespace": "_types" } } - } - ] - }, - { - "inherits": { + ], "type": { - "name": "QueryBase", + "name": "DistanceFeatureQueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "MatchAllQuery", + "name": "DateDistanceFeatureQuery", "namespace": "_types.query_dsl" }, - "properties": [] + "properties": [], + "specLocation": "_types/query_dsl/specialized.ts#L52-L55" }, { "inherits": { "type": { - "name": "QueryBase", + "name": "RangeQueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "MatchBoolPrefixQuery", + "name": "DateRangeQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", + "name": "gt", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DateMath", + "namespace": "_types" } } }, { - "name": "fuzziness", + "name": "gte", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", + "name": "DateMath", "namespace": "_types" } } }, { - "name": "fuzzy_rewrite", + "name": "lt", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "DateMath", "namespace": "_types" } } }, { - "name": "fuzzy_transpositions", + "name": "lte", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DateMath", + "namespace": "_types" } } }, { - "name": "max_expansions", + "name": "from", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DateMath", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "minimum_should_match", + "name": "to", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DateMath", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "operator", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Operator", - "namespace": "_types.query_dsl" + "name": "DateFormat", + "namespace": "_types" } } }, { - "name": "prefix_length", + "name": "time_zone", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "TimeZone", "namespace": "_types" } } - }, - { - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } } ], - "shortcutProperty": "query" + "specLocation": "_types/query_dsl/term.ts#L72-L81" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", + "codegenNames": [ + "date", + "numeric", + "geo" + ], + "kind": "type_alias", "name": { - "name": "MatchNoneQuery", + "name": "DecayFunction", "namespace": "_types.query_dsl" }, - "properties": [] + "specLocation": "_types/query_dsl/compound.ts#L100-L105", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DateDecayFunction", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NumericDecayFunction", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoDecayFunction", + "namespace": "_types.query_dsl" + } + } + ], + "kind": "union_of" + } }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "MatchPhrasePrefixQuery", + "name": "DecayFunctionBase", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", + "name": "multi_value_mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "MultiValueMode", + "namespace": "_types.query_dsl" } } + } + ], + "specLocation": "_types/query_dsl/compound.ts#L84-L86" + }, + { + "generics": [ + { + "name": "TOrigin", + "namespace": "_types.query_dsl" }, { - "name": "max_expansions", + "name": "TScale", + "namespace": "_types.query_dsl" + } + ], + "kind": "interface", + "name": { + "name": "DecayPlacement", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "decay", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "query", - "required": true, + "name": "offset", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TScale", + "namespace": "_types.query_dsl" } } }, { - "name": "slop", + "name": "scale", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TScale", + "namespace": "_types.query_dsl" } } }, { - "name": "zero_terms_query", + "name": "origin", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", + "name": "TOrigin", "namespace": "_types.query_dsl" } } } ], - "shortcutProperty": "query" + "specLocation": "_types/query_dsl/compound.ts#L77-L82" }, { "inherits": { @@ -53216,59 +60655,81 @@ }, "kind": "interface", "name": { - "name": "MatchPhraseQuery", + "name": "DisMaxQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "query", + "name": "queries", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } } } }, { - "name": "slop", + "name": "tie_breaker", "required": false, - "serverDefault": "0", + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } - }, - { - "name": "zero_terms_query", - "required": false, - "type": { + } + ], + "specLocation": "_types/query_dsl/compound.ts#L46-L50" + }, + { + "codegenNames": [ + "geo", + "date" + ], + "kind": "type_alias", + "name": { + "name": "DistanceFeatureQuery", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/specialized.ts#L57-L61", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", + "name": "GeoDistanceFeatureQuery", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateDistanceFeatureQuery", "namespace": "_types.query_dsl" } } - } - ], - "shortcutProperty": "query" + ], + "kind": "union_of" + } }, { + "generics": [ + { + "name": "TOrigin", + "namespace": "_types.query_dsl" + }, + { + "name": "TDistance", + "namespace": "_types.query_dsl" + } + ], "inherits": { "type": { "name": "QueryBase", @@ -53277,638 +60738,479 @@ }, "kind": "interface", "name": { - "name": "MatchQuery", + "name": "DistanceFeatureQueryBase", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", - "required": false, + "name": "origin", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TOrigin", + "namespace": "_types.query_dsl" } } }, { - "name": "auto_generate_synonyms_phrase_query", - "required": false, - "serverDefault": true, + "name": "pivot", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TDistance", + "namespace": "_types.query_dsl" } } }, { - "deprecation": { - "version": "7.3.0" - }, - "name": "cutoff_frequency", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L41-L45" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "ExistsQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "fuzziness", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/term.ts#L36-L38" + }, + { + "description": "A reference to a field with formatting instructions on how to return the value", + "kind": "interface", + "name": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "fuzzy_rewrite", - "required": false, + "description": "Wildcard pattern. The request returns values for field names matching this pattern.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "Field", "namespace": "_types" } } }, { - "name": "fuzzy_transpositions", + "description": "Format in which the values are returned.", + "name": "format", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "lenient", + "name": "include_unmapped", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "shortcutProperty": "field", + "specLocation": "_types/query_dsl/abstractions.ts#L211-L225" + }, + { + "kind": "interface", + "name": { + "name": "FieldLookup", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "max_expansions", - "required": false, - "serverDefault": "50", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "name": "minimum_should_match", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "operator", - "required": false, - "serverDefault": "'or'", - "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "prefix_length", + "name": "path", "required": false, - "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } }, { - "name": "query", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "zero_terms_query", + "name": "routing", "required": false, - "serverDefault": "'none'", "type": { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" + "name": "Routing", + "namespace": "_types" } } } ], - "shortcutProperty": "query" + "specLocation": "_types/query_dsl/abstractions.ts#L163-L168" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MoreLikeThisQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "name": "none" }, { - "name": "boost_terms", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "name": "log" }, { - "name": "fail_on_unsupported_field", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "log1p" }, { - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } + "name": "log2p" }, { - "name": "include", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "ln" }, { - "name": "like", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } + "name": "ln1p" }, { - "name": "max_doc_freq", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "ln2p" }, { - "name": "max_query_terms", - "required": false, - "serverDefault": "25", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "square" }, { - "name": "max_word_length", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "sqrt" }, { - "name": "min_doc_freq", - "required": false, - "serverDefault": "5", + "name": "reciprocal" + } + ], + "name": { + "name": "FieldValueFactorModifier", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/compound.ts#L147-L158" + }, + { + "kind": "interface", + "name": { + "name": "FieldValueFactorScoreFunction", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } }, { - "name": "minimum_should_match", + "name": "factor", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", + "name": "double", "namespace": "_types" } } }, { - "name": "min_term_freq", + "name": "missing", "required": false, - "serverDefault": "2", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "min_word_length", + "name": "modifier", "required": false, - "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FieldValueFactorModifier", + "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/compound.ts#L70-L75" + }, + { + "kind": "enum", + "members": [ { - "name": "per_field_analyzer", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } + "name": "multiply" }, { - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } + "name": "replace" }, { - "name": "stop_words", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } + "name": "sum" }, { - "name": "unlike", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } + "name": "avg" }, { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } + "name": "max" }, { - "name": "version_type", - "required": false, - "serverDefault": "'internal'", - "type": { - "kind": "instance_of", - "type": { - "name": "VersionType", - "namespace": "_types" - } - } + "name": "min" } - ] + ], + "name": { + "name": "FunctionBoostMode", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/compound.ts#L138-L145" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, + "esQuirk": "this container is valid without a variant. Despite being documented as a function, 'weight'\nis actually a container property that can be combined with a function. Comment in the ES code\n(SearchModule#registerScoreFunctions) says: Weight doesn't have its own parser, so every function\nsupports it out of the box. Can be a single function too when not associated to any other function,\nwhich is why it needs to be registered manually here.", "kind": "interface", "name": { - "name": "MultiMatchQuery", + "name": "FunctionScoreContainer", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", + "name": "exp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DecayFunction", + "namespace": "_types.query_dsl" } } }, { - "name": "auto_generate_synonyms_phrase_query", + "name": "gauss", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DecayFunction", + "namespace": "_types.query_dsl" } } }, { - "deprecation": { - "version": "7.3.0" - }, - "name": "cutoff_frequency", + "name": "linear", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DecayFunction", + "namespace": "_types.query_dsl" } } }, { - "name": "fields", + "name": "field_value_factor", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "FieldValueFactorScoreFunction", + "namespace": "_types.query_dsl" } } }, { - "name": "fuzziness", + "name": "random_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", - "namespace": "_types" + "name": "RandomScoreFunction", + "namespace": "_types.query_dsl" } } }, { - "name": "fuzzy_rewrite", + "name": "script_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "ScriptScoreFunction", + "namespace": "_types.query_dsl" } } }, { - "name": "fuzzy_transpositions", + "containerProperty": true, + "name": "filter", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "lenient", + "containerProperty": true, + "name": "weight", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } + } + ], + "specLocation": "_types/query_dsl/compound.ts#L107-L127", + "variants": { + "kind": "container" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "multiply" }, { - "name": "max_expansions", - "required": false, - "serverDefault": "50", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "sum" }, { - "name": "minimum_should_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" - } - } + "name": "avg" }, { - "name": "operator", - "required": false, - "serverDefault": "'or'", - "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } - } + "name": "first" }, { - "name": "prefix_length", + "name": "max" + }, + { + "name": "min" + } + ], + "name": { + "name": "FunctionScoreMode", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/compound.ts#L129-L136" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "FunctionScoreQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "boost_mode", "required": false, - "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FunctionBoostMode", + "namespace": "_types.query_dsl" } } }, { - "name": "query", - "required": true, + "name": "functions", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FunctionScoreContainer", + "namespace": "_types.query_dsl" + } } } }, { - "name": "slop", + "name": "max_boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "tie_breaker", + "name": "min_score", "required": false, "type": { "kind": "instance_of", @@ -53919,50 +61221,29 @@ } }, { - "name": "type", + "name": "query", "required": false, - "serverDefault": "'best_fields'", "type": { "kind": "instance_of", "type": { - "name": "TextQueryType", + "name": "QueryContainer", "namespace": "_types.query_dsl" } } }, { - "name": "zero_terms_query", + "name": "score_mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", + "name": "FunctionScoreMode", "namespace": "_types.query_dsl" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "min" - }, - { - "name": "max" - }, - { - "name": "avg" - }, - { - "name": "sum" - } ], - "name": { - "name": "MultiValueMode", - "namespace": "_types.query_dsl" - } + "specLocation": "_types/query_dsl/compound.ts#L52-L59" }, { "inherits": { @@ -53973,152 +61254,179 @@ }, "kind": "interface", "name": { - "name": "NestedQuery", + "name": "FuzzyQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "ignore_unmapped", + "name": "max_expansions", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "inner_hits", + "name": "prefix_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "path", - "required": true, + "name": "rewrite", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "name": "query", - "required": true, + "name": "transpositions", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "score_mode", + "name": "fuzziness", "required": false, - "serverDefault": "'avg'", "type": { "kind": "instance_of", "type": { - "name": "NestedScoreMode", - "namespace": "_types.query_dsl" + "name": "Fuzziness", + "namespace": "_types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "avg" - }, - { - "name": "sum" - }, - { - "name": "min" - }, - { - "name": "max" }, { - "name": "none" + "name": "value", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } ], - "name": { - "name": "NestedScoreMode", - "namespace": "_types.query_dsl" - } + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L40-L51" }, { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoBounds", + "namespace": "_types" + } + } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], "inherits": { "type": { - "name": "RangeQueryBase", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "NumberRangeQuery", + "name": "GeoBoundingBoxQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "gt", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "gte", + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "GeoExecution", + "namespace": "_types.query_dsl" } } }, { - "name": "lt", + "name": "validation_method", "required": false, + "serverDefault": "'strict'", "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "GeoValidationMethod", + "namespace": "_types.query_dsl" } } }, { - "name": "lte", + "name": "ignore_unmapped", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "variantName": "number" + "specLocation": "_types/query_dsl/geo.ts#L32-L41" }, { "attachedBehaviors": [ @@ -54139,14 +61447,14 @@ { "kind": "instance_of", "type": { - "name": "double", + "name": "GeoLocation", "namespace": "_types" } }, { "kind": "instance_of", "type": { - "name": "double", + "name": "Distance", "namespace": "_types" } } @@ -54172,27 +61480,71 @@ }, "kind": "interface", "name": { - "name": "NumericDecayFunction", + "name": "GeoDecayFunction", "namespace": "_types.query_dsl" }, - "properties": [] + "properties": [], + "specLocation": "_types/query_dsl/compound.ts#L96-L98" }, { - "kind": "enum", - "members": [ - { - "name": "and" - }, - { - "name": "or" + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "Distance", + "namespace": "_types" + } + } + ], + "type": { + "name": "DistanceFeatureQueryBase", + "namespace": "_types.query_dsl" } - ], + }, + "kind": "interface", "name": { - "name": "Operator", + "name": "GeoDistanceFeatureQuery", "namespace": "_types.query_dsl" - } + }, + "properties": [], + "specLocation": "_types/query_dsl/specialized.ts#L47-L50" }, { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], "inherits": { "type": { "name": "QueryBase", @@ -54201,154 +61553,286 @@ }, "kind": "interface", "name": { - "name": "ParentIdQuery", + "name": "GeoDistanceQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "id", + "name": "distance", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Distance", "namespace": "_types" } } }, { - "name": "ignore_unmapped", + "name": "distance_type", "required": false, - "serverDefault": false, + "serverDefault": "'arc'", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "GeoDistanceType", + "namespace": "_types" } } }, { - "name": "type", + "name": "validation_method", "required": false, + "serverDefault": "'strict'", "type": { "kind": "instance_of", "type": { - "name": "RelationName", - "namespace": "_types" + "name": "GeoValidationMethod", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", + "name": "ignore_unmapped", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/query_dsl/geo.ts#L48-L63" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "kind": "enum", + "members": [ + { + "name": "memory" + }, + { + "name": "indexed" } - }, - "kind": "interface", + ], "name": { - "name": "PercolateQuery", + "name": "GeoExecution", "namespace": "_types.query_dsl" }, - "properties": [ - { - "name": "document", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, + "specLocation": "_types/query_dsl/geo.ts#L43-L46" + }, + { + "kind": "interface", + "name": { + "name": "GeoPolygonPoints", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "documents", - "required": false, + "name": "points", + "required": true, "type": { "kind": "array_of", "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } } } - }, + } + ], + "specLocation": "_types/query_dsl/geo.ts#L65-L67" + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoPolygonPoints", + "namespace": "_types.query_dsl" + } } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" } - }, + } + ], + "deprecation": { + "description": "Use geo-shape instead.", + "version": "7.12.0" + }, + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "GeoPolygonQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "id", + "name": "validation_method", "required": false, + "serverDefault": "'strict'", "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "GeoValidationMethod", + "namespace": "_types.query_dsl" } } }, { - "name": "index", + "name": "ignore_unmapped", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/query_dsl/geo.ts#L69-L77" + }, + { + "kind": "interface", + "name": { + "name": "GeoShapeFieldQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "name", + "name": "shape", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "GeoShape", + "namespace": "_types" } } }, { - "name": "preference", + "name": "indexed_shape", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FieldLookup", + "namespace": "_types.query_dsl" } } }, { - "name": "routing", + "name": "relation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "GeoShapeRelation", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/geo.ts#L84-L88" + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ { - "name": "version", + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoShapeFieldQuery", + "namespace": "_types.query_dsl" + } + } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "GeoShapeQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "ignore_unmapped", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/query_dsl/geo.ts#L92-L97" + }, + { + "kind": "enum", + "members": [ + { + "name": "coerce" + }, + { + "name": "ignore_malformed" + }, + { + "name": "strict" + } + ], + "name": { + "name": "GeoValidationMethod", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/geo.ts#L113-L117" }, { "inherits": { @@ -54359,26 +61843,57 @@ }, "kind": "interface", "name": { - "name": "PinnedQuery", + "name": "HasChildQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "ids", - "required": true, + "name": "ignore_unmapped", + "required": false, + "serverDefault": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "organic", + "name": "inner_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + }, + { + "name": "max_children", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "min_children", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "query", "required": true, "type": { "kind": "instance_of", @@ -54387,8 +61902,32 @@ "namespace": "_types.query_dsl" } } + }, + { + "name": "score_mode", + "required": false, + "serverDefault": "'none'", + "type": { + "kind": "instance_of", + "type": { + "name": "ChildScoreMode", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + } } - ] + ], + "specLocation": "_types/query_dsl/joining.ts#L41-L51" }, { "inherits": { @@ -54399,775 +61938,805 @@ }, "kind": "interface", "name": { - "name": "PrefixQuery", + "name": "HasParentQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "rewrite", + "name": "ignore_unmapped", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "inner_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + }, + { + "name": "parent_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RelationName", "namespace": "_types" } } }, { - "name": "value", + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "case_insensitive", + "name": "score", "required": false, "serverDefault": false, - "since": "7.10.0", "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } ], - "shortcutProperty": "value" + "specLocation": "_types/query_dsl/joining.ts#L53-L61" }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "QueryBase", + "name": "IdsQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "boost", + "name": "values", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "Ids", "namespace": "_types" } } - }, - { - "identifier": "query_name", - "name": "_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } } - ] + ], + "specLocation": "_types/query_dsl/term.ts#L53-L55" }, { "kind": "interface", "name": { - "name": "QueryContainer", + "name": "IntervalsAllOf", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "bool", + "name": "intervals", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "max_gaps", "required": false, + "serverDefault": -1, "type": { "kind": "instance_of", "type": { - "name": "BoolQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "name": "boosting", + "name": "ordered", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "BoostingQuery", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "deprecation": { - "version": "7.3.0" - }, - "name": "common", + "name": "filter", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, + "kind": "instance_of", + "type": { + "name": "IntervalsFilter", + "namespace": "_types.query_dsl" + } + } + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L49-L56" + }, + { + "kind": "interface", + "name": { + "name": "IntervalsAnyOf", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "intervals", + "required": true, + "type": { + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "CommonTermsQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } } }, { - "name": "combined_fields", + "name": "filter", "required": false, - "since": "7.13.0", "type": { "kind": "instance_of", "type": { - "name": "CombinedFieldsQuery", + "name": "IntervalsFilter", "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L58-L61" + }, + { + "kind": "interface", + "name": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "constant_score", + "name": "all_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ConstantScoreQuery", + "name": "IntervalsAllOf", "namespace": "_types.query_dsl" } } }, { - "name": "dis_max", + "name": "any_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DisMaxQuery", + "name": "IntervalsAnyOf", "namespace": "_types.query_dsl" } } }, { - "name": "distance_feature", + "name": "fuzzy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DistanceFeatureQuery", + "name": "IntervalsFuzzy", "namespace": "_types.query_dsl" } } }, { - "name": "exists", + "name": "match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExistsQuery", + "name": "IntervalsMatch", "namespace": "_types.query_dsl" } } }, { - "name": "function_score", + "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FunctionScoreQuery", + "name": "IntervalsPrefix", "namespace": "_types.query_dsl" } } }, { - "name": "fuzzy", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "FuzzyQuery", - "namespace": "_types.query_dsl" - } - } - } - }, - { - "name": "geo_bounding_box", + "name": "wildcard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoBoundingBoxQuery", + "name": "IntervalsWildcard", "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L63-L72", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "IntervalsFilter", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "geo_distance", + "name": "after", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoDistanceQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } }, { - "name": "geo_polygon", + "name": "before", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoPolygonQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } }, { - "name": "geo_shape", + "name": "contained_by", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoShapeQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } }, { - "name": "has_child", + "name": "containing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HasChildQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } }, { - "name": "has_parent", + "name": "not_contained_by", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HasParentQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } }, { - "name": "ids", + "name": "not_containing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IdsQuery", + "name": "IntervalsContainer", "namespace": "_types.query_dsl" } } }, { - "name": "intervals", + "name": "not_overlapping", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "IntervalsQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "match", + "name": "overlapping", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "MatchQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "match_all", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MatchAllQuery", - "namespace": "_types.query_dsl" + "name": "Script", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L74-L86", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "IntervalsFuzzy", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "match_bool_prefix", + "name": "analyzer", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "MatchBoolPrefixQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "match_none", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MatchNoneQuery", - "namespace": "_types.query_dsl" + "name": "Fuzziness", + "namespace": "_types" } } }, { - "name": "match_phrase", + "name": "prefix_length", "required": false, + "serverDefault": 0, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "MatchPhraseQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "match_phrase_prefix", - "required": false, + "name": "term", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "MatchPhrasePrefixQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "more_like_this", + "name": "transpositions", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "MoreLikeThisQuery", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "multi_match", + "name": "use_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiMatchQuery", - "namespace": "_types.query_dsl" + "name": "Field", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L88-L97" + }, + { + "kind": "interface", + "name": { + "name": "IntervalsMatch", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "nested", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NestedQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "parent_id", + "name": "max_gaps", "required": false, + "serverDefault": -1, "type": { "kind": "instance_of", "type": { - "name": "ParentIdQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "name": "percolate", + "name": "ordered", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "PercolateQuery", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "pinned", - "required": false, + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "PinnedQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "prefix", + "name": "use_field", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "PrefixQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } }, { - "name": "query_string", + "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryStringQuery", + "name": "IntervalsFilter", "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L99-L108" + }, + { + "kind": "interface", + "name": { + "name": "IntervalsPrefix", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "range", + "name": "analyzer", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "RangeQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "rank_feature", - "required": false, + "name": "prefix", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "regexp", + "name": "use_field", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "RegexpQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L110-L114" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "IntervalsQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "script", + "name": "all_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptQuery", + "name": "IntervalsAllOf", "namespace": "_types.query_dsl" } } }, { - "name": "script_score", + "name": "any_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptScoreQuery", + "name": "IntervalsAnyOf", "namespace": "_types.query_dsl" } } }, { - "name": "shape", + "name": "fuzzy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShapeQuery", + "name": "IntervalsFuzzy", "namespace": "_types.query_dsl" } } }, { - "name": "simple_query_string", + "name": "match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SimpleQueryStringQuery", + "name": "IntervalsMatch", "namespace": "_types.query_dsl" } } }, { - "name": "span_containing", + "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanContainingQuery", + "name": "IntervalsPrefix", "namespace": "_types.query_dsl" } } }, { - "name": "field_masking_span", + "name": "wildcard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanFieldMaskingQuery", + "name": "IntervalsWildcard", "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L116-L125", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "IntervalsWildcard", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "span_first", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanFirstQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "span_multi", - "required": false, + "name": "pattern", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SpanMultiTermQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "span_near", + "name": "use_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanNearQuery", - "namespace": "_types.query_dsl" + "name": "Field", + "namespace": "_types" } } - }, - { - "name": "span_not", - "required": false, - "type": { + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L127-L131" + }, + { + "codegenNames": [ + "text", + "document" + ], + "description": "Text that we want similar documents for or a lookup to a document's field for the text.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "kind": "type_alias", + "name": { + "name": "Like", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/specialized.ts#L105-L110", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "SpanNotQuery", + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LikeDocument", "namespace": "_types.query_dsl" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "LikeDocument", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "span_or", + "name": "doc", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SpanOrQuery", - "namespace": "_types.query_dsl" - } + "kind": "user_defined_value" } }, { - "name": "span_term", + "name": "fields", "required": false, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "SpanTermQuery", - "namespace": "_types.query_dsl" - } } } }, { - "name": "span_within", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanWithinQuery", - "namespace": "_types.query_dsl" + "name": "Id", + "namespace": "_types" } } }, { - "name": "term", + "name": "_type", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "TermQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "Type", + "namespace": "_types" } } }, { - "name": "terms", + "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsQuery", - "namespace": "_types.query_dsl" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "terms_set", + "name": "per_field_analyzer", "required": false, "type": { "key": { @@ -55178,57 +62747,52 @@ } }, "kind": "dictionary_of", - "singleKey": true, + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "TermsSetQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "wildcard", + "name": "routing", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "WildcardQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" } } }, { - "deprecation": { - "description": "https://www.elastic.co/guide/en/elasticsearch/reference/7.x/removal-of-types.html", - "version": "7.0.0" - }, - "name": "type", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeQuery", - "namespace": "_types.query_dsl" + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "version_type", + "required": false, + "serverDefault": "'internal'", + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" } } } ], - "variants": { - "kind": "container" - } + "specLocation": "_types/query_dsl/specialized.ts#L92-L103" }, { "inherits": { @@ -55239,133 +62803,170 @@ }, "kind": "interface", "name": { - "name": "QueryStringQuery", + "name": "MatchAllQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L22" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchBoolPrefixQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "allow_leading_wildcard", + "name": "analyzer", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "analyzer", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fuzziness", + "namespace": "_types" } } }, { - "name": "analyze_wildcard", + "name": "fuzzy_rewrite", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "MultiTermQueryRewrite", + "namespace": "_types" } } }, { - "name": "auto_generate_synonyms_phrase_query", + "name": "fuzzy_transpositions", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "default_field", + "name": "max_expansions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "name": "default_operator", + "name": "minimum_should_match", "required": false, - "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "Operator", - "namespace": "_types.query_dsl" + "name": "MinimumShouldMatch", + "namespace": "_types" } } }, { - "name": "enable_position_increments", + "name": "operator", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { - "name": "escape", + "name": "prefix_length", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L160-L171" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchNoneQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L22" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchPhrasePrefixQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "fuzziness", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "fuzzy_max_expansions", + "name": "max_expansions", "required": false, - "serverDefault": "50", "type": { "kind": "instance_of", "type": { @@ -55375,7 +62976,18 @@ } }, { - "name": "fuzzy_prefix_length", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "slop", "required": false, "type": { "kind": "instance_of", @@ -55386,382 +62998,547 @@ } }, { - "name": "fuzzy_rewrite", + "name": "zero_terms_query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L182-L189" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchPhraseQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "slop", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } }, { - "name": "fuzzy_transpositions", + "name": "zero_terms_query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L173-L180" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "lenient", + "name": "auto_generate_synonyms_phrase_query", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "max_determinized_states", + "deprecation": { + "description": "", + "version": "7.3.0" + }, + "name": "cutoff_frequency", "required": false, - "serverDefault": "10000", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "minimum_should_match", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", + "name": "Fuzziness", "namespace": "_types" } } }, { - "name": "phrase_slop", + "name": "fuzzy_rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "name": "query", - "required": true, + "name": "fuzzy_transpositions", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "quote_analyzer", + "name": "lenient", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "quote_field_suffix", + "name": "max_expansions", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "rewrite", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "MinimumShouldMatch", "namespace": "_types" } } }, { - "name": "tie_breaker", + "name": "operator", "required": false, + "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { - "name": "time_zone", + "name": "prefix_length", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "integer", "namespace": "_types" } } }, { - "name": "type", + "name": "query", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "zero_terms_query", "required": false, - "serverDefault": "'best_fields'", + "serverDefault": "'none'", "type": { "kind": "instance_of", "type": { - "name": "TextQueryType", + "name": "ZeroTermsQuery", "namespace": "_types.query_dsl" } } } - ] + ], + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L133-L158" }, { "inherits": { "type": { - "name": "ScoreFunctionBase", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "RandomScoreFunction", + "name": "MoreLikeThisQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "field", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "boost_terms", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", "namespace": "_types" } } }, { - "name": "seed", + "name": "fail_on_unsupported_field", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + }, + { + "name": "include", "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "like", + "required": true, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Like", + "namespace": "_types.query_dsl" } }, { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } } } ], "kind": "union_of" } - } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "RangeQuery", - "namespace": "_types.query_dsl" - }, - "type": { - "items": [ - { + }, + { + "name": "max_doc_freq", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DateRangeQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "name": "max_query_terms", + "required": false, + "serverDefault": 25, + "type": { "kind": "instance_of", "type": { - "name": "NumberRangeQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "RangeQueryBase", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "relation", + "name": "max_word_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RangeRelation", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "kind": "enum", - "members": [ + }, { - "name": "within" + "name": "min_doc_freq", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "contains" + "name": "minimum_should_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MinimumShouldMatch", + "namespace": "_types" + } + } }, { - "name": "intersects" - } - ], - "name": { - "name": "RangeRelation", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "interface", - "name": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - }, - "properties": [] - }, - { - "inherits": { - "type": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "RankFeatureFunctionLinear", - "namespace": "_types.query_dsl" - }, - "properties": [] - }, - { - "inherits": { - "type": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "RankFeatureFunctionLogarithm", - "namespace": "_types.query_dsl" - }, - "properties": [ + "name": "min_term_freq", + "required": false, + "serverDefault": 2, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { - "name": "scaling_factor", - "required": true, + "name": "min_word_length", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "RankFeatureFunctionSaturation", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "pivot", + "name": "per_field_analyzer", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "Routing", "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "RankFeatureFunctionSigmoid", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "pivot", - "required": true, + "name": "stop_words", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "unlike", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", "namespace": "_types" } } }, { - "name": "exponent", - "required": true, + "name": "version_type", + "required": false, + "serverDefault": "'internal'", "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "VersionType", "namespace": "_types" } } } - ] + ], + "specLocation": "_types/query_dsl/specialized.ts#L63-L90" }, { "inherits": { @@ -55772,161 +63549,176 @@ }, "kind": "interface", "name": { - "name": "RankFeatureQuery", + "name": "MultiMatchQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "field", - "required": true, + "name": "analyzer", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "auto_generate_synonyms_phrase_query", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "deprecation": { + "description": "", + "version": "7.3.0" + }, + "name": "cutoff_frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", "namespace": "_types" } } }, { - "name": "saturation", + "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionSaturation", - "namespace": "_types.query_dsl" + "name": "Fields", + "namespace": "_types" } } }, { - "name": "log", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionLogarithm", - "namespace": "_types.query_dsl" + "name": "Fuzziness", + "namespace": "_types" } } }, { - "name": "linear", + "name": "fuzzy_rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionLinear", - "namespace": "_types.query_dsl" + "name": "MultiTermQueryRewrite", + "namespace": "_types" } } }, { - "name": "sigmoid", + "name": "fuzzy_transpositions", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionSigmoid", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "RegexpQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "case_insensitive", + "name": "lenient", "required": false, "serverDefault": false, - "since": "7.10.0", "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "flags", + "name": "max_expansions", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "max_determinized_states", + "name": "minimum_should_match", "required": false, - "serverDefault": "10000", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "MinimumShouldMatch", "namespace": "_types" } } }, { - "name": "rewrite", + "name": "operator", "required": false, + "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "prefix_length", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } }, { - "name": "value", + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ], - "shortcutProperty": "value" - }, - { - "kind": "interface", - "name": { - "name": "ScoreFunctionBase", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "filter", + "name": "slop", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "name": "weight", + "name": "tie_breaker", "required": false, "type": { "kind": "instance_of", @@ -55935,60 +63727,54 @@ "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "ScriptQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "script", - "required": true, + "name": "type", + "required": false, + "serverDefault": "'best_fields'", "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "TextQueryType", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ScoreFunctionBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "ScriptScoreFunction", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "script", - "required": true, + "name": "zero_terms_query", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" } } } - ] + ], + "specLocation": "_types/query_dsl/fulltext.ts#L191-L217" + }, + { + "kind": "enum", + "members": [ + { + "name": "min" + }, + { + "name": "max" + }, + { + "name": "avg" + }, + { + "name": "sum" + } + ], + "name": { + "name": "MultiValueMode", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/compound.ts#L160-L165" }, { "inherits": { @@ -55999,17 +63785,40 @@ }, "kind": "interface", "name": { - "name": "ScriptScoreQuery", + "name": "NestedQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "min_score", + "name": "ignore_unmapped", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "inner_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + }, + { + "name": "path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", "namespace": "_types" } } @@ -56026,70 +63835,125 @@ } }, { - "name": "script", - "required": true, + "name": "score_mode", + "required": false, + "serverDefault": "'avg'", "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "ChildScoreMode", + "namespace": "_types.query_dsl" } } } - ] + ], + "specLocation": "_types/query_dsl/joining.ts#L63-L71" }, { + "inherits": { + "type": { + "name": "RangeQueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "ShapeFieldQuery", + "name": "NumberRangeQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "ignore_unmapped", + "name": "gt", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "indexed_shape", + "name": "gte", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldLookup", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } }, { - "name": "relation", + "name": "lt", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShapeRelation", + "name": "double", "namespace": "_types" } } }, { - "name": "shape", + "name": "lte", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoShape", + "name": "double", "namespace": "_types" } } + }, + { + "name": "from", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "to", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } - ] + ], + "specLocation": "_types/query_dsl/term.ts#L83-L90" }, { "attachedBehaviors": [ @@ -56106,9 +63970,25 @@ } }, { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "ShapeFieldQuery", + "name": "DecayPlacement", "namespace": "_types.query_dsl" } } @@ -56121,64 +64001,39 @@ ], "inherits": { "type": { - "name": "QueryBase", + "name": "DecayFunctionBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "ShapeQuery", + "name": "NumericDecayFunction", "namespace": "_types.query_dsl" }, - "properties": [] + "properties": [], + "specLocation": "_types/query_dsl/compound.ts#L88-L90" }, { "kind": "enum", "members": [ { - "name": "NONE" - }, - { - "name": "AND" - }, - { - "name": "OR" - }, - { - "name": "NOT" - }, - { - "name": "PREFIX" - }, - { - "name": "PHRASE" - }, - { - "name": "PRECEDENCE" - }, - { - "name": "ESCAPE" - }, - { - "name": "WHITESPACE" - }, - { - "name": "FUZZY" - }, - { - "name": "NEAR" - }, - { - "name": "SLOP" + "aliases": [ + "AND" + ], + "name": "and" }, { - "name": "ALL" + "aliases": [ + "OR" + ], + "name": "or" } ], "name": { - "name": "SimpleQueryStringFlags", + "name": "Operator", "namespace": "_types.query_dsl" - } + }, + "specLocation": "_types/query_dsl/Operator.ts#L22-L27" }, { "inherits": { @@ -56189,210 +64044,188 @@ }, "kind": "interface", "name": { - "name": "SimpleQueryStringQuery", + "name": "ParentIdQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "analyzer", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "analyze_wildcard", + "name": "ignore_unmapped", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "auto_generate_synonyms_phrase_query", + "name": "type", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "RelationName", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/joining.ts#L73-L78" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "PercolateQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "default_operator", + "name": "document", "required": false, - "serverDefault": "'or'", "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } + "kind": "user_defined_value" } }, { - "name": "fields", + "name": "documents", "required": false, "type": { "kind": "array_of", "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "kind": "user_defined_value" } } }, { - "name": "flags", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SimpleQueryStringFlags", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "fuzzy_max_expansions", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } }, { - "name": "fuzzy_prefix_length", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "name": "fuzzy_transpositions", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "lenient", + "name": "name", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "minimum_should_match", + "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "query", - "required": true, + "name": "routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Routing", + "namespace": "_types" } } }, { - "name": "quote_field_suffix", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionNumber", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/query_dsl/specialized.ts#L112-L122" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "SpanContainingQuery", + "name": "PinnedDoc", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "big", + "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "Id", + "namespace": "_types" } } }, { - "name": "little", + "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "IndexName", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/query_dsl/specialized.ts#L134-L137" }, { "inherits": { @@ -56403,33 +64236,55 @@ }, "kind": "interface", "name": { - "name": "SpanFieldMaskingQuery", + "name": "PinnedQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "field", + "containerProperty": true, + "name": "organic", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "query", - "required": true, + "name": "ids", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "name": "docs", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PinnedDoc", + "namespace": "_types.query_dsl" + } } } } - ] + ], + "specLocation": "_types/query_dsl/specialized.ts#L124-L132", + "variants": { + "kind": "container" + } }, { "inherits": { @@ -56440,256 +64295,206 @@ }, "kind": "interface", "name": { - "name": "SpanFirstQuery", + "name": "PrefixQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "end", - "required": true, + "name": "rewrite", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "name": "match", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanMultiTermQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "description": "Should be a multi term query (one of wildcard, fuzzy, prefix, range or regexp query)", - "name": "match", - "required": true, + "name": "case_insensitive", + "required": false, + "serverDefault": false, + "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L57-L66" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "SpanNearQuery", + "name": "QueryBase", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "clauses", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } - } - } - }, - { - "name": "in_order", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "float", + "namespace": "_types" } } }, { - "name": "slop", + "codegenName": "query_name", + "name": "_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_types/query_dsl/abstractions.ts#L174-L178" }, { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "SpanNotQuery", + "name": "QueryContainer", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "dist", + "name": "bool", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "BoolQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "exclude", - "required": true, + "name": "boosting", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", + "name": "BoostingQuery", "namespace": "_types.query_dsl" } } }, { - "name": "include", - "required": true, + "deprecation": { + "description": "", + "version": "7.3.0" + }, + "name": "common", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "CommonTermsQuery", + "namespace": "_types.query_dsl" + } } } }, { - "name": "post", + "name": "combined_fields", "required": false, - "serverDefault": "0", + "since": "7.13.0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "CombinedFieldsQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "pre", + "name": "constant_score", "required": false, - "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ConstantScoreQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanOrQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "clauses", - "required": true, + "name": "dis_max", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "DisMaxQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "span_containing", + "name": "distance_feature", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanContainingQuery", + "name": "DistanceFeatureQuery", "namespace": "_types.query_dsl" } } }, { - "name": "field_masking_span", + "name": "exists", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanFieldMaskingQuery", + "name": "ExistsQuery", "namespace": "_types.query_dsl" } } }, { - "name": "span_first", + "name": "function_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanFirstQuery", + "name": "FunctionScoreQuery", "namespace": "_types.query_dsl" } } }, { - "description": "Can only be used as a clause in a span_near query", - "name": "span_gap", + "name": "fuzzy", "required": false, "type": { "key": { @@ -56704,58 +64509,91 @@ "value": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FuzzyQuery", + "namespace": "_types.query_dsl" } } } }, { - "name": "span_multi", + "name": "geo_bounding_box", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanMultiTermQuery", + "name": "GeoBoundingBoxQuery", "namespace": "_types.query_dsl" } } }, { - "name": "span_near", + "name": "geo_distance", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanNearQuery", + "name": "GeoDistanceQuery", "namespace": "_types.query_dsl" } } }, { - "name": "span_not", + "name": "geo_polygon", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanNotQuery", + "name": "GeoPolygonQuery", "namespace": "_types.query_dsl" } } }, { - "name": "span_or", + "name": "geo_shape", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanOrQuery", + "name": "GeoShapeQuery", "namespace": "_types.query_dsl" } } }, { - "name": "span_term", + "name": "has_child", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "HasChildQuery", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "has_parent", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "HasParentQuery", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "ids", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IdsQuery", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "intervals", "required": false, "type": { "key": { @@ -56770,2914 +64608,2699 @@ "value": { "kind": "instance_of", "type": { - "name": "SpanTermQuery", + "name": "IntervalsQuery", "namespace": "_types.query_dsl" } } } }, { - "name": "span_within", + "name": "match", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "MatchQuery", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "match_all", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanWithinQuery", + "name": "MatchAllQuery", "namespace": "_types.query_dsl" } } - } - ], - "variants": { - "kind": "container" - } - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanTermQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "value", - "required": true, + "name": "match_bool_prefix", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "MatchBoolPrefixQuery", + "namespace": "_types.query_dsl" + } } } - } - ], - "shortcutProperty": "value" - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanWithinQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "big", - "required": true, + "name": "match_none", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", + "name": "MatchNoneQuery", "namespace": "_types.query_dsl" } } }, { - "name": "little", - "required": true, + "name": "match_phrase", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "MatchPhraseQuery", + "namespace": "_types.query_dsl" + } } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "TermQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "value", - "required": true, + "name": "match_phrase_prefix", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "MatchPhrasePrefixQuery", + "namespace": "_types.query_dsl" + } + } } }, { - "name": "case_insensitive", + "name": "more_like_this", "required": false, - "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "MoreLikeThisQuery", + "namespace": "_types.query_dsl" } } - } - ], - "shortcutProperty": "value" - }, - { - "kind": "interface", - "name": { - "name": "TermsLookup", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "index", - "required": true, + "name": "multi_match", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "MultiMatchQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "id", - "required": true, + "name": "nested", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "NestedQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "path", - "required": true, + "name": "parent_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "ParentIdQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "routing", + "name": "percolate", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "PercolateQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { + "name": "pinned", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PinnedQuery", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "prefix", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, - { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TermsLookup", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "union_of" + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "PrefixQuery", + "namespace": "_types.query_dsl" + } } - ], - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" } - } - ], - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "TermsQuery", - "namespace": "_types.query_dsl" - }, - "properties": [] - }, - { - "kind": "interface", - "name": { - "name": "TermsSetFieldQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "minimum_should_match_field", + "name": "query_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "QueryStringQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "minimum_should_match_script", + "name": "range", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "RangeQuery", + "namespace": "_types.query_dsl" + } } } }, { - "name": "terms", - "required": true, + "name": "rank_feature", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "RankFeatureQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { + "name": "regexp", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } }, - { + "kind": "dictionary_of", + "singleKey": true, + "value": { "kind": "instance_of", "type": { - "name": "TermsSetFieldQuery", + "name": "RegexpQuery", "namespace": "_types.query_dsl" } } - ], - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" } - } - ], - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "TermsSetQuery", - "namespace": "_types.query_dsl" - }, - "properties": [] - }, - { - "kind": "enum", - "members": [ - { - "name": "best_fields" - }, - { - "name": "most_fields" - }, - { - "name": "cross_fields" }, { - "name": "phrase" + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScriptQuery", + "namespace": "_types.query_dsl" + } + } }, { - "name": "phrase_prefix" + "name": "script_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScriptScoreQuery", + "namespace": "_types.query_dsl" + } + } }, { - "name": "bool_prefix" - } - ], - "name": { - "name": "TextQueryType", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "interface", - "name": { - "name": "ThreeDimensionalPoint", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "name": "lat", - "required": true, + "name": "shape", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "ShapeQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "lon", - "required": true, + "name": "simple_query_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SimpleQueryStringQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "z", + "name": "span_containing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SpanContainingQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "TwoDimensionalPoint", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "lat", - "required": true, + "name": "field_masking_span", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SpanFieldMaskingQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "lon", - "required": true, + "name": "span_first", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SpanFirstQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "TypeQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "value", - "required": true, + "name": "span_multi", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanMultiTermQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "WildcardQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "name": "case_insensitive", + "name": "span_near", "required": false, - "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SpanNearQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "rewrite", + "name": "span_not", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "SpanNotQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "value", - "required": true, + "name": "span_or", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanOrQuery", + "namespace": "_types.query_dsl" } } - } - ], - "shortcutProperty": "value" - }, - { - "kind": "enum", - "members": [ - { - "name": "all" }, { - "name": "none" - } - ], - "name": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" - } - }, - { - "generics": [ + "name": "span_term", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SpanTermQuery", + "namespace": "_types.query_dsl" + } + } + } + }, { - "name": "TDocument", - "namespace": "async_search._types" - } - ], - "kind": "interface", - "name": { - "name": "AsyncSearch", - "namespace": "async_search._types" - }, - "properties": [ + "name": "span_within", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SpanWithinQuery", + "namespace": "_types.query_dsl" + } + } + }, { - "name": "aggregations", + "name": "term", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } }, "kind": "dictionary_of", - "singleKey": false, + "singleKey": true, "value": { "kind": "instance_of", "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" + "name": "TermQuery", + "namespace": "_types.query_dsl" } } } }, { - "name": "_clusters", + "name": "terms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStatistics", - "namespace": "_types" + "name": "TermsQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "fields", + "name": "terms_set", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } }, "kind": "dictionary_of", - "singleKey": false, + "singleKey": true, "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "TermsSetQuery", + "namespace": "_types.query_dsl" + } } } }, { - "name": "hits", - "required": true, + "name": "wildcard", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types" - } + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } - ], + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "WildcardQuery", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "wrapper", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" + "name": "WrapperQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "max_score", + "deprecation": { + "description": "https://www.elastic.co/guide/en/elasticsearch/reference/7.x/removal-of-types.html", + "version": "7.0.0" + }, + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "TypeQuery", + "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/abstractions.ts#L96-L161", + "variants": { + "kind": "container", + "nonExhaustive": true + } + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "QueryStringQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "num_reduce_phases", + "name": "allow_leading_wildcard", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "profile", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Profile", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "pit_id", + "name": "analyze_wildcard", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "_scroll_id", + "name": "auto_generate_synonyms_phrase_query", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "_shards", - "required": true, + "name": "default_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "Field", "namespace": "_types" } } }, { - "name": "suggest", + "name": "default_operator", "required": false, + "serverDefault": "'or'", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "SuggestionName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "instance_of", + "type": { + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "enable_position_increments", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "escape", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "kind": "array_of", "value": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Suggest", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } } }, { - "name": "terminated_early", + "name": "fuzziness", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fuzziness", + "namespace": "_types" + } + } + }, + { + "name": "fuzzy_max_expansions", + "required": false, + "serverDefault": 50, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "fuzzy_prefix_length", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "fuzzy_rewrite", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MultiTermQueryRewrite", + "namespace": "_types" + } + } + }, + { + "name": "fuzzy_transpositions", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "timed_out", - "required": true, + "name": "lenient", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "took", + "name": "max_determinized_states", + "required": false, + "serverDefault": 10000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "minimum_should_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MinimumShouldMatch", + "namespace": "_types" + } + } + }, + { + "name": "phrase_slop", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "quote_analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "quote_field_suffix", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "rewrite", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MultiTermQueryRewrite", "namespace": "_types" } } - } - ] - }, - { - "generics": [ + }, { - "name": "TDocument", - "namespace": "async_search._types" + "name": "tie_breaker", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "time_zone", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeZone", + "namespace": "_types" + } + } + }, + { + "name": "type", + "required": false, + "serverDefault": "'best_fields'", + "type": { + "kind": "instance_of", + "type": { + "name": "TextQueryType", + "namespace": "_types.query_dsl" + } + } } ], - "inherits": { - "type": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - } - }, + "specLocation": "_types/query_dsl/fulltext.ts#L233-L269" + }, + { "kind": "interface", "name": { - "name": "AsyncSearchDocumentResponseBase", - "namespace": "async_search._types" + "name": "RandomScoreFunction", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "response", - "required": true, + "name": "field", + "required": false, "type": { - "generics": [ + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "seed", + "required": false, + "type": { + "items": [ { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "async_search._types" + "name": "long", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } ], + "kind": "union_of" + } + } + ], + "specLocation": "_types/query_dsl/compound.ts#L65-L68" + }, + { + "codegenNames": [ + "date", + "number" + ], + "kind": "type_alias", + "name": { + "name": "RangeQuery", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/term.ts#L92-L94", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "AsyncSearch", - "namespace": "async_search._types" + "name": "DateRangeQuery", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NumberRangeQuery", + "namespace": "_types.query_dsl" } } - } - ] + ], + "kind": "union_of" + } }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" + "name": "RangeQueryBase", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "id", + "name": "relation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "RangeRelation", + "namespace": "_types.query_dsl" } } + } + ], + "specLocation": "_types/query_dsl/term.ts#L68-L70" + }, + { + "kind": "enum", + "members": [ + { + "name": "within" }, { - "name": "is_partial", + "name": "contains" + }, + { + "name": "intersects" + } + ], + "name": { + "name": "RangeRelation", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/term.ts#L96-L100" + }, + { + "kind": "interface", + "name": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/specialized.ts#L139-L139" + }, + { + "inherits": { + "type": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RankFeatureFunctionLinear", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/specialized.ts#L141-L141" + }, + { + "inherits": { + "type": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RankFeatureFunctionLogarithm", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "scaling_factor", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "float", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L143-L145" + }, + { + "inherits": { + "type": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RankFeatureFunctionSaturation", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "is_running", - "required": true, + "name": "pivot", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "float", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L147-L149" + }, + { + "inherits": { + "type": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RankFeatureFunctionSigmoid", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "expiration_time_in_millis", + "name": "pivot", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "float", "namespace": "_types" } } }, { - "name": "start_time_in_millis", + "name": "exponent", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "float", "namespace": "_types" } } } - ] + ], + "specLocation": "_types/query_dsl/specialized.ts#L151-L154" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "async_search.delete" + "name": "RankFeatureQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "id", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } + }, + { + "name": "saturation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RankFeatureFunctionSaturation", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "log", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RankFeatureFunctionLogarithm", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "linear", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RankFeatureFunctionLinear", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "sigmoid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RankFeatureFunctionSigmoid", + "namespace": "_types.query_dsl" + } + } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "async_search.delete" - } + "specLocation": "_types/query_dsl/specialized.ts#L156-L164" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "async_search.get" + "name": "RegexpQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "id", - "required": true, + "name": "case_insensitive", + "required": false, + "serverDefault": false, + "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "keep_alive", + "name": "flags", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "typed_keys", + "name": "max_determinized_states", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "wait_for_completion_timeout", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } + }, + { + "name": "value", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L102-L114" }, { - "body": { - "kind": "properties", - "properties": [] + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } }, - "generics": [ + "kind": "interface", + "name": { + "name": "ScriptQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "TDocument", - "namespace": "async_search.get" + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } } ], - "inherits": { - "generics": [ - { + "specLocation": "_types/query_dsl/specialized.ts#L166-L168" + }, + { + "kind": "interface", + "name": { + "name": "ScriptScoreFunction", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "script", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "async_search.get" + "name": "Script", + "namespace": "_types" } } - ], - "type": { - "name": "AsyncSearchDocumentResponseBase", - "namespace": "async_search._types" } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "async_search.get" - } + ], + "specLocation": "_types/query_dsl/compound.ts#L61-L63" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "async_search.status" + "name": "ScriptScoreQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "id", + "name": "min_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", "namespace": "_types" } } } ], - "query": [] + "specLocation": "_types/query_dsl/specialized.ts#L170-L174" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "_shards", - "required": true, + "kind": "interface", + "name": { + "name": "ShapeFieldQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "indexed_shape", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldLookup", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "relation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoShapeRelation", + "namespace": "_types" + } + } + }, + { + "name": "shape", + "required": false, + "type": { + "kind": "instance_of", "type": { + "name": "GeoShape", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L185-L189" + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "Field", "namespace": "_types" } - } - }, - { - "name": "completion_status", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ShapeFieldQuery", + "namespace": "_types.query_dsl" } } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" } - ] - }, - "generics": [ - { - "name": "TDocument", - "namespace": "async_search.status" } ], "inherits": { "type": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "async_search.status" - } + "name": "ShapeQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "ignore_unmapped", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L178-L183" }, { - "attachedBehaviors": [ - "CommonQueryParameters" + "kind": "enum", + "members": [ + { + "name": "NONE" + }, + { + "name": "AND" + }, + { + "name": "OR" + }, + { + "name": "NOT" + }, + { + "name": "PREFIX" + }, + { + "name": "PHRASE" + }, + { + "name": "PRECEDENCE" + }, + { + "name": "ESCAPE" + }, + { + "name": "WHITESPACE" + }, + { + "name": "FUZZY" + }, + { + "name": "NEAR" + }, + { + "name": "SLOP" + }, + { + "name": "ALL" + } ], - "body": { - "kind": "properties", - "properties": [ + "name": { + "name": "SimpleQueryStringFlag", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/fulltext.ts#L278-L292" + }, + { + "codegenNames": [ + "single", + "multiple" + ], + "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/7.15/query-dsl-simple-query-string-query.html#supported-flags", + "kind": "type_alias", + "name": { + "name": "SimpleQueryStringFlags", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/fulltext.ts#L271-L276", + "type": { + "items": [ { - "name": "aggs", - "required": false, + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } + "name": "SimpleQueryStringFlag", + "namespace": "_types.query_dsl" } }, { - "name": "allow_no_indices", - "required": false, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "allow_partial_search_results", - "required": false, + } + ], + "kind": "union_of" + } + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SimpleQueryStringQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "analyzer", - "required": false, + } + }, + { + "name": "analyze_wildcard", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "analyze_wildcard", - "required": false, + } + }, + { + "name": "auto_generate_synonyms_phrase_query", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "batched_reduce_size", - "required": false, + } + }, + { + "name": "default_operator", + "required": false, + "serverDefault": "'or'", + "type": { + "kind": "instance_of", "type": { + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } - }, - { - "name": "collapse", - "required": false, + } + }, + { + "name": "flags", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "FieldCollapse", - "namespace": "_global.search._types" - } + "name": "SimpleQueryStringFlags", + "namespace": "_types.query_dsl" } - }, - { - "name": "default_operator", - "required": false, + } + }, + { + "name": "fuzzy_max_expansions", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DefaultOperator", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "df", - "required": false, + } + }, + { + "name": "fuzzy_prefix_length", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "docvalue_fields", - "required": false, + } + }, + { + "name": "fuzzy_transpositions", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "expand_wildcards", - "required": false, + } + }, + { + "name": "lenient", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "explain", - "required": false, + } + }, + { + "name": "minimum_should_match", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "from", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "highlight", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Highlight", - "namespace": "_global.search._types" - } - } - }, - { - "name": "ignore_throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "indices_boost", - "required": false, - "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } - } - }, - { - "name": "keep_alive", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "keep_on_completion", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "lenient", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "max_concurrent_shard_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "min_score", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "post_filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "preference", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "profile", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "pit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PointInTimeReference", - "namespace": "_global.search._types" - } - } - }, - { - "name": "query", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "query_on_query_string", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "request_cache", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "rescore", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Rescore", - "namespace": "_global.search._types" - } - } - } - }, - { - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } - }, - { - "name": "script_fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" - } - } - } - }, - { - "name": "search_after", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "search_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SearchType", - "namespace": "_types" - } - } - }, - { - "name": "sequence_number_primary_term", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "sort", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Sort", - "namespace": "_global.search._types" - } - } - }, - { - "name": "_source", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "stats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "stored_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "name": "suggest", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "SuggestContainer", - "namespace": "_global.search._types" - } - } - } - }, - { - "name": "suggest_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "suggest_mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SuggestMode", - "namespace": "_types" - } - } - }, - { - "name": "suggest_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "suggest_text", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "terminate_after", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "track_scores", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "track_total_hits", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "typed_keys", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "wait_for_completion_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateField", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "async_search.submit" - }, - "path": [ - { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" + "name": "MinimumShouldMatch", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "batched_reduce_size", - "required": false, + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "wait_for_completion_timeout", + "name": "quote_field_suffix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L294-L312" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanContainingQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "keep_on_completion", - "required": false, + "name": "big", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } }, { - "name": "typed_keys", - "required": false, + "name": "little", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "generics": [ - { - "name": "TDocument", - "namespace": "async_search.submit" - } ], - "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search.submit" - } - } - ], - "type": { - "name": "AsyncSearchDocumentResponseBase", - "namespace": "async_search._types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "async_search.submit" - } + "specLocation": "_types/query_dsl/span.ts#L25-L28" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "autoscaling.capacity_get" + "name": "SpanFieldMaskingQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "stub_a", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub_b", + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "autoscaling.capacity_get" - } + ], + "specLocation": "_types/query_dsl/span.ts#L30-L33" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "autoscaling.policy_delete" + "name": "SpanFirstQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "stub_a", + "name": "end", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub_b", + "name": "match", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } } - ] + ], + "specLocation": "_types/query_dsl/span.ts#L35-L38" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", + "description": "Can only be used as a clause in a span_near query.", + "kind": "type_alias", "name": { - "name": "Response", - "namespace": "autoscaling.policy_delete" + "name": "SpanGapQuery", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/span.ts#L40-L42", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "autoscaling.policy_get" + "name": "SpanMultiTermQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "stub_a", + "description": "Should be a multi term query (one of wildcard, fuzzy, prefix, range or regexp query)", + "name": "match", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } } ], - "query": [ + "specLocation": "_types/query_dsl/span.ts#L44-L47" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanNearQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "stub_b", + "name": "clauses", "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "in_order", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + }, + { + "name": "slop", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "autoscaling.policy_get" - } + } + ], + "specLocation": "_types/query_dsl/span.ts#L49-L53" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "autoscaling.policy_put" + "name": "SpanNotQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ + { + "name": "dist", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { - "name": "stub_a", + "name": "exclude", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } - } - ], - "query": [ + }, { - "name": "stub_b", + "name": "include", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + }, + { + "name": "post", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "autoscaling.policy_put" - } - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "behaviors": [ + }, { + "name": "pre", + "required": false, + "serverDefault": 0, "type": { - "name": "CommonCatQueryParameters", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } ], + "specLocation": "_types/query_dsl/span.ts#L55-L63" + }, + { "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "SpanOrQuery", + "namespace": "_types.query_dsl" }, - "properties": [] + "properties": [ + { + "name": "clauses", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } + } + } + } + ], + "specLocation": "_types/query_dsl/span.ts#L65-L67" }, { "kind": "interface", "name": { - "name": "AliasesRecord", - "namespace": "cat.aliases" + "name": "SpanQuery", + "namespace": "_types.query_dsl" }, "properties": [ { - "aliases": [ - "a" - ], - "description": "alias name", - "name": "alias", + "name": "span_containing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanContainingQuery", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "i", - "idx" - ], - "description": "index alias points to", - "name": "index", + "name": "field_masking_span", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "SpanFieldMaskingQuery", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "f", - "fi" - ], - "description": "filter", - "name": "filter", + "name": "span_first", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanFirstQuery", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "ri", - "routingIndex" - ], - "description": "index routing", - "name": "routing.index", + "name": "span_gap", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanGapQuery", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "rs", - "routingSearch" - ], - "description": "search routing", - "name": "routing.search", + "name": "span_multi", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanMultiTermQuery", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "w", - "isWriteIndex" - ], - "description": "write index", - "name": "is_write_index", + "name": "span_near", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SpanNearQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.aliases" - }, - "path": [ + }, { - "name": "name", + "name": "span_not", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "SpanNotQuery", + "namespace": "_types.query_dsl" } } - } - ], - "query": [ + }, { - "name": "expand_wildcards", + "name": "span_or", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "SpanOrQuery", + "namespace": "_types.query_dsl" } } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "name": "span_term", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SpanTermQuery", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "span_within", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AliasesRecord", - "namespace": "cat.aliases" + "name": "SpanWithinQuery", + "namespace": "_types.query_dsl" } } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.aliases" + ], + "specLocation": "_types/query_dsl/span.ts#L79-L91", + "variants": { + "kind": "container" } }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "AllocationRecord", - "namespace": "cat.allocation" + "name": "SpanTermQuery", + "namespace": "_types.query_dsl" }, "properties": [ { - "aliases": [ - "s" - ], - "description": "number of shards on node", - "name": "shards", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/span.ts#L69-L72" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanWithinQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "aliases": [ - "di", - "diskIndices" - ], - "description": "disk used by ES indices", - "name": "disk.indices", - "required": false, + "name": "big", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "du", - "diskUsed" - ], - "description": "disk used (total, not just ES)", - "name": "disk.used", - "required": false, + "name": "little", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/span.ts#L74-L77" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "TermQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "aliases": [ - "da", - "diskAvail" - ], - "description": "disk available", - "name": "disk.avail", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "FieldValue", "namespace": "_types" } } }, { - "aliases": [ - "dt", - "diskTotal" - ], - "description": "total capacity of all volumes", - "name": "disk.total", + "name": "case_insensitive", "required": false, + "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L116-L121" + }, + { + "kind": "interface", + "name": { + "name": "TermsLookup", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "aliases": [ - "dp", - "diskPercent" - ], - "description": "percent disk used", - "name": "disk.percent", - "required": false, + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Percentage", + "name": "IndexName", "namespace": "_types" } } }, { - "aliases": [ - "h" - ], - "description": "host of node", - "name": "host", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Host", + "name": "Id", "namespace": "_types" } } }, { - "description": "ip of node", - "name": "ip", - "required": false, + "name": "path", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ip", + "name": "Field", "namespace": "_types" } } }, { - "aliases": [ - "n" - ], - "description": "name of node", - "name": "node", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Routing", + "namespace": "_types" } } } - ] + ], + "specLocation": "_types/query_dsl/term.ts#L132-L137" }, { "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" + "AdditionalProperty" ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.allocation" - }, - "path": [ + "behaviors": [ { - "name": "node_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeIds", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TermsQueryField", + "namespace": "_types.query_dsl" + } } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" } } ], - "query": [ - { - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" } - ] + }, + "kind": "interface", + "name": { + "name": "TermsQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/term.ts#L123-L125" }, { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + "codegenNames": [ + "value", + "lookup" + ], + "kind": "type_alias", + "name": { + "name": "TermsQueryField", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/term.ts#L127-L130", + "type": { + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + }, + { "kind": "instance_of", "type": { - "name": "AllocationRecord", - "namespace": "cat.allocation" + "name": "TermsLookup", + "namespace": "_types.query_dsl" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.allocation" + ], + "kind": "union_of" } }, { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "CountRecord", - "namespace": "cat.count" + "name": "TermsSetQuery", + "namespace": "_types.query_dsl" }, "properties": [ { - "aliases": [ - "t", - "time" - ], - "description": "seconds since 1969-01-01 00:00:00", - "name": "epoch", + "name": "minimum_should_match_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } }, { - "aliases": [ - "ts", - "hms", - "hhmmss" - ], - "description": "time in HH:MM:SS", - "name": "timestamp", + "name": "minimum_should_match_script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "Script", "namespace": "_types" } } }, { - "aliases": [ - "dc", - "docs.count", - "docsCount" - ], - "description": "the document count", - "name": "count", - "required": false, + "name": "terms", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - ] + ], + "specLocation": "_types/query_dsl/term.ts#L139-L143" }, { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" + "kind": "enum", + "members": [ + { + "name": "best_fields" + }, + { + "name": "most_fields" + }, + { + "name": "cross_fields" + }, + { + "name": "phrase" + }, + { + "name": "phrase_prefix" + }, + { + "name": "bool_prefix" + } ], - "body": { - "kind": "no_body" + "name": { + "name": "TextQueryType", + "namespace": "_types.query_dsl" }, + "specLocation": "_types/query_dsl/fulltext.ts#L219-L226" + }, + { "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cat.count" + "name": "TypeQuery", + "namespace": "_types.query_dsl" }, - "path": [ + "properties": [ { - "name": "index", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "query": [] + "specLocation": "_types/query_dsl/term.ts#L145-L147" }, { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CountRecord", - "namespace": "cat.count" - } - } + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.count" - } - }, - { "kind": "interface", "name": { - "name": "DataFrameAnalyticsRecord", - "namespace": "cat.data_frame_analytics" + "name": "WildcardQuery", + "namespace": "_types.query_dsl" }, "properties": [ { - "description": "the id", - "name": "id", + "description": "Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping.", + "name": "case_insensitive", "required": false, + "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "t" - ], - "description": "analysis type", - "name": "type", + "description": "Method used to rewrite the query", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Type", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "aliases": [ - "ct", - "createTime" - ], - "description": "job creation time", - "name": "create_time", + "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.", + "name": "value", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "v" - ], - "description": "the version of Elasticsearch when the analytics was created", - "name": "version", + "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.", + "name": "wildcard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L149-L162" + }, + { + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "WrapperQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "source index", - "name": "source_index", - "required": false, + "description": "A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings", + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } + } + ], + "specLocation": "_types/query_dsl/abstractions.ts#L196-L199" + }, + { + "kind": "enum", + "members": [ + { + "name": "all" }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "destination index", - "name": "dest_index", + "name": "none" + } + ], + "name": { + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/fulltext.ts#L228-L231" + }, + { + "generics": [ + { + "name": "TDocument", + "namespace": "async_search._types" + } + ], + "kind": "interface", + "name": { + "name": "AsyncSearch", + "namespace": "async_search._types" + }, + "properties": [ + { + "name": "aggregations", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "AggregateName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Aggregate", + "namespace": "_types.aggregations" + } } } }, { - "aliases": [ - "d" - ], - "description": "description", - "name": "description", + "name": "_clusters", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ClusterStatistics", + "namespace": "_types" } } }, { - "aliases": [ - "mml", - "modelMemoryLimit" - ], - "description": "model memory limit", - "name": "model_memory_limit", + "name": "fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "aliases": [ - "s" - ], - "description": "job state", - "name": "state", - "required": false, + "name": "hits", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "HitsMetadata", + "namespace": "_global.search._types" } } }, { - "aliases": [ - "fr", - "failureReason" - ], - "description": "failure reason", - "name": "failure_reason", + "name": "max_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "aliases": [ - "p" - ], - "description": "progress", - "name": "progress", + "name": "num_reduce_phases", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "ae", - "assignmentExplanation" - ], - "description": "why the job is or is not assigned to a node", - "name": "assignment_explanation", + "name": "profile", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Profile", + "namespace": "_global.search._types" } } }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "id of the assigned node", - "name": "node.id", + "name": "pit_id", "required": false, "type": { "kind": "instance_of", @@ -59688,350 +67311,388 @@ } }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "name of the assigned node", - "name": "node.name", + "name": "_scroll_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "ephemeral id of the assigned node", - "name": "node.ephemeral_id", - "required": false, + "name": "_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "ShardStatistics", "namespace": "_types" } } }, { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "network address of the assigned node", - "name": "node.address", + "name": "suggest", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "SuggestionName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Suggest", + "namespace": "_global.search._types" + } + } } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.data_frame_analytics" - }, - "path": [ + }, { - "name": "id", + "name": "terminated_early", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "allow_no_match", - "required": false, + "name": "timed_out", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "bytes", - "required": false, + "name": "took", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Bytes", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "async_search/_types/AsyncSearch.ts#L30-L45" }, { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataFrameAnalyticsRecord", - "namespace": "cat.data_frame_analytics" - } - } + "generics": [ + { + "name": "TDocument", + "namespace": "async_search._types" + } + ], + "inherits": { + "type": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.data_frame_analytics" - } - }, - { "kind": "interface", "name": { - "name": "DatafeedsRecord", - "namespace": "cat.datafeeds" + "name": "AsyncSearchDocumentResponseBase", + "namespace": "async_search._types" }, "properties": [ { - "description": "the datafeed_id", - "name": "id", - "required": false, + "name": "response", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AsyncSearch", + "namespace": "async_search._types" } } - }, + } + ], + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L31-L35" + }, + { + "kind": "interface", + "name": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" + }, + "properties": [ { - "aliases": [ - "s" - ], - "description": "the datafeed state", - "name": "state", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedState", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "aliases": [ - "ae" - ], - "description": "why the datafeed is or is not assigned to a node", - "name": "assignment_explanation", - "required": false, + "name": "is_partial", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "bc", - "bucketsCount" - ], - "description": "bucket count", - "name": "buckets.count", - "required": false, + "name": "is_running", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "sc", - "searchCount" - ], - "description": "number of searches ran by the datafeed", - "name": "search.count", - "required": false, + "name": "expiration_time_in_millis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } }, { - "aliases": [ - "st", - "searchTime" - ], - "description": "the total search time", - "name": "search.time", - "required": false, + "name": "start_time_in_millis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } - }, + } + ], + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L30" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "async_search.delete" + }, + "path": [ { - "aliases": [ - "sba", - "searchBucketAvg" - ], - "description": "the average search time per bucket (millisecond)", - "name": "search.bucket_avg", - "required": false, + "description": "The async search ID", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "async_search.delete" + }, + "specLocation": "async_search/delete/AsyncSearchDeleteResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves the results of a previously submitted async search request given its ID.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "async_search.get" + }, + "path": [ { - "aliases": [ - "seah", - "searchExpAvgHour" - ], - "description": "the exponential average search time per hour (millisecond)", - "name": "search.exp_avg_hour", - "required": false, + "description": "The async search ID", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "ni", - "nodeId" - ], - "description": "id of the assigned node", - "name": "node.id", + "description": "Specify the time interval in which the results (partial or final) for this search will be available", + "name": "keep_alive", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "name of the assigned node", - "name": "node.name", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "name": "typed_keys", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "ephemeral id of the assigned node", - "name": "node.ephemeral_id", + "description": "Specify the time that the request should block waiting for the final response", + "name": "wait_for_completion_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } - }, + } + ], + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L38" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "generics": [ { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "network address of the assigned node", - "name": "node.address", - "required": false, - "type": { + "name": "TDocument", + "namespace": "async_search.get" + } + ], + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TDocument", + "namespace": "async_search.get" } } + ], + "type": { + "name": "AsyncSearchDocumentResponseBase", + "namespace": "async_search._types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "async_search.get" + }, + "specLocation": "async_search/get/AsyncSearchGetResponse.ts#L22-L24" }, { "attachedBehaviors": [ - "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, + "description": "Retrieves the status of a previously submitted async search request given its ID.", "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "cat.datafeeds" + "namespace": "async_search.status" }, "path": [ { - "name": "datafeed_id", - "required": false, + "description": "The async search ID", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { @@ -60041,157 +67702,525 @@ } } ], - "query": [ - { - "name": "allow_no_datafeeds", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] + "query": [], + "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L23-L32" }, { "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DatafeedsRecord", - "namespace": "cat.datafeeds" - } + "kind": "properties", + "properties": [ + { + "name": "_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" + } + } + }, + { + "name": "completion_status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } + ] + }, + "generics": [ + { + "name": "TDocument", + "namespace": "async_search.status" + } + ], + "inherits": { + "type": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "cat.datafeeds" - } + "namespace": "async_search.status" + }, + "specLocation": "async_search/status/AsyncSearchStatusResponse.ts#L24-L29" }, { - "kind": "interface", - "name": { - "name": "FielddataRecord", - "namespace": "cat.fielddata" - }, - "properties": [ - { - "description": "node id", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "aliases": [ + "aggs" + ], + "name": "aggregations", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } } - } - }, - { - "aliases": [ - "h" - ], - "description": "host name", - "name": "host", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "collapse", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "FieldCollapse", + "namespace": "_global.search._types" + } } - } - }, - { - "description": "ip address", - "name": "ip", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "If true, returns detailed information about score computation as part of a hit.", + "name": "explain", + "required": false, + "serverDefault": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "aliases": [ - "n" - ], - "description": "node name", - "name": "node", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Configuration of search extensions defined by Elasticsearch plugins.", + "name": "ext", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } } - } - }, - { - "aliases": [ - "f" - ], - "description": "field name", - "name": "field", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - }, - { - "description": "field data usage", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "highlight", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "Highlight", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", + "name": "track_total_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TrackHits", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Boosts the _score of documents from specified indices.", + "name": "indices_boost", + "required": false, + "type": { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + } + }, + { + "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", + "name": "docvalue_fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in the search results.", + "name": "min_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "post_filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "profile", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Defines the search definition using the Query DSL.", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "rescore", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Rescore", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Rescore", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Retrieve a script evaluation (based on different fields) for each hit.", + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "name": "search_after", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortResults", + "namespace": "_types" + } + } + }, + { + "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", + "name": "size", + "required": false, + "serverDefault": 10, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "slice", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SlicedScroll", + "namespace": "_types" + } + } + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "name": "sort", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Sort", + "namespace": "_types" + } + } + }, + { + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "suggest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Suggester", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", + "name": "terminate_after", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", + "name": "track_scores", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, returns document version as part of a hit.", + "name": "version", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", + "name": "seq_no_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", + "name": "stored_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", + "name": "pit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PointInTimeReference", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", + "name": "stats", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + ] }, + "description": "Executes a search request asynchronously.", "inherits": { "type": { - "name": "CatRequestBase", - "namespace": "cat._types" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "cat.fielddata" + "namespace": "async_search.submit" }, "path": [ { - "name": "fields", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Indices", "namespace": "_types" } } @@ -60199,2400 +68228,2422 @@ ], "query": [ { - "name": "bytes", + "description": "Specify the time that the request should block waiting for the final response", + "name": "wait_for_completion_timeout", "required": false, + "serverDefault": "1s", "type": { "kind": "instance_of", "type": { - "name": "Bytes", + "name": "Time", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FielddataRecord", - "namespace": "cat.fielddata" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.fielddata" - } - }, - { - "kind": "interface", - "name": { - "name": "HealthRecord", - "namespace": "cat.health" - }, - "properties": [ + }, { - "aliases": [ - "time" - ], - "description": "seconds since 1969-01-01 00:00:00", - "name": "epoch", + "description": "Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)", + "name": "keep_on_completion", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "ts", - "hms", - "hhmmss" - ], - "description": "time in HH:MM:SS", - "name": "timestamp", + "description": "Update the time interval in which the results (partial or final) for this search will be available", + "name": "keep_alive", "required": false, + "serverDefault": "5d", "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "Time", "namespace": "_types" } } }, { - "aliases": [ - "cl" - ], - "description": "cluster name", - "name": "cluster", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "st" - ], - "description": "health status", - "name": "status", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout", + "name": "allow_partial_search_results", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "nt", - "nodeTotal" - ], - "description": "total number of nodes", - "name": "node.total", + "description": "The analyzer to use for the query string", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "nd", - "nodeData" - ], - "description": "number of nodes that can store data", - "name": "node.data", + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "name": "analyze_wildcard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "t", - "sh", - "shards.total", - "shardsTotal" - ], - "description": "total number of shards", - "name": "shards", + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.", + "name": "batched_reduce_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "p", - "shards.primary", - "shardsPrimary" - ], - "description": "number of primary shards", - "name": "pri", + "name": "ccs_minimize_roundtrips", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "r", - "shards.relocating", - "shardsRelocating" - ], - "description": "number of relocating nodes", - "name": "relo", + "description": "The default operator for query string query (AND or OR)", + "name": "default_operator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { - "aliases": [ - "i", - "shards.initializing", - "shardsInitializing" - ], - "description": "number of initializing nodes", - "name": "init", + "description": "The field to use as default where no field prefix is given in the query string", + "name": "df", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "u", - "shards.unassigned", - "shardsUnassigned" - ], - "description": "number of unassigned shards", - "name": "unassign", + "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", + "name": "docvalue_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } }, { - "aliases": [ - "pt", - "pendingTasks" - ], - "description": "number of pending tasks", - "name": "pending_tasks", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "aliases": [ - "mtwt", - "maxTaskWaitTime" - ], - "description": "wait time of longest task pending", - "name": "max_task_wait_time", + "description": "Specify whether to return detailed information about score computation as part of a hit", + "name": "explain", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "asp", - "activeShardsPercent" - ], - "description": "active number of shards in percent", - "name": "active_shards_percent", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", + "name": "ignore_throttled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.health" - }, - "path": [], - "query": [ + }, { - "name": "include_timestamp", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "ts", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "HealthRecord", - "namespace": "cat.health" + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.health" - } - }, - { - "kind": "interface", - "name": { - "name": "HelpRecord", - "namespace": "cat.help" - }, - "properties": [ + }, { - "name": "endpoint", - "required": true, + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "name": "max_concurrent_shard_requests", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.help" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "HelpRecord", - "namespace": "cat.help" + "name": "long", + "namespace": "_types" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.help" - } - }, - { - "kind": "interface", - "name": { - "name": "IndicesRecord", - "namespace": "cat.indices" - }, - "properties": [ + }, { - "aliases": [ - "h" - ], - "description": "current health status", - "name": "health", + "name": "min_compatible_shard_node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "aliases": [ - "s" - ], - "description": "open/close status", - "name": "status", + "description": "Specify the node or shard the operation should be performed on (default: random)", + "name": "preference", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "i", - "idx" - ], - "description": "index name", - "name": "index", + "name": "pre_filter_shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "id" - ], - "description": "index uuid", - "name": "uuid", + "description": "Specify if request cache should be used for this request or not, defaults to true", + "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "p", - "shards.primary", - "shardsPrimary" - ], - "description": "number of primary shards", - "name": "pri", + "description": "A comma-separated list of specific routing values", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Routing", + "namespace": "_types" } } }, { - "aliases": [ - "r", - "shards.replica", - "shardsReplica" - ], - "description": "number of replica shards", - "name": "rep", + "name": "scroll", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "aliases": [ - "dc", - "docsCount" - ], - "description": "available docs", - "name": "docs.count", + "description": "Search operation type", + "name": "search_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SearchType", + "namespace": "_types" } } }, { - "aliases": [ - "dd", - "docsDeleted" - ], - "description": "deleted docs", - "name": "docs.deleted", + "description": "Specific 'tag' of the request for logging and statistical purposes", + "name": "stats", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "aliases": [ - "cd" - ], - "description": "index creation date (millisecond value)", - "name": "creation.date", + "description": "A comma-separated list of stored fields to return as part of a hit", + "name": "stored_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } }, { - "aliases": [ - "cds" - ], - "description": "index creation date (as string)", - "name": "creation.date.string", + "description": "Specifies which field to use for suggestions.", + "name": "suggest_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "aliases": [ - "ss", - "storeSize" - ], - "description": "store size of primaries & replicas", - "name": "store.size", + "description": "Specify suggest mode", + "name": "suggest_mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SuggestMode", + "namespace": "_types" } } }, { - "description": "store size of primaries", - "name": "pri.store.size", + "description": "How many suggestions to return in response", + "name": "suggest_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "cs", - "completionSize" - ], - "description": "size of completion", - "name": "completion.size", + "description": "The source text for which the suggestions should be returned.", + "name": "suggest_text", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "size of completion", - "name": "pri.completion.size", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "name": "terminate_after", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "fm", - "fielddataMemory" - ], - "description": "used fielddata cache", - "name": "fielddata.memory_size", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "description": "used fielddata cache", - "name": "pri.fielddata.memory_size", + "description": "Indicate if the number of documents that match the query should be tracked", + "name": "track_total_hits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TrackHits", + "namespace": "_global.search._types" } } }, { - "aliases": [ - "fe", - "fielddataEvictions" - ], - "description": "fielddata evictions", - "name": "fielddata.evictions", + "description": "Whether to calculate and return scores even if they are not used for sorting", + "name": "track_scores", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "fielddata evictions", - "name": "pri.fielddata.evictions", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "name": "typed_keys", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "qcm", - "queryCacheMemory" - ], - "description": "used query cache", - "name": "query_cache.memory_size", + "name": "rest_total_hits_as_int", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "used query cache", - "name": "pri.query_cache.memory_size", + "description": "Specify whether to return document version as part of a hit", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "qce", - "queryCacheEvictions" - ], - "description": "query cache evictions", - "name": "query_cache.evictions", + "description": "True or false to return the _source field or not, or a list of fields to return", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "SourceConfigParam", + "namespace": "_global.search._types" } } }, { - "description": "query cache evictions", - "name": "pri.query_cache.evictions", + "description": "A list of fields to exclude from the returned _source field", + "name": "_source_excludes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } }, { - "aliases": [ - "rcm", - "requestCacheMemory" - ], - "description": "used request cache", - "name": "request_cache.memory_size", + "description": "A list of fields to extract and return from the _source field", + "name": "_source_includes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } }, { - "description": "used request cache", - "name": "pri.request_cache.memory_size", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit", + "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "rce", - "requestCacheEvictions" - ], - "description": "request cache evictions", - "name": "request_cache.evictions", + "description": "Query in the Lucene query string syntax", + "name": "q", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "request cache evictions", - "name": "pri.request_cache.evictions", + "description": "Number of hits to return (default: 10)", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "rchc", - "requestCacheHitCount" - ], - "description": "request cache hit count", - "name": "request_cache.hit_count", + "description": "Starting offset (default: 0)", + "name": "from", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "description": "request cache hit count", - "name": "pri.request_cache.hit_count", + "description": "A comma-separated list of : pairs", + "name": "sort", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } - }, + } + ], + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L53-L247" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "generics": [ { - "aliases": [ - "rcmc", - "requestCacheMissCount" - ], - "description": "request cache miss count", - "name": "request_cache.miss_count", - "required": false, - "type": { + "name": "TDocument", + "namespace": "async_search.submit" + } + ], + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TDocument", + "namespace": "async_search.submit" } } - }, + ], + "type": { + "name": "AsyncSearchDocumentResponseBase", + "namespace": "async_search._types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "async_search.submit" + }, + "specLocation": "async_search/submit/AsyncSearchSubmitResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingPolicy", + "namespace": "autoscaling._types" + }, + "properties": [ { - "description": "request cache miss count", - "name": "pri.request_cache.miss_count", - "required": false, + "name": "roles", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "aliases": [ - "ft", - "flushTotal" - ], - "description": "number of flushes", - "name": "flush.total", - "required": false, + "description": "Decider settings", + "name": "deciders", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "autoscaling/_types/AutoscalingPolicy.ts#L23-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.delete_autoscaling_policy" + }, + "path": [ { - "description": "number of flushes", - "name": "pri.flush.total", - "required": false, + "description": "the name of the autoscaling policy", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.delete_autoscaling_policy" + }, + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ { - "aliases": [ - "ftt", - "flushTotalTime" - ], - "description": "time spent in flush", - "name": "flush.total_time", - "required": false, + "name": "node", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AutoscalingResources", + "namespace": "autoscaling.get_autoscaling_capacity" } } }, { - "description": "time spent in flush", - "name": "pri.flush.total_time", - "required": false, + "name": "total", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AutoscalingResources", + "namespace": "autoscaling.get_autoscaling_capacity" } } - }, + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L38-L41" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingDecider", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ { - "aliases": [ - "gc", - "getCurrent" - ], - "description": "number of current get ops", - "name": "get.current", - "required": false, + "name": "required_capacity", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" } } }, { - "description": "number of current get ops", - "name": "pri.get.current", + "name": "reason_summary", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "gti", - "getTime" - ], - "description": "time spent in get", - "name": "get.time", + "name": "reason_details", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "user_defined_value" } - }, + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L52-L56" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingDeciders", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ { - "description": "time spent in get", - "name": "pri.get.time", - "required": false, + "name": "required_capacity", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" } } }, { - "aliases": [ - "gto", - "getTotal" - ], - "description": "number of get ops", - "name": "get.total", - "required": false, + "name": "current_capacity", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AutoscalingCapacity", + "namespace": "autoscaling.get_autoscaling_capacity" } } }, { - "description": "number of get ops", - "name": "pri.get.total", - "required": false, + "name": "current_nodes", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingNode", + "namespace": "autoscaling.get_autoscaling_capacity" + } } } }, { - "aliases": [ - "geti", - "getExistsTime" - ], - "description": "time spent in successful gets", - "name": "get.exists_time", - "required": false, + "name": "deciders", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingDecider", + "namespace": "autoscaling.get_autoscaling_capacity" + } } } - }, + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L31-L36" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingNode", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ { - "description": "time spent in successful gets", - "name": "pri.get.exists_time", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodeName", + "namespace": "_types" } } - }, + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L48-L50" + }, + { + "kind": "interface", + "name": { + "name": "AutoscalingResources", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "properties": [ { - "aliases": [ - "geto", - "getExistsTotal" - ], - "description": "number of successful gets", - "name": "get.exists_total", - "required": false, + "name": "storage", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "description": "number of successful gets", - "name": "pri.get.exists_total", - "required": false, + "name": "memory", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, - { - "aliases": [ - "gmti", - "getMissingTime" - ], - "description": "time spent in failed gets", - "name": "get.missing_time", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L43-L46" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "path": [], + "query": [], + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "policies", + "required": true, "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingDeciders", + "namespace": "autoscaling.get_autoscaling_capacity" + } + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.get_autoscaling_capacity" + }, + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L25-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.get_autoscaling_policy" + }, + "path": [ { - "description": "time spent in failed gets", - "name": "pri.get.missing_time", - "required": false, + "description": "the name of the autoscaling policy", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } - }, - { - "aliases": [ - "gmto", - "getMissingTotal" - ], - "description": "number of failed gets", - "name": "get.missing_total", - "required": false, + } + ], + "query": [], + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "AutoscalingPolicy", + "namespace": "autoscaling._types" } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.get_autoscaling_policy" + }, + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "policy", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoscalingPolicy", + "namespace": "autoscaling._types" + } + } + }, + "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "autoscaling.put_autoscaling_policy" + }, + "path": [ { - "description": "number of failed gets", - "name": "pri.get.missing_total", - "required": false, + "description": "the name of the autoscaling policy", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } + } + ], + "query": [], + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L35" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "autoscaling.put_autoscaling_policy" + }, + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts#L22-L22" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ae" + ], + "description": "For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.", + "name": "assignment_explanation" }, { "aliases": [ - "idc", - "indexingDeleteCurrent" + "bc", + "bucketsCount" ], - "description": "number of current deletions", - "name": "indexing.delete_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of bucket results produced by the job.", + "name": "buckets.count" }, { - "description": "number of current deletions", - "name": "pri.indexing.delete_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "btea", + "bucketsTimeExpAvg" + ], + "description": "Exponential moving average of all bucket processing times, in milliseconds.", + "name": "buckets.time.exp_avg" }, { "aliases": [ - "idti", - "indexingDeleteTime" + "bteah", + "bucketsTimeExpAvgHour" ], - "description": "time spent in deletions", - "name": "indexing.delete_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.", + "name": "buckets.time.exp_avg_hour" }, { - "description": "time spent in deletions", - "name": "pri.indexing.delete_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "btmax", + "bucketsTimeMax" + ], + "description": "Maximum among all bucket processing times, in milliseconds.", + "name": "buckets.time.max" }, { "aliases": [ - "idto", - "indexingDeleteTotal" + "btmin", + "bucketsTimeMin" ], - "description": "number of delete ops", - "name": "indexing.delete_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "Minimum among all bucket processing times, in milliseconds.", + "name": "buckets.time.min" }, { - "description": "number of delete ops", - "name": "pri.indexing.delete_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "btt", + "bucketsTimeTotal" + ], + "description": "Sum of all bucket processing times, in milliseconds.", + "name": "buckets.time.total" }, { "aliases": [ - "iic", - "indexingIndexCurrent" + "db", + "dataBuckets" ], - "description": "number of current indexing ops", - "name": "indexing.index_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of buckets processed.", + "name": "data.buckets" }, { - "description": "number of current indexing ops", - "name": "pri.indexing.index_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "der", + "dataEarliestRecord" + ], + "description": "The timestamp of the earliest chronologically input document.", + "name": "data.earliest_record" }, { "aliases": [ - "iiti", - "indexingIndexTime" + "deb", + "dataEmptyBuckets" ], - "description": "time spent in indexing", - "name": "indexing.index_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of buckets which did not contain any data.", + "name": "data.empty_buckets" }, { - "description": "time spent in indexing", - "name": "pri.indexing.index_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dib", + "dataInputBytes" + ], + "description": "The number of bytes of input data posted to the anomaly detection job.", + "name": "data.input_bytes" }, { "aliases": [ - "iito", - "indexingIndexTotal" + "dif", + "dataInputFields" ], - "description": "number of indexing ops", - "name": "indexing.index_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.", + "name": "data.input_fields" }, { - "description": "number of indexing ops", - "name": "pri.indexing.index_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dir", + "dataInputRecords" + ], + "description": "The number of input documents posted to the anomaly detection job.", + "name": "data.input_records" }, { "aliases": [ - "iif", - "indexingIndexFailed" + "did", + "dataInvalidDates" ], - "description": "number of failed indexing ops", - "name": "indexing.index_failed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of input documents with either a missing date field or a date\nthat could not be parsed.", + "name": "data.invalid_dates" }, { - "description": "number of failed indexing ops", - "name": "pri.indexing.index_failed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dl", + "dataLast" + ], + "description": "The timestamp at which data was last analyzed, according to server time.", + "name": "data.last" }, { "aliases": [ - "mc", - "mergesCurrent" + "dleb", + "dataLastEmptyBucket" ], - "description": "number of current merges", - "name": "merges.current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The timestamp of the last bucket that did not contain any data.", + "name": "data.last_empty_bucket" }, { - "description": "number of current merges", - "name": "pri.merges.current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dlsb", + "dataLastSparseBucket" + ], + "description": "The timestamp of the last bucket that was considered sparse.", + "name": "data.last_sparse_bucket" }, { "aliases": [ - "mcd", - "mergesCurrentDocs" + "dlr", + "dataLatestRecord" ], - "description": "number of current merging docs", - "name": "merges.current_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The timestamp of the latest chronologically input document.", + "name": "data.latest_record" }, { - "description": "number of current merging docs", - "name": "pri.merges.current_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dmf", + "dataMissingFields" + ], + "description": "The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.", + "name": "data.missing_fields" }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "doot", + "dataOutOfOrderTimestamps" ], - "description": "size of current merges", - "name": "merges.current_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.", + "name": "data.out_of_order_timestamps" }, { - "description": "size of current merges", - "name": "pri.merges.current_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dpf", + "dataProcessedFields" + ], + "description": "The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.", + "name": "data.processed_fields" }, { "aliases": [ - "mt", - "mergesTotal" + "dpr", + "dataProcessedRecords" ], - "description": "number of completed merge ops", - "name": "merges.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.", + "name": "data.processed_records" }, { - "description": "number of completed merge ops", - "name": "pri.merges.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "dsb", + "dataSparseBuckets" + ], + "description": "The number of buckets that contained few data points compared to the\nexpected number of data points.", + "name": "data.sparse_buckets" }, { "aliases": [ - "mtd", - "mergesTotalDocs" + "fmavg", + "forecastsMemoryAvg" ], - "description": "docs merged", - "name": "merges.total_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The average memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.avg" }, { - "description": "docs merged", - "name": "pri.merges.total_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "fmmax", + "forecastsMemoryMax" + ], + "description": "The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.max" }, { "aliases": [ - "mts", - "mergesTotalSize" + "fmmin", + "forecastsMemoryMin" ], - "description": "size merged", - "name": "merges.total_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.min" }, { - "description": "size merged", - "name": "pri.merges.total_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "fmt", + "forecastsMemoryTotal" + ], + "description": "The total memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.total" }, { "aliases": [ - "mtt", - "mergesTotalTime" + "fravg", + "forecastsRecordsAvg" ], - "description": "time spent in merges", - "name": "merges.total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.avg" }, { - "description": "time spent in merges", - "name": "pri.merges.total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "frmax", + "forecastsRecordsMax" + ], + "description": "The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.max" }, { "aliases": [ - "rto", - "refreshTotal" + "frmin", + "forecastsRecordsMin" ], - "description": "total refreshes", - "name": "refresh.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.min" }, { - "description": "total refreshes", - "name": "pri.refresh.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "frt", + "forecastsRecordsTotal" + ], + "description": "The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.total" }, { "aliases": [ - "rti", - "refreshTime" + "ftavg", + "forecastsTimeAvg" ], - "description": "time spent in refreshes", - "name": "refresh.time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.avg" }, { - "description": "time spent in refreshes", - "name": "pri.refresh.time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "ftmax", + "forecastsTimeMax" + ], + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.max" }, { "aliases": [ - "reto" + "ftmin", + "forecastsTimeMin" ], - "description": "total external refreshes", - "name": "refresh.external_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.min" }, { - "description": "total external refreshes", - "name": "pri.refresh.external_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "ftt", + "forecastsTimeTotal" + ], + "description": "The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.total" }, { "aliases": [ - "reti" + "ft", + "forecastsTotal" ], - "description": "time spent in external refreshes", - "name": "refresh.external_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of individual forecasts currently available for the job.", + "name": "forecasts.total" }, { - "description": "time spent in external refreshes", - "name": "pri.refresh.external_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "Identifier for the anomaly detection job.", + "name": "id" }, { "aliases": [ - "rli", - "refreshListeners" + "mbaf", + "modelBucketAllocationFailures" ], - "description": "number of pending refresh listeners", - "name": "refresh.listeners", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.", + "name": "model.bucket_allocation_failures" }, { - "description": "number of pending refresh listeners", - "name": "pri.refresh.listeners", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mbf", + "modelByFields" + ], + "description": "The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.", + "name": "model.by_fields" }, { "aliases": [ - "sfc", - "searchFetchCurrent" + "mb", + "modelBytes" ], - "description": "current fetch phase ops", - "name": "search.fetch_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.", + "name": "model.bytes" }, { - "description": "current fetch phase ops", - "name": "pri.search.fetch_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mbe", + "modelBytesExceeded" + ], + "description": "The number of bytes over the high limit for memory usage at the last\nallocation failure.", + "name": "model.bytes_exceeded" }, { "aliases": [ - "sfti", - "searchFetchTime" + "mcs", + "modelCategorizationStatus" ], - "description": "time spent in fetch phase", - "name": "search.fetch_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.", + "name": "model.categorization_status" }, { - "description": "time spent in fetch phase", - "name": "pri.search.fetch_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mcdc", + "modelCategorizedDocCount" + ], + "description": "The number of documents that have had a field categorized.", + "name": "model.categorized_doc_count" }, { "aliases": [ - "sfto", - "searchFetchTotal" + "mdcc", + "modelDeadCategoryCount" ], - "description": "total fetch ops", - "name": "search.fetch_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.", + "name": "model.dead_category_count" }, { - "description": "total fetch ops", - "name": "pri.search.fetch_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mdcc", + "modelFailedCategoryCount" + ], + "description": "The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.", + "name": "model.failed_category_count" }, { "aliases": [ - "so", - "searchOpenContexts" + "mfcc", + "modelFrequentCategoryCount" ], - "description": "open search contexts", - "name": "search.open_contexts", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of categories that match more than 1% of categorized documents.", + "name": "model.frequent_category_count" }, { - "description": "open search contexts", - "name": "pri.search.open_contexts", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mlt", + "modelLogTime" + ], + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.log_time" }, { "aliases": [ - "sqc", - "searchQueryCurrent" + "mml", + "modelMemoryLimit" ], - "description": "current query phase ops", - "name": "search.query_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.memory_limit" }, { - "description": "current query phase ops", - "name": "pri.search.query_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mms", + "modelMemoryStatus" + ], + "description": "The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.", + "name": "model.memory_status" }, { "aliases": [ - "sqti", - "searchQueryTime" + "mof", + "modelOverFields" ], - "description": "time spent in query phase", - "name": "search.query_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", + "name": "model.over_fields" }, { - "description": "time spent in query phase", - "name": "pri.search.query_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mpf", + "modelPartitionFields" + ], + "description": "The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", + "name": "model.partition_fields" }, { "aliases": [ - "sqto", - "searchQueryTotal" + "mrcc", + "modelRareCategoryCount" ], - "description": "total query phase ops", - "name": "search.query_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of categories that match just one categorized document.", + "name": "model.rare_category_count" }, { - "description": "total query phase ops", - "name": "pri.search.query_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "mt", + "modelTimestamp" + ], + "description": "The timestamp of the last record when the model stats were gathered.", + "name": "model.timestamp" }, { "aliases": [ - "scc", - "searchScrollCurrent" + "mtcc", + "modelTotalCategoryCount" ], - "description": "open scroll contexts", - "name": "search.scroll_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The number of categories created by categorization.", + "name": "model.total_category_count" }, { - "description": "open scroll contexts", - "name": "pri.search.scroll_current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.address" }, { "aliases": [ - "scti", - "searchScrollTime" + "ne", + "nodeEphemeralId" ], - "description": "time scroll contexts held open", - "name": "search.scroll_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.ephemeral_id" }, { - "description": "time scroll contexts held open", - "name": "pri.search.scroll_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.id" }, { "aliases": [ - "scto", - "searchScrollTotal" + "nn", + "nodeName" ], - "description": "completed scroll contexts", - "name": "search.scroll_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The name of the node that runs the job. This information is available only\nfor open jobs.", + "name": "node.name" }, { - "description": "completed scroll contexts", - "name": "pri.search.scroll_total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "ot" + ], + "description": "For open jobs only, the elapsed time for which the job has been open.", + "name": "opened_time" }, { "aliases": [ - "sc", - "segmentsCount" + "s" ], - "description": "number of segments", - "name": "segments.count", - "required": false, - "type": { + "description": "The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.", + "name": "state" + } + ], + "name": { + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L32-L401" + }, + { + "kind": "type_alias", + "name": { + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L402-L404", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "assignment_explanation" + ], + "description": "For started datafeeds only, contains messages relating to the selection of\na node.", + "name": "ae" }, { - "description": "number of segments", - "name": "pri.segments.count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "buckets.count", + "bucketsCount" + ], + "description": "The number of buckets processed.", + "name": "bc" + }, + { + "description": "A numerical character string that uniquely identifies the datafeed.", + "name": "id" }, { "aliases": [ - "sm", - "segmentsMemory" + "node.address", + "nodeAddress" ], - "description": "memory used by segments", - "name": "segments.memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "For started datafeeds only, the network address of the node where the\ndatafeed is started.", + "name": "na" }, { - "description": "memory used by segments", - "name": "pri.segments.memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "node.ephemeral_id", + "nodeEphemeralId" + ], + "description": "For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.", + "name": "ne" }, { "aliases": [ - "siwm", - "segmentsIndexWriterMemory" + "node.id", + "nodeId" ], - "description": "memory used by index writer", - "name": "segments.index_writer_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.", + "name": "ni" }, { - "description": "memory used by index writer", - "name": "pri.segments.index_writer_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "node.name", + "nodeName" + ], + "description": "For started datafeeds only, the name of the node where the datafeed is\nstarted.", + "name": "nn" }, { "aliases": [ - "svmm", - "segmentsVersionMapMemory" + "search.bucket_avg", + "searchBucketAvg" ], - "description": "memory used by version map", - "name": "segments.version_map_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The average search time per bucket, in milliseconds.", + "name": "sba" }, { - "description": "memory used by version map", - "name": "pri.segments.version_map_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "search.count", + "searchCount" + ], + "description": "The number of searches run by the datafeed.", + "name": "sc" }, { "aliases": [ - "sfbm", - "fixedBitsetMemory" + "search.exp_avg_hour", + "searchExpAvgHour" ], - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "segments.fixed_bitset_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The exponential average search time per hour, in milliseconds.", + "name": "seah" }, { - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "pri.segments.fixed_bitset_memory", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "search.time", + "searchTime" + ], + "description": "The total time the datafeed spent searching, in milliseconds.", + "name": "st" }, { "aliases": [ - "wc", - "warmerCurrent" + "state" ], - "description": "current warmer ops", - "name": "warmer.current", - "required": false, - "type": { + "description": "The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.", + "name": "s" + } + ], + "name": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L405-L471" + }, + { + "kind": "type_alias", + "name": { + "name": "CatDatafeedColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L559-L559", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatDatafeedColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ae" + ], + "description": "Contains messages relating to the selection of a node.", + "name": "assignment_explanation" }, { - "description": "current warmer ops", - "name": "pri.warmer.current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "ct", + "createTime" + ], + "description": "The time when the data frame analytics job was created.", + "name": "create_time" }, { "aliases": [ - "wto", - "warmerTotal" + "d" ], - "description": "total warmer ops", - "name": "warmer.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "A description of a job.", + "name": "description" }, { - "description": "total warmer ops", - "name": "pri.warmer.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "di", + "destIndex" + ], + "description": "Name of the destination index.", + "name": "dest_index" }, { "aliases": [ - "wtt", - "warmerTotalTime" + "fr", + "failureReason" ], - "description": "time spent in warmers", - "name": "warmer.total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "Contains messages about the reason why a data frame analytics job failed.", + "name": "failure_reason" }, { - "description": "time spent in warmers", - "name": "pri.warmer.total_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "Identifier for the data frame analytics job.", + "name": "id" }, { "aliases": [ - "suc", - "suggestCurrent" + "mml", + "modelMemoryLimit" ], - "description": "number of current suggest ops", - "name": "suggest.current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.", + "name": "model_memory_limit" }, { - "description": "number of current suggest ops", - "name": "pri.suggest.current", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the node that the data frame analytics job is\nassigned to.", + "name": "node.address" }, { "aliases": [ - "suti", - "suggestTime" + "ne", + "nodeEphemeralId" ], - "description": "time spend in suggest", - "name": "suggest.time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The ephemeral ID of the node that the data frame analytics job is assigned\nto.", + "name": "node.ephemeral_id" }, { - "description": "time spend in suggest", - "name": "pri.suggest.time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the node that the data frame analytics job is\nassigned to.", + "name": "node.id" }, { "aliases": [ - "suto", - "suggestTotal" + "nn", + "nodeName" ], - "description": "number of suggest ops", - "name": "suggest.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The name of the node that the data frame analytics job is assigned to.", + "name": "node.name" }, { - "description": "number of suggest ops", - "name": "pri.suggest.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "p" + ], + "description": "The progress report of the data frame analytics job by phase.", + "name": "progress" }, { "aliases": [ - "tm", - "memoryTotal" + "si", + "sourceIndex" ], - "description": "total used memory", - "name": "memory.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "Name of the source index.", + "name": "source_index" }, { - "description": "total user memory", - "name": "pri.memory.total", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "aliases": [ + "s" + ], + "description": "Current state of the data frame analytics job.", + "name": "state" }, { "aliases": [ - "sth" + "t" ], - "description": "indicates if the index is search throttled", - "name": "search.throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "description": "The type of analysis that the data frame analytics job performs.", + "name": "type" }, { "aliases": [ - "bto", - "bulkTotalOperation" + "v" ], - "description": "number of bulk shard ops", - "name": "bulk.total_operations", - "required": false, - "type": { + "description": "The Elasticsearch version number in which the data frame analytics job was\ncreated.", + "name": "version" + } + ], + "name": { + "name": "CatDfaColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L472-L557" + }, + { + "kind": "type_alias", + "name": { + "name": "CatDfaColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L558-L558", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatDfaColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatDfaColumn", + "namespace": "cat._types" + } } } - }, + ], + "kind": "union_of" + } + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "behaviors": [ { - "description": "number of bulk shard ops", - "name": "pri.bulk.total_operations", - "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "CommonCatQueryParameters", + "namespace": "_spec_utils" } + } + ], + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "CatRequestBase", + "namespace": "cat._types" + }, + "properties": [], + "specLocation": "cat/_types/CatBase.ts#L28-L30" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ct" + ], + "description": "The time when the trained model was created.", + "name": "create_time" }, { "aliases": [ - "btti", - "bulkTotalTime" + "c", + "createdBy" ], - "description": "time spend in shard bulk", - "name": "bulk.total_time", - "required": false, - "type": { + "description": "Information on the creator of the trained model.", + "name": "created_by" + }, + { + "aliases": [ + "df", + "dataFrameAnalytics" + ], + "description": "Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.", + "name": "data_frame_analytics_id" + }, + { + "aliases": [ + "d" + ], + "description": "The description of the trained model.", + "name": "description" + }, + { + "aliases": [ + "hs", + "modelHeapSize" + ], + "description": "The estimated heap size to keep the trained model in memory.", + "name": "heap_size" + }, + { + "description": "Idetifier for the trained model.", + "name": "id" + }, + { + "aliases": [ + "ic", + "ingestCount" + ], + "description": "The total number of documents that are processed by the model.", + "name": "ingest.count" + }, + { + "aliases": [ + "icurr", + "ingestCurrent" + ], + "description": "The total number of document that are currently being handled by the\ntrained model.", + "name": "ingest.current" + }, + { + "aliases": [ + "if", + "ingestFailed" + ], + "description": "The total number of failed ingest attempts with the trained model.", + "name": "ingest.failed" + }, + { + "aliases": [ + "ip", + "ingestPipelines" + ], + "description": "The total number of ingest pipelines that are referencing the trained\nmodel.", + "name": "ingest.pipelines" + }, + { + "aliases": [ + "it", + "ingestTime" + ], + "description": "The total time that is spent processing documents with the trained model.", + "name": "ingest.time" + }, + { + "aliases": [ + "l" + ], + "description": "The license level of the trained model.", + "name": "license" + }, + { + "aliases": [ + "o", + "modelOperations" + ], + "description": "The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.", + "name": "operations" + }, + { + "aliases": [ + "v" + ], + "description": "The Elasticsearch version number in which the trained model was created.", + "name": "version" + } + ], + "name": { + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L561-L635" + }, + { + "kind": "type_alias", + "name": { + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L636-L638", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" + } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "cldt" + ], + "description": "The timestamp when changes were last detected in the source indices.", + "name": "changes_last_detection_time" }, { - "description": "time spend in shard bulk", - "name": "pri.bulk.total_time", - "required": false, - "type": { + "aliases": [ + "cp" + ], + "description": "The sequence number for the checkpoint.", + "name": "checkpoint" + }, + { + "aliases": [ + "cdtea", + "checkpointTimeExpAvg" + ], + "description": "Exponential moving average of the duration of the checkpoint, in\nmilliseconds.", + "name": "checkpoint_duration_time_exp_avg" + }, + { + "aliases": [ + "c", + "checkpointProgress" + ], + "description": "The progress of the next checkpoint that is currently in progress.", + "name": "checkpoint_progress" + }, + { + "aliases": [ + "ct", + "createTime" + ], + "description": "The time the transform was created.", + "name": "create_time" + }, + { + "aliases": [ + "dtime" + ], + "description": "The amount of time spent deleting, in milliseconds.", + "name": "delete_time" + }, + { + "aliases": [ + "d" + ], + "description": "The description of the transform.", + "name": "description" + }, + { + "aliases": [ + "di", + "destIndex" + ], + "description": "The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.", + "name": "dest_index" + }, + { + "aliases": [ + "docd" + ], + "description": "The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.", + "name": "documents_deleted" + }, + { + "aliases": [ + "doci" + ], + "description": "The number of documents that have been indexed into the destination index\nfor the transform.", + "name": "documents_indexed" + }, + { + "aliases": [ + "dps" + ], + "description": "Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.", + "name": "docs_per_second" + }, + { + "aliases": [ + "docp" + ], + "description": "The number of documents that have been processed from the source index of\nthe transform.", + "name": "documents_processed" + }, + { + "aliases": [ + "f" + ], + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.", + "name": "frequency" + }, + { + "description": "Identifier for the transform.", + "name": "id" + }, + { + "aliases": [ + "if" + ], + "description": "The number of indexing failures.", + "name": "index_failure" + }, + { + "aliases": [ + "itime" + ], + "description": "The amount of time spent indexing, in milliseconds.", + "name": "index_time" + }, + { + "aliases": [ + "it" + ], + "description": "The number of index operations.", + "name": "index_total" + }, + { + "aliases": [ + "idea" + ], + "description": "Exponential moving average of the number of new documents that have been\nindexed.", + "name": "indexed_documents_exp_avg" + }, + { + "aliases": [ + "lst", + "lastSearchTime" + ], + "description": "The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.", + "name": "last_search_time" + }, + { + "aliases": [ + "mpsz" + ], + "description": "Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.", + "name": "max_page_search_size" + }, + { + "aliases": [ + "pp" + ], + "description": "The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.", + "name": "pages_processed" + }, + { + "aliases": [ + "p" + ], + "description": "The unique identifier for an ingest pipeline.", + "name": "pipeline" + }, + { + "aliases": [ + "pdea" + ], + "description": "Exponential moving average of the number of documents that have been\nprocessed.", + "name": "processed_documents_exp_avg" + }, + { + "aliases": [ + "pt" + ], + "description": "The amount of time spent processing results, in milliseconds.", + "name": "processing_time" + }, + { + "aliases": [ + "r" + ], + "description": "If a transform has a `failed` state, this property provides details about\nthe reason for the failure.", + "name": "reason" + }, + { + "aliases": [ + "sf" + ], + "description": "The number of search failures.", + "name": "search_failure" + }, + { + "aliases": [ + "stime" + ], + "description": "The amount of time spent searching, in milliseconds.", + "name": "search_time" + }, + { + "aliases": [ + "st" + ], + "description": "The number of search operations on the source index for the transform.", + "name": "search_total" + }, + { + "aliases": [ + "si", + "sourceIndex" + ], + "description": "The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.", + "name": "source_index" + }, + { + "aliases": [ + "s" + ], + "description": "The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.", + "name": "state" + }, + { + "aliases": [ + "tt" + ], + "description": "Indicates the type of transform: `batch` or `continuous`.", + "name": "transform_type" + }, + { + "aliases": [ + "tc" + ], + "description": "The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.", + "name": "trigger_count" + }, + { + "aliases": [ + "v" + ], + "description": "The version of Elasticsearch that existed on the node when the transform\nwas created.", + "name": "version" + } + ], + "name": { + "name": "CatTransformColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L640-L844" + }, + { + "kind": "type_alias", + "name": { + "name": "CatTransformColumns", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L845-L845", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatTransformColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatTransformColumn", + "namespace": "cat._types" + } } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "AliasesRecord", + "namespace": "cat.aliases" + }, + "properties": [ { "aliases": [ - "btsi", - "bulkTotalSizeInBytes" + "a" ], - "description": "total size in bytes of shard bulk", - "name": "bulk.total_size_in_bytes", + "description": "alias name", + "name": "alias", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "total size in bytes of shard bulk", - "name": "pri.bulk.total_size_in_bytes", + "aliases": [ + "i", + "idx" + ], + "description": "index alias points to", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { "aliases": [ - "bati", - "bulkAvgTime" + "f", + "fi" ], - "description": "average time spend in shard bulk", - "name": "bulk.avg_time", + "description": "filter", + "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "average time spend in shard bulk", - "name": "pri.bulk.avg_time", + "aliases": [ + "ri", + "routingIndex" + ], + "description": "index routing", + "name": "routing.index", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "basi", - "bulkAvgSizeInBytes" + "rs", + "routingSearch" ], - "description": "average size in bytes of shard bulk", - "name": "bulk.avg_size_in_bytes", + "description": "search routing", + "name": "routing.search", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "average size in bytes of shard bulk", - "name": "pri.bulk.avg_size_in_bytes", + "aliases": [ + "w", + "isWriteIndex" + ], + "description": "write index", + "name": "is_write_index", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cat/aliases/types.ts#L22-L53" }, { "attachedBehaviors": [ @@ -62602,6 +70653,7 @@ "body": { "kind": "no_body" }, + "description": "Shows information about currently configured aliases to indices including filter and routing infos.", "inherits": { "type": { "name": "CatRequestBase", @@ -62611,16 +70663,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.indices" + "namespace": "cat.aliases" }, "path": [ { - "name": "index", + "description": "A comma-separated list of alias names to return", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Names", "namespace": "_types" } } @@ -62628,61 +70681,321 @@ ], "query": [ { - "name": "bytes", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", + "name": "ExpandWildcards", "namespace": "_types" } } - }, + } + ], + "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L35" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AliasesRecord", + "namespace": "cat.aliases" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.aliases" + }, + "specLocation": "cat/aliases/CatAliasesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AllocationRecord", + "namespace": "cat.allocation" + }, + "properties": [ { - "name": "expand_wildcards", + "aliases": [ + "s" + ], + "description": "number of shards on node", + "name": "shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "health", + "aliases": [ + "di", + "diskIndices" + ], + "description": "disk used by ES indices", + "name": "disk.indices", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "du", + "diskUsed" + ], + "description": "disk used (total, not just ES)", + "name": "disk.used", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "da", + "diskAvail" + ], + "description": "disk available", + "name": "disk.avail", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "dt", + "diskTotal" + ], + "description": "total capacity of all volumes", + "name": "disk.total", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "dp", + "diskPercent" + ], + "description": "percent disk used", + "name": "disk.percent", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Percentage", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "h" + ], + "description": "host of node", + "name": "host", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Host", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "ip of node", + "name": "ip", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Ip", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "n" + ], + "description": "name of node", + "name": "node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Health", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/allocation/types.ts#L24-L69" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.allocation" + }, + "path": [ { - "name": "include_unloaded_segments", + "description": "A comma-separated list of node IDs or names to limit the returned information", + "name": "node_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "NodeIds", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "pri", + "description": "The unit in which to display byte values", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } } - ] + ], + "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L35" }, { "body": { @@ -62692,8 +71005,8 @@ "value": { "kind": "instance_of", "type": { - "name": "IndicesRecord", - "namespace": "cat.indices" + "name": "AllocationRecord", + "namespace": "cat.allocation" } } } @@ -62701,2875 +71014,2797 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.indices" - } + "namespace": "cat.allocation" + }, + "specLocation": "cat/allocation/CatAllocationResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "JobsRecord", - "namespace": "cat.jobs" + "name": "CountRecord", + "namespace": "cat.count" }, "properties": [ { - "description": "the job_id", - "name": "id", + "aliases": [ + "t", + "time" + ], + "description": "seconds since 1969-01-01 00:00:00", + "name": "epoch", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "EpochMillis", "namespace": "_types" } } }, { "aliases": [ - "s" + "ts", + "hms", + "hhmmss" ], - "description": "the job state", - "name": "state", + "description": "time in HH:MM:SS", + "name": "timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobState", - "namespace": "ml._types" + "name": "DateString", + "namespace": "_types" } } }, { "aliases": [ - "ot" + "dc", + "docs.count", + "docsCount" ], - "description": "the amount of time the job has been opened", - "name": "opened_time", + "description": "the document count", + "name": "count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/count/types.ts#L22-L38" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Provides quick access to the document count of the entire cluster, or individual indices.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.count" + }, + "path": [ { - "aliases": [ - "ae" - ], - "description": "why the job is or is not assigned to a node", - "name": "assignment_explanation", + "description": "A comma-separated list of index names to limit the returned information", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "cat/count/CatCountRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CountRecord", + "namespace": "cat.count" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.count" + }, + "specLocation": "cat/count/CatCountResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "FielddataRecord", + "namespace": "cat.fielddata" + }, + "properties": [ { - "aliases": [ - "dpr", - "dataProcessedRecords" - ], - "description": "number of processed records", - "name": "data.processed_records", + "description": "node id", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dpf", - "dataProcessedFields" + "h" ], - "description": "number of processed fields", - "name": "data.processed_fields", + "description": "host name", + "name": "host", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "dib", - "dataInputBytes" - ], - "description": "total input bytes", - "name": "data.input_bytes", + "description": "ip address", + "name": "ip", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "dir", - "dataInputRecords" + "n" ], - "description": "total record count", - "name": "data.input_records", + "description": "node name", + "name": "node", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dif", - "dataInputFields" + "f" ], - "description": "total field count", - "name": "data.input_fields", + "description": "field name", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "did", - "dataInvalidDates" - ], - "description": "number of records with invalid dates", - "name": "data.invalid_dates", + "description": "field data usage", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/fielddata/types.ts#L20-L48" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.fielddata" + }, + "path": [ { - "aliases": [ - "dmf", - "dataMissingFields" - ], - "description": "number of records with missing fields", - "name": "data.missing_fields", + "description": "A comma-separated list of fields to return the fielddata size", + "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "doot", - "dataOutOfOrderTimestamps" - ], - "description": "number of records handled out of order", - "name": "data.out_of_order_timestamps", + "description": "The unit in which to display byte values", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } - }, + } + ], + "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L35" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FielddataRecord", + "namespace": "cat.fielddata" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.fielddata" + }, + "specLocation": "cat/fielddata/CatFielddataResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "HealthRecord", + "namespace": "cat.health" + }, + "properties": [ { "aliases": [ - "deb", - "dataEmptyBuckets" + "time" ], - "description": "number of empty buckets", - "name": "data.empty_buckets", + "description": "seconds since 1969-01-01 00:00:00", + "name": "epoch", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } }, { "aliases": [ - "dsb", - "dataSparseBuckets" + "ts", + "hms", + "hhmmss" ], - "description": "number of sparse buckets", - "name": "data.sparse_buckets", + "description": "time in HH:MM:SS", + "name": "timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DateString", + "namespace": "_types" } } }, { "aliases": [ - "db", - "dataBuckets" + "cl" ], - "description": "total bucket count", - "name": "data.buckets", + "description": "cluster name", + "name": "cluster", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "der", - "dataEarliestRecord" + "st" ], - "description": "earliest record time", - "name": "data.earliest_record", + "description": "health status", + "name": "status", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dlr", - "dataLatestRecord" + "nt", + "nodeTotal" ], - "description": "latest record time", - "name": "data.latest_record", + "description": "total number of nodes", + "name": "node.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dl", - "dataLast" + "nd", + "nodeData" ], - "description": "last time data was seen", - "name": "data.last", + "description": "number of nodes that can store data", + "name": "node.data", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dleb", - "dataLastEmptyBucket" + "t", + "sh", + "shards.total", + "shardsTotal" ], - "description": "last time an empty bucket occurred", - "name": "data.last_empty_bucket", + "description": "total number of shards", + "name": "shards", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dlsb", - "dataLastSparseBucket" + "p", + "shards.primary", + "shardsPrimary" ], - "description": "last time a sparse bucket occurred", - "name": "data.last_sparse_bucket", + "description": "number of primary shards", + "name": "pri", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mb", - "modelBytes" + "r", + "shards.relocating", + "shardsRelocating" ], - "description": "model size", - "name": "model.bytes", + "description": "number of relocating nodes", + "name": "relo", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mms", - "modelMemoryStatus" + "i", + "shards.initializing", + "shardsInitializing" ], - "description": "current memory status", - "name": "model.memory_status", + "description": "number of initializing nodes", + "name": "init", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MemoryStatus", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mbe", - "modelBytesExceeded" + "u", + "shards.unassigned", + "shardsUnassigned" ], - "description": "how much the model has exceeded the limit", - "name": "model.bytes_exceeded", + "description": "number of unassigned shards", + "name": "unassign", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mml", - "modelMemoryLimit" + "pt", + "pendingTasks" ], - "description": "model memory limit", - "name": "model.memory_limit", + "description": "number of pending tasks", + "name": "pending_tasks", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mbf", - "modelByFields" + "mtwt", + "maxTaskWaitTime" ], - "description": "count of 'by' fields", - "name": "model.by_fields", + "description": "wait time of longest task pending", + "name": "max_task_wait_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mof", - "modelOverFields" + "asp", + "activeShardsPercent" ], - "description": "count of 'over' fields", - "name": "model.over_fields", + "description": "active number of shards in percent", + "name": "active_shards_percent", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/health/types.ts#L22-L93" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a concise representation of the cluster health.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.health" + }, + "path": [], + "query": [ { - "aliases": [ - "mpf", - "modelPartitionFields" - ], - "description": "count of 'partition' fields", - "name": "model.partition_fields", + "description": "Set to false to disable timestamping", + "name": "ts", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/health/CatHealthRequest.ts#L22-L31" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "HealthRecord", + "namespace": "cat.health" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.health" + }, + "specLocation": "cat/health/CatHealthResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "HelpRecord", + "namespace": "cat.help" + }, + "properties": [ { - "aliases": [ - "mbaf", - "modelBucketAllocationFailures" - ], - "description": "number of bucket allocation failures", - "name": "model.bucket_allocation_failures", - "required": false, + "name": "endpoint", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/help/types.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns help for the Cat APIs.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.help" + }, + "path": [], + "query": [], + "specLocation": "cat/help/CatHelpRequest.ts#L22-L27" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "HelpRecord", + "namespace": "cat.help" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.help" + }, + "specLocation": "cat/help/CatHelpResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "IndicesRecord", + "namespace": "cat.indices" + }, + "properties": [ { "aliases": [ - "mcs", - "modelCategorizationStatus" + "h" ], - "description": "current categorization status", - "name": "model.categorization_status", + "description": "current health status", + "name": "health", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CategorizationStatus", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "mcdc", - "modelCategorizedDocCount" + "s" ], - "description": "count of categorized documents", - "name": "model.categorized_doc_count", + "description": "open/close status", + "name": "status", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mtcc", - "modelTotalCategoryCount" + "i", + "idx" ], - "description": "count of categories", - "name": "model.total_category_count", + "description": "index name", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "modelFrequentCategoryCount" + "id" ], - "description": "count of frequent categories", - "name": "model.frequent_category_count", + "description": "index uuid", + "name": "uuid", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mrcc", - "modelRareCategoryCount" + "p", + "shards.primary", + "shardsPrimary" ], - "description": "count of rare categories", - "name": "model.rare_category_count", + "description": "number of primary shards", + "name": "pri", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mdcc", - "modelDeadCategoryCount" + "r", + "shards.replica", + "shardsReplica" ], - "description": "count of dead categories", - "name": "model.dead_category_count", + "description": "number of replica shards", + "name": "rep", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mfcc", - "modelFailedCategoryCount" + "dc", + "docsCount" ], - "description": "count of failed categories", - "name": "model.failed_category_count", + "description": "available docs", + "name": "docs.count", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "mlt", - "modelLogTime" + "dd", + "docsDeleted" ], - "description": "when the model stats were gathered", - "name": "model.log_time", + "description": "deleted docs", + "name": "docs.deleted", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "mt", - "modelTimestamp" + "cd" ], - "description": "the time of the last record when the model stats were gathered", - "name": "model.timestamp", + "description": "index creation date (millisecond value)", + "name": "creation.date", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ft", - "forecastsTotal" + "cds" ], - "description": "total number of forecasts", - "name": "forecasts.total", + "description": "index creation date (as string)", + "name": "creation.date.string", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fmmin", - "forecastsMemoryMin" + "ss", + "storeSize" ], - "description": "minimum memory used by forecasts", - "name": "forecasts.memory.min", + "description": "store size of primaries & replicas", + "name": "store.size", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "store size of primaries", + "name": "pri.store.size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "fmmax", - "forecastsMemoryMax" + "cs", + "completionSize" ], - "description": "maximum memory used by forecasts", - "name": "forecasts.memory.max", + "description": "size of completion", + "name": "completion.size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "fmavg", - "forecastsMemoryAvg" - ], - "description": "average memory used by forecasts", - "name": "forecasts.memory.avg", + "description": "size of completion", + "name": "pri.completion.size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fmt", - "forecastsMemoryTotal" + "fm", + "fielddataMemory" ], - "description": "total memory used by all forecasts", - "name": "forecasts.memory.total", + "description": "used fielddata cache", + "name": "fielddata.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "frmin", - "forecastsRecordsMin" - ], - "description": "minimum record count for forecasts", - "name": "forecasts.records.min", + "description": "used fielddata cache", + "name": "pri.fielddata.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "frmax", - "forecastsRecordsMax" + "fe", + "fielddataEvictions" ], - "description": "maximum record count for forecasts", - "name": "forecasts.records.max", + "description": "fielddata evictions", + "name": "fielddata.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "fravg", - "forecastsRecordsAvg" - ], - "description": "average record count for forecasts", - "name": "forecasts.records.avg", + "description": "fielddata evictions", + "name": "pri.fielddata.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "frt", - "forecastsRecordsTotal" + "qcm", + "queryCacheMemory" ], - "description": "total record count for all forecasts", - "name": "forecasts.records.total", + "description": "used query cache", + "name": "query_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "ftmin", - "forecastsTimeMin" - ], - "description": "minimum runtime for forecasts", - "name": "forecasts.time.min", + "description": "used query cache", + "name": "pri.query_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ftmax", - "forecastsTimeMax" + "qce", + "queryCacheEvictions" ], - "description": "maximum run time for forecasts", - "name": "forecasts.time.max", + "description": "query cache evictions", + "name": "query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "ftavg", - "forecastsTimeAvg" - ], - "description": "average runtime for all forecasts (milliseconds)", - "name": "forecasts.time.avg", + "description": "query cache evictions", + "name": "pri.query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ftt", - "forecastsTimeTotal" + "rcm", + "requestCacheMemory" ], - "description": "total runtime for all forecasts", - "name": "forecasts.time.total", + "description": "used request cache", + "name": "request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "id of the assigned node", - "name": "node.id", + "description": "used request cache", + "name": "pri.request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "nn", - "nodeName" + "rce", + "requestCacheEvictions" ], - "description": "name of the assigned node", - "name": "node.name", + "description": "request cache evictions", + "name": "request_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "ephemeral id of the assigned node", - "name": "node.ephemeral_id", + "description": "request cache evictions", + "name": "pri.request_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "na", - "nodeAddress" + "rchc", + "requestCacheHitCount" ], - "description": "network address of the assigned node", - "name": "node.address", + "description": "request cache hit count", + "name": "request_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "bc", - "bucketsCount" - ], - "description": "bucket count", - "name": "buckets.count", + "description": "request cache hit count", + "name": "pri.request_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "btt", - "bucketsTimeTotal" + "rcmc", + "requestCacheMissCount" ], - "description": "total bucket processing time", - "name": "buckets.time.total", + "description": "request cache miss count", + "name": "request_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "btmin", - "bucketsTimeMin" - ], - "description": "minimum bucket processing time", - "name": "buckets.time.min", + "description": "request cache miss count", + "name": "pri.request_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "btmax", - "bucketsTimeMax" + "ft", + "flushTotal" ], - "description": "maximum bucket processing time", - "name": "buckets.time.max", + "description": "number of flushes", + "name": "flush.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "btea", - "bucketsTimeExpAvg" - ], - "description": "exponential average bucket processing time (milliseconds)", - "name": "buckets.time.exp_avg", + "description": "number of flushes", + "name": "pri.flush.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "bteah", - "bucketsTimeExpAvgHour" + "ftt", + "flushTotalTime" ], - "description": "exponential average bucket processing time by hour (milliseconds)", - "name": "buckets.time.exp_avg_hour", + "description": "time spent in flush", + "name": "flush.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.jobs" - }, - "path": [ + }, { - "name": "job_id", + "description": "time spent in flush", + "name": "pri.flush.total_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "allow_no_jobs", + "aliases": [ + "gc", + "getCurrent" + ], + "description": "number of current get ops", + "name": "get.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "bytes", + "description": "number of current get ops", + "name": "pri.get.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "aliases": [ + "gti", + "getTime" + ], + "description": "time spent in get", + "name": "get.time", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "JobsRecord", - "namespace": "cat.jobs" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.jobs" - } - }, - { - "kind": "interface", - "name": { - "name": "MasterRecord", - "namespace": "cat.master" - }, - "properties": [ + }, { - "description": "node id", - "name": "id", + "description": "time spent in get", + "name": "pri.get.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "h" + "gto", + "getTotal" ], - "description": "host name", - "name": "host", + "description": "number of get ops", + "name": "get.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "ip address", - "name": "ip", + "description": "number of get ops", + "name": "pri.get.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "n" + "geti", + "getExistsTime" ], - "description": "node name", - "name": "node", + "description": "time spent in successful gets", + "name": "get.exists_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.master" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "MasterRecord", - "namespace": "cat.master" + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.master" - } - }, - { - "kind": "interface", - "name": { - "name": "NodeAttributesRecord", - "namespace": "cat.node_attributes" - }, - "properties": [ + }, { - "description": "node name", - "name": "node", + "description": "time spent in successful gets", + "name": "pri.get.exists_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "unique node id", - "name": "id", + "aliases": [ + "geto", + "getExistsTotal" + ], + "description": "number of successful gets", + "name": "get.exists_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "process id", - "name": "pid", + "description": "number of successful gets", + "name": "pri.get.exists_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "h" + "gmti", + "getMissingTime" ], - "description": "host name", - "name": "host", + "description": "time spent in failed gets", + "name": "get.missing_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "i" - ], - "description": "ip address", - "name": "ip", + "description": "time spent in failed gets", + "name": "pri.get.missing_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "bound transport port", - "name": "port", + "aliases": [ + "gmto", + "getMissingTotal" + ], + "description": "number of failed gets", + "name": "get.missing_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "attribute description", - "name": "attr", + "description": "number of failed gets", + "name": "pri.get.missing_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "attribute value", - "name": "value", + "aliases": [ + "idc", + "indexingDeleteCurrent" + ], + "description": "number of current deletions", + "name": "indexing.delete_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.node_attributes" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "description": "number of current deletions", + "name": "pri.indexing.delete_current", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NodeAttributesRecord", - "namespace": "cat.node_attributes" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.node_attributes" - } - }, - { - "kind": "interface", - "name": { - "name": "NodesRecord", - "namespace": "cat.nodes" - }, - "properties": [ + }, { "aliases": [ - "nodeId" + "idti", + "indexingDeleteTime" ], - "description": "unique node id", - "name": "id", + "description": "time spent in deletions", + "name": "indexing.delete_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "p" - ], - "description": "process id", - "name": "pid", + "description": "time spent in deletions", + "name": "pri.indexing.delete_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "i" + "idto", + "indexingDeleteTotal" ], - "description": "ip address", - "name": "ip", + "description": "number of delete ops", + "name": "indexing.delete_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "po" - ], - "description": "bound transport port", - "name": "port", + "description": "number of delete ops", + "name": "pri.indexing.delete_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "http" + "iic", + "indexingIndexCurrent" ], - "description": "bound http address", - "name": "http_address", + "description": "number of current indexing ops", + "name": "indexing.index_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "v" - ], - "description": "es version", - "name": "version", + "description": "number of current indexing ops", + "name": "pri.indexing.index_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "f" + "iiti", + "indexingIndexTime" ], - "description": "es distribution flavor", - "name": "flavor", + "description": "time spent in indexing", + "name": "indexing.index_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "t" - ], - "description": "es distribution type", - "name": "type", + "description": "time spent in indexing", + "name": "pri.indexing.index_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Type", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "b" + "iito", + "indexingIndexTotal" ], - "description": "es build hash", - "name": "build", + "description": "number of indexing ops", + "name": "indexing.index_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "j" - ], - "description": "jdk version", - "name": "jdk", + "description": "number of indexing ops", + "name": "pri.indexing.index_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dt", - "diskTotal" + "iif", + "indexingIndexFailed" ], - "description": "total disk space", - "name": "disk.total", + "description": "number of failed indexing ops", + "name": "indexing.index_failed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "du", - "diskUsed" - ], - "description": "used disk space", - "name": "disk.used", + "description": "number of failed indexing ops", + "name": "pri.indexing.index_failed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "d", - "da", - "disk", - "diskAvail" + "mc", + "mergesCurrent" ], - "description": "available disk space", - "name": "disk.avail", + "description": "number of current merges", + "name": "merges.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "dup", - "diskUsedPercent" - ], - "description": "used disk space percentage", - "name": "disk.used_percent", + "description": "number of current merges", + "name": "pri.merges.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "hc", - "heapCurrent" + "mcd", + "mergesCurrentDocs" ], - "description": "used heap", - "name": "heap.current", + "description": "number of current merging docs", + "name": "merges.current_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "hp", - "heapPercent" - ], - "description": "used heap ratio", - "name": "heap.percent", + "description": "number of current merging docs", + "name": "pri.merges.current_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "hm", - "heapMax" + "mcs", + "mergesCurrentSize" ], - "description": "max configured heap", - "name": "heap.max", + "description": "size of current merges", + "name": "merges.current_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "rc", - "ramCurrent" - ], - "description": "used machine memory", - "name": "ram.current", + "description": "size of current merges", + "name": "pri.merges.current_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "rp", - "ramPercent" + "mt", + "mergesTotal" ], - "description": "used machine memory ratio", - "name": "ram.percent", + "description": "number of completed merge ops", + "name": "merges.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "rn", - "ramMax" - ], - "description": "total machine memory", - "name": "ram.max", + "description": "number of completed merge ops", + "name": "pri.merges.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fdc", - "fileDescriptorCurrent" + "mtd", + "mergesTotalDocs" ], - "description": "used file descriptors", - "name": "file_desc.current", + "description": "docs merged", + "name": "merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "fdp", - "fileDescriptorPercent" - ], - "description": "used file descriptor ratio", - "name": "file_desc.percent", + "description": "docs merged", + "name": "pri.merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "fdm", - "fileDescriptorMax" + "mts", + "mergesTotalSize" ], - "description": "max file descriptors", - "name": "file_desc.max", + "description": "size merged", + "name": "merges.total_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "recent cpu usage", - "name": "cpu", + "description": "size merged", + "name": "pri.merges.total_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "1m load avg", - "name": "load_1m", + "aliases": [ + "mtt", + "mergesTotalTime" + ], + "description": "time spent in merges", + "name": "merges.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "5m load avg", - "name": "load_5m", + "description": "time spent in merges", + "name": "pri.merges.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "l" + "rto", + "refreshTotal" ], - "description": "15m load avg", - "name": "load_15m", + "description": "total refreshes", + "name": "refresh.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "u" - ], - "description": "node uptime", - "name": "uptime", + "description": "total refreshes", + "name": "pri.refresh.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "r", - "role", - "nodeRole" + "rti", + "refreshTime" ], - "description": "m:master eligible node, d:data node, i:ingest node, -:coordinating node only", - "name": "node.role", + "description": "time spent in refreshes", + "name": "refresh.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "m" - ], - "description": "*:current master", - "name": "master", + "description": "time spent in refreshes", + "name": "pri.refresh.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "n" + "reto" ], - "description": "node name", - "name": "name", + "description": "total external refreshes", + "name": "refresh.external_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "cs", - "completionSize" - ], - "description": "size of completion", - "name": "completion.size", + "description": "total external refreshes", + "name": "pri.refresh.external_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fm", - "fielddataMemory" + "reti" ], - "description": "used fielddata cache", - "name": "fielddata.memory_size", + "description": "time spent in external refreshes", + "name": "refresh.external_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "fe", - "fielddataEvictions" - ], - "description": "fielddata evictions", - "name": "fielddata.evictions", + "description": "time spent in external refreshes", + "name": "pri.refresh.external_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "qcm", - "queryCacheMemory" + "rli", + "refreshListeners" ], - "description": "used query cache", - "name": "query_cache.memory_size", + "description": "number of pending refresh listeners", + "name": "refresh.listeners", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "qce", - "queryCacheEvictions" - ], - "description": "query cache evictions", - "name": "query_cache.evictions", + "description": "number of pending refresh listeners", + "name": "pri.refresh.listeners", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "qchc", - "queryCacheHitCount" + "sfc", + "searchFetchCurrent" ], - "description": "query cache hit counts", - "name": "query_cache.hit_count", + "description": "current fetch phase ops", + "name": "search.fetch_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "qcmc", - "queryCacheMissCount" - ], - "description": "query cache miss counts", - "name": "query_cache.miss_count", + "description": "current fetch phase ops", + "name": "pri.search.fetch_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "rcm", - "requestCacheMemory" + "sfti", + "searchFetchTime" ], - "description": "used request cache", - "name": "request_cache.memory_size", + "description": "time spent in fetch phase", + "name": "search.fetch_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "rce", - "requestCacheEvictions" - ], - "description": "request cache evictions", - "name": "request_cache.evictions", + "description": "time spent in fetch phase", + "name": "pri.search.fetch_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "rchc", - "requestCacheHitCount" + "sfto", + "searchFetchTotal" ], - "description": "request cache hit counts", - "name": "request_cache.hit_count", + "description": "total fetch ops", + "name": "search.fetch_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "rcmc", - "requestCacheMissCount" - ], - "description": "request cache miss counts", - "name": "request_cache.miss_count", + "description": "total fetch ops", + "name": "pri.search.fetch_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ft", - "flushTotal" + "so", + "searchOpenContexts" ], - "description": "number of flushes", - "name": "flush.total", + "description": "open search contexts", + "name": "search.open_contexts", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "ftt", - "flushTotalTime" - ], - "description": "time spent in flush", - "name": "flush.total_time", + "description": "open search contexts", + "name": "pri.search.open_contexts", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gc", - "getCurrent" + "sqc", + "searchQueryCurrent" ], - "description": "number of current get ops", - "name": "get.current", + "description": "current query phase ops", + "name": "search.query_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "gti", - "getTime" - ], - "description": "time spent in get", - "name": "get.time", + "description": "current query phase ops", + "name": "pri.search.query_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gto", - "getTotal" + "sqti", + "searchQueryTime" ], - "description": "number of get ops", - "name": "get.total", + "description": "time spent in query phase", + "name": "search.query_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "geti", - "getExistsTime" - ], - "description": "time spent in successful gets", - "name": "get.exists_time", + "description": "time spent in query phase", + "name": "pri.search.query_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "geto", - "getExistsTotal" + "sqto", + "searchQueryTotal" ], - "description": "number of successful gets", - "name": "get.exists_total", + "description": "total query phase ops", + "name": "search.query_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "gmti", - "getMissingTime" - ], - "description": "time spent in failed gets", - "name": "get.missing_time", + "description": "total query phase ops", + "name": "pri.search.query_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gmto", - "getMissingTotal" + "scc", + "searchScrollCurrent" ], - "description": "number of failed gets", - "name": "get.missing_total", + "description": "open scroll contexts", + "name": "search.scroll_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "idc", - "indexingDeleteCurrent" - ], - "description": "number of current deletions", - "name": "indexing.delete_current", + "description": "open scroll contexts", + "name": "pri.search.scroll_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "idti", - "indexingDeleteTime" + "scti", + "searchScrollTime" ], - "description": "time spent in deletions", - "name": "indexing.delete_time", + "description": "time scroll contexts held open", + "name": "search.scroll_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "idto", - "indexingDeleteTotal" - ], - "description": "number of delete ops", - "name": "indexing.delete_total", + "description": "time scroll contexts held open", + "name": "pri.search.scroll_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "iic", - "indexingIndexCurrent" + "scto", + "searchScrollTotal" ], - "description": "number of current indexing ops", - "name": "indexing.index_current", + "description": "completed scroll contexts", + "name": "search.scroll_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "iiti", - "indexingIndexTime" - ], - "description": "time spent in indexing", - "name": "indexing.index_time", + "description": "completed scroll contexts", + "name": "pri.search.scroll_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "iito", - "indexingIndexTotal" + "sc", + "segmentsCount" ], - "description": "number of indexing ops", - "name": "indexing.index_total", + "description": "number of segments", + "name": "segments.count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "iif", - "indexingIndexFailed" - ], - "description": "number of failed indexing ops", - "name": "indexing.index_failed", + "description": "number of segments", + "name": "pri.segments.count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mc", - "mergesCurrent" + "sm", + "segmentsMemory" ], - "description": "number of current merges", - "name": "merges.current", + "description": "memory used by segments", + "name": "segments.memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "mcd", - "mergesCurrentDocs" - ], - "description": "number of current merging docs", - "name": "merges.current_docs", + "description": "memory used by segments", + "name": "pri.segments.memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "siwm", + "segmentsIndexWriterMemory" ], - "description": "size of current merges", - "name": "merges.current_size", + "description": "memory used by index writer", + "name": "segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "mt", - "mergesTotal" - ], - "description": "number of completed merge ops", - "name": "merges.total", + "description": "memory used by index writer", + "name": "pri.segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mtd", - "mergesTotalDocs" + "svmm", + "segmentsVersionMapMemory" ], - "description": "docs merged", - "name": "merges.total_docs", + "description": "memory used by version map", + "name": "segments.version_map_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "mts", - "mergesTotalSize" - ], - "description": "size merged", - "name": "merges.total_size", + "description": "memory used by version map", + "name": "pri.segments.version_map_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mtt", - "mergesTotalTime" + "sfbm", + "fixedBitsetMemory" ], - "description": "time spent in merges", - "name": "merges.total_time", + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "total refreshes", - "name": "refresh.total", + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "pri.segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "time spent in refreshes", - "name": "refresh.time", + "aliases": [ + "wc", + "warmerCurrent" + ], + "description": "current warmer ops", + "name": "warmer.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "rto", - "refreshTotal" - ], - "description": "total external refreshes", - "name": "refresh.external_total", + "description": "current warmer ops", + "name": "pri.warmer.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "rti", - "refreshTime" + "wto", + "warmerTotal" ], - "description": "time spent in external refreshes", - "name": "refresh.external_time", + "description": "total warmer ops", + "name": "warmer.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "rli", - "refreshListeners" - ], - "description": "number of pending refresh listeners", - "name": "refresh.listeners", + "description": "total warmer ops", + "name": "pri.warmer.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "scrcc", - "scriptCompilations" + "wtt", + "warmerTotalTime" ], - "description": "script compilations", - "name": "script.compilations", + "description": "time spent in warmers", + "name": "warmer.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "scrce", - "scriptCacheEvictions" - ], - "description": "script cache evictions", - "name": "script.cache_evictions", + "description": "time spent in warmers", + "name": "pri.warmer.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "scrclt", - "scriptCacheCompilationLimitTriggered" + "suc", + "suggestCurrent" ], - "description": "script cache compilation limit triggered", - "name": "script.compilation_limit_triggered", + "description": "number of current suggest ops", + "name": "suggest.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "sfc", - "searchFetchCurrent" - ], - "description": "current fetch phase ops", - "name": "search.fetch_current", + "description": "number of current suggest ops", + "name": "pri.suggest.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sfti", - "searchFetchTime" + "suti", + "suggestTime" ], - "description": "time spent in fetch phase", - "name": "search.fetch_time", + "description": "time spend in suggest", + "name": "suggest.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "sfto", - "searchFetchTotal" - ], - "description": "total fetch ops", - "name": "search.fetch_total", + "description": "time spend in suggest", + "name": "pri.suggest.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "so", - "searchOpenContexts" + "suto", + "suggestTotal" ], - "description": "open search contexts", - "name": "search.open_contexts", + "description": "number of suggest ops", + "name": "suggest.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "sqc", - "searchQueryCurrent" - ], - "description": "current query phase ops", - "name": "search.query_current", + "description": "number of suggest ops", + "name": "pri.suggest.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sqti", - "searchQueryTime" + "tm", + "memoryTotal" ], - "description": "time spent in query phase", - "name": "search.query_time", + "description": "total used memory", + "name": "memory.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "sqto", - "searchQueryTotal" - ], - "description": "total query phase ops", - "name": "search.query_total", + "description": "total user memory", + "name": "pri.memory.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "scc", - "searchScrollCurrent" + "sth" ], - "description": "open scroll contexts", - "name": "search.scroll_current", + "description": "indicates if the index is search throttled", + "name": "search.throttled", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "scti", - "searchScrollTime" + "bto", + "bulkTotalOperation" ], - "description": "time scroll contexts held open", - "name": "search.scroll_time", + "description": "number of bulk shard ops", + "name": "bulk.total_operations", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "scto", - "searchScrollTotal" - ], - "description": "completed scroll contexts", - "name": "search.scroll_total", + "description": "number of bulk shard ops", + "name": "pri.bulk.total_operations", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sc", - "segmentsCount" + "btti", + "bulkTotalTime" ], - "description": "number of segments", - "name": "segments.count", + "description": "time spend in shard bulk", + "name": "bulk.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "sm", - "segmentsMemory" - ], - "description": "memory used by segments", - "name": "segments.memory", + "description": "time spend in shard bulk", + "name": "pri.bulk.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "siwm", - "segmentsIndexWriterMemory" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "memory used by index writer", - "name": "segments.index_writer_memory", + "description": "total size in bytes of shard bulk", + "name": "bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "svmm", - "segmentsVersionMapMemory" - ], - "description": "memory used by version map", - "name": "segments.version_map_memory", + "description": "total size in bytes of shard bulk", + "name": "pri.bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sfbm", - "fixedBitsetMemory" + "bati", + "bulkAvgTime" ], - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "segments.fixed_bitset_memory", + "description": "average time spend in shard bulk", + "name": "bulk.avg_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "suc", - "suggestCurrent" - ], - "description": "number of current suggest ops", - "name": "suggest.current", + "description": "average time spend in shard bulk", + "name": "pri.bulk.avg_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "suti", - "suggestTime" + "basi", + "bulkAvgSizeInBytes" ], - "description": "time spend in suggest", - "name": "suggest.time", + "description": "average size in bytes of shard bulk", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "suto", - "suggestTotal" - ], - "description": "number of suggest ops", - "name": "suggest.total", + "description": "average size in bytes of shard bulk", + "name": "pri.bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/indices/types.ts#L20-L801" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ...", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.indices" + }, + "path": [ { - "aliases": [ - "bto", - "bulkTotalOperations" - ], - "description": "number of bulk shard ops", - "name": "bulk.total_operations", + "description": "A comma-separated list of index names to limit the returned information", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "btti", - "bulkTotalTime" - ], - "description": "time spend in shard bulk", - "name": "bulk.total_time", + "description": "The unit in which to display byte values", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "btsi", - "bulkTotalSizeInBytes" - ], - "description": "total size in bytes of shard bulk", - "name": "bulk.total_size_in_bytes", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "aliases": [ - "bati", - "bulkAvgTime" - ], - "description": "average time spend in shard bulk", - "name": "bulk.avg_time", + "description": "A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status", + "name": "health", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "HealthStatus", + "namespace": "_types" } } }, { - "aliases": [ - "basi", - "bulkAvgSizeInBytes" - ], - "description": "average size in bytes of shard bulk", - "name": "bulk.avg_size_in_bytes", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory", + "name": "include_unloaded_segments", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.nodes" - }, - "path": [], - "query": [ + }, { - "name": "bytes", + "description": "Set to true to return stats only for primary shards", + "name": "pri", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, - { - "name": "full_id", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } } - ] + ], + "specLocation": "cat/indices/CatIndicesRequest.ts#L23-L39" }, { "body": { @@ -65579,8 +73814,8 @@ "value": { "kind": "instance_of", "type": { - "name": "NodesRecord", - "namespace": "cat.nodes" + "name": "IndicesRecord", + "namespace": "cat.indices" } } } @@ -65588,77 +73823,73 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.nodes" - } + "namespace": "cat.indices" + }, + "specLocation": "cat/indices/CatIndicesResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "PendingTasksRecord", - "namespace": "cat.pending_tasks" + "name": "MasterRecord", + "namespace": "cat.master" }, "properties": [ { - "aliases": [ - "o" - ], - "description": "task insertion order", - "name": "insertOrder", + "description": "node id", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "t" + "h" ], - "description": "how long task has been in queue", - "name": "timeInQueue", + "description": "host name", + "name": "host", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "p" - ], - "description": "task priority", - "name": "priority", + "description": "ip address", + "name": "ip", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "s" + "n" ], - "description": "task source", - "name": "source", + "description": "node name", + "name": "node", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cat/master/types.ts#L20-L39" }, { "attachedBehaviors": [ @@ -65668,6 +73899,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about the master node.", "inherits": { "type": { "name": "CatRequestBase", @@ -65677,10 +73909,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.pending_tasks" + "namespace": "cat.master" }, "path": [], - "query": [] + "query": [], + "specLocation": "cat/master/CatMasterRequest.ts#L22-L27" }, { "body": { @@ -65690,8 +73923,8 @@ "value": { "kind": "instance_of", "type": { - "name": "PendingTasksRecord", - "namespace": "cat.pending_tasks" + "name": "MasterRecord", + "namespace": "cat.master" } } } @@ -65699,55 +73932,57 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.pending_tasks" - } + "namespace": "cat.master" + }, + "specLocation": "cat/master/CatMasterResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "PluginsRecord", - "namespace": "cat.plugins" + "name": "DataFrameAnalyticsRecord", + "namespace": "cat.ml_data_frame_analytics" }, "properties": [ { - "description": "unique node id", + "description": "the id", "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "Id", "namespace": "_types" } } }, { "aliases": [ - "n" + "t" ], - "description": "node name", - "name": "name", + "description": "analysis type", + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Type", "namespace": "_types" } } }, { "aliases": [ - "c" + "ct", + "createTime" ], - "description": "component", - "name": "component", + "description": "job creation time", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -65755,7 +73990,7 @@ "aliases": [ "v" ], - "description": "component version", + "description": "the version of Elasticsearch when the analytics was created", "name": "version", "required": false, "type": { @@ -65768,479 +74003,511 @@ }, { "aliases": [ - "d" + "si", + "sourceIndex" ], - "description": "plugin details", - "name": "description", + "description": "source index", + "name": "source_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { "aliases": [ - "t" + "di", + "destIndex" ], - "description": "plugin type", - "name": "type", + "description": "destination index", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Type", + "name": "IndexName", "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.plugins" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PluginsRecord", - "namespace": "cat.plugins" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.plugins" - } - }, - { - "kind": "interface", - "name": { - "name": "RecoveryRecord", - "namespace": "cat.recovery" - }, - "properties": [ + }, { "aliases": [ - "i", - "idx" + "d" ], - "description": "index name", - "name": "index", + "description": "description", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "s", - "sh" + "mml", + "modelMemoryLimit" ], - "description": "shard name", - "name": "shard", + "description": "model memory limit", + "name": "model_memory_limit", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "start" + "s" ], - "description": "recovery start time", - "name": "start_time", + "description": "job state", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "start_millis" + "fr", + "failureReason" ], - "description": "recovery start time in epoch milliseconds", - "name": "start_time_millis", + "description": "failure reason", + "name": "failure_reason", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "stop" + "p" ], - "description": "recovery stop time", - "name": "stop_time", + "description": "progress", + "name": "progress", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "stop_millis" + "ae", + "assignmentExplanation" ], - "description": "recovery stop time in epoch milliseconds", - "name": "stop_time_millis", + "description": "why the job is or is not assigned to a node", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "t", - "ti" + "ni", + "nodeId" ], - "description": "recovery time", - "name": "time", + "description": "id of the assigned node", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "ty" + "nn", + "nodeName" ], - "description": "recovery type", - "name": "type", + "description": "name of the assigned node", + "name": "node.name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Type", + "name": "Name", "namespace": "_types" } } }, { "aliases": [ - "st" + "ne", + "nodeEphemeralId" ], - "description": "recovery stage", - "name": "stage", + "description": "ephemeral id of the assigned node", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "shost" + "na", + "nodeAddress" ], - "description": "source host", - "name": "source_host", + "description": "network address of the assigned node", + "name": "node.address", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.ml_data_frame_analytics" + }, + "path": [ { - "aliases": [ - "snode" - ], - "description": "source node name", - "name": "source_node", + "description": "The ID of the data frame analytics to fetch", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", + "name": "allow_no_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "thost" - ], - "description": "target host", - "name": "target_host", + "description": "The unit in which to display byte values", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "tnode" - ], - "description": "target node name", - "name": "target_node", + "description": "Comma-separated list of column names to display.", + "name": "h", "required": false, + "serverDefault": "create_time,id,state,type", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatDfaColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "rep" - ], - "description": "repository", - "name": "repository", + "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatDfaColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "snap" - ], - "description": "snapshot", - "name": "snapshot", + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L56" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataFrameAnalyticsRecord", + "namespace": "cat.ml_data_frame_analytics" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.ml_data_frame_analytics" + }, + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "DatafeedsRecord", + "namespace": "cat.ml_datafeeds" + }, + "properties": [ + { + "description": "the datafeed_id", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "f" + "s" ], - "description": "number of files to recover", - "name": "files", + "description": "the datafeed state", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DatafeedState", + "namespace": "ml._types" } } }, { "aliases": [ - "fr" + "ae" ], - "description": "files recovered", - "name": "files_recovered", + "description": "why the datafeed is or is not assigned to a node", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fp" + "bc", + "bucketsCount" ], - "description": "percent of files recovered", - "name": "files_percent", + "description": "bucket count", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "tf" + "sc", + "searchCount" ], - "description": "total number of files", - "name": "files_total", + "description": "number of searches ran by the datafeed", + "name": "search.count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "b" + "st", + "searchTime" ], - "description": "number of bytes to recover", - "name": "bytes", + "description": "the total search time", + "name": "search.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "br" + "sba", + "searchBucketAvg" ], - "description": "bytes recovered", - "name": "bytes_recovered", + "description": "the average search time per bucket (millisecond)", + "name": "search.bucket_avg", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "bp" + "seah", + "searchExpAvgHour" ], - "description": "percent of bytes recovered", - "name": "bytes_percent", + "description": "the exponential average search time per hour (millisecond)", + "name": "search.exp_avg_hour", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "tb" + "ni", + "nodeId" ], - "description": "total number of bytes", - "name": "bytes_total", + "description": "id of the assigned node", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "to" + "nn", + "nodeName" ], - "description": "number of translog ops to recover", - "name": "translog_ops", + "description": "name of the assigned node", + "name": "node.name", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "tor" + "ne", + "nodeEphemeralId" ], - "description": "translog ops recovered", - "name": "translog_ops_recovered", + "description": "ephemeral id of the assigned node", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "top" + "na", + "nodeAddress" ], - "description": "percent of translog ops recovered", - "name": "translog_ops_percent", + "description": "network address of the assigned node", + "name": "node.address", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cat/ml_datafeeds/types.ts#L22-L83" }, { "attachedBehaviors": [ @@ -66250,6 +74517,7 @@ "body": { "kind": "no_body" }, + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -66259,16 +74527,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.recovery" + "namespace": "cat.ml_datafeeds" }, "path": [ { - "name": "index", + "description": "A numerical character string that uniquely identifies the datafeed.", + "name": "datafeed_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Id", "namespace": "_types" } } @@ -66276,186 +74545,111 @@ ], "query": [ { - "name": "active_only", + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", + "name": "allow_no_datafeeds", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "bytes", + "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "detailed", + "description": "Short version of the HTTP accept header. Valid values include JSON, YAML, for example.", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RecoveryRecord", - "namespace": "cat.recovery" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.recovery" - } - }, - { - "kind": "interface", - "name": { - "name": "RepositoriesRecord", - "namespace": "cat.repositories" - }, - "properties": [ + }, { - "aliases": [ - "repoId" - ], - "description": "unique repository id", - "name": "id", + "description": "Comma-separated list of column names to display.", + "name": "h", "required": false, + "serverDefault": "bc,id,sc,s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatDatafeedColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "t" - ], - "description": "repository type", - "name": "type", + "description": "If `true`, the response includes help information.", + "name": "help", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.repositories" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + }, + { + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "name": "s", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "RepositoriesRecord", - "namespace": "cat.repositories" + "name": "CatDatafeedColumns", + "namespace": "cat._types" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.repositories" - } - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.segments" - }, - "path": [ + }, { - "name": "index", + "description": "The unit used to display time values.", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "TimeUnit", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "bytes", + "description": "If `true`, the response includes column headings.", + "name": "v", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L86" }, { "body": { @@ -66465,8 +74659,8 @@ "value": { "kind": "instance_of", "type": { - "name": "SegmentsRecord", - "namespace": "cat.segments" + "name": "DatafeedsRecord", + "namespace": "cat.ml_datafeeds" } } } @@ -66474,1786 +74668,1663 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.segments" - } + "namespace": "cat.ml_datafeeds" + }, + "specLocation": "cat/ml_datafeeds/CatDatafeedsResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "SegmentsRecord", - "namespace": "cat.segments" + "name": "JobsRecord", + "namespace": "cat.ml_jobs" }, "properties": [ { - "aliases": [ - "i", - "idx" - ], - "description": "index name", - "name": "index", + "description": "the job_id", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Id", "namespace": "_types" } } }, { "aliases": [ - "s", - "sh" + "s" ], - "description": "shard name", - "name": "shard", + "description": "the job state", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "JobState", + "namespace": "ml._types" } } }, { "aliases": [ - "p", - "pr", - "primaryOrReplica" + "ot" ], - "description": "primary or replica", - "name": "prirep", + "description": "the amount of time the job has been opened", + "name": "opened_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "ip of node where it lives", - "name": "ip", + "aliases": [ + "ae" + ], + "description": "why the job is or is not assigned to a node", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "unique id of node where it lives", - "name": "id", + "aliases": [ + "dpr", + "dataProcessedRecords" + ], + "description": "number of processed records", + "name": "data.processed_records", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "seg" + "dpf", + "dataProcessedFields" ], - "description": "segment name", - "name": "segment", + "description": "number of processed fields", + "name": "data.processed_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "g", - "gen" + "dib", + "dataInputBytes" ], - "description": "segment generation", - "name": "generation", + "description": "total input bytes", + "name": "data.input_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "dc", - "docsCount" + "dir", + "dataInputRecords" ], - "description": "number of docs in segment", - "name": "docs.count", + "description": "total record count", + "name": "data.input_records", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dd", - "docsDeleted" + "dif", + "dataInputFields" ], - "description": "number of deleted docs in segment", - "name": "docs.deleted", + "description": "total field count", + "name": "data.input_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "si" + "did", + "dataInvalidDates" ], - "description": "segment size in bytes", - "name": "size", + "description": "number of records with invalid dates", + "name": "data.invalid_dates", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "sm", - "sizeMemory" + "dmf", + "dataMissingFields" ], - "description": "segment memory in bytes", - "name": "size.memory", + "description": "number of records with missing fields", + "name": "data.missing_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ic", - "isCommitted" + "doot", + "dataOutOfOrderTimestamps" ], - "description": "is segment committed", - "name": "committed", + "description": "number of records handled out of order", + "name": "data.out_of_order_timestamps", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "is", - "isSearchable" + "deb", + "dataEmptyBuckets" ], - "description": "is segment searched", - "name": "searchable", + "description": "number of empty buckets", + "name": "data.empty_buckets", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "v" + "dsb", + "dataSparseBuckets" ], - "description": "version", - "name": "version", + "description": "number of sparse buckets", + "name": "data.sparse_buckets", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ico", - "isCompound" + "db", + "dataBuckets" ], - "description": "is segment compound", - "name": "compound", + "description": "total bucket count", + "name": "data.buckets", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.shards" - }, - "path": [ + }, { - "name": "index", + "aliases": [ + "der", + "dataEarliestRecord" + ], + "description": "earliest record time", + "name": "data.earliest_record", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "bytes", + "aliases": [ + "dlr", + "dataLatestRecord" + ], + "description": "latest record time", + "name": "data.latest_record", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" - } - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardsRecord", - "namespace": "cat.shards" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.shards" - } - }, - { - "kind": "interface", - "name": { - "name": "ShardsRecord", - "namespace": "cat.shards" - }, - "properties": [ + }, { "aliases": [ - "i", - "idx" + "dl", + "dataLast" ], - "description": "index name", - "name": "index", + "description": "last time data was seen", + "name": "data.last", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "s", - "sh" + "dleb", + "dataLastEmptyBucket" ], - "description": "shard name", - "name": "shard", + "description": "last time an empty bucket occurred", + "name": "data.last_empty_bucket", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "p", - "pr", - "primaryOrReplica" + "dlsb", + "dataLastSparseBucket" ], - "description": "primary or replica", - "name": "prirep", + "description": "last time a sparse bucket occurred", + "name": "data.last_sparse_bucket", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "st" + "mb", + "modelBytes" ], - "description": "shard state", - "name": "state", + "description": "model size", + "name": "model.bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "d", - "dc" + "mms", + "modelMemoryStatus" ], - "description": "number of docs in shard", - "name": "docs", + "description": "current memory status", + "name": "model.memory_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "MemoryStatus", + "namespace": "ml._types" } } }, { "aliases": [ - "sto" + "mbe", + "modelBytesExceeded" ], - "description": "store size of shard (how much disk it uses)", - "name": "store", + "description": "how much the model has exceeded the limit", + "name": "model.bytes_exceeded", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "ip of node where it lives", - "name": "ip", + "aliases": [ + "mml", + "modelMemoryLimit" + ], + "description": "model memory limit", + "name": "model.memory_limit", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "unique id of node where it lives", - "name": "id", - "required": false, + "aliases": [ + "mbf", + "modelByFields" + ], + "description": "count of 'by' fields", + "name": "model.by_fields", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "n" + "mof", + "modelOverFields" ], - "description": "name of node where it lives", - "name": "node", + "description": "count of 'over' fields", + "name": "model.over_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "sync id", - "name": "sync_id", + "aliases": [ + "mpf", + "modelPartitionFields" + ], + "description": "count of 'partition' fields", + "name": "model.partition_fields", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ur" + "mbaf", + "modelBucketAllocationFailures" ], - "description": "reason shard is unassigned", - "name": "unassigned.reason", + "description": "number of bucket allocation failures", + "name": "model.bucket_allocation_failures", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ua" + "mcs", + "modelCategorizationStatus" ], - "description": "time shard became unassigned (UTC)", - "name": "unassigned.at", + "description": "current categorization status", + "name": "model.categorization_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CategorizationStatus", + "namespace": "ml._types" } } }, { "aliases": [ - "uf" + "mcdc", + "modelCategorizedDocCount" ], - "description": "time has been unassigned", - "name": "unassigned.for", + "description": "count of categorized documents", + "name": "model.categorized_doc_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ud" + "mtcc", + "modelTotalCategoryCount" ], - "description": "additional details as to why the shard became unassigned", - "name": "unassigned.details", + "description": "count of categories", + "name": "model.total_category_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "rs" + "modelFrequentCategoryCount" ], - "description": "recovery source type", - "name": "recoverysource.type", + "description": "count of frequent categories", + "name": "model.frequent_category_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "cs", - "completionSize" + "mrcc", + "modelRareCategoryCount" ], - "description": "size of completion", - "name": "completion.size", + "description": "count of rare categories", + "name": "model.rare_category_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fm", - "fielddataMemory" + "mdcc", + "modelDeadCategoryCount" ], - "description": "used fielddata cache", - "name": "fielddata.memory_size", + "description": "count of dead categories", + "name": "model.dead_category_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "fe", - "fielddataEvictions" + "mfcc", + "modelFailedCategoryCount" ], - "description": "fielddata evictions", - "name": "fielddata.evictions", + "description": "count of failed categories", + "name": "model.failed_category_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "qcm", - "queryCacheMemory" + "mlt", + "modelLogTime" ], - "description": "used query cache", - "name": "query_cache.memory_size", + "description": "when the model stats were gathered", + "name": "model.log_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "qce", - "queryCacheEvictions" + "mt", + "modelTimestamp" ], - "description": "query cache evictions", - "name": "query_cache.evictions", + "description": "the time of the last record when the model stats were gathered", + "name": "model.timestamp", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ "ft", - "flushTotal" + "forecastsTotal" ], - "description": "number of flushes", - "name": "flush.total", + "description": "total number of forecasts", + "name": "forecasts.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ftt", - "flushTotalTime" + "fmmin", + "forecastsMemoryMin" ], - "description": "time spent in flush", - "name": "flush.total_time", + "description": "minimum memory used by forecasts", + "name": "forecasts.memory.min", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gc", - "getCurrent" + "fmmax", + "forecastsMemoryMax" ], - "description": "number of current get ops", - "name": "get.current", + "description": "maximum memory used by forecasts", + "name": "forecasts.memory.max", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gti", - "getTime" + "fmavg", + "forecastsMemoryAvg" ], - "description": "time spent in get", - "name": "get.time", + "description": "average memory used by forecasts", + "name": "forecasts.memory.avg", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gto", - "getTotal" + "fmt", + "forecastsMemoryTotal" ], - "description": "number of get ops", - "name": "get.total", + "description": "total memory used by all forecasts", + "name": "forecasts.memory.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "geti", - "getExistsTime" + "frmin", + "forecastsRecordsMin" ], - "description": "time spent in successful gets", - "name": "get.exists_time", + "description": "minimum record count for forecasts", + "name": "forecasts.records.min", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "geto", - "getExistsTotal" + "frmax", + "forecastsRecordsMax" ], - "description": "number of successful gets", - "name": "get.exists_total", + "description": "maximum record count for forecasts", + "name": "forecasts.records.max", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gmti", - "getMissingTime" + "fravg", + "forecastsRecordsAvg" ], - "description": "time spent in failed gets", - "name": "get.missing_time", + "description": "average record count for forecasts", + "name": "forecasts.records.avg", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "gmto", - "getMissingTotal" + "frt", + "forecastsRecordsTotal" ], - "description": "number of failed gets", - "name": "get.missing_total", + "description": "total record count for all forecasts", + "name": "forecasts.records.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "idc", - "indexingDeleteCurrent" + "ftmin", + "forecastsTimeMin" ], - "description": "number of current deletions", - "name": "indexing.delete_current", + "description": "minimum runtime for forecasts", + "name": "forecasts.time.min", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "idti", - "indexingDeleteTime" + "ftmax", + "forecastsTimeMax" ], - "description": "time spent in deletions", - "name": "indexing.delete_time", + "description": "maximum run time for forecasts", + "name": "forecasts.time.max", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "idto", - "indexingDeleteTotal" + "ftavg", + "forecastsTimeAvg" ], - "description": "number of delete ops", - "name": "indexing.delete_total", + "description": "average runtime for all forecasts (milliseconds)", + "name": "forecasts.time.avg", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "iic", - "indexingIndexCurrent" + "ftt", + "forecastsTimeTotal" ], - "description": "number of current indexing ops", - "name": "indexing.index_current", + "description": "total runtime for all forecasts", + "name": "forecasts.time.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "iiti", - "indexingIndexTime" + "ni", + "nodeId" ], - "description": "time spent in indexing", - "name": "indexing.index_time", + "description": "id of the assigned node", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "iito", - "indexingIndexTotal" + "nn", + "nodeName" ], - "description": "number of indexing ops", - "name": "indexing.index_total", + "description": "name of the assigned node", + "name": "node.name", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "iif", - "indexingIndexFailed" + "ne", + "nodeEphemeralId" ], - "description": "number of failed indexing ops", - "name": "indexing.index_failed", + "description": "ephemeral id of the assigned node", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "mc", - "mergesCurrent" + "na", + "nodeAddress" ], - "description": "number of current merges", - "name": "merges.current", + "description": "network address of the assigned node", + "name": "node.address", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mcd", - "mergesCurrentDocs" + "bc", + "bucketsCount" ], - "description": "number of current merging docs", - "name": "merges.current_docs", + "description": "bucket count", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "btt", + "bucketsTimeTotal" ], - "description": "size of current merges", - "name": "merges.current_size", + "description": "total bucket processing time", + "name": "buckets.time.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mt", - "mergesTotal" + "btmin", + "bucketsTimeMin" ], - "description": "number of completed merge ops", - "name": "merges.total", + "description": "minimum bucket processing time", + "name": "buckets.time.min", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mtd", - "mergesTotalDocs" + "btmax", + "bucketsTimeMax" ], - "description": "docs merged", - "name": "merges.total_docs", + "description": "maximum bucket processing time", + "name": "buckets.time.max", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mts", - "mergesTotalSize" + "btea", + "bucketsTimeExpAvg" ], - "description": "size merged", - "name": "merges.total_size", + "description": "exponential average bucket processing time (milliseconds)", + "name": "buckets.time.exp_avg", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mtt", - "mergesTotalTime" + "bteah", + "bucketsTimeExpAvgHour" ], - "description": "time spent in merges", - "name": "merges.total_time", + "description": "exponential average bucket processing time by hour (milliseconds)", + "name": "buckets.time.exp_avg_hour", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_jobs/types.ts#L24-L325" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.ml_jobs" + }, + "path": [ { - "description": "total refreshes", - "name": "refresh.total", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "time spent in refreshes", - "name": "refresh.time", + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", + "name": "allow_no_jobs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "rto", - "refreshTotal" - ], - "description": "total external refreshes", - "name": "refresh.external_total", + "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "rti", - "refreshTime" - ], - "description": "time spent in external refreshes", - "name": "refresh.external_time", + "description": "The unit used to display byte values.", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "rli", - "refreshListeners" - ], - "description": "number of pending refresh listeners", - "name": "refresh.listeners", + "description": "Short version of the HTTP accept header. Valid values include JSON, YAML, for example.", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "sfc", - "searchFetchCurrent" - ], - "description": "current fetch phase ops", - "name": "search.fetch_current", + "description": "Comma-separated list of column names to display.", + "name": "h", "required": false, + "serverDefault": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "sfti", - "searchFetchTime" - ], - "description": "time spent in fetch phase", - "name": "search.fetch_time", + "description": "If true, the response includes help information.", + "name": "help", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "sfto", - "searchFetchTotal" - ], - "description": "total fetch ops", - "name": "search.fetch_total", + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "so", - "searchOpenContexts" - ], - "description": "open search contexts", - "name": "search.open_contexts", + "description": "The unit used to display time values.", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TimeUnit", + "namespace": "_types" } } }, { - "aliases": [ - "sqc", - "searchQueryCurrent" - ], - "description": "current query phase ops", - "name": "search.query_current", + "description": "If `true`, the response includes column headings.", + "name": "v", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - }, - { - "aliases": [ - "sqti", - "searchQueryTime" - ], - "description": "time spent in query phase", - "name": "search.query_time", - "required": false, - "type": { + } + ], + "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L93" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "JobsRecord", + "namespace": "cat.ml_jobs" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.ml_jobs" + }, + "specLocation": "cat/ml_jobs/CatJobsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information about inference trained models.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.ml_trained_models" + }, + "path": [ { - "aliases": [ - "sqto", - "searchQueryTotal" - ], - "description": "total query phase ops", - "name": "search.query_total", + "description": "The ID of the trained models stats to fetch", + "name": "model_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "scc", - "searchScrollCurrent" - ], - "description": "open scroll contexts", - "name": "search.scroll_current", + "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", + "name": "allow_no_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "scti", - "searchScrollTime" - ], - "description": "time scroll contexts held open", - "name": "search.scroll_time", + "description": "The unit in which to display byte values", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "scto", - "searchScrollTotal" - ], - "description": "completed scroll contexts", - "name": "search.scroll_total", + "description": "Comma-separated list of column names to display", + "name": "h", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "sc", - "segmentsCount" - ], - "description": "number of segments", - "name": "segments.count", + "description": "Comma-separated list of column names or column aliases to sort by", + "name": "s", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" } } }, { - "aliases": [ - "sm", - "segmentsMemory" - ], - "description": "memory used by segments", - "name": "segments.memory", + "description": "skips a number of trained models", + "name": "from", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "siwm", - "segmentsIndexWriterMemory" - ], - "description": "memory used by index writer", - "name": "segments.index_writer_memory", + "description": "specifies a max number of trained models to get", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, - { - "aliases": [ - "svmm", - "segmentsVersionMapMemory" - ], - "description": "memory used by version map", - "name": "segments.version_map_memory", - "required": false, - "type": { + } + ], + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L47" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TrainedModelsRecord", + "namespace": "cat.ml_trained_models" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.ml_trained_models" + }, + "specLocation": "cat/ml_trained_models/CatTrainedModelsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelsRecord", + "namespace": "cat.ml_trained_models" + }, + "properties": [ { - "aliases": [ - "sfbm", - "fixedBitsetMemory" - ], - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "segments.fixed_bitset_memory", + "description": "the trained model id", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "sqm", - "maxSeqNo" + "c", + "createdBy" ], - "description": "max sequence number", - "name": "seq_no.max", + "description": "who created the model", + "name": "created_by", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sql", - "localCheckpoint" + "hs", + "modelHeapSize" ], - "description": "local checkpoint", - "name": "seq_no.local_checkpoint", + "description": "the estimated heap size to keep the model in memory", + "name": "heap_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "sqg", - "globalCheckpoint" + "o", + "modelOperations" ], - "description": "global checkpoint", - "name": "seq_no.global_checkpoint", + "description": "the estimated number of operations to use the model", + "name": "operations", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "wc", - "warmerCurrent" + "l" ], - "description": "current warmer ops", - "name": "warmer.current", + "description": "The license level of the model", + "name": "license", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "wto", - "warmerTotal" + "ct" ], - "description": "total warmer ops", - "name": "warmer.total", + "description": "The time the model was created", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DateString", + "namespace": "_types" } } }, { "aliases": [ - "wtt", - "warmerTotalTime" + "v" ], - "description": "time spent in warmers", - "name": "warmer.total_time", + "description": "The version of Elasticsearch when the model was created", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "pd", - "dataPath" + "d" ], - "description": "shard data path", - "name": "path.data", + "description": "The model description", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ps", - "statsPath" + "ip", + "ingestPipelines" ], - "description": "shard state path", - "name": "path.state", + "description": "The number of pipelines referencing the model", + "name": "ingest.pipelines", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "bto", - "bulkTotalOperations" + "ic", + "ingestCount" ], - "description": "number of bulk shard ops", - "name": "bulk.total_operations", + "description": "The total number of docs processed by the model", + "name": "ingest.count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "btti", - "bulkTotalTime" + "it", + "ingestTime" ], - "description": "time spend in shard bulk", - "name": "bulk.total_time", + "description": "The total time spent processing docs with this model", + "name": "ingest.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "btsi", - "bulkTotalSizeInBytes" + "icurr", + "ingestCurrent" ], - "description": "total size in bytes of shard bulk", - "name": "bulk.total_size_in_bytes", + "description": "The total documents currently being handled by the model", + "name": "ingest.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "bati", - "bulkAvgTime" + "if", + "ingestFailed" ], - "description": "average time spend in shard bulk", - "name": "bulk.avg_time", + "description": "The total count of failed ingest attempts with this model", + "name": "ingest.failed", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "basi", - "bulkAvgSizeInBytes" - ], - "description": "avg size in bytes of shard bulk", - "name": "bulk.avg_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.snapshots" - }, - "path": [ - { - "name": "repository", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SnapshotsRecord", - "namespace": "cat.snapshots" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.snapshots" - } - }, - { - "kind": "interface", - "name": { - "name": "SnapshotsRecord", - "namespace": "cat.snapshots" - }, - "properties": [ - { - "aliases": [ - "snapshot" + "dfid", + "dataFrameAnalytics" ], - "description": "unique snapshot", - "name": "id", + "description": "The data frame analytics config id that created the model (if still available)", + "name": "data_frame.id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "re", - "repo" + "dft", + "dataFrameAnalyticsTime" ], - "description": "repository name", - "name": "repository", + "description": "The time the data frame analytics config was created", + "name": "data_frame.create_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "s" + "dfsi", + "dataFrameAnalyticsSrcIndex" ], - "description": "snapshot name", - "name": "status", + "description": "The source index used to train in the data frame analysis", + "name": "data_frame.source_index", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "aliases": [ - "ste", - "startEpoch" - ], - "description": "start time in seconds since 1970-01-01 00:00:00", - "name": "start_epoch", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "EpochMillis", - "namespace": "_types" + "namespace": "_builtins" } } }, { "aliases": [ - "sti", - "startTime" + "dfa", + "dataFrameAnalyticsAnalysis" ], - "description": "start time in HH:MM:SS", - "name": "start_time", + "description": "The analysis used by the data frame to build the model", + "name": "data_frame.analysis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_trained_models/types.ts#L23-L109" + }, + { + "kind": "interface", + "name": { + "name": "NodeAttributesRecord", + "namespace": "cat.nodeattrs" + }, + "properties": [ { - "aliases": [ - "ete", - "endEpoch" - ], - "description": "end time in seconds since 1970-01-01 00:00:00", - "name": "end_epoch", + "description": "node name", + "name": "node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "eti", - "endTime" - ], - "description": "end time in HH:MM:SS", - "name": "end_time", + "description": "unique node id", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "dur" - ], - "description": "duration", - "name": "duration", + "description": "process id", + "name": "pid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "i" + "h" ], - "description": "number of indices", - "name": "indices", + "description": "host name", + "name": "host", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ss" + "i" ], - "description": "number of successful shards", - "name": "successful_shards", + "description": "ip address", + "name": "ip", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "fs" - ], - "description": "number of failed shards", - "name": "failed_shards", + "description": "bound transport port", + "name": "port", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "ts" - ], - "description": "number of total shards", - "name": "total_shards", + "description": "attribute description", + "name": "attr", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "r" - ], - "description": "reason for failures", - "name": "reason", + "description": "attribute value", + "name": "value", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cat/nodeattrs/types.ts#L20-L55" }, { "attachedBehaviors": [ @@ -68263,6 +76334,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about custom node attributes.", "inherits": { "type": { "name": "CatRequestBase", @@ -68272,61 +76344,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cat.tasks" + "namespace": "cat.nodeattrs" }, "path": [], - "query": [ - { - "name": "actions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "detailed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "node_id", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "parent_task", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ] + "query": [], + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L27" }, { "body": { @@ -68336,8 +76358,8 @@ "value": { "kind": "instance_of", "type": { - "name": "TasksRecord", - "namespace": "cat.tasks" + "name": "NodeAttributesRecord", + "namespace": "cat.nodeattrs" } } } @@ -68345,18 +76367,22 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cat.tasks" - } + "namespace": "cat.nodeattrs" + }, + "specLocation": "cat/nodeattrs/CatNodeAttributesResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "TasksRecord", - "namespace": "cat.tasks" + "name": "NodesRecord", + "namespace": "cat.nodes" }, "properties": [ { - "description": "id of the task with the node", + "aliases": [ + "nodeId" + ], + "description": "unique node id", "name": "id", "required": false, "type": { @@ -68369,556 +76395,444 @@ }, { "aliases": [ - "ac" + "p" ], - "description": "task action", - "name": "action", + "description": "process id", + "name": "pid", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ti" + "i" ], - "description": "unique task id", - "name": "task_id", + "description": "ip address", + "name": "ip", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "pti" + "po" ], - "description": "parent task id", - "name": "parent_task_id", + "description": "bound transport port", + "name": "port", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ty" + "http" ], - "description": "task type", - "name": "type", + "description": "bound http address", + "name": "http_address", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Type", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "start" + "v" ], - "description": "start time in ms", - "name": "start_time", + "description": "es version", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "ts", - "hms", - "hhmmss" + "f" ], - "description": "start time in HH:MM:SS", - "name": "timestamp", + "description": "es distribution flavor", + "name": "flavor", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "running time ns", - "name": "running_time_ns", + "aliases": [ + "t" + ], + "description": "es distribution type", + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Type", + "namespace": "_types" } } }, { "aliases": [ - "time" + "b" ], - "description": "running time", - "name": "running_time", + "description": "es build hash", + "name": "build", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ni" + "j" ], - "description": "unique node id", - "name": "node_id", + "description": "jdk version", + "name": "jdk", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "i" + "dt", + "diskTotal" ], - "description": "ip address", - "name": "ip", + "description": "total disk space", + "name": "disk.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "po" + "du", + "diskUsed" ], - "description": "bound transport port", - "name": "port", + "description": "used disk space", + "name": "disk.used", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "n" + "d", + "da", + "disk", + "diskAvail" ], - "description": "node name", - "name": "node", + "description": "available disk space", + "name": "disk.avail", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "v" + "dup", + "diskUsedPercent" ], - "description": "es version", - "name": "version", + "description": "used disk space percentage", + "name": "disk.used_percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "Percentage", "namespace": "_types" } } }, { "aliases": [ - "x" + "hc", + "heapCurrent" ], - "description": "X-Opaque-ID header", - "name": "x_opaque_id", + "description": "used heap", + "name": "heap.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "desc" + "hp", + "heapPercent" ], - "description": "task action", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.templates" - }, - "path": [ - { - "name": "name", + "description": "used heap ratio", + "name": "heap.percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Percentage", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TemplatesRecord", - "namespace": "cat.templates" - } - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.templates" - } - }, - { - "kind": "interface", - "name": { - "name": "TemplatesRecord", - "namespace": "cat.templates" - }, - "properties": [ + }, { "aliases": [ - "n" + "hm", + "heapMax" ], - "description": "template name", - "name": "name", + "description": "max configured heap", + "name": "heap.max", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "t" + "rc", + "ramCurrent" ], - "description": "template index patterns", - "name": "index_patterns", + "description": "used machine memory", + "name": "ram.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "o", - "p" + "rp", + "ramPercent" ], - "description": "template application order/priority number", - "name": "order", + "description": "used machine memory ratio", + "name": "ram.percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Percentage", + "namespace": "_types" } } }, { "aliases": [ - "v" + "rn", + "ramMax" ], - "description": "version", - "name": "version", + "description": "total machine memory", + "name": "ram.max", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "c" + "fdc", + "fileDescriptorCurrent" ], - "description": "component templates comprising index template", - "name": "composed_of", + "description": "used file descriptors", + "name": "file_desc.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.thread_pool" - }, - "path": [ + }, { - "name": "thread_pool_patterns", + "aliases": [ + "fdp", + "fileDescriptorPercent" + ], + "description": "used file descriptor ratio", + "name": "file_desc.percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "Percentage", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "size", + "aliases": [ + "fdm", + "fileDescriptorMax" + ], + "description": "max file descriptors", + "name": "file_desc.max", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Size", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { "kind": "instance_of", "type": { - "name": "ThreadPoolRecord", - "namespace": "cat.thread_pool" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.thread_pool" - } - }, - { - "kind": "interface", - "name": { - "name": "ThreadPoolRecord", - "namespace": "cat.thread_pool" - }, - "properties": [ + }, { - "aliases": [ - "nn" - ], - "description": "node name", - "name": "node_name", + "description": "recent cpu usage", + "name": "cpu", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "id" - ], - "description": "persistent node id", - "name": "node_id", + "description": "1m load avg", + "name": "load_1m", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "eid" - ], - "description": "ephemeral node id", - "name": "ephemeral_node_id", + "description": "5m load avg", + "name": "load_5m", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "p" + "l" ], - "description": "process id", - "name": "pid", + "description": "15m load avg", + "name": "load_15m", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "h" + "u" ], - "description": "host name", - "name": "host", + "description": "node uptime", + "name": "uptime", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "i" + "r", + "role", + "nodeRole" ], - "description": "ip address", - "name": "ip", + "description": "m:master eligible node, d:data node, i:ingest node, -:coordinating node only", + "name": "node.role", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "po" + "m" ], - "description": "bound transport port", - "name": "port", + "description": "*:current master", + "name": "master", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -68926,1734 +76840,1823 @@ "aliases": [ "n" ], - "description": "thread pool name", + "description": "node name", "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } }, { "aliases": [ - "t" + "cs", + "completionSize" ], - "description": "thread pool type", - "name": "type", + "description": "size of completion", + "name": "completion.size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "a" + "fm", + "fielddataMemory" ], - "description": "number of active threads", - "name": "active", + "description": "used fielddata cache", + "name": "fielddata.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "psz" + "fe", + "fielddataEvictions" ], - "description": "number of threads", - "name": "pool_size", + "description": "fielddata evictions", + "name": "fielddata.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "q" + "qcm", + "queryCacheMemory" ], - "description": "number of tasks currently in queue", - "name": "queue", + "description": "used query cache", + "name": "query_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "qs" + "qce", + "queryCacheEvictions" ], - "description": "maximum number of tasks permitted in queue", - "name": "queue_size", + "description": "query cache evictions", + "name": "query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "r" + "qchc", + "queryCacheHitCount" ], - "description": "number of rejected tasks", - "name": "rejected", + "description": "query cache hit counts", + "name": "query_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "l" + "qcmc", + "queryCacheMissCount" ], - "description": "highest number of seen active threads", - "name": "largest", + "description": "query cache miss counts", + "name": "query_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "c" + "rcm", + "requestCacheMemory" ], - "description": "number of completed tasks", - "name": "completed", + "description": "used request cache", + "name": "request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "cr" + "rce", + "requestCacheEvictions" ], - "description": "core number of threads in a scaling thread pool", - "name": "core", + "description": "request cache evictions", + "name": "request_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mx" + "rchc", + "requestCacheHitCount" ], - "description": "maximum number of threads in a scaling thread pool", - "name": "max", + "description": "request cache hit counts", + "name": "request_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sz" + "rcmc", + "requestCacheMissCount" ], - "description": "number of threads in a fixed thread pool", - "name": "size", + "description": "request cache miss counts", + "name": "request_cache.miss_count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ka" + "ft", + "flushTotal" ], - "description": "thread keep alive time", - "name": "keep_alive", + "description": "number of flushes", + "name": "flush.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.trained_models" - }, - "path": [ + }, { - "name": "model_id", + "aliases": [ + "ftt", + "flushTotalTime" + ], + "description": "time spent in flush", + "name": "flush.total_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "allow_no_match", + "aliases": [ + "gc", + "getCurrent" + ], + "description": "number of current get ops", + "name": "get.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "bytes", + "aliases": [ + "gti", + "getTime" + ], + "description": "time spent in get", + "name": "get.time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Bytes", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "from", + "aliases": [ + "gto", + "getTotal" + ], + "description": "number of get ops", + "name": "get.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "size", + "aliases": [ + "geti", + "getExistsTime" + ], + "description": "time spent in successful gets", + "name": "get.exists_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TrainedModelsRecord", - "namespace": "cat.trained_models" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.trained_models" - } - }, - { - "kind": "interface", - "name": { - "name": "TrainedModelsRecord", - "namespace": "cat.trained_models" - }, - "properties": [ + }, { - "description": "the trained model id", - "name": "id", + "aliases": [ + "geto", + "getExistsTotal" + ], + "description": "number of successful gets", + "name": "get.exists_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "c", - "createdBy" + "gmti", + "getMissingTime" ], - "description": "who created the model", - "name": "created_by", + "description": "time spent in failed gets", + "name": "get.missing_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "hs", - "modelHeapSize" + "gmto", + "getMissingTotal" ], - "description": "the estimated heap size to keep the model in memory", - "name": "heap_size", + "description": "number of failed gets", + "name": "get.missing_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "o", - "modelOperations" + "idc", + "indexingDeleteCurrent" ], - "description": "the estimated number of operations to use the model", - "name": "operations", + "description": "number of current deletions", + "name": "indexing.delete_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "l" + "idti", + "indexingDeleteTime" ], - "description": "The license level of the model", - "name": "license", + "description": "time spent in deletions", + "name": "indexing.delete_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ct" + "idto", + "indexingDeleteTotal" ], - "description": "The time the model was created", - "name": "create_time", + "description": "number of delete ops", + "name": "indexing.delete_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "v" + "iic", + "indexingIndexCurrent" ], - "description": "The version of Elasticsearch when the model was created", - "name": "version", + "description": "number of current indexing ops", + "name": "indexing.index_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "d" + "iiti", + "indexingIndexTime" ], - "description": "The model description", - "name": "description", + "description": "time spent in indexing", + "name": "indexing.index_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ip", - "ingestPipelines" + "iito", + "indexingIndexTotal" ], - "description": "The number of pipelines referencing the model", - "name": "ingest.pipelines", + "description": "number of indexing ops", + "name": "indexing.index_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ic", - "ingestCount" + "iif", + "indexingIndexFailed" ], - "description": "The total number of docs processed by the model", - "name": "ingest.count", + "description": "number of failed indexing ops", + "name": "indexing.index_failed", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "it", - "ingestTime" + "mc", + "mergesCurrent" ], - "description": "The total time spent processing docs with this model", - "name": "ingest.time", + "description": "number of current merges", + "name": "merges.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "icurr", - "ingestCurrent" + "mcd", + "mergesCurrentDocs" ], - "description": "The total documents currently being handled by the model", - "name": "ingest.current", + "description": "number of current merging docs", + "name": "merges.current_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "if", - "ingestFailed" + "mcs", + "mergesCurrentSize" ], - "description": "The total count of failed ingest attempts with this model", - "name": "ingest.failed", + "description": "size of current merges", + "name": "merges.current_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dfid", - "dataFrameAnalytics" + "mt", + "mergesTotal" ], - "description": "The data frame analytics config id that created the model (if still available)", - "name": "data_frame.id", + "description": "number of completed merge ops", + "name": "merges.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dft", - "dataFrameAnalyticsTime" + "mtd", + "mergesTotalDocs" ], - "description": "The time the data frame analytics config was created", - "name": "data_frame.create_time", + "description": "docs merged", + "name": "merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dfsi", - "dataFrameAnalyticsSrcIndex" + "mts", + "mergesTotalSize" ], - "description": "The source index used to train in the data frame analysis", - "name": "data_frame.source_index", + "description": "size merged", + "name": "merges.total_size", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dfa", - "dataFrameAnalyticsAnalysis" + "mtt", + "mergesTotalTime" ], - "description": "The analysis used by the data frame to build the model", - "name": "data_frame.analysis", + "description": "time spent in merges", + "name": "merges.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "CatRequestBase", - "namespace": "cat._types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cat.transforms" - }, - "path": [ + }, { - "name": "transform_id", + "description": "total refreshes", + "name": "refresh.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "allow_no_match", + "description": "time spent in refreshes", + "name": "refresh.time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "from", + "aliases": [ + "rto", + "refreshTotal" + ], + "description": "total external refreshes", + "name": "refresh.external_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "size", + "aliases": [ + "rti", + "refreshTime" + ], + "description": "time spent in external refreshes", + "name": "refresh.external_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TransformsRecord", - "namespace": "cat.transforms" + "name": "string", + "namespace": "_builtins" } } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cat.transforms" - } - }, - { - "kind": "interface", - "name": { - "name": "TransformsRecord", - "namespace": "cat.transforms" - }, - "properties": [ + }, { - "description": "the id", - "name": "id", + "aliases": [ + "rli", + "refreshListeners" + ], + "description": "number of pending refresh listeners", + "name": "refresh.listeners", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "s" + "scrcc", + "scriptCompilations" ], - "description": "transform state", - "name": "state", + "description": "script compilations", + "name": "script.compilations", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "c" + "scrce", + "scriptCacheEvictions" ], - "description": "checkpoint", - "name": "checkpoint", + "description": "script cache evictions", + "name": "script.cache_evictions", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "docp", - "documentsProcessed" + "scrclt", + "scriptCacheCompilationLimitTriggered" ], - "description": "the number of documents read from source indices and processed", - "name": "documents_processed", + "description": "script cache compilation limit triggered", + "name": "script.compilation_limit_triggered", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "cp", - "checkpointProgress" + "sfc", + "searchFetchCurrent" ], - "description": "progress of the checkpoint", - "name": "checkpoint_progress", + "description": "current fetch phase ops", + "name": "search.fetch_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "lst", - "lastSearchTime" + "sfti", + "searchFetchTime" ], - "description": "last time transform searched for updates", - "name": "last_search_time", + "description": "time spent in fetch phase", + "name": "search.fetch_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "cldt" + "sfto", + "searchFetchTotal" ], - "description": "changes last detected time", - "name": "changes_last_detection_time", + "description": "total fetch ops", + "name": "search.fetch_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "ct", - "createTime" + "so", + "searchOpenContexts" ], - "description": "transform creation time", - "name": "create_time", + "description": "open search contexts", + "name": "search.open_contexts", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "v" + "sqc", + "searchQueryCurrent" ], - "description": "the version of Elasticsearch when the transform was created", - "name": "version", + "description": "current query phase ops", + "name": "search.query_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "si", - "sourceIndex" + "sqti", + "searchQueryTime" ], - "description": "source index", - "name": "source_index", + "description": "time spent in query phase", + "name": "search.query_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "di", - "destIndex" + "sqto", + "searchQueryTotal" ], - "description": "destination index", - "name": "dest_index", + "description": "total query phase ops", + "name": "search.query_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "p" + "scc", + "searchScrollCurrent" ], - "description": "transform pipeline", - "name": "pipeline", + "description": "open scroll contexts", + "name": "search.scroll_current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "d" + "scti", + "searchScrollTime" ], - "description": "description", - "name": "description", + "description": "time scroll contexts held open", + "name": "search.scroll_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "tt" + "scto", + "searchScrollTotal" ], - "description": "batch or continuous transform", - "name": "transform_type", + "description": "completed scroll contexts", + "name": "search.scroll_total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "f" + "sc", + "segmentsCount" ], - "description": "frequency of transform", - "name": "frequency", + "description": "number of segments", + "name": "segments.count", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "mpsz" + "sm", + "segmentsMemory" ], - "description": "max page search size", - "name": "max_page_search_size", + "description": "memory used by segments", + "name": "segments.memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dps" + "siwm", + "segmentsIndexWriterMemory" ], - "description": "docs per second", - "name": "docs_per_second", + "description": "memory used by index writer", + "name": "segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "r" + "svmm", + "segmentsVersionMapMemory" ], - "description": "reason for the current state", - "name": "reason", + "description": "memory used by version map", + "name": "segments.version_map_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "st" + "sfbm", + "fixedBitsetMemory" ], - "description": "total number of search phases", - "name": "search_total", + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "segments.fixed_bitset_memory", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "sf" + "suc", + "suggestCurrent" ], - "description": "total number of search failures", - "name": "search_failure", + "description": "number of current suggest ops", + "name": "suggest.current", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "stime" + "suti", + "suggestTime" ], - "description": "total search time", - "name": "search_time", + "description": "time spend in suggest", + "name": "suggest.time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "it" + "suto", + "suggestTotal" ], - "description": "total number of index phases done by the transform", - "name": "index_total", + "description": "number of suggest ops", + "name": "suggest.total", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "if" + "bto", + "bulkTotalOperations" ], - "description": "total number of index failures", - "name": "index_failure", + "description": "number of bulk shard ops", + "name": "bulk.total_operations", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "itime" + "btti", + "bulkTotalTime" ], - "description": "total time spent indexing documents", - "name": "index_time", + "description": "time spend in shard bulk", + "name": "bulk.total_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "doci" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "the number of documents written to the destination index", - "name": "documents_indexed", + "description": "total size in bytes of shard bulk", + "name": "bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "dtime" + "bati", + "bulkAvgTime" ], - "description": "total time spent deleting documents", - "name": "delete_time", + "description": "average time spend in shard bulk", + "name": "bulk.avg_time", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "docd" + "basi", + "bulkAvgSizeInBytes" ], - "description": "the number of documents deleted from the destination index", - "name": "documents_deleted", + "description": "average size in bytes of shard bulk", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/nodes/types.ts#L23-L541" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns basic statistics about performance of cluster nodes.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.nodes" + }, + "path": [], + "query": [ { - "aliases": [ - "tc" - ], - "description": "the number of times the transform has been triggered", - "name": "trigger_count", + "description": "The unit in which to display byte values", + "name": "bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Bytes", + "namespace": "_types" } } }, { - "aliases": [ - "pp" - ], - "description": "the number of pages processed", - "name": "pages_processed", + "description": "Return the full node ID instead of the shortened version (default: false)", + "name": "full_id", "required": false, "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L33" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodesRecord", + "namespace": "cat.nodes" } } - }, + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.nodes" + }, + "specLocation": "cat/nodes/CatNodesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "PendingTasksRecord", + "namespace": "cat.pending_tasks" + }, + "properties": [ { "aliases": [ - "pt" + "o" ], - "description": "the total time spent processing documents", - "name": "processing_time", + "description": "task insertion order", + "name": "insertOrder", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "cdtea", - "checkpointTimeExpAvg" + "t" ], - "description": "exponential average checkpoint processing time (milliseconds)", - "name": "checkpoint_duration_time_exp_avg", + "description": "how long task has been in queue", + "name": "timeInQueue", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "idea" + "p" ], - "description": "exponential average number of documents indexed", - "name": "indexed_documents_exp_avg", + "description": "task priority", + "name": "priority", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "aliases": [ - "pdea" + "s" ], - "description": "exponential average number of documents processed", - "name": "processed_documents_exp_avg", + "description": "task source", + "name": "source", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cat/pending_tasks/types.ts#L20-L41" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a concise representation of the cluster pending tasks.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", "name": { - "name": "FollowIndexStats", - "namespace": "ccr._types" + "name": "Request", + "namespace": "cat.pending_tasks" }, - "properties": [ - { - "name": "index", - "required": true, - "type": { + "path": [], + "query": [], + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L27" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "shards", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardStats", - "namespace": "ccr._types" - } + "name": "PendingTasksRecord", + "namespace": "cat.pending_tasks" } } } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.pending_tasks" + }, + "specLocation": "cat/pending_tasks/CatPendingTasksResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "ReadException", - "namespace": "ccr._types" + "name": "PluginsRecord", + "namespace": "cat.plugins" }, "properties": [ { - "name": "exception", - "required": true, + "description": "unique node id", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", + "name": "NodeId", "namespace": "_types" } } }, { - "name": "from_seq_no", - "required": true, + "aliases": [ + "n" + ], + "description": "node name", + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", + "name": "Name", "namespace": "_types" } } }, { - "name": "retries", - "required": true, + "aliases": [ + "c" + ], + "description": "component", + "name": "component", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ShardStats", - "namespace": "ccr._types" - }, - "properties": [ + }, { - "name": "bytes_read", - "required": true, + "aliases": [ + "v" + ], + "description": "component version", + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "VersionString", "namespace": "_types" } } }, { - "name": "failed_read_requests", - "required": true, + "aliases": [ + "d" + ], + "description": "plugin details", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "failed_write_requests", - "required": true, + "aliases": [ + "t" + ], + "description": "plugin type", + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Type", "namespace": "_types" } } - }, + } + ], + "specLocation": "cat/plugins/types.ts#L22-L52" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about installed plugins across nodes node.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.plugins" + }, + "path": [], + "query": [], + "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L27" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PluginsRecord", + "namespace": "cat.plugins" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.plugins" + }, + "specLocation": "cat/plugins/CatPluginsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "RecoveryRecord", + "namespace": "cat.recovery" + }, + "properties": [ { - "name": "fatal_exception", + "aliases": [ + "i", + "idx" + ], + "description": "index name", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "follower_aliases_version", - "required": true, + "aliases": [ + "s", + "sh" + ], + "description": "shard name", + "name": "shard", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "follower_global_checkpoint", - "required": true, + "aliases": [ + "start" + ], + "description": "recovery start time", + "name": "start_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "follower_index", - "required": true, + "aliases": [ + "start_millis" + ], + "description": "recovery start time in epoch milliseconds", + "name": "start_time_millis", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "follower_mapping_version", - "required": true, + "aliases": [ + "stop" + ], + "description": "recovery stop time", + "name": "stop_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "follower_max_seq_no", - "required": true, + "aliases": [ + "stop_millis" + ], + "description": "recovery stop time in epoch milliseconds", + "name": "stop_time_millis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "follower_settings_version", - "required": true, + "aliases": [ + "t", + "ti" + ], + "description": "recovery time", + "name": "time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "last_requested_seq_no", - "required": true, + "aliases": [ + "ty" + ], + "description": "recovery type", + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", + "name": "Type", "namespace": "_types" } } }, { - "name": "leader_global_checkpoint", - "required": true, + "aliases": [ + "st" + ], + "description": "recovery stage", + "name": "stage", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "leader_index", - "required": true, + "aliases": [ + "shost" + ], + "description": "source host", + "name": "source_host", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "leader_max_seq_no", - "required": true, + "aliases": [ + "snode" + ], + "description": "source node name", + "name": "source_node", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "operations_read", - "required": true, + "aliases": [ + "thost" + ], + "description": "target host", + "name": "target_host", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "operations_written", - "required": true, + "aliases": [ + "tnode" + ], + "description": "target node name", + "name": "target_node", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "outstanding_read_requests", - "required": true, + "aliases": [ + "rep" + ], + "description": "repository", + "name": "repository", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "outstanding_write_requests", - "required": true, + "aliases": [ + "snap" + ], + "description": "snapshot", + "name": "snapshot", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "read_exceptions", - "required": true, + "aliases": [ + "f" + ], + "description": "number of files to recover", + "name": "files", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ReadException", - "namespace": "ccr._types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "remote_cluster", - "required": true, + "aliases": [ + "fr" + ], + "description": "files recovered", + "name": "files_recovered", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "shard_id", - "required": true, + "aliases": [ + "fp" + ], + "description": "percent of files recovered", + "name": "files_percent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Percentage", "namespace": "_types" } } }, { - "name": "successful_read_requests", - "required": true, + "aliases": [ + "tf" + ], + "description": "total number of files", + "name": "files_total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "successful_write_requests", - "required": true, + "aliases": [ + "b" + ], + "description": "number of bytes to recover", + "name": "bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "time_since_last_read_millis", - "required": true, + "aliases": [ + "br" + ], + "description": "bytes recovered", + "name": "bytes_recovered", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total_read_remote_exec_time_millis", - "required": true, + "aliases": [ + "bp" + ], + "description": "percent of bytes recovered", + "name": "bytes_percent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Percentage", "namespace": "_types" } } }, { - "name": "total_read_time_millis", - "required": true, + "aliases": [ + "tb" + ], + "description": "total number of bytes", + "name": "bytes_total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total_write_time_millis", - "required": true, + "aliases": [ + "to" + ], + "description": "number of translog ops to recover", + "name": "translog_ops", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "write_buffer_operation_count", - "required": true, + "aliases": [ + "tor" + ], + "description": "translog ops recovered", + "name": "translog_ops_recovered", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "write_buffer_size_in_bytes", - "required": true, + "aliases": [ + "top" + ], + "description": "percent of translog ops recovered", + "name": "translog_ops_percent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "Percentage", "namespace": "_types" } } } - ] + ], + "specLocation": "cat/recovery/types.ts#L23-L154" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "leader_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_read_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_write_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_read_request_operation_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_read_request_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "max_retry_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "max_write_buffer_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_write_buffer_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "max_write_request_operation_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_write_request_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "read_poll_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "remote_cluster", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "kind": "no_body" }, + "description": "Returns information about index shard recoveries, both on-going completed.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "ccr.create_follow_index" + "namespace": "cat.recovery" }, "path": [ { + "description": "Comma-separated list or wildcard expression of index names to limit the returned information", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Indices", "namespace": "_types" } } @@ -70661,135 +78664,175 @@ ], "query": [ { - "name": "wait_for_active_shards", + "description": "If `true`, the response only includes ongoing shard recoveries", + "name": "active_only", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The unit in which to display byte values", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", "namespace": "_types" } } + }, + { + "description": "If `true`, the response includes detailed information about shard recoveries", + "name": "detailed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L37" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "follow_index_created", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "follow_index_shards_acked", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "index_following_started", - "required": true, + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "RecoveryRecord", + "namespace": "cat.recovery" } } - ] + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ccr.create_follow_index" - } + "namespace": "cat.recovery" + }, + "specLocation": "cat/recovery/CatRecoveryResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "RepositoriesRecord", + "namespace": "cat.repositories" + }, + "properties": [ + { + "aliases": [ + "repoId" + ], + "description": "unique repository id", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "t" + ], + "description": "repository type", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/repositories/types.ts#L20-L31" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, + "description": "Returns information about snapshot repositories registered in the cluster.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "ccr.delete_auto_follow_pattern" + "namespace": "cat.repositories" }, - "path": [ - { - "name": "name", - "required": true, - "type": { + "path": [], + "query": [], + "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L27" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "RepositoriesRecord", + "namespace": "cat.repositories" } } } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } }, "kind": "response", "name": { "name": "Response", - "namespace": "ccr.delete_auto_follow_pattern" - } + "namespace": "cat.repositories" + }, + "specLocation": "cat/repositories/CatRepositoriesResponse.ts#L22-L24" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, + "description": "Provides low-level information about the segments in the shards of an index.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "ccr.follow_index_stats" + "namespace": "cat.segments" }, "path": [ { + "description": "A comma-separated list of index names to limit the returned information", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -70799,44 +78842,58 @@ } } ], - "query": [] + "query": [ + { + "description": "The unit in which to display byte values", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L35" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "indices", - "required": true, + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FollowIndexStats", - "namespace": "ccr._types" - } - } + "name": "SegmentsRecord", + "namespace": "cat.segments" } } - ] + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ccr.follow_index_stats" - } + "namespace": "cat.segments" + }, + "specLocation": "cat/segments/CatSegmentsResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "FollowerIndex", - "namespace": "ccr.follow_info" + "name": "SegmentsRecord", + "namespace": "cat.segments" }, "properties": [ { - "name": "follower_index", - "required": true, + "aliases": [ + "i", + "idx" + ], + "description": "index name", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { @@ -70846,207 +78903,247 @@ } }, { - "name": "leader_index", - "required": true, + "aliases": [ + "s", + "sh" + ], + "description": "shard name", + "name": "shard", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "parameters", + "aliases": [ + "p", + "pr", + "primaryOrReplica" + ], + "description": "primary or replica", + "name": "prirep", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FollowerIndexParameters", - "namespace": "ccr.follow_info" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "remote_cluster", - "required": true, + "description": "ip of node where it lives", + "name": "ip", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "status", - "required": true, + "description": "unique id of node where it lives", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FollowerIndexStatus", - "namespace": "ccr.follow_info" + "name": "NodeId", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FollowerIndexParameters", - "namespace": "ccr.follow_info" - }, - "properties": [ + }, { - "name": "max_outstanding_read_requests", - "required": true, + "aliases": [ + "seg" + ], + "description": "segment name", + "name": "segment", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_outstanding_write_requests", - "required": true, + "aliases": [ + "g", + "gen" + ], + "description": "segment generation", + "name": "generation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_read_request_operation_count", - "required": true, + "aliases": [ + "dc", + "docsCount" + ], + "description": "number of docs in segment", + "name": "docs.count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_read_request_size", - "required": true, + "aliases": [ + "dd", + "docsDeleted" + ], + "description": "number of deleted docs in segment", + "name": "docs.deleted", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "max_retry_delay", - "required": true, + "aliases": [ + "si" + ], + "description": "segment size in bytes", + "name": "size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "max_write_buffer_count", - "required": true, + "aliases": [ + "sm", + "sizeMemory" + ], + "description": "segment memory in bytes", + "name": "size.memory", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "max_write_buffer_size", - "required": true, + "aliases": [ + "ic", + "isCommitted" + ], + "description": "is segment committed", + "name": "committed", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "max_write_request_operation_count", - "required": true, + "aliases": [ + "is", + "isSearchable" + ], + "description": "is segment searched", + "name": "searchable", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_write_request_size", - "required": true, + "aliases": [ + "v" + ], + "description": "version", + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "read_poll_timeout", - "required": true, + "aliases": [ + "ico", + "isCompound" + ], + "description": "is segment compound", + "name": "compound", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "active" - }, - { - "name": "paused" - } ], - "name": { - "name": "FollowerIndexStatus", - "namespace": "ccr.follow_info" - } + "specLocation": "cat/segments/types.ts#L22-L96" }, { "attachedBehaviors": [ + "CommonCatQueryParameters", "CommonQueryParameters" ], "body": { "kind": "no_body" }, + "description": "Provides a detailed view of shard allocation on nodes.", "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "CatRequestBase", + "namespace": "cat._types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "ccr.follow_info" + "namespace": "cat.shards" }, "path": [ { + "description": "A comma-separated list of index names to limit the returned information", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -71056,254 +79153,10454 @@ } } ], - "query": [] + "query": [ + { + "description": "The unit in which to display byte values", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/shards/CatShardsRequest.ts#L23-L35" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "follower_indices", - "required": true, + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FollowerIndex", - "namespace": "ccr.follow_info" + "name": "ShardsRecord", + "namespace": "cat.shards" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.shards" + }, + "specLocation": "cat/shards/CatShardsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "ShardsRecord", + "namespace": "cat.shards" + }, + "properties": [ + { + "aliases": [ + "i", + "idx" + ], + "description": "index name", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "s", + "sh" + ], + "description": "shard name", + "name": "shard", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "p", + "pr", + "primaryOrReplica" + ], + "description": "primary or replica", + "name": "prirep", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "st" + ], + "description": "shard state", + "name": "state", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "d", + "dc" + ], + "description": "number of docs in shard", + "name": "docs", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "sto" + ], + "description": "store size of shard (how much disk it uses)", + "name": "store", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "ip of node where it lives", + "name": "ip", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "unique id of node where it lives", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "n" + ], + "description": "name of node where it lives", + "name": "node", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "sync id", + "name": "sync_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ur" + ], + "description": "reason shard is unassigned", + "name": "unassigned.reason", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ua" + ], + "description": "time shard became unassigned (UTC)", + "name": "unassigned.at", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "uf" + ], + "description": "time has been unassigned", + "name": "unassigned.for", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ud" + ], + "description": "additional details as to why the shard became unassigned", + "name": "unassigned.details", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "rs" + ], + "description": "recovery source type", + "name": "recoverysource.type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "cs", + "completionSize" + ], + "description": "size of completion", + "name": "completion.size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "fm", + "fielddataMemory" + ], + "description": "used fielddata cache", + "name": "fielddata.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "fe", + "fielddataEvictions" + ], + "description": "fielddata evictions", + "name": "fielddata.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "qcm", + "queryCacheMemory" + ], + "description": "used query cache", + "name": "query_cache.memory_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "qce", + "queryCacheEvictions" + ], + "description": "query cache evictions", + "name": "query_cache.evictions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ft", + "flushTotal" + ], + "description": "number of flushes", + "name": "flush.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ftt", + "flushTotalTime" + ], + "description": "time spent in flush", + "name": "flush.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "gc", + "getCurrent" + ], + "description": "number of current get ops", + "name": "get.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "gti", + "getTime" + ], + "description": "time spent in get", + "name": "get.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "gto", + "getTotal" + ], + "description": "number of get ops", + "name": "get.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "geti", + "getExistsTime" + ], + "description": "time spent in successful gets", + "name": "get.exists_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "geto", + "getExistsTotal" + ], + "description": "number of successful gets", + "name": "get.exists_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "gmti", + "getMissingTime" + ], + "description": "time spent in failed gets", + "name": "get.missing_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "gmto", + "getMissingTotal" + ], + "description": "number of failed gets", + "name": "get.missing_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "idc", + "indexingDeleteCurrent" + ], + "description": "number of current deletions", + "name": "indexing.delete_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "idti", + "indexingDeleteTime" + ], + "description": "time spent in deletions", + "name": "indexing.delete_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "idto", + "indexingDeleteTotal" + ], + "description": "number of delete ops", + "name": "indexing.delete_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "iic", + "indexingIndexCurrent" + ], + "description": "number of current indexing ops", + "name": "indexing.index_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "iiti", + "indexingIndexTime" + ], + "description": "time spent in indexing", + "name": "indexing.index_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "iito", + "indexingIndexTotal" + ], + "description": "number of indexing ops", + "name": "indexing.index_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "iif", + "indexingIndexFailed" + ], + "description": "number of failed indexing ops", + "name": "indexing.index_failed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mc", + "mergesCurrent" + ], + "description": "number of current merges", + "name": "merges.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mcd", + "mergesCurrentDocs" + ], + "description": "number of current merging docs", + "name": "merges.current_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mcs", + "mergesCurrentSize" + ], + "description": "size of current merges", + "name": "merges.current_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mt", + "mergesTotal" + ], + "description": "number of completed merge ops", + "name": "merges.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mtd", + "mergesTotalDocs" + ], + "description": "docs merged", + "name": "merges.total_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mts", + "mergesTotalSize" + ], + "description": "size merged", + "name": "merges.total_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mtt", + "mergesTotalTime" + ], + "description": "time spent in merges", + "name": "merges.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "total refreshes", + "name": "refresh.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "time spent in refreshes", + "name": "refresh.time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "rto", + "refreshTotal" + ], + "description": "total external refreshes", + "name": "refresh.external_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "rti", + "refreshTime" + ], + "description": "time spent in external refreshes", + "name": "refresh.external_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "rli", + "refreshListeners" + ], + "description": "number of pending refresh listeners", + "name": "refresh.listeners", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sfc", + "searchFetchCurrent" + ], + "description": "current fetch phase ops", + "name": "search.fetch_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sfti", + "searchFetchTime" + ], + "description": "time spent in fetch phase", + "name": "search.fetch_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sfto", + "searchFetchTotal" + ], + "description": "total fetch ops", + "name": "search.fetch_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "so", + "searchOpenContexts" + ], + "description": "open search contexts", + "name": "search.open_contexts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sqc", + "searchQueryCurrent" + ], + "description": "current query phase ops", + "name": "search.query_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sqti", + "searchQueryTime" + ], + "description": "time spent in query phase", + "name": "search.query_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sqto", + "searchQueryTotal" + ], + "description": "total query phase ops", + "name": "search.query_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "scc", + "searchScrollCurrent" + ], + "description": "open scroll contexts", + "name": "search.scroll_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "scti", + "searchScrollTime" + ], + "description": "time scroll contexts held open", + "name": "search.scroll_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "scto", + "searchScrollTotal" + ], + "description": "completed scroll contexts", + "name": "search.scroll_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sc", + "segmentsCount" + ], + "description": "number of segments", + "name": "segments.count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sm", + "segmentsMemory" + ], + "description": "memory used by segments", + "name": "segments.memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "siwm", + "segmentsIndexWriterMemory" + ], + "description": "memory used by index writer", + "name": "segments.index_writer_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "svmm", + "segmentsVersionMapMemory" + ], + "description": "memory used by version map", + "name": "segments.version_map_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sfbm", + "fixedBitsetMemory" + ], + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "segments.fixed_bitset_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sqm", + "maxSeqNo" + ], + "description": "max sequence number", + "name": "seq_no.max", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sql", + "localCheckpoint" + ], + "description": "local checkpoint", + "name": "seq_no.local_checkpoint", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sqg", + "globalCheckpoint" + ], + "description": "global checkpoint", + "name": "seq_no.global_checkpoint", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "wc", + "warmerCurrent" + ], + "description": "current warmer ops", + "name": "warmer.current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "wto", + "warmerTotal" + ], + "description": "total warmer ops", + "name": "warmer.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "wtt", + "warmerTotalTime" + ], + "description": "time spent in warmers", + "name": "warmer.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "pd", + "dataPath" + ], + "description": "shard data path", + "name": "path.data", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ps", + "statsPath" + ], + "description": "shard state path", + "name": "path.state", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "bto", + "bulkTotalOperations" + ], + "description": "number of bulk shard ops", + "name": "bulk.total_operations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "btti", + "bulkTotalTime" + ], + "description": "time spend in shard bulk", + "name": "bulk.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "btsi", + "bulkTotalSizeInBytes" + ], + "description": "total size in bytes of shard bulk", + "name": "bulk.total_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "bati", + "bulkAvgTime" + ], + "description": "average time spend in shard bulk", + "name": "bulk.avg_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "basi", + "bulkAvgSizeInBytes" + ], + "description": "avg size in bytes of shard bulk", + "name": "bulk.avg_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/shards/types.ts#L20-L396" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns all snapshots in a specific repository.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.snapshots" + }, + "path": [ + { + "description": "Name of repository from which to fetch the snapshot information", + "name": "repository", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Set to true to ignore unavailable snapshots", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L35" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SnapshotsRecord", + "namespace": "cat.snapshots" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.snapshots" + }, + "specLocation": "cat/snapshots/CatSnapshotsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "SnapshotsRecord", + "namespace": "cat.snapshots" + }, + "properties": [ + { + "aliases": [ + "snapshot" + ], + "description": "unique snapshot", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "re", + "repo" + ], + "description": "repository name", + "name": "repository", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "s" + ], + "description": "snapshot name", + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ste", + "startEpoch" + ], + "description": "start time in seconds since 1970-01-01 00:00:00", + "name": "start_epoch", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "sti", + "startTime" + ], + "description": "start time in HH:MM:SS", + "name": "start_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "ete", + "endEpoch" + ], + "description": "end time in seconds since 1970-01-01 00:00:00", + "name": "end_epoch", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "eti", + "endTime" + ], + "description": "end time in HH:MM:SS", + "name": "end_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "dur" + ], + "description": "duration", + "name": "duration", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "i" + ], + "description": "number of indices", + "name": "indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ss" + ], + "description": "number of successful shards", + "name": "successful_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "fs" + ], + "description": "number of failed shards", + "name": "failed_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ts" + ], + "description": "number of total shards", + "name": "total_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "r" + ], + "description": "reason for failures", + "name": "reason", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/snapshots/types.ts#L22-L88" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about the tasks currently executing on one or more nodes in the cluster.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.tasks" + }, + "path": [], + "query": [ + { + "description": "A comma-separated list of actions that should be returned. Leave empty to return all.", + "name": "actions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Return detailed task information (default: false)", + "name": "detailed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "node_id", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "parent_task", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/tasks/CatTasksRequest.ts#L23-L35" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TasksRecord", + "namespace": "cat.tasks" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.tasks" + }, + "specLocation": "cat/tasks/CatTasksResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TasksRecord", + "namespace": "cat.tasks" + }, + "properties": [ + { + "description": "id of the task with the node", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "ac" + ], + "description": "task action", + "name": "action", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ti" + ], + "description": "unique task id", + "name": "task_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "pti" + ], + "description": "parent task id", + "name": "parent_task_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ty" + ], + "description": "task type", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Type", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "start" + ], + "description": "start time in ms", + "name": "start_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ts", + "hms", + "hhmmss" + ], + "description": "start time in HH:MM:SS", + "name": "timestamp", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "running time ns", + "name": "running_time_ns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "time" + ], + "description": "running time", + "name": "running_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "ni" + ], + "description": "unique node id", + "name": "node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "i" + ], + "description": "ip address", + "name": "ip", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "po" + ], + "description": "bound transport port", + "name": "port", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "n" + ], + "description": "node name", + "name": "node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "v" + ], + "description": "es version", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "x" + ], + "description": "X-Opaque-ID header", + "name": "x_opaque_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "desc" + ], + "description": "task action", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/tasks/types.ts#L22-L101" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about existing templates.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.templates" + }, + "path": [ + { + "description": "A pattern that returned template names must match", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TemplatesRecord", + "namespace": "cat.templates" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.templates" + }, + "specLocation": "cat/templates/CatTemplatesResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TemplatesRecord", + "namespace": "cat.templates" + }, + "properties": [ + { + "aliases": [ + "n" + ], + "description": "template name", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "t" + ], + "description": "template index patterns", + "name": "index_patterns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "o", + "p" + ], + "description": "template application order/priority number", + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "v" + ], + "description": "version", + "name": "version", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "c" + ], + "description": "component templates comprising index template", + "name": "composed_of", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/templates/types.ts#L22-L48" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.thread_pool" + }, + "path": [ + { + "description": "A comma-separated list of regular-expressions to filter the thread pools in the output", + "name": "thread_pool_patterns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "The multiplier in which to display values", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ThreadPoolSize", + "namespace": "cat.thread_pool" + } + } + } + ], + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L36" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ThreadPoolRecord", + "namespace": "cat.thread_pool" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.thread_pool" + }, + "specLocation": "cat/thread_pool/CatThreadPoolResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "ThreadPoolRecord", + "namespace": "cat.thread_pool" + }, + "properties": [ + { + "aliases": [ + "nn" + ], + "description": "node name", + "name": "node_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "id" + ], + "description": "persistent node id", + "name": "node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "eid" + ], + "description": "ephemeral node id", + "name": "ephemeral_node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "p" + ], + "description": "process id", + "name": "pid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "h" + ], + "description": "host name", + "name": "host", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "i" + ], + "description": "ip address", + "name": "ip", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "po" + ], + "description": "bound transport port", + "name": "port", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "n" + ], + "description": "thread pool name", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "t" + ], + "description": "thread pool type", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "a" + ], + "description": "number of active threads", + "name": "active", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "psz" + ], + "description": "number of threads", + "name": "pool_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "q" + ], + "description": "number of tasks currently in queue", + "name": "queue", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "qs" + ], + "description": "maximum number of tasks permitted in queue", + "name": "queue_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "r" + ], + "description": "number of rejected tasks", + "name": "rejected", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "l" + ], + "description": "highest number of seen active threads", + "name": "largest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "c" + ], + "description": "number of completed tasks", + "name": "completed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "cr" + ], + "description": "core number of threads in a scaling thread pool", + "name": "core", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "mx" + ], + "description": "maximum number of threads in a scaling thread pool", + "name": "max", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "sz" + ], + "description": "number of threads in a fixed thread pool", + "name": "size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "ka" + ], + "description": "thread keep alive time", + "name": "keep_alive", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "cat/thread_pool/types.ts#L22-L123" + }, + { + "kind": "enum", + "members": [ + { + "name": "k" + }, + { + "name": "m" + }, + { + "name": "g" + }, + { + "name": "t" + }, + { + "name": "p" + } + ], + "name": { + "name": "ThreadPoolSize", + "namespace": "cat.thread_pool" + }, + "specLocation": "cat/thread_pool/types.ts#L125-L131" + }, + { + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns configuration and usage information about transforms.\n\nIMPORTANT: cat APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cat.transforms" + }, + "path": [ + { + "description": "The id of the transform for which to get stats. '_all' or '*' implies all transforms", + "name": "transform_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)", + "name": "allow_no_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "skips a number of transform configs, defaults to 0", + "name": "from", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Comma-separated list of column names to display.", + "name": "h", + "required": false, + "serverDefault": "create_time,id,state,type", + "type": { + "kind": "instance_of", + "type": { + "name": "CatTransformColumns", + "namespace": "cat._types" + } + } + }, + { + "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", + "name": "s", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CatTransformColumns", + "namespace": "cat._types" + } + } + }, + { + "description": "Unit used to display time values.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "specifies a max number of transforms to get, defaults to 100", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L58" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TransformsRecord", + "namespace": "cat.transforms" + } + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cat.transforms" + }, + "specLocation": "cat/transforms/CatTransformsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TransformsRecord", + "namespace": "cat.transforms" + }, + "properties": [ + { + "description": "the id", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "s" + ], + "description": "transform state", + "name": "state", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "c" + ], + "description": "checkpoint", + "name": "checkpoint", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "docp", + "documentsProcessed" + ], + "description": "the number of documents read from source indices and processed", + "name": "documents_processed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "cp", + "checkpointProgress" + ], + "description": "progress of the checkpoint", + "name": "checkpoint_progress", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "lst", + "lastSearchTime" + ], + "description": "last time transform searched for updates", + "name": "last_search_time", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "cldt" + ], + "description": "changes last detected time", + "name": "changes_last_detection_time", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "ct", + "createTime" + ], + "description": "transform creation time", + "name": "create_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "v" + ], + "description": "the version of Elasticsearch when the transform was created", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "si", + "sourceIndex" + ], + "description": "source index", + "name": "source_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "di", + "destIndex" + ], + "description": "destination index", + "name": "dest_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "p" + ], + "description": "transform pipeline", + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "d" + ], + "description": "description", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "tt" + ], + "description": "batch or continuous transform", + "name": "transform_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "f" + ], + "description": "frequency of transform", + "name": "frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "mpsz" + ], + "description": "max page search size", + "name": "max_page_search_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "dps" + ], + "description": "docs per second", + "name": "docs_per_second", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "r" + ], + "description": "reason for the current state", + "name": "reason", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "st" + ], + "description": "total number of search phases", + "name": "search_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "sf" + ], + "description": "total number of search failures", + "name": "search_failure", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "stime" + ], + "description": "total search time", + "name": "search_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "it" + ], + "description": "total number of index phases done by the transform", + "name": "index_total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "if" + ], + "description": "total number of index failures", + "name": "index_failure", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "itime" + ], + "description": "total time spent indexing documents", + "name": "index_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "doci" + ], + "description": "the number of documents written to the destination index", + "name": "documents_indexed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "dtime" + ], + "description": "total time spent deleting documents", + "name": "delete_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "docd" + ], + "description": "the number of documents deleted from the destination index", + "name": "documents_deleted", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "tc" + ], + "description": "the number of times the transform has been triggered", + "name": "trigger_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "pp" + ], + "description": "the number of pages processed", + "name": "pages_processed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "pt" + ], + "description": "the total time spent processing documents", + "name": "processing_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "cdtea", + "checkpointTimeExpAvg" + ], + "description": "exponential average checkpoint processing time (milliseconds)", + "name": "checkpoint_duration_time_exp_avg", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "idea" + ], + "description": "exponential average number of documents indexed", + "name": "indexed_documents_exp_avg", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "pdea" + ], + "description": "exponential average number of documents processed", + "name": "processed_documents_exp_avg", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/transforms/types.ts#L22-L187" + }, + { + "kind": "interface", + "name": { + "name": "FollowIndexStats", + "namespace": "ccr._types" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "shards", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardStats", + "namespace": "ccr._types" + } + } + } + } + ], + "specLocation": "ccr/_types/FollowIndexStats.ts#L30-L33" + }, + { + "kind": "interface", + "name": { + "name": "ReadException", + "namespace": "ccr._types" + }, + "properties": [ + { + "name": "exception", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + }, + { + "name": "from_seq_no", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + }, + { + "name": "retries", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "ccr/_types/FollowIndexStats.ts#L67-L71" + }, + { + "kind": "interface", + "name": { + "name": "ShardStats", + "namespace": "ccr._types" + }, + "properties": [ + { + "name": "bytes_read", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "failed_read_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "failed_write_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "fatal_exception", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + }, + { + "name": "follower_aliases_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "follower_global_checkpoint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "follower_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "follower_mapping_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "follower_max_seq_no", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + }, + { + "name": "follower_settings_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "last_requested_seq_no", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + }, + { + "name": "leader_global_checkpoint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "leader_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "leader_max_seq_no", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + }, + { + "name": "operations_read", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "operations_written", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "outstanding_read_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "outstanding_write_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "read_exceptions", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ReadException", + "namespace": "ccr._types" + } + } + } + }, + { + "name": "remote_cluster", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "shard_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "successful_read_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "successful_write_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "time_since_last_read_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "total_read_remote_exec_time_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "total_read_time_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "total_write_time_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "write_buffer_operation_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "write_buffer_size_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + } + ], + "specLocation": "ccr/_types/FollowIndexStats.ts#L35-L65" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes auto-follow patterns.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.delete_auto_follow_pattern" + }, + "path": [ + { + "description": "The name of the auto follow pattern.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.delete_auto_follow_pattern" + }, + "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "leader_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "max_outstanding_read_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_outstanding_write_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_retry_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_write_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "read_poll_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "remote_cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Creates a new follower index configured to follow the referenced leader index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.follow" + }, + "path": [ + { + "description": "The name of the follower index", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", + "name": "wait_for_active_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForActiveShards", + "namespace": "_types" + } + } + } + ], + "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L25-L51" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "follow_index_created", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "follow_index_shards_acked", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index_following_started", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.follow" + }, + "specLocation": "ccr/follow/CreateFollowIndexResponse.ts#L20-L26" + }, + { + "kind": "interface", + "name": { + "name": "FollowerIndex", + "namespace": "ccr.follow_info" + }, + "properties": [ + { + "name": "follower_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "leader_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "parameters", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FollowerIndexParameters", + "namespace": "ccr.follow_info" + } + } + }, + { + "name": "remote_cluster", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FollowerIndexStatus", + "namespace": "ccr.follow_info" + } + } + } + ], + "specLocation": "ccr/follow_info/types.ts#L22-L28" + }, + { + "kind": "interface", + "name": { + "name": "FollowerIndexParameters", + "namespace": "ccr.follow_info" + }, + "properties": [ + { + "name": "max_outstanding_read_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "max_outstanding_write_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_operation_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_retry_delay", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_write_request_operation_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "max_write_request_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "read_poll_timeout", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "ccr/follow_info/types.ts#L38-L49" + }, + { + "kind": "enum", + "members": [ + { + "name": "active" + }, + { + "name": "paused" + } + ], + "name": { + "name": "FollowerIndexStatus", + "namespace": "ccr.follow_info" + }, + "specLocation": "ccr/follow_info/types.ts#L30-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves information about all follower indices, including parameters and status for each follower index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.follow_info" + }, + "path": [ + { + "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "follower_indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FollowerIndex", + "namespace": "ccr.follow_info" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.follow_info" + }, + "specLocation": "ccr/follow_info/FollowInfoResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.follow_stats" + }, + "path": [ + { + "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FollowIndexStats", + "namespace": "ccr._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.follow_stats" + }, + "specLocation": "ccr/follow_stats/FollowIndexStatsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "follower_cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "follower_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "follower_index_uuid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Uuid", + "namespace": "_types" + } + } + }, + { + "name": "leader_remote_cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Removes the follower retention leases from the leader.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.forget_follower" + }, + "path": [ + { + "description": "the name of the leader index for which specified follower retention leases should be removed", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L38" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.forget_follower" + }, + "specLocation": "ccr/forget_follower/ForgetFollowerIndexResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowPattern", + "namespace": "ccr.get_auto_follow_pattern" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "pattern", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoFollowPatternSummary", + "namespace": "ccr.get_auto_follow_pattern" + } + } + } + ], + "specLocation": "ccr/get_auto_follow_pattern/types.ts#L23-L26" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowPatternSummary", + "namespace": "ccr.get_auto_follow_pattern" + }, + "properties": [ + { + "name": "active", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The remote cluster containing the leader indices to match against.", + "name": "remote_cluster", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The name of follower index.", + "name": "follow_index_pattern", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPattern", + "namespace": "_types" + } + } + }, + { + "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", + "name": "leader_index_patterns", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPatterns", + "namespace": "_types" + } + } + }, + { + "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed.", + "name": "leader_index_exclusion_patterns", + "required": true, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPatterns", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "name": "max_outstanding_read_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "ccr/get_auto_follow_pattern/types.ts#L28-L51" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.get_auto_follow_pattern" + }, + "path": [ + { + "description": "Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts#L23-L33" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "patterns", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoFollowPattern", + "namespace": "ccr.get_auto_follow_pattern" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.get_auto_follow_pattern" + }, + "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Pauses an auto-follow pattern", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.pause_auto_follow_pattern" + }, + "path": [ + { + "description": "The name of the auto follow pattern that should pause discovering new indices to follow.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.pause_auto_follow_pattern" + }, + "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.pause_follow" + }, + "path": [ + { + "description": "The name of the follower index that should pause following its leader index.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.pause_follow" + }, + "specLocation": "ccr/pause_follow/PauseFollowIndexResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The remote cluster containing the leader indices to match against.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-remote-clusters.html", + "name": "remote_cluster", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", + "name": "follow_index_pattern", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPattern", + "namespace": "_types" + } + } + }, + { + "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", + "name": "leader_index_patterns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPatterns", + "namespace": "_types" + } + } + }, + { + "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", + "name": "leader_index_exclusion_patterns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexPatterns", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "name": "max_outstanding_read_requests", + "required": false, + "serverDefault": 12, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", + "name": "settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "name": "max_outstanding_write_requests", + "required": false, + "serverDefault": 9, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", + "name": "read_poll_timeout", + "required": false, + "serverDefault": "1m", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of operations to pull per read from the remote cluster.", + "name": "max_read_request_operation_count", + "required": false, + "serverDefault": 5120, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", + "name": "max_read_request_size", + "required": false, + "serverDefault": "32mb", + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", + "name": "max_retry_delay", + "required": false, + "serverDefault": "500ms", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", + "name": "max_write_buffer_count", + "required": false, + "serverDefault": 2147483647, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", + "name": "max_write_buffer_size", + "required": false, + "serverDefault": "512mb", + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of operations per bulk write request executed on the follower.", + "name": "max_write_request_operation_count", + "required": false, + "serverDefault": 5120, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", + "name": "max_write_request_size", + "required": false, + "serverDefault": "9223372036854775807b", + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + } + ] + }, + "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.put_auto_follow_pattern" + }, + "path": [ + { + "description": "The name of the collection of auto-follow patterns.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L112" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.put_auto_follow_pattern" + }, + "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Resumes an auto-follow pattern that has been paused", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.resume_auto_follow_pattern" + }, + "path": [ + { + "description": "The name of the auto follow pattern to resume discovering new indices to follow.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.resume_auto_follow_pattern" + }, + "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "max_outstanding_read_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_outstanding_write_requests", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_read_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_retry_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_buffer_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_write_request_operation_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_write_request_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "read_poll_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ] + }, + "description": "Resumes a follower index that has been paused", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.resume_follow" + }, + "path": [ + { + "description": "The name of the follow index to resume following.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L46" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.resume_follow" + }, + "specLocation": "ccr/resume_follow/ResumeFollowIndexResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowStats", + "namespace": "ccr.stats" + }, + "properties": [ + { + "name": "auto_followed_clusters", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AutoFollowedCluster", + "namespace": "ccr.stats" + } + } + } + }, + { + "name": "number_of_failed_follow_indices", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "number_of_failed_remote_cluster_state_requests", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "number_of_successful_follow_indices", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "recent_auto_follow_errors", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + } + } + ], + "specLocation": "ccr/stats/types.ts.ts#L33-L39" + }, + { + "kind": "interface", + "name": { + "name": "AutoFollowedCluster", + "namespace": "ccr.stats" + }, + "properties": [ + { + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "last_seen_metadata_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "time_since_last_check_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + } + ], + "specLocation": "ccr/stats/types.ts.ts#L27-L31" + }, + { + "kind": "interface", + "name": { + "name": "FollowStats", + "namespace": "ccr.stats" + }, + "properties": [ + { + "name": "indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FollowIndexStats", + "namespace": "ccr._types" + } + } + } + } + ], + "specLocation": "ccr/stats/types.ts.ts#L41-L43" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets all stats related to cross-cluster replication.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.stats" + }, + "path": [], + "query": [], + "specLocation": "ccr/stats/CcrStatsRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "auto_follow_stats", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AutoFollowStats", + "namespace": "ccr.stats" + } + } + }, + { + "name": "follow_stats", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FollowStats", + "namespace": "ccr.stats" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.stats" + }, + "specLocation": "ccr/stats/CcrStatsResponse.ts#L22-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ccr.unfollow" + }, + "path": [ + { + "description": "The name of the follower index that should be turned into a regular index.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ccr.unfollow" + }, + "specLocation": "ccr/unfollow/UnfollowIndexResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplate", + "namespace": "cluster._types" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "component_template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ComponentTemplateNode", + "namespace": "cluster._types" + } + } + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L26-L29" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateNode", + "namespace": "cluster._types" + }, + "properties": [ + { + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L31-L36" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" + }, + "properties": [ + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } + } + } + }, + { + "name": "mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" + } + } + }, + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AliasDefinition", + "namespace": "indices._types" + } + } + } + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L38-L45" + }, + { + "kind": "interface", + "name": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "decider", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "decision", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AllocationExplainDecision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "explanation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L26-L30" + }, + { + "kind": "enum", + "members": [ + { + "name": "NO" + }, + { + "name": "YES" + }, + { + "name": "THROTTLE" + }, + { + "name": "ALWAYS" + } + ], + "name": { + "name": "AllocationExplainDecision", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/types.ts#L32-L37" + }, + { + "kind": "interface", + "name": { + "name": "AllocationStore", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "allocation_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "found", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "in_sync", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "matching_size_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "matching_sync_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "store_exception", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L39-L46" + }, + { + "kind": "interface", + "name": { + "name": "ClusterInfo", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "NodeDiskUsage", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "shard_sizes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + }, + { + "name": "shard_data_set_sizes", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "shard_paths", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "reserved_sizes", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ReservedSize", + "namespace": "cluster.allocation_explain" + } + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L48-L54" + }, + { + "kind": "interface", + "name": { + "name": "CurrentNode", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "attributes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "transport_address", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TransportAddress", + "namespace": "_types" + } + } + }, + { + "name": "weight_ranking", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L78-L84" + }, + { + "kind": "enum", + "members": [ + { + "name": "yes" + }, + { + "name": "no" + }, + { + "name": "worse_balance" + }, + { + "name": "throttled" + }, + { + "name": "awaiting_info" + }, + { + "name": "allocation_delayed" + }, + { + "name": "no_valid_shard_copy" + }, + { + "name": "no_attempt" + } + ], + "name": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/types.ts#L86-L95" + }, + { + "kind": "interface", + "name": { + "name": "DiskUsage", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "total_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "used_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "free_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "free_disk_percent", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "used_disk_percent", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L62-L69" + }, + { + "kind": "interface", + "name": { + "name": "NodeAllocationExplanation", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "deciders", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "node_attributes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "node_decision", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "node_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AllocationStore", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "transport_address", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TransportAddress", + "namespace": "_types" + } + } + }, + { + "name": "weight_ranking", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L97-L106" + }, + { + "kind": "interface", + "name": { + "name": "NodeDiskUsage", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "node_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "least_available", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DiskUsage", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "most_available", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DiskUsage", + "namespace": "cluster.allocation_explain" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L56-L60" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.", + "name": "current_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies the name of the index that you would like an explanation for.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "description": "If true, returns explanation for the primary shard for the given shard ID.", + "name": "primary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies the ID of the shard that you would like an explanation for.", + "name": "shard", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] + }, + "description": "Provides explanations for shard allocations in the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.allocation_explain" + }, + "path": [], + "query": [ + { + "description": "If true, returns information about disk usage and shard sizes.", + "name": "include_disk_info", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, returns YES decisions in explanation.", + "name": "include_yes_decisions", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L24-L60" + }, + { + "kind": "interface", + "name": { + "name": "ReservedSize", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "shards", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L71-L76" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "allocate_explanation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "allocation_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "allocation_delay_in_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "can_allocate", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_move_to_other_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_rebalance_cluster", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_rebalance_cluster_decisions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "can_rebalance_to_other_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "can_remain_decisions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AllocationDecision", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "can_remain_on_current_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Decision", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "cluster_info", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterInfo", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "configured_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "configured_delay_in_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "current_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CurrentNode", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "current_state", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "move_explanation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "node_allocation_decisions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodeAllocationExplanation", + "namespace": "cluster.allocation_explain" + } + } + } + }, + { + "name": "primary", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rebalance_explanation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "remaining_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "remaining_delay_in_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "unassigned_info", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "UnassignedInformation", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "note", + "required": false, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainResponse.ts#L31-L60" + }, + { + "kind": "interface", + "name": { + "name": "UnassignedInformation", + "namespace": "cluster.allocation_explain" + }, + "properties": [ + { + "name": "at", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "name": "last_allocation_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "reason", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "UnassignedInformationReason", + "namespace": "cluster.allocation_explain" + } + } + }, + { + "name": "details", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "failed_allocation_attempts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "delayed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "allocation_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/allocation_explain/types.ts#L117-L125" + }, + { + "kind": "enum", + "members": [ + { + "name": "INDEX_CREATED" + }, + { + "name": "CLUSTER_RECOVERED" + }, + { + "name": "INDEX_REOPENED" + }, + { + "name": "DANGLING_INDEX_IMPORTED" + }, + { + "name": "NEW_INDEX_RESTORED" + }, + { + "name": "EXISTING_INDEX_RESTORED" + }, + { + "name": "REPLICA_ADDED" + }, + { + "name": "ALLOCATION_FAILED" + }, + { + "name": "NODE_LEFT" + }, + { + "name": "REROUTE_CANCELLED" + }, + { + "name": "REINITIALIZED" + }, + { + "name": "REALLOCATED_REPLICA" + }, + { + "name": "PRIMARY_FAILED" + }, + { + "name": "FORCED_EMPTY_PRIMARY" + }, + { + "name": "MANUAL_ALLOCATION" + } + ], + "name": { + "name": "UnassignedInformationReason", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/types.ts#L127-L146" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes a component template", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.delete_component_template" + }, + "path": [ + { + "description": "The name of the template", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L39" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.delete_component_template" + }, + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Clears cluster voting config exclusions.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.delete_voting_config_exclusions" + }, + "path": [], + "query": [ + { + "description": "Specifies whether to wait for all excluded nodes to be removed from the\ncluster before clearing the voting configuration exclusions list.\nDefaults to true, meaning that all excluded nodes must be removed from\nthe cluster before this API takes any action. If set to false then the\nvoting configuration exclusions list is cleared even if some excluded\nnodes are still in the cluster.", + "name": "wait_for_removal", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts#L22-L40" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.delete_voting_config_exclusions" + }, + "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about whether a particular component template exist", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.exists_component_template" + }, + "path": [ + { + "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L52" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.exists_component_template" + }, + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns one or more component templates", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.get_component_template" + }, + "path": [ + { + "description": "The comma separated names of the component templates", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "name": "flat_settings", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L41" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "component_templates", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ComponentTemplate", + "namespace": "cluster._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.get_component_template" + }, + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns cluster settings.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.get_settings" + }, + "path": [], + "query": [ + { + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether to return all default clusters setting.", + "name": "include_defaults", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L35" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "persistent", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "transient", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "defaults", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.get_settings" + }, + "specLocation": "cluster/get_settings/ClusterGetSettingsResponse.ts#L23-L29" + }, + { + "kind": "interface", + "name": { + "name": "IndexHealthStats", + "namespace": "cluster.health" + }, + "properties": [ + { + "name": "active_primary_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "active_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "initializing_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "number_of_replicas", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "number_of_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "relocating_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "shards", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ShardHealthStats", + "namespace": "cluster.health" + } + } + } + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "HealthStatus", + "namespace": "_types" + } + } + }, + { + "name": "unassigned_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/health/types.ts#L24-L34" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns basic information about the health of the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.health" + }, + "path": [ + { + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Can be one of cluster, indices or shards. Controls the details level of the health information returned.", + "name": "level", + "required": false, + "serverDefault": "cluster", + "type": { + "kind": "instance_of", + "type": { + "name": "Level", + "namespace": "_types" + } + } + }, + { + "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.", + "name": "wait_for_active_shards", + "required": false, + "serverDefault": "0", + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForActiveShards", + "namespace": "_types" + } + } + }, + { + "description": "Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.", + "name": "wait_for_events", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForEvents", + "namespace": "_types" + } + } + }, + { + "description": "The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status.", + "name": "wait_for_status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "HealthStatus", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/health/ClusterHealthRequest.ts#L31-L95" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "The number of active primary shards.", + "name": "active_primary_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The total number of active primary and replica shards.", + "name": "active_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The ratio of active shards in the cluster expressed as a percentage.", + "name": "active_shards_percent_as_number", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Percentage", + "namespace": "_types" + } + } + }, + { + "description": "The name of the cluster.", + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The number of shards whose allocation has been delayed by the timeout settings.", + "name": "delayed_unassigned_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "indices", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexHealthStats", + "namespace": "cluster.health" + } + } + } + }, + { + "description": "The number of shards that are under initialization.", + "name": "initializing_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of nodes that are dedicated data nodes.", + "name": "number_of_data_nodes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "number_of_in_flight_fetch", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of nodes within the cluster.", + "name": "number_of_nodes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of cluster-level changes that have not yet been executed.", + "name": "number_of_pending_tasks", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of shards that are under relocation.", + "name": "relocating_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "HealthStatus", + "namespace": "_types" + } + } + }, + { + "description": "The time expressed in milliseconds since the earliest initiated task is waiting for being performed.", + "name": "task_max_waiting_in_queue_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "description": "If false the response returned within the period of time that is specified by the timeout parameter (30s by default)", + "name": "timed_out", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The number of shards that are not allocated.", + "name": "unassigned_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.health" + }, + "specLocation": "cluster/health/ClusterHealthResponse.ts#L26-L60" + }, + { + "kind": "interface", + "name": { + "name": "ShardHealthStats", + "namespace": "cluster.health" + }, + "properties": [ + { + "name": "active_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "initializing_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "primary_active", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "relocating_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "HealthStatus", + "namespace": "_types" + } + } + }, + { + "name": "unassigned_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/health/types.ts#L36-L43" + }, + { + "kind": "interface", + "name": { + "name": "PendingTask", + "namespace": "cluster.pending_tasks" + }, + "properties": [ + { + "name": "executing", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "insert_order", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "priority", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "time_in_queue", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "time_in_queue_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/pending_tasks/types.ts#L22-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a list of any cluster-level changes (e.g. create index, update mapping,\nallocate or fail shard) which have not yet been executed.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.pending_tasks" + }, + "path": [], + "query": [ + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/pending_tasks/ClusterPendingTasksRequest.ts#L23-L34" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "tasks", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PendingTask", + "namespace": "cluster.pending_tasks" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.pending_tasks" + }, + "specLocation": "cluster/pending_tasks/ClusterPendingTasksResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Updates the cluster voting config exclusions by node ids or node names.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.post_voting_config_exclusions" + }, + "path": [], + "query": [ + { + "description": "A comma-separated list of the names of the nodes to exclude from the\nvoting configuration. If specified, you may not also specify node_ids.", + "name": "node_names", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of the persistent ids of the nodes to exclude\nfrom the voting configuration. If specified, you may not also specify node_names.", + "name": "node_ids", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } + }, + { + "description": "When adding a voting configuration exclusion, the API waits for the\nspecified nodes to be excluded from the voting configuration before\nreturning. If the timeout expires before the appropriate condition\nis satisfied, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts#L24-L50" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.post_voting_config_exclusions" + }, + "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexState", + "namespace": "indices._types" + } + } + }, + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AliasDefinition", + "namespace": "indices._types" + } + } + } + }, + { + "name": "mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + } + ] + }, + "description": "Creates or updates a component template", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.put_component_template" + }, + "path": [ + { + "description": "The name of the template", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether the index template should only be added if new or can also replace an existing one", + "name": "create", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L53" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.put_component_template" + }, + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "persistent", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "transient", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "description": "Updates the cluster settings.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.put_settings" + }, + "path": [], + "query": [ + { + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L42" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "persistent", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "transient", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.put_settings" + }, + "specLocation": "cluster/put_settings/ClusterPutSettingsResponse.ts#L23-L29" + }, + { + "kind": "type_alias", + "name": { + "name": "ClusterRemoteInfo", + "namespace": "cluster.remote_info" + }, + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L29-L30", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteSniffInfo", + "namespace": "cluster.remote_info" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteProxyInfo", + "namespace": "cluster.remote_info" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "mode" + } + }, + { + "kind": "interface", + "name": { + "name": "ClusterRemoteProxyInfo", + "namespace": "cluster.remote_info" + }, + "properties": [ + { + "name": "mode", + "required": true, + "type": { + "kind": "literal_value", + "value": "proxy" + } + }, + { + "name": "connected", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "initial_connect_timeout", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "skip_unavailable", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "proxy_address", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "server_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "num_proxy_sockets_connected", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "max_proxy_socket_connections", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L42-L51" + }, + { + "kind": "interface", + "name": { + "name": "ClusterRemoteSniffInfo", + "namespace": "cluster.remote_info" + }, + "properties": [ + { + "name": "mode", + "required": true, + "type": { + "kind": "literal_value", + "value": "sniff" + } + }, + { + "name": "connected", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "max_connections_per_cluster", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "num_nodes_connected", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "initial_connect_timeout", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "skip_unavailable", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "seeds", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L40" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "The cluster remote info API allows you to retrieve all of the configured\nremote cluster information. It returns connection and endpoint information\nkeyed by the configured remote cluster alias.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.remote_info" + }, + "path": [], + "query": [], + "specLocation": "cluster/remote_info/ClusterRemoteInfoRequest.ts#L23-L31" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteInfo", + "namespace": "cluster.remote_info" + } + } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.remote_info" + }, + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L24-L27" + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html#cluster-reroute-api-request-body", + "kind": "interface", + "name": { + "name": "Command", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "description": "Cancel allocation of a shard (or recovery). Accepts index and shard for index name and shard number, and node for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of a primary shard then the allow_primary flag must also be included in the request.", + "name": "cancel", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommandCancelAction", + "namespace": "cluster.reroute" + } + } + }, + { + "description": "Move a started shard from one node to another node. Accepts index and shard for index name and shard number, from_node for the node to move the shard from, and to_node for the node to move the shard to.", + "name": "move", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommandMoveAction", + "namespace": "cluster.reroute" + } + } + }, + { + "description": "Allocate an unassigned replica shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Takes allocation deciders into account.", + "name": "allocate_replica", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommandAllocateReplicaAction", + "namespace": "cluster.reroute" + } + } + }, + { + "description": "Allocate a primary shard to a node that holds a stale copy. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.", + "name": "allocate_stale_primary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommandAllocatePrimaryAction", + "namespace": "cluster.reroute" + } + } + }, + { + "description": "Allocate an empty primary shard to a node. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.", + "name": "allocate_empty_primary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommandAllocatePrimaryAction", + "namespace": "cluster.reroute" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L23-L45" + }, + { + "kind": "interface", + "name": { + "name": "CommandAllocatePrimaryAction", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true", + "name": "accept_data_loss", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L80-L86" + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html", + "kind": "interface", + "name": { + "name": "CommandAllocateReplicaAction", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L71-L78" + }, + { + "kind": "interface", + "name": { + "name": "CommandCancelAction", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "allow_primary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L47-L52" + }, + { + "kind": "interface", + "name": { + "name": "CommandMoveAction", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The node to move the shard from", + "name": "from_node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The node to move the shard to", + "name": "to_node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L62-L69" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Defines the commands to perform.", + "name": "commands", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Command", + "namespace": "cluster.reroute" + } + } + } + } + ] + }, + "description": "Allows to manually change the allocation of individual shards in the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.reroute" + }, + "path": [], + "query": [ + { + "description": "If true, then the request simulates the operation only and returns the resulting state.", + "name": "dry_run", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, then the response contains an explanation of why the commands can or cannot be executed.", + "name": "explain", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Limits the information returned to the specified metrics.", + "name": "metric", + "required": false, + "serverDefault": "all", + "type": { + "kind": "instance_of", + "type": { + "name": "Metrics", + "namespace": "_types" + } + } + }, + { + "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", + "name": "retry_failed", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/reroute/ClusterRerouteRequest.ts#L25-L69" + }, + { + "kind": "interface", + "name": { + "name": "RerouteDecision", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "decider", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "decision", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "explanation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L88-L92" + }, + { + "kind": "interface", + "name": { + "name": "RerouteExplanation", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "command", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "decisions", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RerouteDecision", + "namespace": "cluster.reroute" + } + } + } + }, + { + "name": "parameters", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RerouteParameters", + "namespace": "cluster.reroute" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L94-L98" + }, + { + "kind": "interface", + "name": { + "name": "RerouteParameters", + "namespace": "cluster.reroute" + }, + "properties": [ + { + "name": "allow_primary", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeName", + "namespace": "_types" + } + } + }, + { + "name": "shard", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "from_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeName", + "namespace": "_types" + } + } + }, + { + "name": "to_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeName", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/reroute/types.ts#L100-L107" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "explanations", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RerouteExplanation", + "namespace": "cluster.reroute" } } } + }, + { + "description": "There aren't any guarantees on the output/structure of the raw cluster state.\nHere you will find the internal representation of the cluster, which can\ndiffer from the external representation.", + "name": "state", + "required": true, + "type": { + "kind": "user_defined_value" + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.reroute" + }, + "specLocation": "cluster/reroute/ClusterRerouteResponse.ts#L23-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a comprehensive information about the state of the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "cluster.state" + }, + "path": [ + { + "description": "Limit the information returned to the specified metrics", + "name": "metric", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metrics", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Wait for the metadata version to be equal or greater than the specified metadata version", + "name": "wait_for_metadata_version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "description": "The maximum time to wait for wait_for_metadata_version before timing out", + "name": "wait_for_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L55" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "user_defined_value" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "cluster.state" + }, + "specLocation": "cluster/state/ClusterStateResponse.ts#L22-L29" + }, + { + "kind": "interface", + "name": { + "name": "CharFilterTypes", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "char_filter_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "tokenizer_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "filter_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "analyzer_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "built_in_char_filters", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "built_in_tokenizers", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "built_in_filters", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "built_in_analyzers", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldTypes", + "namespace": "cluster.stats" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L125-L134" + }, + { + "kind": "interface", + "name": { + "name": "ClusterFileSystem", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "available_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "free_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "total_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L33-L37" + }, + { + "kind": "interface", + "name": { + "name": "ClusterIndices", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains statistics about memory used for completion in selected nodes.", + "name": "completion", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "CompletionStats", + "namespace": "_types" + } + } + }, + { + "description": "Total number of indices with shards assigned to selected nodes.", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Contains counts for documents in selected nodes.", + "name": "docs", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DocStats", + "namespace": "_types" + } + } + }, + { + "description": "Contains statistics about the field data cache of selected nodes.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-fielddata.html", + "name": "fielddata", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FielddataStats", + "namespace": "_types" + } + } + }, + { + "description": "Contains statistics about the query cache of selected nodes.", + "name": "query_cache", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryCacheStats", + "namespace": "_types" + } + } + }, + { + "description": "Contains statistics about segments in selected nodes.", + "name": "segments", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SegmentsStats", + "namespace": "_types" + } + } + }, + { + "description": "Contains statistics about indices with shards assigned to selected nodes.", + "name": "shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterIndicesShards", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the size of shards assigned to selected nodes.", + "name": "store", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "StoreStats", + "namespace": "_types" + } + } + }, + { + "description": "Contains statistics about field mappings in selected nodes.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html", + "name": "mappings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldTypesMappings", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analyzer-anatomy.html", + "name": "analysis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "CharFilterTypes", + "namespace": "cluster.stats" + } + } + }, + { + "name": "versions", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesVersions", + "namespace": "cluster.stats" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L62-L93" + }, + { + "description": "Contains statistics about shards assigned to selected nodes.", + "kind": "interface", + "name": { + "name": "ClusterIndicesShards", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains statistics about shards assigned to selected nodes.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterIndicesShardsIndex", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Number of primary shards assigned to selected nodes.", + "name": "primaries", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "Ratio of replica shards to primary shards across all selected nodes.", + "name": "replication", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "Total number of shards assigned to selected nodes.", + "name": "total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L48-L60" + }, + { + "kind": "interface", + "name": { + "name": "ClusterIndicesShardsIndex", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains statistics about the number of primary shards assigned to selected nodes.", + "name": "primaries", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the number of replication shards assigned to selected nodes.", + "name": "replication", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the number of shards assigned to selected nodes.", + "name": "shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L39-L46" + }, + { + "kind": "interface", + "name": { + "name": "ClusterIngest", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "number_of_pipelines", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "processor_stats", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterProcessor", + "namespace": "cluster.stats" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L143-L146" + }, + { + "kind": "interface", + "name": { + "name": "ClusterJvm", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "max_uptime_in_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "mem", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterJvmMemory", + "namespace": "cluster.stats" + } + } + }, + { + "name": "threads", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "versions", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterJvmVersion", + "namespace": "cluster.stats" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L148-L153" + }, + { + "kind": "interface", + "name": { + "name": "ClusterJvmMemory", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "heap_max_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "heap_used_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L155-L158" + }, + { + "kind": "interface", + "name": { + "name": "ClusterJvmVersion", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "bundled_jdk", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.follow_info" - } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "using_bundled_jdk", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, + { + "name": "vm_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "vm_vendor", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "vm_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L160-L168" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "follower_cluster", - "required": false, - "type": { + "kind": "interface", + "name": { + "name": "ClusterNetworkTypes", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "http_types", + "required": true, + "type": { + "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } - } - }, - { - "name": "follower_index", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } - }, - { - "name": "follower_index_uuid", - "required": false, - "type": { + } + }, + { + "name": "transport_types", + "required": true, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "leader_remote_cluster", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", + ], + "specLocation": "cluster/stats/types.ts#L170-L173" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ccr.forget_follower_index" + "name": "ClusterNodeCount", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ { - "name": "index", + "name": "coordinating_only", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "data", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "ingest", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "master", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "voting_only", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "data_cold", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "data_frozen", + "required": false, + "since": "7.13.0", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "data_content", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "data_warm", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "data_hot", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "ml", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "remote_cluster_client", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "transform", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } } ], - "query": [] + "specLocation": "cluster/stats/types.ts#L175-L191" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "_shards", - "required": true, + "kind": "interface", + "name": { + "name": "ClusterNodes", + "namespace": "cluster.stats" + }, + "properties": [ + { + "description": "Contains counts for nodes selected by the request’s node filters.", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", "type": { + "name": "ClusterNodeCount", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the discovery types used by selected nodes.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-hosts-providers.html", + "name": "discovery_types", + "required": true, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.forget_follower_index" - } - }, - { - "kind": "interface", - "name": { - "name": "AutoFollowPattern", - "namespace": "ccr.get_auto_follow_pattern" - }, - "properties": [ + }, { - "name": "name", + "description": "Contains statistics about file stores by selected nodes.", + "name": "fs", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "ClusterFileSystem", + "namespace": "cluster.stats" } } }, { - "name": "pattern", + "name": "ingest", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AutoFollowPatternSummary", - "namespace": "ccr.get_auto_follow_pattern" + "name": "ClusterIngest", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.", + "name": "jvm", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterJvm", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the transport and HTTP networks used by selected nodes.", + "name": "network_types", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterNetworkTypes", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about the operating systems used by selected nodes.", + "name": "os", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterOperatingSystem", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Contains statistics about Elasticsearch distributions installed on selected nodes.", + "name": "packaging_types", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodePackagingType", + "namespace": "cluster.stats" + } + } + } + }, + { + "description": "Contains statistics about installed plugins and modules by selected nodes.", + "name": "plugins", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PluginStats", + "namespace": "_types" + } + } + } + }, + { + "description": "Contains statistics about processes used by selected nodes.", + "name": "process", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterProcess", + "namespace": "cluster.stats" + } + } + }, + { + "description": "Array of Elasticsearch versions used on selected nodes.", + "name": "versions", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } } } } - ] + ], + "specLocation": "cluster/stats/types.ts#L193-L218" }, { "kind": "interface", "name": { - "name": "AutoFollowPatternSummary", - "namespace": "ccr.get_auto_follow_pattern" + "name": "ClusterOperatingSystem", + "namespace": "cluster.stats" }, "properties": [ { - "name": "active", + "name": "allocated_processors", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "remote_cluster", + "name": "available_processors", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "follow_index_pattern", - "required": false, + "name": "mem", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexPattern", - "namespace": "_types" + "name": "OperatingSystemMemoryInfo", + "namespace": "cluster.stats" } } }, { - "name": "leader_index_patterns", + "name": "names", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterOperatingSystemName", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "pretty_names", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterOperatingSystemPrettyName", + "namespace": "cluster.stats" + } + } + } + }, + { + "name": "architectures", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterOperatingSystemArchitecture", + "namespace": "cluster.stats" + } + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L225-L232" + }, + { + "kind": "interface", + "name": { + "name": "ClusterOperatingSystemArchitecture", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexPatterns", + "name": "integer", "namespace": "_types" } } }, { - "name": "max_outstanding_read_requests", + "name": "arch", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "cluster/stats/types.ts#L220-L223" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ccr.get_auto_follow_pattern" + "name": "ClusterOperatingSystemName", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { - "description": "Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.", "name": "name", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -71313,55 +89610,28 @@ } } ], - "query": [] + "specLocation": "cluster/stats/types.ts#L234-L237" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "patterns", - "required": true, + "kind": "interface", + "name": { + "name": "ClusterOperatingSystemPrettyName", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AutoFollowPattern", - "namespace": "ccr.get_auto_follow_pattern" - } - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.get_auto_follow_pattern" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ccr.pause_auto_follow_pattern" - }, - "path": [ + }, { - "name": "name", + "name": "pretty_name", "required": true, "type": { "kind": "instance_of", @@ -71372,297 +89642,455 @@ } } ], - "query": [] + "specLocation": "cluster/stats/types.ts#L239-L242" }, { - "body": { - "kind": "properties", - "properties": [] + "kind": "interface", + "name": { + "name": "ClusterProcess", + "namespace": "cluster.stats" }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "properties": [ + { + "name": "cpu", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterProcessCpu", + "namespace": "cluster.stats" + } + } + }, + { + "name": "open_file_descriptors", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ClusterProcessOpenFileDescriptors", + "namespace": "cluster.stats" + } + } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.pause_auto_follow_pattern" - } + ], + "specLocation": "cluster/stats/types.ts#L244-L247" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ccr.pause_follow_index" + "name": "ClusterProcessCpu", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ { - "name": "index", + "name": "percent", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } } ], - "query": [] + "specLocation": "cluster/stats/types.ts#L249-L251" }, { - "body": { - "kind": "properties", - "properties": [] + "kind": "interface", + "name": { + "name": "ClusterProcessOpenFileDescriptors", + "namespace": "cluster.stats" }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "properties": [ + { + "name": "avg", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "min", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.pause_follow_index" - } + ], + "specLocation": "cluster/stats/types.ts#L253-L257" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "remote_cluster", - "required": true, + "kind": "interface", + "name": { + "name": "ClusterProcessor", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "follow_index_pattern", - "required": false, + } + }, + { + "name": "current", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "IndexPattern", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "leader_index_patterns", - "required": false, + } + }, + { + "name": "failed", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "IndexPatterns", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "max_outstanding_read_requests", - "required": false, - "serverDefault": "12", + } + }, + { + "name": "time_in_millis", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "settings", - "required": false, + } + } + ], + "specLocation": "cluster/stats/types.ts#L259-L264" + }, + { + "kind": "interface", + "name": { + "name": "ClusterShardMetrics", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "avg", + "required": true, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + "name": "double", + "namespace": "_types" } - }, - { - "name": "max_outstanding_write_requests", - "required": false, - "serverDefault": "9", + } + }, + { + "name": "max", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "double", + "namespace": "_types" } - }, - { - "name": "read_poll_timeout", - "required": false, - "serverDefault": "1m", + } + }, + { + "name": "min", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "double", + "namespace": "_types" } - }, - { - "name": "max_read_request_operation_count", - "required": false, - "serverDefault": "5120", + } + } + ], + "specLocation": "cluster/stats/types.ts#L266-L270" + }, + { + "kind": "interface", + "name": { + "name": "FieldTypes", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "Name", + "namespace": "_types" } - }, - { - "name": "max_read_request_size", - "required": false, - "serverDefault": "32mb", + } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "index_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "script_count", + "required": false, + "since": "7.13.0", + "type": { + "kind": "instance_of", "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "cluster/stats/types.ts#L100-L106" + }, + { + "kind": "interface", + "name": { + "name": "FieldTypesMappings", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "field_types", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "FieldTypes", + "namespace": "cluster.stats" } } - }, - { - "name": "max_retry_delay", - "required": false, - "serverDefault": "500ms", - "type": { + } + }, + { + "name": "runtime_field_types", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "RuntimeFieldTypes", + "namespace": "cluster.stats" } } - }, - { - "name": "max_write_buffer_count", - "required": false, - "serverDefault": "2147483647", + } + } + ], + "specLocation": "cluster/stats/types.ts#L95-L98" + }, + { + "kind": "interface", + "name": { + "name": "IndicesVersions", + "namespace": "cluster.stats" + }, + "properties": [ + { + "name": "index_count", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "max_write_buffer_size", - "required": false, - "serverDefault": "512mb", + } + }, + { + "name": "primary_shard_count", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "max_write_request_operation_count", - "required": false, - "serverDefault": "5120", + } + }, + { + "name": "total_primary_bytes", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "max_write_request_size", - "required": false, - "serverDefault": "9223372036854775807b", + } + }, + { + "name": "version", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } + "name": "VersionString", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", + ], + "specLocation": "cluster/stats/types.ts#L136-L141" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ccr.put_auto_follow_pattern" + "name": "NodePackagingType", + "namespace": "cluster.stats" }, - "path": [ + "properties": [ { - "name": "name", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } + }, + { + "name": "flavor", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "query": [] + "specLocation": "cluster/stats/types.ts#L272-L276" }, { - "body": { - "kind": "properties", - "properties": [] + "kind": "interface", + "name": { + "name": "OperatingSystemMemoryInfo", + "namespace": "cluster.stats" }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "properties": [ + { + "name": "free_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "free_percent", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "total_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "used_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "used_percent", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.put_auto_follow_pattern" - } + ], + "specLocation": "cluster/stats/types.ts#L278-L284" }, { "attachedBehaviors": [ @@ -71671,6 +90099,7 @@ "body": { "kind": "no_body" }, + "description": "Returns high-level overview of cluster statistics.", "inherits": { "type": { "name": "RequestBase", @@ -71680,127 +90109,121 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.resume_auto_follow_pattern" + "namespace": "cluster.stats" }, "path": [ { - "name": "name", - "required": true, + "description": "Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.", + "name": "node_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "NodeIds", "namespace": "_types" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "query": [ + { + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.resume_auto_follow_pattern" - } + ], + "specLocation": "cluster/stats/ClusterStatsRequest.ts#L24-L39" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "max_outstanding_read_requests", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_outstanding_write_requests", - "required": false, + "description": "Name of the cluster, based on the Cluster name setting setting.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name", + "name": "cluster_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Name", "namespace": "_types" } } }, { - "name": "max_read_request_operation_count", - "required": false, + "description": "Unique identifier for the cluster.", + "name": "cluster_uuid", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Uuid", "namespace": "_types" } } }, { - "name": "max_read_request_size", - "required": false, + "description": "Contains statistics about indices with shards assigned to selected nodes.", + "name": "indices", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ClusterIndices", + "namespace": "cluster.stats" } } }, { - "name": "max_retry_delay", - "required": false, + "description": "Contains statistics about nodes selected by the request’s node filters.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "name": "nodes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "ClusterNodes", + "namespace": "cluster.stats" } } }, { - "name": "max_write_buffer_count", - "required": false, + "description": "Health status of the cluster, based on the state of its primary and replica shards.", + "name": "status", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "HealthStatus", "namespace": "_types" } } }, { - "name": "max_write_buffer_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "max_write_request_operation_count", - "required": false, + "description": "Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.", + "docUrl": "https://en.wikipedia.org/wiki/Unix_time", + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { @@ -71808,208 +90231,188 @@ "namespace": "_types" } } - }, - { - "name": "max_write_request_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "read_poll_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } } ] }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "NodesResponseBase", + "namespace": "nodes._types" } }, - "kind": "request", + "kind": "response", "name": { - "name": "Request", - "namespace": "ccr.resume_follow_index" + "name": "Response", + "namespace": "cluster.stats" }, - "path": [ + "specLocation": "cluster/stats/ClusterStatsResponse.ts#L25-L55" + }, + { + "kind": "interface", + "name": { + "name": "RuntimeFieldTypes", + "namespace": "cluster.stats" + }, + "properties": [ { - "name": "index", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Name", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ccr.resume_follow_index" - } - }, - { - "kind": "interface", - "name": { - "name": "AutoFollowStats", - "namespace": "ccr.stats" - }, - "properties": [ + }, { - "name": "auto_followed_clusters", + "name": "count", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AutoFollowedCluster", - "namespace": "ccr.stats" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "number_of_failed_follow_indices", + "name": "index_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "number_of_failed_remote_cluster_state_requests", + "name": "scriptless_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "number_of_successful_follow_indices", + "name": "shadowed_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "recent_auto_follow_errors", + "name": "lang", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ErrorCause", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "AutoFollowedCluster", - "namespace": "ccr.stats" - }, - "properties": [ + }, { - "name": "cluster_name", + "name": "lines_max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } }, { - "name": "last_seen_metadata_version", + "name": "lines_total", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "integer", "namespace": "_types" } } }, { - "name": "time_since_last_check_millis", + "name": "chars_max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FollowStats", - "namespace": "ccr.stats" - }, - "properties": [ + }, { - "name": "indices", + "name": "chars_total", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FollowIndexStats", - "namespace": "ccr._types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "source_max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "source_total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "doc_max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "doc_total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } - ] + ], + "specLocation": "cluster/stats/types.ts#L108-L123" }, { "attachedBehaviors": [ @@ -72018,6 +90421,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes the specified dangling index", "inherits": { "type": { "name": "RequestBase", @@ -72027,44 +90431,79 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.stats" + "namespace": "dangling_indices.delete_dangling_index" }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "auto_follow_stats", - "required": true, + "path": [ + { + "description": "The UUID of the dangling index", + "name": "index_uuid", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "AutoFollowStats", - "namespace": "ccr.stats" - } + "name": "Uuid", + "namespace": "_types" } - }, - { - "name": "follow_stats", - "required": true, + } + } + ], + "query": [ + { + "description": "Must be set to true in order to delete the dangling index", + "name": "accept_data_loss", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "FollowStats", - "namespace": "ccr.stats" - } + "name": "boolean", + "namespace": "_builtins" } } - ] + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L38" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ccr.stats" - } + "namespace": "dangling_indices.delete_dangling_index" + }, + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -72073,6 +90512,7 @@ "body": { "kind": "no_body" }, + "description": "Imports the specified dangling index", "inherits": { "type": { "name": "RequestBase", @@ -72082,22 +90522,61 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ccr.unfollow_index" + "namespace": "dangling_indices.import_dangling_index" }, "path": [ { - "name": "index", + "description": "The UUID of the dangling index", + "name": "index_uuid", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Uuid", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Must be set to true in order to import the dangling index", + "name": "accept_data_loss", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } ], - "query": [] + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L38" }, { "body": { @@ -72113,1245 +90592,2019 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ccr.unfollow_index" - } + "namespace": "dangling_indices.import_dangling_index" + }, + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts#L22-L22" }, { "kind": "interface", "name": { - "name": "ClusterStateBlockIndex", - "namespace": "cluster._types" + "name": "DanglingIndex", + "namespace": "dangling_indices.list_dangling_indices" }, "properties": [ { - "name": "description", - "required": false, + "name": "index_name", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "retryable", - "required": false, + "name": "index_uuid", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "levels", - "required": false, + "name": "creation_date_millis", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" } } }, { - "name": "aliases", - "required": false, + "name": "node_ids", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexAlias", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } + } + ], + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L29-L34" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns all dangling indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "dangling_indices.list_dangling_indices" + }, + "path": [], + "query": [], + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "dangling_indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DanglingIndex", + "namespace": "dangling_indices.list_dangling_indices" + } } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "dangling_indices.list_dangling_indices" + }, + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L23-L27" + }, + { + "kind": "interface", + "name": { + "name": "Policy", + "namespace": "enrich._types" + }, + "properties": [ { - "name": "aliases_version", - "required": false, + "name": "enrich_fields", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Fields", "namespace": "_types" } } }, { - "name": "version", - "required": false, + "name": "indices", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Indices", "namespace": "_types" } } }, { - "name": "mapping_version", - "required": false, + "name": "match_field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Field", "namespace": "_types" } } }, { - "name": "settings_version", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "routing_num_shards", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Name", "namespace": "_types" } } }, { - "name": "state", + "name": "elasticsearch_version", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } + } + ], + "specLocation": "enrich/_types/Policy.ts#L33-L40" + }, + { + "kind": "enum", + "members": [ + { + "name": "geo_match" }, { - "name": "settings", - "required": false, + "name": "match" + }, + { + "name": "range" + } + ], + "name": { + "name": "PolicyType", + "namespace": "enrich._types" + }, + "specLocation": "enrich/_types/Policy.ts#L27-L31" + }, + { + "kind": "interface", + "name": { + "name": "Summary", + "namespace": "enrich._types" + }, + "properties": [ + { + "name": "config", + "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "PolicyType", + "namespace": "enrich._types" } }, "kind": "dictionary_of", - "singleKey": false, + "singleKey": true, "value": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "Policy", + "namespace": "enrich._types" } } } - }, + } + ], + "specLocation": "enrich/_types/Policy.ts#L23-L25" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an existing enrich policy and its enrich index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.delete_policy" + }, + "path": [ { - "name": "in_sync_allocations", - "required": false, + "description": "The name of the enrich policy", + "name": "name", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } + } + ], + "query": [], + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.delete_policy" + }, + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyResponse.ts#L22-L22" + }, + { + "kind": "enum", + "members": [ + { + "name": "SCHEDULED" }, { - "name": "primary_terms", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } + "name": "RUNNING" }, { - "name": "mappings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - } + "name": "COMPLETE" }, { - "name": "rollover_info", - "required": false, + "name": "FAILED" + } + ], + "name": { + "name": "EnrichPolicyPhase", + "namespace": "enrich.execute_policy" + }, + "specLocation": "enrich/execute_policy/types.ts#L24-L29" + }, + { + "kind": "interface", + "name": { + "name": "ExecuteEnrichPolicyStatus", + "namespace": "enrich.execute_policy" + }, + "properties": [ + { + "name": "phase", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "RolloverConditions", - "namespace": "indices.rollover" - } + "kind": "instance_of", + "type": { + "name": "EnrichPolicyPhase", + "namespace": "enrich.execute_policy" } } - }, + } + ], + "specLocation": "enrich/execute_policy/types.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Creates the enrich index for an existing enrich policy.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.execute_policy" + }, + "path": [ { - "name": "timestamp_range", - "required": false, + "description": "The name of the enrich policy", + "name": "name", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "system", + "description": "Should the request should block until the execution is complete.", + "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L35" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ExecuteEnrichPolicyStatus", + "namespace": "enrich.execute_policy" + } + } + }, + { + "name": "task_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskId", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", "name": { - "name": "ClusterStateDeletedSnapshots", - "namespace": "cluster._types" + "name": "Response", + "namespace": "enrich.execute_policy" }, - "properties": [ + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets information about an enrich policy.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.get_policy" + }, + "path": [ { - "name": "snapshot_deletions", - "required": true, + "description": "A comma-separated list of enrich policy names", + "name": "name", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L23-L32" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "policies", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Summary", + "namespace": "enrich._types" + } + } + } + } + ] + }, + "kind": "response", "name": { - "name": "ClusterStateIndexLifecycle", - "namespace": "cluster._types" + "name": "Response", + "namespace": "enrich.get_policy" }, - "properties": [ - { - "name": "policies", - "required": true, - "type": { - "key": { + "specLocation": "enrich/get_policy/GetEnrichPolicyResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "geo_match", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "Policy", + "namespace": "enrich._types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + } + }, + { + "name": "match", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ClusterStateIndexLifecycleSummary", - "namespace": "cluster._types" + "name": "Policy", + "namespace": "enrich._types" } } } - }, + ] + }, + "description": "Creates a new enrich policy.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.put_policy" + }, + "path": [ { - "name": "operation_mode", + "description": "The name of the enrich policy", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "LifecycleOperationMode", + "name": "Name", "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L37" }, { - "kind": "interface", - "name": { - "name": "ClusterStateIndexLifecyclePolicy", - "namespace": "cluster._types" + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ - { - "name": "phases", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Phases", - "namespace": "ilm._types" - } - } + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.put_policy" + }, + "specLocation": "enrich/put_policy/PutEnrichPolicyResponse.ts#L22-L22" }, { "kind": "interface", "name": { - "name": "ClusterStateIndexLifecycleSummary", - "namespace": "cluster._types" + "name": "CacheStats", + "namespace": "enrich.stats" }, "properties": [ { - "name": "policy", + "name": "node_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterStateIndexLifecyclePolicy", - "namespace": "cluster._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "headers", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "HttpHeaders", + "name": "integer", "namespace": "_types" } } }, { - "name": "version", + "name": "hits", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "integer", "namespace": "_types" } } }, { - "name": "modified_date", + "name": "misses", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "modified_date_string", + "name": "evictions", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "integer", "namespace": "_types" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterStateIngest", - "namespace": "cluster._types" - }, - "properties": [ - { - "name": "pipeline", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterStateIngestPipeline", - "namespace": "cluster._types" - } - } - } - } - ] + ], + "specLocation": "enrich/stats/types.ts#L37-L43" }, { "kind": "interface", "name": { - "name": "ClusterStateIngestPipeline", - "namespace": "cluster._types" + "name": "CoordinatorStats", + "namespace": "enrich.stats" }, "properties": [ { - "name": "id", + "name": "executed_searches_total", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } }, { - "name": "config", + "name": "node_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterStateIngestPipelineConfig", - "namespace": "cluster._types" + "name": "Id", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterStateIngestPipelineConfig", - "namespace": "cluster._types" - }, - "properties": [ + }, { - "name": "description", - "required": false, + "name": "queue_size", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "version", - "required": false, + "name": "remote_requests_current", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "integer", "namespace": "_types" } } }, { - "name": "processors", + "name": "remote_requests_total", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } } - ] + ], + "specLocation": "enrich/stats/types.ts#L29-L35" }, { "kind": "interface", "name": { - "name": "ClusterStateMetadata", - "namespace": "cluster._types" + "name": "ExecutingPolicy", + "namespace": "enrich.stats" }, "properties": [ { - "name": "cluster_uuid", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "Name", "namespace": "_types" } } }, { - "name": "cluster_uuid_committed", + "name": "task", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Info", + "namespace": "tasks._types" } } - }, + } + ], + "specLocation": "enrich/stats/types.ts#L24-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "enrich.stats" + }, + "path": [], + "query": [], + "specLocation": "enrich/stats/EnrichStatsRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "coordinator_stats", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CoordinatorStats", + "namespace": "enrich.stats" + } + } + } + }, + { + "name": "executing_policies", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ExecutingPolicy", + "namespace": "enrich.stats" + } + } + } + }, + { + "name": "cache_stats", + "required": false, + "since": "7.16.0", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CacheStats", + "namespace": "enrich.stats" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "enrich.stats" + }, + "specLocation": "enrich/stats/EnrichStatsResponse.ts#L22-L29" + }, + { + "generics": [ { - "name": "templates", - "required": true, + "name": "TEvent", + "namespace": "eql._types" + } + ], + "kind": "interface", + "name": { + "name": "EqlHits", + "namespace": "eql._types" + }, + "properties": [ + { + "description": "Metadata about the number of matching events or sequences.", + "name": "total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStateMetadataTemplate", - "namespace": "cluster._types" + "name": "TotalHits", + "namespace": "_global.search._types" } } }, { - "name": "indices", + "description": "Contains events matching the query. Each object represents a matching event.", + "name": "events", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types" + } + } + ], "kind": "instance_of", "type": { - "name": "ClusterStateBlockIndex", - "namespace": "cluster._types" + "name": "HitsEvent", + "namespace": "eql._types" } } } }, { - "name": "index-graveyard", - "required": true, + "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "name": "sequences", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateMetadataIndexGraveyard", - "namespace": "cluster._types" + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "HitsSequence", + "namespace": "eql._types" + } } } - }, + } + ], + "specLocation": "eql/_types/EqlHits.ts#L25-L39" + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html#eql-search-api-response-body", + "generics": [ { - "name": "cluster_coordination", - "required": true, + "name": "TEvent", + "namespace": "eql._types" + } + ], + "kind": "interface", + "name": { + "name": "EqlSearchResponseBase", + "namespace": "eql._types" + }, + "properties": [ + { + "description": "Identifier for the search.", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStateMetadataClusterCoordination", - "namespace": "cluster._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "ingest", + "description": "If true, the response does not contain complete search results.", + "name": "is_partial", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStateIngest", - "namespace": "cluster._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "repositories", + "description": "If true, the search request is still executing.", + "name": "is_running", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "component_template", + "description": "Milliseconds it took Elasticsearch to execute the request.", + "name": "took", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "index_template", + "description": "If true, the request timed out before completion.", + "name": "timed_out", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index_lifecycle", - "required": false, + "description": "Contains matching events and sequences. Also contains related metadata.", + "name": "hits", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types" + } + } + ], "kind": "instance_of", "type": { - "name": "ClusterStateIndexLifecycle", - "namespace": "cluster._types" + "name": "EqlHits", + "namespace": "eql._types" } } } - ] + ], + "specLocation": "eql/_types/EqlSearchResponseBase.ts#L24-L52" }, { + "generics": [ + { + "name": "TEvent", + "namespace": "eql._types" + } + ], "kind": "interface", "name": { - "name": "ClusterStateMetadataClusterCoordination", - "namespace": "cluster._types" + "name": "HitsEvent", + "namespace": "eql._types" }, "properties": [ { - "name": "term", + "description": "Name of the index containing the event.", + "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "last_committed_config", + "description": "Unique identifier for the event. This ID is only unique within the index.", + "name": "_id", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } }, { - "name": "last_accepted_config", + "description": "Original JSON body passed for the event at index time.", + "name": "_source", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types" } } }, { - "name": "voting_config_exclusions", - "required": true, + "name": "fields", + "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "VotingConfigExclusionsItem", - "namespace": "cluster._types" + "name": "Field", + "namespace": "_types" } - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterStateMetadataIndexGraveyard", - "namespace": "cluster._types" - }, - "properties": [ - { - "name": "tombstones", - "required": true, - "type": { - "kind": "array_of", + }, + "kind": "dictionary_of", + "singleKey": false, "value": { - "kind": "instance_of", - "type": { - "name": "Tombstone", - "namespace": "cluster._types" + "kind": "array_of", + "value": { + "kind": "user_defined_value" } } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterStateMetadataTemplate", - "namespace": "cluster._types" - }, - "properties": [] + ], + "specLocation": "eql/_types/EqlHits.ts#L41-L49" }, { + "generics": [ + { + "name": "TEvent", + "namespace": "eql._types" + } + ], "kind": "interface", "name": { - "name": "ClusterStateRoutingNodes", - "namespace": "cluster._types" + "name": "HitsSequence", + "namespace": "eql._types" }, "properties": [ { - "name": "unassigned", + "description": "Contains events matching the query. Each object represents a matching event.", + "name": "events", "required": true, "type": { "kind": "array_of", "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types" + } + } + ], "kind": "instance_of", "type": { - "name": "NodeShard", - "namespace": "_types" + "name": "HitsEvent", + "namespace": "eql._types" } } } }, { - "name": "nodes", + "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "name": "join_keys", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "NodeShard", - "namespace": "_types" - } - } + "kind": "user_defined_value" } } } - ] + ], + "specLocation": "eql/_types/EqlHits.ts#L51-L59" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ClusterStateSnapshots", - "namespace": "cluster._types" + "name": "Request", + "namespace": "eql.delete" }, - "properties": [ + "path": [ { - "name": "snapshots", + "description": "Identifier for the search to delete.", + "name": "id", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Status", - "namespace": "snapshot._types" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L33" }, { - "kind": "enum", - "members": [ - { - "description": "All shards are assigned.", - "name": "green" - }, - { - "description": "All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.", - "name": "yellow" - }, - { - "description": "One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.", - "name": "red" + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ], + }, + "kind": "response", "name": { - "name": "ClusterStatus", - "namespace": "cluster._types" - } + "name": "Response", + "namespace": "eql.delete" + }, + "specLocation": "eql/delete/EqlDeleteResponse.ts#L22-L22" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns async results from previously executed Event Query Language (EQL) search", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ComponentTemplate", - "namespace": "cluster._types" + "name": "Request", + "namespace": "eql.get" }, - "properties": [ + "path": [ { - "name": "name", + "description": "Identifier for the search.", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "component_template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" - } - } } - ] - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" - }, - "properties": [ + ], + "query": [ { - "name": "template", - "required": true, + "description": "Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.", + "name": "keep_alive", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" + "name": "Time", + "namespace": "_types" } } }, { - "name": "version", + "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", + "name": "wait_for_completion_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "eql/get/EqlGetRequest.ts#L24-L46" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "generics": [ { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", - "required": false, - "type": { + "name": "TEvent", + "namespace": "eql.get" + } + ], + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "TEvent", + "namespace": "eql.get" } } + ], + "type": { + "name": "EqlSearchResponseBase", + "namespace": "eql._types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "eql.get" + }, + "specLocation": "eql/get/EqlGetResponse.ts#L22-L22" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" + "name": "Request", + "namespace": "eql.get_status" }, - "properties": [ + "path": [ { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", - "required": false, + "description": "Identifier for the search.", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L33" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "Identifier for the search.", + "name": "id", + "required": true, "type": { - "name": "VersionNumber", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - }, - { - "name": "settings", - "required": true, - "type": { - "key": { + }, + { + "description": "If true, the search request is still executing. If false, the search is completed.", + "name": "is_partial", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.", + "name": "is_running", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.", + "name": "start_time_in_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", "namespace": "_types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + } + }, + { + "description": "Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing.", + "name": "expiration_time_in_millis", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "EpochMillis", + "namespace": "_types" } } - } - }, - { - "name": "mappings", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "For a completed search shows the http status code of the completed search.", + "name": "completion_status", + "required": false, "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - }, - { - "name": "aliases", - "required": false, - "type": { - "key": { + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "eql.get_status" + }, + "specLocation": "eql/get_status/EqlGetStatusResponse.ts#L24-L51" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "EQL query you wish to run.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html", + "name": "query", + "required": true, + "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + } + }, + { + "name": "case_sensitive", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Field containing the event classification, such as process, file, or network.", + "name": "event_category_field", + "required": false, + "serverDefault": "event.category", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field used to sort hits with the same timestamp in ascending order", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html#eql-search-specify-a-sort-tiebreaker", + "name": "tiebreaker_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing event timestamp. Default \"@timestamp\"", + "name": "timestamp_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Maximum number of events to search at a time for sequence queries.", + "name": "fetch_size", + "required": false, + "serverDefault": 1000, + "type": { + "kind": "instance_of", + "type": { + "name": "uint", + "namespace": "_types" + } + } + }, + { + "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", + "name": "filter", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" + } + }, + { + "name": "keep_alive", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "keep_on_completion", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "wait_for_completion_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "uint", + "namespace": "_types" + } + } + }, + { + "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", + "name": "fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "result_position", + "required": false, + "serverDefault": "tail", + "type": { "kind": "instance_of", "type": { - "name": "AliasDefinition", - "namespace": "indices._types" + "name": "ResultPosition", + "namespace": "eql.search" } } } + ] + }, + "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ] - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "Tombstone", - "namespace": "cluster._types" + "name": "Request", + "namespace": "eql.search" }, - "properties": [ + "path": [ { + "description": "The name of the index to scope the operation", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TombstoneIndex", - "namespace": "cluster._types" + "name": "IndexName", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "delete_date", + "name": "allow_no_indices", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "delete_date_in_millis", - "required": true, + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ExpandWildcards", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "TombstoneIndex", - "namespace": "cluster._types" - }, - "properties": [ + }, { - "name": "index_name", - "required": true, + "description": "If true, missing or closed indices are not included in the response.", + "name": "ignore_unavailable", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index_uuid", - "required": true, + "description": "Period for which the search and its results are stored on the cluster.", + "name": "keep_alive", + "required": false, + "serverDefault": "5d", "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "Time", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "VotingConfigExclusionsItem", - "namespace": "cluster._types" - }, - "properties": [ + }, { - "name": "node_id", - "required": true, + "description": "If true, the search and its results are stored on the cluster.", + "name": "keep_on_completion", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "node_name", - "required": true, + "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", + "name": "wait_for_completion_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "eql/search/EqlSearchRequest.ts#L27-L112" }, { - "kind": "interface", - "name": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ + "generics": [ { - "name": "decider", - "required": true, - "type": { + "name": "TEvent", + "namespace": "eql.search" + } + ], + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TEvent", + "namespace": "eql.search" } } + ], + "type": { + "name": "EqlSearchResponseBase", + "namespace": "eql._types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "eql.search" + }, + "specLocation": "eql/search/EqlSearchResponse.ts#L22-L22" + }, + { + "kind": "enum", + "members": [ + { + "description": "Return the most recent matches, similar to the Unix tail command.", + "name": "tail" }, { - "name": "decision", + "description": "Return the earliest matches, similar to the Unix head command.", + "name": "head" + } + ], + "name": { + "name": "ResultPosition", + "namespace": "eql.search" + }, + "specLocation": "eql/search/types.ts#L20-L32" + }, + { + "kind": "interface", + "name": { + "name": "Feature", + "namespace": "features._types" + }, + "properties": [ + { + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AllocationExplainDecision", - "namespace": "cluster.allocation_explain" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "explanation", + "name": "description", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "features/_types/Feature.ts#L20-L23" }, { - "kind": "enum", - "members": [ - { - "name": "NO" - }, - { - "name": "YES" - }, - { - "name": "THROTTLE" - }, - { - "name": "ALWAYS" + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "features.get_features" + }, + "path": [], + "query": [], + "specLocation": "features/get_features/GetFeaturesRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "features", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Feature", + "namespace": "features._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "features.get_features" + }, + "specLocation": "features/get_features/GetFeaturesResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" ], + "body": { + "kind": "no_body" + }, + "description": "Resets the internal state of features, usually by deleting system indices", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "AllocationExplainDecision", - "namespace": "cluster.allocation_explain" + "name": "Request", + "namespace": "features.reset_features" + }, + "path": [], + "query": [], + "specLocation": "features/reset_features/ResetFeaturesRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "features", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Feature", + "namespace": "features._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "features.reset_features" + }, + "specLocation": "features/reset_features/ResetFeaturesResponse.ts#L22-L26" + }, + { + "kind": "type_alias", + "name": { + "name": "Checkpoint", + "namespace": "fleet._types" + }, + "specLocation": "fleet/_types/Checkpoints.ts#L22-L22", + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "AllocationStore", - "namespace": "cluster.allocation_explain" + "name": "Request", + "namespace": "fleet.global_checkpoints" }, - "properties": [ + "path": [ { - "name": "allocation_id", + "description": "A single index or index alias that resolves to a single index.", + "name": "index", "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } + ], + "kind": "union_of" + } + } + ], + "query": [ + { + "description": "A boolean value which controls whether to wait (until the timeout) for the global checkpoints\nto advance past the provided `checkpoints`.", + "name": "wait_for_advance", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "found", - "required": true, + "description": "A boolean value which controls whether to wait (until the timeout) for the target index to exist\nand all primary shards be active. Can only be true when `wait_for_advance` is true.", + "name": "wait_for_index", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "in_sync", + "description": "A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`,\nthe API will only return once the global checkpoints advances past the checkpoints. Providing an empty list\nwill cause Elasticsearch to immediately return the current global checkpoints.", + "name": "checkpoints", + "required": false, + "serverDefault": [], + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Checkpoint", + "namespace": "fleet._types" + } + } + } + }, + { + "description": "Period to wait for a global checkpoints to advance past `checkpoints`.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L63" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "global_checkpoints", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Checkpoint", + "namespace": "fleet._types" + } + } + } + }, + { + "name": "timed_out", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "fleet.global_checkpoints" + }, + "specLocation": "fleet/global_checkpoints/GlobalCheckpointsResponse.ts#L22-L27" + }, + { + "kind": "interface", + "name": { + "name": "Connection", + "namespace": "graph._types" + }, + "properties": [ + { + "name": "doc_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "matching_size_in_bytes", + "name": "source", "required": true, "type": { "kind": "instance_of", @@ -73362,204 +92615,150 @@ } }, { - "name": "matching_sync_id", + "name": "target", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "store_exception", + "name": "weight", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "graph/_types/Connection.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "ClusterInfo", - "namespace": "cluster.allocation_explain" + "name": "ExploreControls", + "namespace": "graph._types" }, "properties": [ { - "name": "nodes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeDiskUsage", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "shard_sizes", - "required": true, + "name": "sample_diversity", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "SampleDiversity", + "namespace": "graph._types" } } }, { - "name": "shard_data_set_sizes", + "name": "sample_size", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "shard_paths", - "required": true, + "name": "timeout", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } }, { - "name": "reserved_sizes", + "name": "use_significance", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ReservedSize", - "namespace": "cluster.allocation_explain" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "graph/_types/ExploreControls.ts#L24-L29" }, { "kind": "interface", "name": { - "name": "CurrentNode", - "namespace": "cluster.allocation_explain" + "name": "Hop", + "namespace": "graph._types" }, "properties": [ { - "name": "id", - "required": true, + "name": "connections", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "Hop", + "namespace": "graph._types" } } }, { - "name": "name", + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "attributes", + "name": "vertices", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VertexDefinition", + "namespace": "graph._types" } } } - }, + } + ], + "specLocation": "graph/_types/Hop.ts#L23-L27" + }, + { + "kind": "interface", + "name": { + "name": "SampleDiversity", + "namespace": "graph._types" + }, + "properties": [ { - "name": "transport_address", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", + "name": "Field", "namespace": "_types" } } }, { - "name": "weight_ranking", + "name": "max_docs_per_value", "required": true, "type": { "kind": "instance_of", @@ -73569,72 +92768,18 @@ } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "yes" - }, - { - "name": "no" - }, - { - "name": "worse_balance" - }, - { - "name": "throttled" - }, - { - "name": "awaiting_info" - }, - { - "name": "allocation_delayed" - }, - { - "name": "no_valid_shard_copy" - }, - { - "name": "no_attempt" - } ], - "name": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } + "specLocation": "graph/_types/ExploreControls.ts#L31-L34" }, { "kind": "interface", "name": { - "name": "DiskUsage", - "namespace": "cluster.allocation_explain" + "name": "Vertex", + "namespace": "graph._types" }, "properties": [ { - "name": "path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "total_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "used_bytes", + "name": "depth", "required": true, "type": { "kind": "instance_of", @@ -73645,29 +92790,29 @@ } }, { - "name": "free_bytes", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "free_disk_percent", + "name": "term", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "used_disk_percent", + "name": "weight", "required": true, "type": { "kind": "instance_of", @@ -73677,109 +92822,80 @@ } } } - ] + ], + "specLocation": "graph/_types/Vertex.ts#L23-L28" }, { "kind": "interface", "name": { - "name": "NodeAllocationExplanation", - "namespace": "cluster.allocation_explain" + "name": "VertexDefinition", + "namespace": "graph._types" }, "properties": [ { - "name": "deciders", - "required": true, + "name": "exclude", + "required": false, "type": { "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "node_attributes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "node_decision", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "node_id", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } }, { - "name": "node_name", - "required": true, + "name": "include", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "VertexInclude", + "namespace": "graph._types" + } } } }, { - "name": "store", + "name": "min_doc_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AllocationStore", - "namespace": "cluster.allocation_explain" + "name": "long", + "namespace": "_types" } } }, { - "name": "transport_address", - "required": true, + "name": "shard_min_doc_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", + "name": "long", "namespace": "_types" } } }, { - "name": "weight_ranking", - "required": true, + "name": "size", + "required": false, "type": { "kind": "instance_of", "type": { @@ -73788,49 +92904,40 @@ } } } - ] + ], + "specLocation": "graph/_types/Vertex.ts#L30-L37" }, { "kind": "interface", "name": { - "name": "NodeDiskUsage", - "namespace": "cluster.allocation_explain" + "name": "VertexInclude", + "namespace": "graph._types" }, "properties": [ { - "name": "node_name", + "name": "boost", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "double", "namespace": "_types" } } }, { - "name": "least_available", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DiskUsage", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "most_available", + "name": "term", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DiskUsage", - "namespace": "cluster.allocation_explain" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "graph/_types/Vertex.ts#L39-L42" }, { "attachedBehaviors": [ @@ -73840,55 +92947,55 @@ "kind": "properties", "properties": [ { - "description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.", - "name": "current_node", + "name": "connections", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Hop", + "namespace": "graph._types" } } }, { - "description": "Specifies the name of the index that you would like an explanation for.", - "name": "index", + "name": "controls", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "ExploreControls", + "namespace": "graph._types" } } }, { - "description": "If true, returns explanation for the primary shard for the given shard ID.", - "name": "primary", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "description": "Specifies the ID of the shard that you would like an explanation for.", - "name": "shard", + "name": "vertices", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "VertexDefinition", + "namespace": "graph._types" + } } } } ] }, + "description": "Explore extracted and summarized information about the documents and terms in an index.", "inherits": { "type": { "name": "RequestBase", @@ -73898,341 +93005,108 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.allocation_explain" - }, - "path": [], - "query": [ - { - "description": "If true, returns information about disk usage and shard sizes.", - "name": "include_disk_info", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "If true, returns YES decisions in explanation.", - "name": "include_yes_decisions", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ReservedSize", - "namespace": "cluster.allocation_explain" + "namespace": "graph.explore" }, - "properties": [ + "path": [ { - "name": "node_id", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Indices", "namespace": "_types" } } }, { - "name": "path", - "required": true, + "description": "A comma-separated list of document types to search; leave empty to perform the operation on all types", + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Types", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "total", - "required": true, + "description": "Specific routing value", + "name": "routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Routing", "namespace": "_types" } } }, { - "name": "shards", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "allocate_explanation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "allocation_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "allocation_delay_in_millis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "can_allocate", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_move_to_other_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_rebalance_cluster", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_rebalance_cluster_decisions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "can_rebalance_to_other_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "can_remain_decisions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AllocationDecision", - "namespace": "cluster.allocation_explain" - } - } - } - }, - { - "name": "can_remain_on_current_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Decision", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "cluster_info", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterInfo", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "configured_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "configured_delay_in_millis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "current_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CurrentNode", - "namespace": "cluster.allocation_explain" - } - } - }, - { - "name": "current_state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "move_explanation", - "required": false, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "Time", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L48" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "name": "node_allocation_decisions", - "required": false, + "name": "connections", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "NodeAllocationExplanation", - "namespace": "cluster.allocation_explain" + "name": "Connection", + "namespace": "graph._types" } } } }, { - "name": "primary", + "name": "failures", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "rebalance_explanation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardFailure", + "namespace": "_types" + } } } }, { - "name": "remaining_delay", - "required": false, + "name": "timed_out", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "remaining_delay_in_millis", - "required": false, + "name": "took", + "required": true, "type": { "kind": "instance_of", "type": { @@ -74242,24 +93116,16 @@ } }, { - "name": "shard", + "name": "vertices", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "unassigned_info", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "UnassignedInformation", - "namespace": "cluster.allocation_explain" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Vertex", + "namespace": "graph._types" + } } } } @@ -74268,148 +93134,138 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cluster.allocation_explain" + "namespace": "graph.explore" + }, + "specLocation": "graph/explore/GraphExploreResponse.ts#L25-L33" + }, + { + "kind": "type_alias", + "name": { + "name": "Actions", + "namespace": "ilm._types" + }, + "specLocation": "ilm/_types/Phase.ts#L39-L39", + "type": { + "kind": "user_defined_value" } }, { "kind": "interface", "name": { - "name": "UnassignedInformation", - "namespace": "cluster.allocation_explain" + "name": "Phase", + "namespace": "ilm._types" }, "properties": [ { - "name": "at", - "required": true, + "name": "actions", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "Actions", + "namespace": "ilm._types" } } }, { - "name": "last_allocation_status", + "name": "min_age", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ilm/_types/Phase.ts#L25-L28" + }, + { + "kind": "interface", + "name": { + "name": "Phases", + "namespace": "ilm._types" + }, + "properties": [ { - "name": "reason", - "required": true, + "name": "cold", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "UnassignedInformationReason", - "namespace": "cluster.allocation_explain" + "name": "Phase", + "namespace": "ilm._types" } } }, { - "name": "details", + "name": "delete", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Phase", + "namespace": "ilm._types" } } }, { - "name": "failed_allocation_attempts", + "name": "hot", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Phase", + "namespace": "ilm._types" } } }, { - "name": "delayed", + "name": "warm", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Phase", + "namespace": "ilm._types" } } - }, + } + ], + "specLocation": "ilm/_types/Phase.ts#L30-L35" + }, + { + "kind": "interface", + "name": { + "name": "Policy", + "namespace": "ilm._types" + }, + "properties": [ { - "name": "allocation_status", - "required": false, + "name": "phases", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Phases", + "namespace": "ilm._types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "INDEX_CREATED" - }, - { - "name": "CLUSTER_RECOVERED" - }, - { - "name": "INDEX_REOPENED" - }, - { - "name": "DANGLING_INDEX_IMPORTED" - }, - { - "name": "NEW_INDEX_RESTORED" - }, - { - "name": "EXISTING_INDEX_RESTORED" - }, - { - "name": "REPLICA_ADDED" - }, - { - "name": "ALLOCATION_FAILED" - }, - { - "name": "NODE_LEFT" - }, - { - "name": "REROUTE_CANCELLED" - }, - { - "name": "REINITIALIZED" - }, - { - "name": "REALLOCATED_REPLICA" - }, - { - "name": "PRIMARY_FAILED" - }, - { - "name": "FORCED_EMPTY_PRIMARY" }, { - "name": "MANUAL_ALLOCATION" + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } } ], - "name": { - "name": "UnassignedInformationReason", - "namespace": "cluster.allocation_explain" - } + "specLocation": "ilm/_types/Policy.ts#L23-L26" }, { "attachedBehaviors": [ @@ -74418,6 +93274,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", "inherits": { "type": { "name": "RequestBase", @@ -74427,11 +93284,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.delete_component_template" + "namespace": "ilm.delete_lifecycle" }, "path": [ { - "name": "name", + "codegenName": "name", + "description": "Identifier for the policy.", + "name": "policy", "required": true, "type": { "kind": "instance_of", @@ -74444,6 +93303,7 @@ ], "query": [ { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -74456,6 +93316,7 @@ } }, { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -74467,7 +93328,8 @@ } } } - ] + ], + "specLocation": "ilm/delete_lifecycle/DeleteLifecycleRequest.ts#L24-L52" }, { "body": { @@ -74483,168 +93345,83 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cluster.delete_component_template" - } + "namespace": "ilm.delete_lifecycle" + }, + "specLocation": "ilm/delete_lifecycle/DeleteLifecycleResponse.ts#L22-L22" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + "kind": "type_alias", + "name": { + "name": "LifecycleExplain", + "namespace": "ilm.explain_lifecycle" + }, + "specLocation": "ilm/explain_lifecycle/types.ts#L52-L55", + "type": { + "items": [ { - "name": "stub", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "LifecycleExplainManaged", + "namespace": "ilm.explain_lifecycle" } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.delete_voting_config_exclusions" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "stub", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "LifecycleExplainUnmanaged", + "namespace": "ilm.explain_lifecycle" } } - ] + ], + "kind": "union_of" }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.delete_voting_config_exclusions" + "variants": { + "kind": "internal_tag", + "tag": "managed" } }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.exists_component_template" + "name": "LifecycleExplainManaged", + "namespace": "ilm.explain_lifecycle" }, - "path": [ + "properties": [ { - "name": "stub_a", + "name": "action", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub_b", + "name": "action_time_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + }, + { + "name": "age", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "Time", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.exists_component_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.get_component_template" - }, - "path": [ + }, { - "name": "name", + "name": "failed_step", "required": false, "type": { "kind": "instance_of", @@ -74653,323 +93430,239 @@ "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "flat_settings", + "name": "failed_step_retry_count", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "local", - "required": false, - "serverDefault": false, + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "master_timeout", + "name": "index_creation_date_millis", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "EpochMillis", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "component_templates", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ComponentTemplate", - "namespace": "cluster._types" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.get_component_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.get_settings" - }, - "path": [], - "query": [ + }, { - "name": "flat_settings", + "name": "is_auto_retryable_error", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "include_defaults", - "required": false, + "name": "lifecycle_date_millis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } }, { - "name": "master_timeout", - "required": false, + "name": "managed", + "required": true, + "type": { + "kind": "literal_value", + "value": true + } + }, + { + "name": "phase", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Name", "namespace": "_types" } } }, { - "name": "timeout", - "required": false, + "name": "phase_time_millis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "EpochMillis", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "persistent", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "transient", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "defaults", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.get_settings" - } - }, - { - "kind": "interface", - "name": { - "name": "IndexHealthStats", - "namespace": "cluster.health" - }, - "properties": [ + }, { - "name": "active_primary_shards", + "name": "policy", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "active_shards", + "name": "step", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "initializing_shards", + "name": "step_info", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "step_time_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "number_of_replicas", + "name": "phase_execution", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "LifecycleExplainPhaseExecution", + "namespace": "ilm.explain_lifecycle" } } }, { - "name": "number_of_shards", - "required": true, + "name": "time_since_index_creation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "ilm/explain_lifecycle/types.ts#L26-L45" + }, + { + "kind": "interface", + "name": { + "name": "LifecycleExplainPhaseExecution", + "namespace": "ilm.explain_lifecycle" + }, + "properties": [ { - "name": "relocating_shards", + "name": "policy", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "shards", - "required": false, + "name": "version", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ShardHealthStats", - "namespace": "cluster.health" - } + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" } } }, { - "name": "status", + "name": "modified_date_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Health", + "name": "EpochMillis", "namespace": "_types" } } - }, + } + ], + "specLocation": "ilm/explain_lifecycle/types.ts#L57-L61" + }, + { + "kind": "interface", + "name": { + "name": "LifecycleExplainUnmanaged", + "namespace": "ilm.explain_lifecycle" + }, + "properties": [ { - "name": "unassigned_shards", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } + }, + { + "name": "managed", + "required": true, + "type": { + "kind": "literal_value", + "value": false + } } - ] + ], + "specLocation": "ilm/explain_lifecycle/types.ts#L47-L50" }, { "attachedBehaviors": [ @@ -74978,6 +93671,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures.", "inherits": { "type": { "name": "RequestBase", @@ -74987,17 +93681,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.health" + "namespace": "ilm.explain_lifecycle" }, "path": [ { - "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.", + "description": "Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`).\nTo target all data streams and indices, use `*` or `_all`.", "name": "index", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "IndexName", "namespace": "_types" } } @@ -75005,39 +93699,26 @@ ], "query": [ { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "description": "Can be one of cluster, indices or shards. Controls the details level of the health information returned.", - "name": "level", + "description": "Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist.", + "name": "only_errors", "required": false, - "serverDefault": "cluster", "type": { "kind": "instance_of", "type": { - "name": "Level", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", - "name": "local", + "description": "Filters the returned indices to only indices that are managed by ILM.", + "name": "only_managed", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -75066,285 +93747,384 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "ilm/explain_lifecycle/ExplainLifecycleRequest.ts#L24-L59" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "indices", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "LifecycleExplain", + "namespace": "ilm.explain_lifecycle" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ilm.explain_lifecycle" + }, + "specLocation": "ilm/explain_lifecycle/ExplainLifecycleResponse.ts#L24-L28" + }, + { + "kind": "interface", + "name": { + "name": "Lifecycle", + "namespace": "ilm.get_lifecycle" + }, + "properties": [ { - "description": "A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.", - "name": "wait_for_active_shards", - "required": false, - "serverDefault": "0", + "name": "modified_date", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "DateString", "namespace": "_types" } } }, { - "description": "Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.", - "name": "wait_for_events", - "required": false, + "name": "policy", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "WaitForEvents", - "namespace": "_types" + "name": "Policy", + "namespace": "ilm._types" } } }, { - "description": "The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status.", - "name": "wait_for_status", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "WaitForStatus", + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "ilm/get_lifecycle/GetLifecycleRequest.ts#L24-L51" }, { "body": { "kind": "properties", - "properties": [ + "properties": [] + }, + "inherits": { + "generics": [ { - "description": "The number of active primary shards.", - "name": "active_primary_shards", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } }, { - "description": "The total number of active primary and replica shards.", - "name": "active_shards", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "Lifecycle", + "namespace": "ilm.get_lifecycle" } - }, + } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ilm.get_lifecycle" + }, + "specLocation": "ilm/get_lifecycle/GetLifecycleResponse.ts#L23-L23" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves the current index lifecycle management (ILM) status.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ilm.get_status" + }, + "path": [], + "query": [], + "specLocation": "ilm/get_status/GetIlmStatusRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "description": "The ratio of active shards in the cluster expressed as a percentage.", - "name": "active_shards_percent_as_number", + "name": "operation_mode", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Percentage", + "name": "LifecycleOperationMode", "namespace": "_types" } } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ilm.get_status" + }, + "specLocation": "ilm/get_status/GetIlmStatusResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "description": "The name of the cluster.", - "name": "cluster_name", - "required": true, + "name": "legacy_template_to_delete", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "The number of shards whose allocation has been delayed by the timeout settings.", - "name": "delayed_unassigned_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "indices", + "name": "node_attribute", "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndexHealthStats", - "namespace": "cluster.health" - } - } - } - }, - { - "description": "The number of shards that are under initialization.", - "name": "initializing_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The number of nodes that are dedicated data nodes.", - "name": "number_of_data_nodes", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, - { - "name": "number_of_in_flight_fetch", - "required": true, + } + ] + }, + "description": "Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and\nattribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+\nUsing node roles enables ILM to automatically move the indices between data tiers.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ilm.migrate_to_data_tiers" + }, + "path": [], + "query": [ + { + "description": "If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.\nThis provides a way to retrieve the indices and ILM policies that need to be migrated.", + "name": "dry_run", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, + } + } + ], + "specLocation": "ilm/migrate_to_data_tiers/Request.ts#L22-L44" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "description": "The number of nodes within the cluster.", - "name": "number_of_nodes", + "name": "dry_run", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The number of cluster-level changes that have not yet been executed.", - "name": "number_of_pending_tasks", + "name": "removed_legacy_template", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The number of shards that are under relocation.", - "name": "relocating_shards", + "name": "migrated_ilm_policies", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "status", + "name": "migrated_indices", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Health", + "name": "Indices", "namespace": "_types" } } }, { - "description": "The time expressed in milliseconds since the earliest initiated task is waiting for being performed.", - "name": "task_max_waiting_in_queue_millis", + "name": "migrated_legacy_templates", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "EpochMillis", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "If false the response returned within the period of time that is specified by the timeout parameter (30s by default)", - "name": "timed_out", + "name": "migrated_composable_templates", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The number of shards that are not allocated.", - "name": "unassigned_shards", + "name": "migrated_component_templates", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } @@ -75353,155 +94133,152 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cluster.health" - } + "namespace": "ilm.migrate_to_data_tiers" + }, + "specLocation": "ilm/migrate_to_data_tiers/Response.ts#L22-L32" }, { - "kind": "interface", - "name": { - "name": "ShardHealthStats", - "namespace": "cluster.health" - }, - "properties": [ - { - "name": "active_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "initializing_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "primary_active", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "relocating_shards", - "required": true, - "type": { - "kind": "instance_of", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "current_step", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "StepKey", + "namespace": "ilm.move_to_step" + } } - } - }, - { - "name": "status", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "next_step", + "required": false, "type": { - "name": "Health", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "StepKey", + "namespace": "ilm.move_to_step" + } } } - }, + ] + }, + "description": "Manually moves an index into the specified step and executes that step.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ilm.move_to_step" + }, + "path": [ { - "name": "unassigned_shards", + "description": "The name of the index whose lifecycle step is to change", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L37" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ilm.move_to_step" + }, + "specLocation": "ilm/move_to_step/MoveToStepResponse.ts#L22-L22" }, { "kind": "interface", "name": { - "name": "PendingTask", - "namespace": "cluster.pending_tasks" + "name": "StepKey", + "namespace": "ilm.move_to_step" }, "properties": [ { - "name": "insert_order", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "priority", + "name": "action", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "source", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "time_in_queue", + "name": "phase", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "time_in_queue_millis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ilm/move_to_step/types.ts#L20-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "name": "policy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Policy", + "namespace": "ilm._types" + } + } + } + ] }, + "description": "Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented.", "inherits": { "type": { "name": "RequestBase", @@ -75511,23 +94288,40 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.pending_tasks" + "namespace": "ilm.put_lifecycle" }, - "path": [], + "path": [ + { + "codegenName": "name", + "description": "Identifier for the policy.", + "name": "policy", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], "query": [ { - "name": "local", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "master_timeout", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", "required": false, "serverDefault": "30s", "type": { @@ -75538,121 +94332,109 @@ } } } - ] + ], + "specLocation": "ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L56" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "tasks", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PendingTask", - "namespace": "cluster.pending_tasks" - } - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "cluster.pending_tasks" - } + "namespace": "ilm.put_lifecycle" + }, + "specLocation": "ilm/put_lifecycle/PutLifecycleResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], + "body": { + "kind": "no_body" + }, + "description": "Removes the assigned lifecycle policy and stops managing the specified index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ilm.remove_policy" + }, + "path": [ + { + "description": "The name of the index to remove policy on", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L32" + }, + { "body": { "kind": "properties", "properties": [ { - "name": "template", + "name": "failed_indexes", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IndexState", - "namespace": "indices._types" - } - } - }, - { - "name": "aliases", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "AliasDefinition", - "namespace": "indices._types" + "name": "IndexName", + "namespace": "_types" } } } }, { - "name": "mappings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", - "required": false, + "name": "has_failures", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ilm.remove_policy" + }, + "specLocation": "ilm/remove_policy/RemovePolicyResponse.ts#L22-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retries executing the policy for an index that is in the ERROR step.", "inherits": { "type": { "name": "RequestBase", @@ -75662,38 +94444,78 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.put_component_template" + "namespace": "ilm.retry" }, "path": [ { - "name": "name", + "description": "The name of the indices (comma-separated) whose failed lifecycle step is to be retry", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } } ], + "query": [], + "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ilm.retry" + }, + "specLocation": "ilm/retry/RetryIlmResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Start the index lifecycle management (ILM) plugin.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ilm.start" + }, + "path": [], "query": [ { - "name": "create", + "name": "master_timeout", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "master_timeout", + "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -75702,7 +94524,8 @@ } } } - ] + ], + "specLocation": "ilm/start/StartIlmRequest.ts#L23-L33" }, { "body": { @@ -75718,54 +94541,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "cluster.put_component_template" - } + "namespace": "ilm.start" + }, + "specLocation": "ilm/start/StartIlmResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "persistent", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "transient", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] + "kind": "no_body" }, + "description": "Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin", "inherits": { "type": { "name": "RequestBase", @@ -75775,25 +94562,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.put_settings" + "namespace": "ilm.stop" }, "path": [], "query": [ - { - "name": "flat_settings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, { "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -75805,7 +94580,6 @@ { "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -75814,683 +94588,970 @@ } } } - ] + ], + "specLocation": "ilm/stop/StopIlmRequest.ts#L23-L33" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "persistent", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "transient", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.put_settings" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + "properties": [] }, "inherits": { "type": { - "name": "RequestBase", + "name": "AcknowledgedResponseBase", "namespace": "_types" } }, - "kind": "request", + "kind": "response", "name": { - "name": "Request", - "namespace": "cluster.put_voting_config_exclusions" + "name": "Response", + "namespace": "ilm.stop" }, - "path": [], - "query": [ + "specLocation": "ilm/stop/StopIlmResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "Alias", + "namespace": "indices._types" + }, + "properties": [ { - "name": "node_names", + "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "node_ids", + "name": "index_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Routing", "namespace": "_types" } } }, { - "name": "timeout", + "name": "is_hidden", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "wait_for_removal", + "name": "is_write_index", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "name": "search_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/_types/Alias.ts#L23-L30" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + "kind": "interface", + "name": { + "name": "AliasDefinition", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.put_voting_config_exclusions" - } + }, + { + "name": "index_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "is_write_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "search_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/_types/AliasDefinition.ts#L22-L28" }, { "kind": "interface", "name": { - "name": "ClusterRemoteInfo", - "namespace": "cluster.remote_info" + "name": "DataStream", + "namespace": "indices._types" }, "properties": [ { - "name": "connected", - "required": true, + "name": "hidden", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/_types/DataStream.ts#L20-L22" + }, + { + "kind": "interface", + "name": { + "name": "FielddataFrequencyFilter", + "namespace": "indices._types" + }, + "properties": [ { - "name": "initial_connect_timeout", + "name": "max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "double", "namespace": "_types" } } }, { - "name": "max_connections_per_cluster", + "name": "min", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "num_nodes_connected", + "name": "min_segment_size", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } + } + ], + "specLocation": "indices/_types/FielddataFrequencyFilter.ts#L22-L26" + }, + { + "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.", + "kind": "enum", + "members": [ + { + "name": "true" }, { - "name": "seeds", - "required": true, + "name": "false" + }, + { + "name": "checksum" + } + ], + "name": { + "name": "IndexCheckOnStartup", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSettings.ts#L324-L331" + }, + { + "kind": "interface", + "name": { + "name": "IndexRouting", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "allocation", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "IndexRoutingAllocation", + "namespace": "indices._types" } } }, { - "name": "skip_unavailable", - "required": true, + "name": "rebalance", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexRoutingRebalance", + "namespace": "indices._types" } } } - ] + ], + "specLocation": "indices/_types/IndexRouting.ts#L22-L25" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + "kind": "interface", + "name": { + "name": "IndexRoutingAllocation", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "enable", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "IndexRoutingAllocationOptions", + "namespace": "indices._types" + } + } + }, + { + "name": "include", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexRoutingAllocationInclude", + "namespace": "indices._types" + } + } + }, + { + "name": "initial_recovery", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexRoutingAllocationInitialRecovery", + "namespace": "indices._types" + } + } + }, + { + "name": "disk", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexRoutingAllocationDisk", + "namespace": "indices._types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", + ], + "specLocation": "indices/_types/IndexRouting.ts#L27-L32" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "cluster.remote_info" + "name": "IndexRoutingAllocationDisk", + "namespace": "indices._types" }, - "path": [], - "query": [] + "properties": [ + { + "name": "threshold_enabled", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L62-L64" }, { - "body": { - "kind": "properties", - "properties": [] + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationInclude", + "namespace": "indices._types" }, - "inherits": { - "generics": [ - { + "properties": [ + { + "name": "_tier_preference", + "required": false, + "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "_id", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ClusterRemoteInfo", - "namespace": "cluster.remote_info" + "name": "Id", + "namespace": "_types" } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.remote_info" - } + ], + "specLocation": "indices/_types/IndexRouting.ts#L52-L55" }, { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html#cluster-reroute-api-request-body", "kind": "interface", "name": { - "name": "Command", - "namespace": "cluster.reroute" + "name": "IndexRoutingAllocationInitialRecovery", + "namespace": "indices._types" }, "properties": [ { - "description": "Cancel allocation of a shard (or recovery). Accepts index and shard for index name and shard number, and node for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of a primary shard then the allow_primary flag must also be included in the request.", - "name": "cancel", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CommandCancelAction", - "namespace": "cluster.reroute" + "name": "Id", + "namespace": "_types" } } + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L57-L59" + }, + { + "kind": "enum", + "members": [ + { + "name": "all" }, { - "description": "Move a started shard from one node to another node. Accepts index and shard for index name and shard number, from_node for the node to move the shard from, and to_node for the node to move the shard to.", - "name": "move", - "required": false, + "name": "primaries" + }, + { + "name": "new_primaries" + }, + { + "name": "none" + } + ], + "name": { + "name": "IndexRoutingAllocationOptions", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexRouting.ts#L38-L43" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingRebalance", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "enable", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandMoveAction", - "namespace": "cluster.reroute" + "name": "IndexRoutingRebalanceOptions", + "namespace": "indices._types" } } + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L34-L36" + }, + { + "kind": "enum", + "members": [ + { + "name": "all" }, { - "description": "Allocate an unassigned replica shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Takes allocation deciders into account.", - "name": "allocate_replica", - "required": false, + "name": "primaries" + }, + { + "name": "replicas" + }, + { + "name": "none" + } + ], + "name": { + "name": "IndexRoutingRebalanceOptions", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexRouting.ts#L45-L50" + }, + { + "kind": "interface", + "name": { + "name": "IndexSegmentSort", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CommandAllocateReplicaAction", - "namespace": "cluster.reroute" + "name": "Fields", + "namespace": "_types" } } }, { - "description": "Allocate a primary shard to a node that holds a stale copy. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.", - "name": "allocate_stale_primary", + "name": "order", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SegmentSortOrder", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortOrder", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "name": "mode", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "CommandAllocatePrimaryAction", - "namespace": "cluster.reroute" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SegmentSortMode", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortMode", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" } }, { - "description": "Allocate an empty primary shard to a node. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.", - "name": "allocate_empty_primary", + "name": "missing", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "CommandAllocatePrimaryAction", - "namespace": "cluster.reroute" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" } } - ] + ], + "specLocation": "indices/_types/IndexSegmentSort.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "CommandAllocatePrimaryAction", - "namespace": "cluster.reroute" + "name": "IndexSettingBlocks", + "namespace": "indices._types" }, "properties": [ { - "name": "index", - "required": true, + "name": "read_only", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "shard", - "required": true, + "name": "read_only_allow_delete", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "node", - "required": true, + "name": "read", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true", - "name": "accept_data_loss", - "required": true, + "name": "write", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "metadata", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L316-L322" }, { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html", + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index-modules.html#index-modules-settings", "kind": "interface", "name": { - "name": "CommandAllocateReplicaAction", - "namespace": "cluster.reroute" + "name": "IndexSettings", + "namespace": "indices._types" }, "properties": [ { "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "IndexSettings", + "namespace": "indices._types" } } }, { - "name": "shard", - "required": true, + "aliases": [ + "index.mode" + ], + "name": "mode", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "node", - "required": true, + "aliases": [ + "index.routing_path" + ], + "name": "routing_path", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "CommandCancelAction", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "index", - "required": true, + "aliases": [ + "index.soft_deletes" + ], + "name": "soft_deletes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "SoftDeletes", + "namespace": "indices._types" } } }, { - "name": "shard", - "required": true, + "aliases": [ + "index.sort" + ], + "name": "sort", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexSegmentSort", + "namespace": "indices._types" } } }, { - "name": "node", - "required": true, + "aliases": [ + "index.number_of_shards" + ], + "name": "number_of_shards", + "required": false, + "serverDefault": "1", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "allow_primary", + "aliases": [ + "index.number_of_replicas" + ], + "name": "number_of_replicas", "required": false, + "serverDefault": "0", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "CommandMoveAction", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "index", - "required": true, + "aliases": [ + "index.number_of_routing_shards" + ], + "name": "number_of_routing_shards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "shard", - "required": true, + "aliases": [ + "index.check_on_startup" + ], + "name": "check_on_startup", + "required": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexCheckOnStartup", + "namespace": "indices._types" } } }, { - "description": "The node to move the shard from", - "name": "from_node", - "required": true, + "aliases": [ + "index.codec" + ], + "name": "codec", + "required": false, + "serverDefault": "LZ4", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "The node to move the shard to", - "name": "to_node", - "required": true, + "aliases": [ + "index.routing_partition_size" + ], + "name": "routing_partition_size", + "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Defines the commands to perform.", - "name": "commands", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Command", - "namespace": "cluster.reroute" - } - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.reroute" - }, - "path": [], - "query": [ + }, { - "description": "If true, then the request simulates the operation only and returns the resulting state.", - "name": "dry_run", + "aliases": [ + "index.soft_deletes.retention_lease.period" + ], + "name": "soft_deletes.retention_lease.period", "required": false, - "serverDefault": false, + "serverDefault": "12h", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "description": "If true, then the response contains an explanation of why the commands can or cannot be executed.", - "name": "explain", + "aliases": [ + "index.load_fixed_bitset_filters_eagerly" + ], + "name": "load_fixed_bitset_filters_eagerly", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "Limits the information returned to the specified metrics.", - "name": "metric", + "aliases": [ + "index.hidden" + ], + "name": "hidden", "required": false, - "serverDefault": "all", + "serverDefault": "false", "type": { - "kind": "instance_of", - "type": { - "name": "Metrics", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", - "name": "retry_failed", + "aliases": [ + "index.auto_expand_replicas" + ], + "name": "auto_expand_replicas", "required": false, - "serverDefault": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", + "aliases": [ + "index.merge.scheduler.max_thread_count" + ], + "name": "merge.scheduler.max_thread_count", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "integer", "namespace": "_types" } } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", + "aliases": [ + "index.search.idle.after" + ], + "name": "search.idle.after", "required": false, "serverDefault": "30s", "type": { @@ -76500,1391 +95561,1643 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RerouteDecision", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "decider", - "required": true, + "aliases": [ + "index.refresh_interval" + ], + "name": "refresh_interval", + "required": false, + "serverDefault": "1s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "decision", - "required": true, + "aliases": [ + "index.max_result_window" + ], + "name": "max_result_window", + "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "explanation", - "required": true, + "aliases": [ + "index.max_inner_result_window" + ], + "name": "max_inner_result_window", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RerouteExplanation", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "command", - "required": true, + "aliases": [ + "index.max_rescore_window" + ], + "name": "max_rescore_window", + "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "decisions", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RerouteDecision", - "namespace": "cluster.reroute" - } + "name": "integer", + "namespace": "_types" } } }, { - "name": "parameters", - "required": true, + "aliases": [ + "index.max_docvalue_fields_search" + ], + "name": "max_docvalue_fields_search", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "RerouteParameters", - "namespace": "cluster.reroute" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RerouteParameters", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "allow_primary", - "required": true, + "aliases": [ + "index.max_script_fields" + ], + "name": "max_script_fields", + "required": false, + "serverDefault": 32, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "index", - "required": true, + "aliases": [ + "index.max_ngram_diff" + ], + "name": "max_ngram_diff", + "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "node", - "required": true, + "aliases": [ + "index.max_shingle_diff" + ], + "name": "max_shingle_diff", + "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "NodeName", + "name": "integer", "namespace": "_types" } } }, { - "name": "shard", - "required": true, + "aliases": [ + "index.blocks" + ], + "name": "blocks", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexSettingBlocks", + "namespace": "indices._types" } } }, { - "name": "from_node", + "aliases": [ + "index.blocks.read_only" + ], + "name": "blocks.read_only", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "to_node", + "aliases": [ + "index.blocks.read_only_allow_delete" + ], + "name": "blocks.read_only_allow_delete", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RerouteState", - "namespace": "cluster.reroute" - }, - "properties": [ + }, { - "name": "cluster_uuid", - "required": true, + "aliases": [ + "index.blocks.read" + ], + "name": "blocks.read", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "state_uuid", + "aliases": [ + "index.blocks.write" + ], + "name": "blocks.write", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "master_node", + "aliases": [ + "index.blocks.metadata" + ], + "name": "blocks.metadata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", + "aliases": [ + "index.max_refresh_listeners" + ], + "name": "max_refresh_listeners", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "integer", "namespace": "_types" } } }, { - "name": "blocks", + "aliases": [ + "index.analyze.max_token_count" + ], + "name": "analyze.max_token_count", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "EmptyObject", + "name": "integer", "namespace": "_types" } } }, { - "name": "nodes", + "aliases": [ + "index.highlight.max_analyzed_offset" + ], + "name": "highlight.max_analyzed_offset", "required": false, + "serverDefault": 1000000, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "NodeName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeAttributes", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "routing_table", + "aliases": [ + "index.max_terms_count" + ], + "name": "max_terms_count", "required": false, + "serverDefault": 65536, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "routing_nodes", + "aliases": [ + "index.max_regex_length" + ], + "name": "max_regex_length", "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "ClusterStateRoutingNodes", - "namespace": "cluster._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "security_tokens", + "aliases": [ + "index.routing" + ], + "name": "routing", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "IndexRouting", + "namespace": "indices._types" } } }, { - "name": "snapshots", + "aliases": [ + "index.gc_deletes" + ], + "name": "gc_deletes", "required": false, + "serverDefault": "60s", "type": { "kind": "instance_of", "type": { - "name": "ClusterStateSnapshots", - "namespace": "cluster._types" + "name": "Time", + "namespace": "_types" } } }, { - "name": "snapshot_deletions", + "aliases": [ + "index.default_pipeline" + ], + "name": "default_pipeline", "required": false, + "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "ClusterStateDeletedSnapshots", - "namespace": "cluster._types" + "name": "PipelineName", + "namespace": "_types" } } }, { - "name": "metadata", + "aliases": [ + "index.final_pipeline" + ], + "name": "final_pipeline", "required": false, + "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "ClusterStateMetadata", - "namespace": "cluster._types" - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "explanations", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RerouteExplanation", - "namespace": "cluster.reroute" - } - } - } - }, - { - "name": "state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "RerouteState", - "namespace": "cluster.reroute" - } + "name": "PipelineName", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.reroute" - } - }, - { - "kind": "interface", - "name": { - "name": "ClusterStateBlocks", - "namespace": "cluster.state" - }, - "properties": [ + }, { - "name": "indices", + "aliases": [ + "index.lifecycle" + ], + "name": "lifecycle", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterStateBlockIndex", - "namespace": "cluster._types" - } - } + "kind": "instance_of", + "type": { + "name": "IndexSettingsLifecycle", + "namespace": "indices._types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "cluster.state" - }, - "path": [ + }, { - "name": "metric", + "aliases": [ + "index.lifecycle.name" + ], + "name": "lifecycle.name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metrics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index", + "aliases": [ + "index.provided_name" + ], + "name": "provided_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Name", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "aliases": [ + "index.creation_date" + ], + "name": "creation_date", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DateString", + "namespace": "_types" } } }, { - "name": "expand_wildcards", + "aliases": [ + "index.uuid" + ], + "name": "uuid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "Uuid", "namespace": "_types" } } }, { - "name": "flat_settings", + "aliases": [ + "index.version" + ], + "name": "version", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexVersioning", + "namespace": "indices._types" } } }, { - "name": "ignore_unavailable", + "aliases": [ + "index.verified_before_close" + ], + "name": "verified_before_close", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "local", + "aliases": [ + "index.format" + ], + "name": "format", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], + "kind": "union_of" } }, { - "name": "master_timeout", + "aliases": [ + "index.max_slices_per_scroll" + ], + "name": "max_slices_per_scroll", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "integer", "namespace": "_types" } } }, { - "name": "wait_for_metadata_version", + "name": "translog", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "Translog", + "namespace": "indices._types" } } }, { - "name": "wait_for_timeout", + "aliases": [ + "index.query_string.lenient" + ], + "name": "query_string.lenient", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "cluster_uuid", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } - } - }, - { - "name": "master_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "state", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "state_uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "name": "blocks", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateBlocks", - "namespace": "cluster.state" - } - } - }, - { - "name": "metadata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateMetadata", - "namespace": "cluster._types" - } - } - }, - { - "name": "nodes", - "required": false, - "type": { - "key": { + }, + { + "aliases": [ + "index.priority" + ], + "name": "priority", + "required": false, + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "NodeName", + "name": "integer", "namespace": "_types" } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + { "kind": "instance_of", "type": { - "name": "NodeAttributes", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } + ], + "kind": "union_of" + } + }, + { + "name": "top_metrics_max_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } - }, - { - "name": "routing_table", - "required": false, + } + }, + { + "aliases": [ + "index.analysis" + ], + "name": "analysis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } - } + "name": "IndexSettingsAnalysis", + "namespace": "indices._types" + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" } - }, - { - "name": "routing_nodes", - "required": false, + } + }, + { + "description": "Enable or disable dynamic mapping for an index.", + "name": "mapping", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateRoutingNodes", - "namespace": "cluster._types" - } + "name": "MappingLimitSettings", + "namespace": "indices._types" } - }, - { - "name": "snapshots", - "required": false, + } + }, + { + "name": "indexing.slowlog", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateSnapshots", - "namespace": "cluster._types" - } + "name": "SlowlogSettings", + "namespace": "indices._types" } - }, - { - "name": "snapshot_deletions", - "required": false, + } + }, + { + "description": "Configure indexing back pressure limits.", + "name": "indexing_pressure", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStateDeletedSnapshots", - "namespace": "cluster._types" - } + "name": "IndexingPressure", + "namespace": "indices._types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.state" - } + }, + { + "description": "The store module allows you to control how index data is stored and accessed on disk.", + "name": "store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Storage", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L69-L314" }, { "kind": "interface", "name": { - "name": "CharFilterTypes", - "namespace": "cluster.stats" + "name": "IndexSettingsAnalysis", + "namespace": "indices._types" }, "properties": [ { - "name": "char_filter_types", - "required": true, + "name": "analyzer", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "Analyzer", + "namespace": "_types.analysis" } } } }, { - "name": "tokenizer_types", - "required": true, + "name": "char_filter", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "CharFilter", + "namespace": "_types.analysis" } } } }, { - "name": "filter_types", - "required": true, + "name": "filter", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "TokenFilter", + "namespace": "_types.analysis" } } } }, { - "name": "analyzer_types", - "required": true, + "name": "normalizer", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "Normalizer", + "namespace": "_types.analysis" } } } }, { - "name": "built_in_char_filters", - "required": true, + "name": "tokenizer", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "Tokenizer", + "namespace": "_types.analysis" } } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L380-L386" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingsLifecycle", + "namespace": "indices._types" + }, + "properties": [ { - "name": "built_in_tokenizers", + "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", + "name": "name", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "name": "built_in_filters", - "required": true, + "description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.", + "name": "indexing_complete", + "required": false, + "serverDefault": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "built_in_analyzers", - "required": true, + "description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.", + "name": "origination_date", + "required": false, + "serverDefault": 0, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Set to true to parse the origination date from the index name. This origination date is used to calculate the index age\nfor its phase transitions. The index name must match the pattern ^.*-{date_format}-\\\\d+, where the date_format is\nyyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,\nfor example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.", + "name": "parse_origination_date", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "step", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexSettingsLifecycleStep", + "namespace": "indices._types" + } + } + }, + { + "description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.", + "name": "rollover_alias", + "required": false, + "serverDefault": "", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L337-L370" }, { "kind": "interface", "name": { - "name": "ClusterFileSystem", - "namespace": "cluster.stats" + "name": "IndexSettingsLifecycleStep", + "namespace": "indices._types" }, "properties": [ { - "name": "available_in_bytes", - "required": true, + "description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.", + "name": "wait_time_threshold", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L372-L378" + }, + { + "kind": "interface", + "name": { + "name": "IndexState", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } + } + } }, { - "name": "free_in_bytes", - "required": true, + "name": "mappings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "total_in_bytes", - "required": true, + "name": "settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexSettings", + "namespace": "indices._types" + } + } + }, + { + "description": "Default settings, included when the request's `include_default` is `true`.", + "name": "defaults", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } + } + }, + { + "name": "data_stream", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamName", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/_types/IndexState.ts#L26-L33" }, { "kind": "interface", "name": { - "name": "ClusterIndices", - "namespace": "cluster.stats" + "name": "IndexVersioning", + "namespace": "indices._types" }, "properties": [ { - "description": "Contains statistics about memory used for completion in selected nodes.", - "name": "completion", - "required": true, + "name": "created", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompletionStats", + "name": "VersionString", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L333-L335" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressure", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Total number of indices with shards assigned to selected nodes.", - "name": "count", + "name": "memory", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "IndexingPressureMemory", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L585-L587" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressureMemory", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Contains counts for documents in selected nodes.", - "name": "docs", - "required": true, + "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.", + "name": "limit", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DocStats", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L589-L596" + }, + { + "description": "Mapping Limit Settings", + "docId": "mapping-settings-limit", + "kind": "interface", + "name": { + "name": "MappingLimitSettings", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Contains statistics about the field data cache of selected nodes.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-fielddata.html", - "name": "fielddata", - "required": true, + "name": "coerce", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FielddataStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the query cache of selected nodes.", - "name": "query_cache", - "required": true, + "name": "total_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryCacheStats", - "namespace": "_types" + "name": "MappingLimitSettingsTotalFields", + "namespace": "indices._types" } } }, { - "description": "Contains statistics about segments in selected nodes.", - "name": "segments", - "required": true, + "name": "depth", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SegmentsStats", - "namespace": "_types" + "name": "MappingLimitSettingsDepth", + "namespace": "indices._types" } } }, { - "description": "Contains statistics about indices with shards assigned to selected nodes.", - "name": "shards", - "required": true, + "name": "nested_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterIndicesShards", - "namespace": "cluster.stats" + "name": "MappingLimitSettingsNestedFields", + "namespace": "indices._types" } } }, { - "description": "Contains statistics about the size of shards assigned to selected nodes.", - "name": "store", - "required": true, + "name": "nested_objects", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "StoreStats", - "namespace": "_types" + "name": "MappingLimitSettingsNestedObjects", + "namespace": "indices._types" } } }, { - "description": "Contains statistics about field mappings in selected nodes.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html", - "name": "mappings", - "required": true, + "name": "field_name_length", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldTypesMappings", - "namespace": "cluster.stats" + "name": "MappingLimitSettingsFieldNameLength", + "namespace": "indices._types" } } }, { - "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analyzer-anatomy.html", - "name": "analysis", - "required": true, + "name": "dimension_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "CharFilterTypes", - "namespace": "cluster.stats" + "name": "MappingLimitSettingsDimensionFields", + "namespace": "indices._types" } } }, { - "name": "versions", + "name": "ignore_malformed", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesVersions", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L450-L463" }, { - "description": "Contains statistics about shards assigned to selected nodes.", "kind": "interface", "name": { - "name": "ClusterIndicesShards", - "namespace": "cluster.stats" + "name": "MappingLimitSettingsDepth", + "namespace": "indices._types" }, "properties": [ { - "description": "Contains statistics about shards assigned to selected nodes.", - "name": "index", + "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.", + "name": "limit", "required": false, + "serverDefault": 20, "type": { "kind": "instance_of", "type": { - "name": "ClusterIndicesShardsIndex", - "namespace": "cluster.stats" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L475-L482" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsDimensionFields", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Number of primary shards assigned to selected nodes.", - "name": "primaries", + "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will\napply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", + "name": "limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L512-L518" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsFieldNameLength", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Ratio of replica shards to primary shards across all selected nodes.", - "name": "replication", + "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).", + "name": "limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L503-L510" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsNestedFields", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Total number of shards assigned to selected nodes.", - "name": "total", + "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.", + "name": "limit", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L484-L492" }, { "kind": "interface", "name": { - "name": "ClusterIndicesShardsIndex", - "namespace": "cluster.stats" + "name": "MappingLimitSettingsNestedObjects", + "namespace": "indices._types" }, "properties": [ { - "description": "Contains statistics about the number of primary shards assigned to selected nodes.", - "name": "primaries", - "required": true, + "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.", + "name": "limit", + "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L494-L501" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsTotalFields", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Contains statistics about the number of replication shards assigned to selected nodes.", - "name": "replication", - "required": true, + "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.", + "name": "limit", + "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L465-L473" + }, + { + "kind": "interface", + "name": { + "name": "NumericFielddata", + "namespace": "indices._types" + }, + "properties": [ { - "description": "Contains statistics about the number of shards assigned to selected nodes.", - "name": "shards", + "name": "format", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" + "name": "NumericFielddataFormat", + "namespace": "indices._types" } } } - ] + ], + "specLocation": "indices/_types/NumericFielddata.ts#L22-L24" + }, + { + "kind": "enum", + "members": [ + { + "name": "array" + }, + { + "name": "disabled" + } + ], + "name": { + "name": "NumericFielddataFormat", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/NumericFielddataFormat.ts#L20-L23" }, { "kind": "interface", "name": { - "name": "ClusterIngest", - "namespace": "cluster.stats" + "name": "OverlappingIndexTemplate", + "namespace": "indices._types" }, "properties": [ { - "name": "number_of_pipelines", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "processor_stats", - "required": true, + "name": "index_patterns", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ClusterProcessor", - "namespace": "cluster.stats" + "name": "IndexName", + "namespace": "_types" } } } } - ] + ], + "specLocation": "indices/_types/OverlappingIndexTemplate.ts#L22-L25" }, { "kind": "interface", "name": { - "name": "ClusterJvm", - "namespace": "cluster.stats" + "name": "RetentionLease", + "namespace": "indices._types" }, "properties": [ { - "name": "max_uptime_in_millis", + "name": "period", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L65-L67" + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "last", + "name": "_last" }, { - "name": "mem", - "required": true, + "codegenName": "first", + "name": "_first" + } + ], + "name": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSegmentSort.ts#L39-L44" + }, + { + "kind": "enum", + "members": [ + { + "name": "min" + }, + { + "name": "max" + } + ], + "name": { + "name": "SegmentSortMode", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSegmentSort.ts#L34-L37" + }, + { + "kind": "enum", + "members": [ + { + "name": "asc" + }, + { + "name": "desc" + } + ], + "name": { + "name": "SegmentSortOrder", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSegmentSort.ts#L29-L32" + }, + { + "kind": "interface", + "name": { + "name": "SlowlogSettings", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "level", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterJvmMemory", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "threads", - "required": true, + "name": "source", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "versions", - "required": true, + "name": "reformat", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterJvmVersion", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "threshold", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SlowlogTresholds", + "namespace": "indices._types" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L520-L525" }, { "kind": "interface", "name": { - "name": "ClusterJvmMemory", - "namespace": "cluster.stats" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" }, "properties": [ { - "name": "heap_max_in_bytes", - "required": true, + "name": "warn", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } }, { - "name": "heap_used_in_bytes", - "required": true, + "name": "info", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "debug", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "trace", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L538-L543" }, { "kind": "interface", "name": { - "name": "ClusterJvmVersion", - "namespace": "cluster.stats" + "name": "SlowlogTresholds", + "namespace": "indices._types" }, "properties": [ { - "name": "bundled_jdk", - "required": true, + "name": "query", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } }, { - "name": "count", - "required": true, + "name": "fetch", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } }, { - "name": "using_bundled_jdk", - "required": true, + "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", + "docId": "index-modules-slowlog-slowlog", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L527-L536" + }, + { + "kind": "interface", + "name": { + "name": "SoftDeletes", + "namespace": "indices._types" + }, + "properties": [ { - "name": "version", - "required": true, + "description": "Indicates whether soft deletes are enabled on the index.", + "name": "enabled", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "vm_name", - "required": true, + "description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.", + "name": "retention_lease", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "RetentionLease", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L50-L63" + }, + { + "kind": "interface", + "name": { + "name": "Storage", + "namespace": "indices._types" + }, + "properties": [ { - "name": "vm_vendor", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "StorageType", + "namespace": "indices._types" } } }, { - "name": "vm_version", - "required": true, + "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.", + "name": "allow_mmap", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/_types/IndexSettings.ts#L545-L554" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "" + ], + "description": "Default file system implementation. This will pick the best implementation depending on the operating environment, which\nis currently hybridfs on all supported systems but is subject to change.", + "name": "fs" + }, + { + "description": "The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple\nthreads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java\nimplementation and disables some optimizations for heap memory usage.", + "name": "niofs" + }, + { + "description": "The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into\nmemory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size\nof the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space.", + "name": "mmapfs" + }, + { + "description": "The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file\nbased on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory\nmapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed\nplenty of virtual address space.", + "name": "hybridfs" + } + ], + "name": { + "name": "StorageType", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSettings.ts#L556-L583" }, { "kind": "interface", "name": { - "name": "ClusterNetworkTypes", - "namespace": "cluster.stats" + "name": "TemplateMapping", + "namespace": "indices._types" }, "properties": [ { - "name": "http_types", + "name": "aliases", "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } }, "kind": "dictionary_of", @@ -77892,56 +97205,39 @@ "value": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Alias", + "namespace": "indices._types" } } } }, { - "name": "transport_types", + "name": "index_patterns", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterNodeCount", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "name": "coordinating_only", + "name": "mappings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "data", + "name": "order", "required": true, "type": { "kind": "instance_of", @@ -77952,518 +97248,624 @@ } }, { - "name": "ingest", + "name": "settings", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "name": "master", - "required": true, + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "VersionNumber", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/TemplateMapping.ts#L27-L34" + }, + { + "kind": "interface", + "name": { + "name": "Translog", + "namespace": "indices._types" + }, + "properties": [ { - "name": "total", - "required": true, + "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", + "name": "sync_interval", + "required": false, + "serverDefault": "5s", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } }, { - "name": "voting_only", - "required": true, + "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", + "name": "durability", + "required": false, + "serverDefault": "string", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TranslogDurability", + "namespace": "indices._types" } } }, { - "name": "data_cold", - "required": true, + "description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.", + "name": "flush_threshold_size", + "required": false, + "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "data_frozen", + "name": "retention", "required": false, - "since": "7.13.0", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TranslogRetention", + "namespace": "indices._types" } } + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L388-L410" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "REQUEST" + ], + "description": "(default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes\nwill already have been committed to disk.", + "name": "request" }, { - "name": "data_content", - "required": true, + "aliases": [ + "ASYNC" + ], + "description": "fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes\nsince the last automatic commit will be discarded.", + "name": "async" + } + ], + "name": { + "name": "TranslogDurability", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSettings.ts#L412-L427" + }, + { + "kind": "interface", + "name": { + "name": "TranslogRetention", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.", + "name": "size", + "required": false, + "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "data_warm", - "required": true, + "description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.", + "name": "age", + "required": false, + "serverDefault": "12h", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L429-L448" + }, + { + "kind": "enum", + "members": [ + { + "name": "metadata" }, { - "name": "data_hot", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "read" }, { - "name": "ml", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "read_only" }, { - "name": "remote_cluster_client", + "name": "write" + } + ], + "name": { + "name": "IndicesBlockOptions", + "namespace": "indices.add_block" + }, + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L43-L48" + }, + { + "kind": "interface", + "name": { + "name": "IndicesBlockStatus", + "namespace": "indices.add_block" + }, + "properties": [ + { + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "transform", + "name": "blocked", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/add_block/IndicesAddBlockResponse.ts#L29-L32" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Adds a block to an index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ClusterNodes", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "indices.add_block" }, - "properties": [ + "path": [ { - "description": "Contains counts for nodes selected by the request’s node filters.", - "name": "count", + "description": "A comma separated list of indices to add a block to", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterNodeCount", - "namespace": "cluster.stats" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "Contains statistics about the discovery types used by selected nodes.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-hosts-providers.html", - "name": "discovery_types", + "description": "The block to add (one of read, write, read_only or metadata)", + "name": "block", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "IndicesBlockOptions", + "namespace": "indices.add_block" } } - }, - { - "description": "Contains statistics about file stores by selected nodes.", - "name": "fs", - "required": true, + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterFileSystem", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "ingest", - "required": true, + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterIngest", - "namespace": "cluster.stats" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "description": "Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.", - "name": "jvm", - "required": true, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterJvm", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the transport and HTTP networks used by selected nodes.", - "name": "network_types", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterNetworkTypes", - "namespace": "cluster.stats" + "name": "Time", + "namespace": "_types" } } }, { - "description": "Contains statistics about the operating systems used by selected nodes.", - "name": "os", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterOperatingSystem", - "namespace": "cluster.stats" + "name": "Time", + "namespace": "_types" } } - }, - { - "description": "Contains statistics about Elasticsearch distributions installed on selected nodes.", - "name": "packaging_types", - "required": true, - "type": { - "kind": "array_of", - "value": { + } + ], + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L41" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "shards_acknowledged", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "NodePackagingType", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesBlockStatus", + "namespace": "indices.add_block" + } } } } + ] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.add_block" + }, + "specLocation": "indices/add_block/IndicesAddBlockResponse.ts#L23-L28" + }, + { + "kind": "interface", + "name": { + "name": "AnalyzeDetail", + "namespace": "indices.analyze" + }, + "properties": [ + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AnalyzerDetail", + "namespace": "indices.analyze" + } + } }, { - "description": "Contains statistics about installed plugins and modules by selected nodes.", - "name": "plugins", - "required": true, + "name": "charfilters", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "PluginStats", - "namespace": "_types" + "name": "CharFilterDetail", + "namespace": "indices.analyze" } } } }, { - "description": "Contains statistics about processes used by selected nodes.", - "name": "process", + "name": "custom_analyzer", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterProcess", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Array of Elasticsearch versions used on selected nodes.", - "name": "versions", - "required": true, + "name": "tokenfilters", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "TokenDetail", + "namespace": "indices.analyze" } } } + }, + { + "name": "tokenizer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TokenDetail", + "namespace": "indices.analyze" + } + } } - ] + ], + "specLocation": "indices/analyze/types.ts#L24-L30" }, { "kind": "interface", "name": { - "name": "ClusterOperatingSystem", - "namespace": "cluster.stats" + "name": "AnalyzeToken", + "namespace": "indices.analyze" }, "properties": [ { - "name": "allocated_processors", + "name": "end_offset", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "available_processors", + "name": "position", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "mem", - "required": true, + "name": "positionLength", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "OperatingSystemMemoryInfo", - "namespace": "cluster.stats" - } - } - }, - { - "name": "names", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterOperatingSystemName", - "namespace": "cluster.stats" - } + "name": "long", + "namespace": "_types" } } }, { - "name": "pretty_names", + "name": "start_offset", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterOperatingSystemName", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "architectures", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterOperatingSystemArchitecture", - "namespace": "cluster.stats" - } - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterOperatingSystemArchitecture", - "namespace": "cluster.stats" - }, - "properties": [ - { - "name": "count", + "name": "token", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "arch", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/analyze/types.ts#L37-L44" }, { "kind": "interface", "name": { - "name": "ClusterOperatingSystemName", - "namespace": "cluster.stats" + "name": "AnalyzerDetail", + "namespace": "indices.analyze" }, "properties": [ { - "name": "count", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "name", + "name": "tokens", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ExplainAnalyzeToken", + "namespace": "indices.analyze" + } } } } - ] + ], + "specLocation": "indices/analyze/types.ts#L32-L35" }, { "kind": "interface", "name": { - "name": "ClusterProcess", - "namespace": "cluster.stats" + "name": "CharFilterDetail", + "namespace": "indices.analyze" }, "properties": [ { - "name": "cpu", + "name": "filtered_text", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "ClusterProcessCpu", - "namespace": "cluster.stats" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "open_file_descriptors", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterProcessOpenFileDescriptors", - "namespace": "cluster.stats" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/analyze/types.ts#L46-L49" }, { - "kind": "interface", - "name": { - "name": "ClusterProcessCpu", - "namespace": "cluster.stats" - }, - "properties": [ + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ { - "name": "percent", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" } } - ] - }, - { + ], "kind": "interface", "name": { - "name": "ClusterProcessOpenFileDescriptors", - "namespace": "cluster.stats" + "name": "ExplainAnalyzeToken", + "namespace": "indices.analyze" }, "properties": [ { - "name": "avg", + "name": "bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max", + "name": "end_offset", "required": true, "type": { "kind": "instance_of", @@ -78474,27 +97876,18 @@ } }, { - "name": "min", - "required": true, + "name": "keyword", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterProcessor", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "name": "count", + "name": "position", "required": true, "type": { "kind": "instance_of", @@ -78505,7 +97898,7 @@ } }, { - "name": "current", + "name": "positionLength", "required": true, "type": { "kind": "instance_of", @@ -78516,7 +97909,7 @@ } }, { - "name": "failed", + "name": "start_offset", "required": true, "type": { "kind": "instance_of", @@ -78527,7 +97920,7 @@ } }, { - "name": "time_in_millis", + "name": "termFrequency", "required": true, "type": { "kind": "instance_of", @@ -78536,300 +97929,654 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ClusterShardMetrics", - "namespace": "cluster.stats" - }, - "properties": [ - { - "name": "avg", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } }, { - "name": "max", + "name": "token", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/analyze/types.ts#L52-L64" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "attributes", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "char_filter", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CharFilter", + "namespace": "_types.analysis" + } + } + } + }, + { + "name": "explain", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "filter", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TokenFilter", + "namespace": "_types.analysis" + } + } + } + }, + { + "name": "normalizer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "text", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TextToAnalyze", + "namespace": "indices.analyze" + } + } + }, + { + "name": "tokenizer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Tokenizer", + "namespace": "_types.analysis" + } + } + } + ] + }, + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "FieldTypes", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "indices.analyze" }, - "properties": [ + "path": [ { - "name": "name", - "required": true, + "description": "The name of the index to scope the operation", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } - }, - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L47" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "detail", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AnalyzeDetail", + "namespace": "indices.analyze" + } } - } - }, - { - "name": "index_count", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "tokens", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AnalyzeToken", + "namespace": "indices.analyze" + } + } } } - }, - { - "name": "script_count", - "required": false, - "since": "7.13.0", - "type": { + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.analyze" + }, + "specLocation": "indices/analyze/IndicesAnalyzeResponse.ts#L22-L27" + }, + { + "kind": "type_alias", + "name": { + "name": "TextToAnalyze", + "namespace": "indices.analyze" + }, + "specLocation": "indices/analyze/types.ts#L66-L66", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ] + ], + "kind": "union_of" + } }, { "kind": "interface", "name": { - "name": "FieldTypesMappings", - "namespace": "cluster.stats" + "name": "TokenDetail", + "namespace": "indices.analyze" }, "properties": [ { - "name": "field_types", + "name": "name", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldTypes", - "namespace": "cluster.stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "runtime_field_types", - "required": false, + "name": "tokens", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "RuntimeFieldTypes", - "namespace": "cluster.stats" + "name": "ExplainAnalyzeToken", + "namespace": "indices.analyze" } } } } - ] + ], + "specLocation": "indices/analyze/types.ts#L68-L71" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Clears all or specific caches for one or more indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "IndicesVersions", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "indices.clear_cache" }, - "properties": [ + "path": [ { - "name": "index_count", - "required": true, + "description": "A comma-separated list of index name to limit the operation", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Indices", "namespace": "_types" } } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "primary_shard_count", - "required": true, + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "total_primary_bytes", - "required": true, + "description": "Clear field data", + "name": "fielddata", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", - "required": true, + "description": "A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)", + "name": "fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "Fields", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "NodePackagingType", - "namespace": "cluster.stats" - }, - "properties": [ + }, { - "name": "count", - "required": true, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "flavor", - "required": true, + "description": "Clear query caches", + "name": "query", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "description": "Clear request cache", + "name": "request", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/clear_cache/IndicesIndicesClearCacheRequest.ts#L23-L41" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "ShardsOperationResponseBase", + "namespace": "_types" + } + }, + "kind": "response", "name": { - "name": "OperatingSystemMemoryInfo", - "namespace": "cluster.stats" + "name": "Response", + "namespace": "indices.clear_cache" }, - "properties": [ + "specLocation": "indices/clear_cache/IndicesClearCacheResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "description": "Clones an index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.clone" + }, + "path": [ { - "name": "free_in_bytes", + "description": "The name of the source index to clone", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "free_percent", + "description": "The name of the target index to clone into", + "name": "target", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "total_in_bytes", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } }, { - "name": "used_in_bytes", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } }, { - "name": "used_percent", - "required": true, + "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", + "name": "wait_for_active_shards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "WaitForActiveShards", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/clone/IndicesCloneRequest.ts#L27-L46" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "shards_acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.clone" + }, + "specLocation": "indices/clone/IndicesCloneResponse.ts#L23-L28" + }, + { + "kind": "interface", + "name": { + "name": "CloseIndexResult", + "namespace": "indices.close" + }, + "properties": [ + { + "name": "closed", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "shards", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CloseShardResult", + "namespace": "indices.close" + } + } + } + } + ], + "specLocation": "indices/close/CloseIndexResponse.ts#L32-L35" + }, + { + "kind": "interface", + "name": { + "name": "CloseShardResult", + "namespace": "indices.close" + }, + "properties": [ + { + "name": "failures", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardFailure", + "namespace": "_types" + } + } + } + } + ], + "specLocation": "indices/close/CloseIndexResponse.ts#L37-L39" }, { "attachedBehaviors": [ @@ -78838,6 +98585,7 @@ "body": { "kind": "no_body" }, + "description": "Closes an index.", "inherits": { "type": { "name": "RequestBase", @@ -78847,17 +98595,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "cluster.stats" + "namespace": "indices.close" }, "path": [ { - "description": "Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.", - "name": "node_id", - "required": false, + "description": "A comma separated list of indices to close", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "NodeIds", + "name": "Indices", "namespace": "_types" } } @@ -78865,18 +98613,55 @@ ], "query": [ { - "name": "flat_settings", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -78886,213 +98671,315 @@ "namespace": "_types" } } + }, + { + "description": "Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`.", + "name": "wait_for_active_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForActiveShards", + "namespace": "_types" + } + } } - ] + ], + "specLocation": "indices/close/CloseIndexRequest.ts#L24-L41" }, { "body": { "kind": "properties", "properties": [ { - "description": "Name of the cluster, based on the Cluster name setting setting.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name", - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "Unique identifier for the cluster.", - "name": "cluster_uuid", + "name": "indices", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CloseIndexResult", + "namespace": "indices.close" + } } } }, { - "description": "Contains statistics about indices with shards assigned to selected nodes.", - "name": "indices", + "name": "shards_acknowledged", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterIndices", - "namespace": "cluster.stats" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.close" + }, + "specLocation": "indices/close/CloseIndexResponse.ts#L25-L30" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "description": "Contains statistics about nodes selected by the request’s node filters.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", - "name": "nodes", - "required": true, + "name": "aliases", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "ClusterNodes", - "namespace": "cluster.stats" + "key": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } } } }, { - "description": "Health status of the cluster, based on the state of its primary and replica shards.", - "name": "status", - "required": true, + "description": "Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters", + "name": "mappings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStatus", - "namespace": "cluster._types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "description": "Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.", - "docUrl": "https://en.wikipedia.org/wiki/Unix_time", - "name": "timestamp", - "required": true, + "name": "settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "IndexSettings", + "namespace": "indices._types" } } } ] }, + "description": "Creates an index with optional settings and mappings.", "inherits": { "type": { - "name": "NodesResponseBase", - "namespace": "nodes._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "cluster.stats" - } - }, - { - "kind": "interface", + "kind": "request", "name": { - "name": "RuntimeFieldTypes", - "namespace": "cluster.stats" + "name": "Request", + "namespace": "indices.create" }, - "properties": [ + "path": [ { - "name": "name", + "description": "The name of the index", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "count", - "required": true, + "description": "Whether a type should be expected in the body of the mappings.", + "name": "include_type_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index_count", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } }, { - "name": "scriptless_count", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } }, { - "name": "shadowed_count", - "required": true, + "description": "Set the number of active shards to wait for before the operation returns.", + "name": "wait_for_active_shards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "WaitForActiveShards", "namespace": "_types" } } - }, - { - "name": "lang", - "required": true, - "type": { - "kind": "array_of", - "value": { + } + ], + "specLocation": "indices/create/IndicesCreateRequest.ts#L28-L57" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "index", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } - } - }, - { - "name": "lines_max", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "shards_acknowledged", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "name": "lines_total", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "acknowledged", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.create" + }, + "specLocation": "indices/create/IndicesCreateResponse.ts#L22-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Creates a data stream", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.create_data_stream" + }, + "path": [ { - "name": "chars_max", + "description": "The name of the data stream", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DataStreamName", "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.create_data_stream" + }, + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "DataStreamsStatsItem", + "namespace": "indices.data_streams_stats" + }, + "properties": [ { - "name": "chars_total", + "name": "backing_indices", "required": true, "type": { "kind": "instance_of", @@ -79103,29 +98990,29 @@ } }, { - "name": "source_max", + "name": "data_stream", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "source_total", - "required": true, + "name": "store_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "doc_max", + "name": "store_size_bytes", "required": true, "type": { "kind": "instance_of", @@ -79136,38 +99023,27 @@ } }, { - "name": "doc_total", + "name": "maximum_timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts#L35-L41" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "kind": "no_body" }, + "description": "Provides statistics on operations happening in a data stream.", "inherits": { "type": { "name": "RequestBase", @@ -79177,122 +99053,87 @@ "kind": "request", "name": { "name": "Request", - "namespace": "dangling_indices.index_delete" + "namespace": "indices.data_streams_stats" }, "path": [ { - "name": "stub_a", - "required": true, + "description": "A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams", + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } } ], "query": [ { - "name": "stub_b", - "required": true, + "name": "expand_wildcards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ExpandWildcards", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L35" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ShardStatistics", "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "dangling_indices.index_delete" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "stub_c", + "name": "backing_indices", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "dangling_indices.index_import" - }, - "path": [ - { - "name": "stub_a", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "data_stream_count", + "required": true, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - } - ], - "query": [ - { - "name": "stub_b", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "total_store_sizes", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "stub", + "name": "total_store_size_bytes", "required": true, "type": { "kind": "instance_of", @@ -79301,35 +99142,38 @@ "namespace": "_types" } } + }, + { + "name": "data_streams", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataStreamsStatsItem", + "namespace": "indices.data_streams_stats" + } + } + } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "dangling_indices.index_import" - } + "namespace": "indices.data_streams_stats" + }, + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts#L24-L33" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "kind": "no_body" }, + "description": "Deletes an index.", "inherits": { "type": { "name": "RequestBase", @@ -79339,109 +99183,127 @@ "kind": "request", "name": { "name": "Request", - "namespace": "dangling_indices.indices_list" + "namespace": "indices.delete" }, "path": [ { - "name": "stub_a", + "description": "A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" } } } ], "query": [ { - "name": "stub_b", - "required": true, + "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)", + "name": "allow_no_indices", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + }, + { + "description": "Whether wildcard expressions should get expanded to open, closed, or hidden indices", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "ExpandWildcards", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "dangling_indices.indices_list" - } - }, - { - "kind": "interface", - "name": { - "name": "Configuration", - "namespace": "enrich._types" - }, - "properties": [ + }, { - "name": "geo_match", + "description": "Ignore unavailable indexes (default: false)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Policy", - "namespace": "enrich._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "match", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Policy", - "namespace": "enrich._types" + "name": "Time", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Policy", - "namespace": "enrich._types" - }, - "properties": [ + }, { - "name": "enrich_fields", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/delete/IndicesDeleteRequest.ts#L24-L40" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "IndicesResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.delete" + }, + "specLocation": "indices/delete/IndicesDeleteResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an alias.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.delete_alias" + }, + "path": [ { - "name": "indices", + "description": "A comma-separated list of index names (supports wildcards); use `_all` for all indices", + "name": "index", "required": true, "type": { "kind": "instance_of", @@ -79452,59 +99314,63 @@ } }, { - "name": "match_field", + "description": "A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Names", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "query", + "description": "Specify timeout for connection to master", + "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "name", + "description": "Explicit timestamp for the document", + "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/delete_alias/IndicesDeleteAliasRequest.ts#L24-L38" }, { - "kind": "interface", - "name": { - "name": "Summary", - "namespace": "enrich._types" + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ - { - "name": "config", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Configuration", - "namespace": "enrich._types" - } - } + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.delete_alias" + }, + "specLocation": "indices/delete_alias/IndicesDeleteAliasResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -79513,6 +99379,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a data stream.", "inherits": { "type": { "name": "RequestBase", @@ -79522,22 +99389,37 @@ "kind": "request", "name": { "name": "Request", - "namespace": "enrich.delete_policy" + "namespace": "indices.delete_data_stream" }, "path": [ { + "description": "A comma-separated list of data streams to delete; use `*` to delete all data streams", "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", "namespace": "_types" } } } ], - "query": [] + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L23-L35" }, { "body": { @@ -79553,49 +99435,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "enrich.delete_policy" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "SCHEDULED" - }, - { - "name": "RUNNING" - }, - { - "name": "COMPLETE" - }, - { - "name": "FAILED" - } - ], - "name": { - "name": "EnrichPolicyPhase", - "namespace": "enrich.execute_policy" - } - }, - { - "kind": "interface", - "name": { - "name": "ExecuteEnrichPolicyStatus", - "namespace": "enrich.execute_policy" + "namespace": "indices.delete_data_stream" }, - "properties": [ - { - "name": "phase", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "EnrichPolicyPhase", - "namespace": "enrich.execute_policy" - } - } - } - ] + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -79604,6 +99446,7 @@ "body": { "kind": "no_body" }, + "description": "The provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "inherits": { "type": { "name": "RequestBase", @@ -79613,16 +99456,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "enrich.execute_policy" + "namespace": "indices.delete_index_template" }, "path": [ { + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Names", "namespace": "_types" } } @@ -79630,51 +99474,51 @@ ], "query": [ { - "name": "wait_for_completion", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L52" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "status", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ExecuteEnrichPolicyStatus", - "namespace": "enrich.execute_policy" - } - } - }, - { - "name": "task_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskId", - "namespace": "_types" - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "enrich.execute_policy" - } + "namespace": "indices.delete_index_template" + }, + "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -79683,6 +99527,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes an index template.", "inherits": { "type": { "name": "RequestBase", @@ -79692,80 +99537,76 @@ "kind": "request", "name": { "name": "Request", - "namespace": "enrich.get_policy" + "namespace": "indices.delete_template" }, "path": [ { + "description": "The name of the template", "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } ], - "query": [] + "specLocation": "indices/delete_template/IndicesDeleteTemplateRequest.ts#L24-L37" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "policies", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Summary", - "namespace": "enrich._types" - } - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "enrich.get_policy" - } + "namespace": "indices.delete_template" + }, + "specLocation": "indices/delete_template/IndicesDeleteTemplateResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "geo_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Policy", - "namespace": "enrich._types" - } - } - }, - { - "name": "match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Policy", - "namespace": "enrich._types" - } - } - } - ] + "kind": "no_body" }, + "description": "Analyzes the disk usage of each field of an index or data stream", "inherits": { "type": { "name": "RequestBase", @@ -79775,134 +99616,142 @@ "kind": "request", "name": { "name": "Request", - "namespace": "enrich.put_policy" + "namespace": "indices.disk_usage" }, "path": [ { - "name": "name", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "enrich.put_policy" - } - }, - { - "kind": "interface", - "name": { - "name": "CoordinatorStats", - "namespace": "enrich.stats" - }, - "properties": [ + "query": [ { - "name": "executed_searches_total", - "required": true, + "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", + "name": "allow_no_indices", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "node_id", - "required": true, + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "queue_size", - "required": true, + "description": "If true, the API performs a flush before analysis. If false, the response may not include uncommitted data.", + "name": "flush", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "remote_requests_current", - "required": true, + "description": "If true, missing or closed indices are not included in the response.", + "name": "ignore_unavailable", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "remote_requests_total", - "required": true, + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "TimeUnit", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ExecutingPolicy", - "namespace": "enrich.stats" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "TimeUnit", "namespace": "_types" } } }, { - "name": "task", - "required": true, + "description": "Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true.", + "name": "run_expensive_tasks", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Info", - "namespace": "task._types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.", + "name": "wait_for_active_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/disk_usage/IndicesDiskUsageRequest.ts#L24-L77" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "user_defined_value" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.disk_usage" + }, + "specLocation": "indices/disk_usage/IndicesDiskUsageResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -79911,6 +99760,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about whether a particular index exists.", "inherits": { "type": { "name": "RequestBase", @@ -79920,346 +99770,361 @@ "kind": "request", "name": { "name": "Request", - "namespace": "enrich.stats" + "namespace": "indices.exists" }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "coordinator_stats", - "required": true, + "path": [ + { + "description": "A comma-separated list of index names", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CoordinatorStats", - "namespace": "enrich.stats" - } - } + "name": "Indices", + "namespace": "_types" } - }, - { - "name": "executing_policies", - "required": true, + } + } + ], + "query": [ + { + "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExecutingPolicy", - "namespace": "enrich.stats" - } - } + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "enrich.stats" - } - }, - { - "generics": [ + }, { - "name": "TEvent", - "namespace": "eql._types" - } - ], - "kind": "interface", - "name": { - "name": "EqlHits", - "namespace": "eql._types" - }, - "properties": [ + "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, { - "description": "Metadata about the number of matching events or sequences.", - "name": "total", + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TotalHits", - "namespace": "_global.search._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains events matching the query. Each object represents a matching event.", - "name": "events", + "description": "Ignore unavailable indexes (default: false)", + "name": "ignore_unavailable", "required": false, "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsEvent", - "namespace": "eql._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", - "name": "sequences", + "description": "Whether to return all default setting for each of the indices.", + "name": "include_defaults", "required": false, "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsSequence", - "namespace": "eql._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/exists/IndicesExistsRequest.ts#L23-L40" }, { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html#eql-search-api-response-body", - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types" - } + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.exists" + }, + "specLocation": "indices/exists/IndicesExistsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" ], - "kind": "interface", + "body": { + "kind": "no_body" + }, + "description": "Returns information about whether a particular alias exists.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "EqlSearchResponseBase", - "namespace": "eql._types" + "name": "Request", + "namespace": "indices.exists_alias" }, - "properties": [ + "path": [ { - "description": " Identifier for the search.", - "name": "id", - "required": false, + "description": "A comma-separated list of alias names to return", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Names", "namespace": "_types" } } }, { - "description": "If true, the response does not contain complete search results.", - "name": "is_partial", + "description": "A comma-separated list of index names to filter aliases", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "If true, the search request is still executing.", - "name": "is_running", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "Milliseconds it took Elasticsearch to execute the request.", - "name": "took", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "description": "If true, the request timed out before completion.", - "name": "timed_out", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "Contains matching events and sequences. Also contains related metadata.", - "name": "hits", - "required": true, + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types" - } - } - ], "kind": "instance_of", "type": { - "name": "EqlHits", - "namespace": "eql._types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L39" }, { - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types" - } + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.exists_alias" + }, + "specLocation": "indices/exists_alias/IndicesExistsAliasResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" ], - "kind": "interface", + "body": { + "kind": "no_body" + }, + "description": "Returns information about whether a particular index template exists.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "HitsEvent", - "namespace": "eql._types" + "name": "Request", + "namespace": "indices.exists_index_template" }, - "properties": [ + "path": [ { - "description": "Name of the index containing the event.", - "name": "_index", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Name", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "Unique identifier for the event. This ID is only unique within the index.", - "name": "_id", - "required": true, + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L41" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.exists_index_template" + }, + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateResponse.ts#L22-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about whether a particular index template exists.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.exists_template" + }, + "path": [ { - "description": "Original JSON body passed for the event at index time.", - "name": "_source", + "description": "The comma separated names of the index templates", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TEvent", - "namespace": "eql._types" + "name": "Names", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "fields", + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types" - } - ], - "kind": "interface", - "name": { - "name": "HitsSequence", - "namespace": "eql._types" - }, - "properties": [ + }, { - "description": "Contains events matching the query. Each object represents a matching event.", - "name": "events", - "required": true, + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsEvent", - "namespace": "eql._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", - "name": "join_keys", - "required": true, + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/exists_template/IndicesExistsTemplateRequest.ts#L24-L38" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.exists_template" + }, + "specLocation": "indices/exists_template/IndicesExistsTemplateResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -80268,6 +100133,11 @@ "body": { "kind": "no_body" }, + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "description": "Returns information about whether a particular document type exists. (DEPRECATED)", "inherits": { "type": { "name": "RequestBase", @@ -80277,40 +100147,96 @@ "kind": "request", "name": { "name": "Request", - "namespace": "eql.delete" + "namespace": "indices.exists_type" }, "path": [ { - "description": "Identifier for the search to delete.", - "name": "id", + "description": "A comma-separated list of index names; use `_all` to check the types across all indices", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of document types to check", + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Types", "namespace": "_types" } } } ], - "query": [] + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/exists_type/IndicesExistsTypeRequest.ts#L23-L40" }, { "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } + "kind": "no_body" }, "kind": "response", "name": { "name": "Response", - "namespace": "eql.delete" - } + "namespace": "indices.exists_type" + }, + "specLocation": "indices/exists_type/IndicesExistsTypeResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -80319,6 +100245,7 @@ "body": { "kind": "no_body" }, + "description": "Performs the flush operation on one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -80328,17 +100255,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "eql.get" + "namespace": "indices.flush" }, "path": [ { - "description": "Identifier for the search.", - "name": "id", - "required": true, + "description": "A comma-separated list of index names; use `_all` or empty string for all indices", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Indices", "namespace": "_types" } } @@ -80346,62 +100273,85 @@ ], "query": [ { - "description": "Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.", - "name": "keep_alive", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", - "name": "wait_for_completion_timeout", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "ExpandWildcards", "namespace": "_types" } } + }, + { + "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)", + "name": "force", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.", + "name": "wait_if_ongoing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "indices/flush/IndicesFlushRequest.ts#L23-L39" }, { "body": { "kind": "properties", "properties": [] }, - "generics": [ - { - "name": "TEvent", - "namespace": "eql.get" - } - ], "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql.get" - } - } - ], "type": { - "name": "EqlSearchResponseBase", - "namespace": "eql._types" + "name": "ShardsOperationResponseBase", + "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "eql.get" - } + "namespace": "indices.flush" + }, + "specLocation": "indices/flush/IndicesFlushResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -80410,6 +100360,7 @@ "body": { "kind": "no_body" }, + "description": "Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead", "inherits": { "type": { "name": "RequestBase", @@ -80419,316 +100370,116 @@ "kind": "request", "name": { "name": "Request", - "namespace": "eql.get_status" + "namespace": "indices.flush_synced" }, "path": [ { - "description": "Identifier for the search.", - "name": "id", - "required": true, + "description": "A comma-separated list of index names; use `_all` or empty string for all indices", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Indices", "namespace": "_types" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "Identifier for the search.", - "name": "id", - "required": true, + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "If true, the search request is still executing. If false, the search is completed.", - "name": "is_partial", - "required": true, + } + }, + { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "ExpandWildcards", + "namespace": "_types" } - }, - { - "description": "If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.", - "name": "is_running", - "required": true, + } + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } - }, + } + } + ], + "specLocation": "indices/flush_synced/IndicesFlushSyncedRequest.ts#L23-L37" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "description": "For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.", - "name": "start_time_in_millis", - "required": false, + "name": "_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "ShardStatistics", "namespace": "_types" } } - }, + } + ] + }, + "inherits": { + "generics": [ { - "description": "Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing.", - "name": "expiration_time_in_millis", - "required": false, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "EpochMillis", - "namespace": "_types" - } + "name": "IndexName", + "namespace": "_types" } }, { - "description": "For a completed search shows the http status code of the completed search.", - "name": "completion_status", - "required": false, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "ShardStatistics", + "namespace": "_types" } } - ] + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "eql.get_status" - } + "namespace": "indices.flush_synced" + }, + "specLocation": "indices/flush_synced/IndicesFlushSyncedResponse.ts#L24-L31" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "EQL query you wish to run.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html", - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "case_sensitive", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "Field containing the event classification, such as process, file, or network.", - "name": "event_category_field", - "required": false, - "serverDefault": "event.category", - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Field used to sort hits with the same timestamp in ascending order", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html#eql-search-specify-a-sort-tiebreaker", - "name": "tiebreaker_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Field containing event timestamp. Default \"@timestamp\"", - "name": "timestamp_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Maximum number of events to search at a time for sequence queries.", - "name": "fetch_size", - "required": false, - "serverDefault": "1000", - "type": { - "kind": "instance_of", - "type": { - "name": "uint", - "namespace": "_types" - } - } - }, - { - "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", - "name": "filter", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "keep_alive", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "keep_on_completion", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "wait_for_completion_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax", - "name": "size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "uint", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SearchFieldFormatted", - "namespace": "eql.search" - } - } - ], - "kind": "union_of" - } - } - }, - { - "name": "result_position", - "required": false, - "serverDefault": "tail", - "type": { - "kind": "instance_of", - "type": { - "name": "ResultPosition", - "namespace": "eql.search" - } - } - } - ] + "kind": "no_body" }, + "description": "Performs the force merge operation on one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -80738,16 +100489,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "eql.search" + "namespace": "indices.forcemerge" }, "path": [ { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Indices", "namespace": "_types" } } @@ -80755,21 +100507,21 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, - "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -80779,241 +100531,221 @@ } }, { - "description": "If true, missing or closed indices are not included in the response.", - "name": "ignore_unavailable", + "description": "Specify whether the index should be flushed after performing the operation (default: true)", + "name": "flush", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "Period for which the search and its results are stored on the cluster.", - "name": "keep_alive", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, - "serverDefault": "5d", "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If true, the search and its results are stored on the cluster.", - "name": "keep_on_completion", + "description": "The number of segments the index should be merged into (default: dynamic)", + "name": "max_num_segments", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", - "name": "wait_for_completion_timeout", + "description": "Specify whether the operation should only expunge deleted documents", + "name": "only_expunge_deletes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L41" }, { "body": { "kind": "properties", "properties": [] }, - "generics": [ - { - "name": "TEvent", - "namespace": "eql.search" - } - ], "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql.search" - } - } - ], "type": { - "name": "EqlSearchResponseBase", - "namespace": "eql._types" + "name": "ShardsOperationResponseBase", + "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "eql.search" - } + "namespace": "indices.forcemerge" + }, + "specLocation": "indices/forcemerge/IndicesForceMergeResponse.ts#L22-L22" }, { - "kind": "enum", - "members": [ - { - "description": "Return the most recent matches, similar to the Unix tail command.", - "name": "tail" - }, - { - "description": "Return the earliest matches, similar to the Unix head command.", - "name": "head" - } + "attachedBehaviors": [ + "CommonQueryParameters" ], + "body": { + "kind": "no_body" + }, + "description": "Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ResultPosition", - "namespace": "eql.search" - } - }, - { - "kind": "interface", - "name": { - "name": "SearchFieldFormatted", - "namespace": "eql.search" + "name": "Request", + "namespace": "indices.freeze" }, - "properties": [ + "path": [ { - "description": "Wildcard pattern. The request returns values for field names matching this pattern.", - "name": "field", + "description": "The name of the index to freeze", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "IndexName", "namespace": "_types" } } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "description": "Format in which the values are returned.", - "name": "format", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ExpandWildcards", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "features.get_features" - }, - "path": [ + }, { - "name": "stub_a", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub_b", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Sets the number of active shards to wait for before the operation returns.", + "name": "wait_for_active_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForActiveShards", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/freeze/IndicesFreezeRequest.ts#L24-L41" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "shards_acknowledged", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "features.get_features" - } + "namespace": "indices.freeze" + }, + "specLocation": "indices/freeze/IndicesFreezeResponse.ts#L22-L26" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "kind": "no_body" }, + "description": "Returns information about one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -81023,461 +100755,589 @@ "kind": "request", "name": { "name": "Request", - "namespace": "features.reset_features" + "namespace": "indices.get" }, "path": [ { - "name": "stub_a", + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" } } } ], "query": [ { - "name": "stub_b", - "required": true, + "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)", + "name": "allow_no_indices", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "If true, returns settings in flat format.", + "name": "flat_settings", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If false, requests that target a missing index return an error.", + "name": "ignore_unavailable", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, return all default settings in the response.", + "name": "include_defaults", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, a mapping type is expected in the body of mappings.", + "name": "include_type_name", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/get/IndicesGetRequest.ts#L24-L73" }, { "body": { "kind": "properties", - "properties": [ + "properties": [] + }, + "inherits": { + "generics": [ { - "name": "stub", - "required": true, + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "IndexState", + "namespace": "indices._types" } } - ] + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "features.reset_features" - } + "namespace": "indices.get" + }, + "specLocation": "indices/get/IndicesGetResponse.ts#L24-L24" }, { "kind": "interface", "name": { - "name": "Connection", - "namespace": "graph._types" + "name": "IndexAliases", + "namespace": "indices.get_alias" }, "properties": [ { - "name": "doc_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "source", + "name": "aliases", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AliasDefinition", + "namespace": "indices._types" + } } } - }, + } + ], + "specLocation": "indices/get_alias/IndicesGetAliasResponse.ts#L27-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns an alias.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.get_alias" + }, + "path": [ { - "name": "target", - "required": true, + "description": "A comma-separated list of alias names to return", + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Names", "namespace": "_types" } } }, { - "name": "weight", - "required": true, + "description": "A comma-separated list of index names to filter aliases", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Indices", "namespace": "_types" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "ExploreControls", - "namespace": "graph._types" - }, - "properties": [ + ], + "query": [ { - "name": "sample_diversity", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SampleDiversity", - "namespace": "graph._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "sample_size", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "timeout", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "use_significance", - "required": true, + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/get_alias/IndicesGetAliasRequest.ts#L23-L39" }, { - "kind": "interface", - "name": { - "name": "Hop", - "namespace": "graph._types" + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ - { - "name": "connections", - "required": false, - "type": { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "Hop", - "namespace": "graph._types" + "name": "IndexName", + "namespace": "_types" } - } - }, - { - "name": "query", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "vertices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "VertexDefinition", - "namespace": "graph._types" - } + "name": "IndexAliases", + "namespace": "indices.get_alias" } } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_alias" + }, + "specLocation": "indices/get_alias/IndicesGetAliasResponse.ts#L25-L25" }, { "kind": "interface", "name": { - "name": "SampleDiversity", - "namespace": "graph._types" + "name": "IndicesGetDataStreamItem", + "namespace": "indices.get_data_stream" }, "properties": [ { - "name": "field", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "DataStreamName", "namespace": "_types" } } }, { - "name": "max_docs_per_value", + "name": "timestamp_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndicesGetDataStreamItemTimestampField", + "namespace": "indices.get_data_stream" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Vertex", - "namespace": "graph._types" - }, - "properties": [ + }, { - "name": "depth", + "name": "indices", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesGetDataStreamItemIndex", + "namespace": "indices.get_data_stream" + } } } }, { - "name": "field", + "name": "generation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "name": "term", + "name": "template", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } }, { - "name": "weight", + "name": "hidden", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "VertexDefinition", - "namespace": "graph._types" - }, - "properties": [ + }, { - "name": "exclude", + "name": "system", "required": false, + "since": "7.10.0", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "field", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "HealthStatus", "namespace": "_types" } } }, { - "name": "include", + "name": "ilm_policy", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "VertexInclude", - "namespace": "graph._types" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "name": "min_doc_count", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Metadata", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/get_data_stream/IndicesGetDataStreamResponse.ts#L35-L48" + }, + { + "kind": "interface", + "name": { + "name": "IndicesGetDataStreamItemIndex", + "namespace": "indices.get_data_stream" + }, + "properties": [ { - "name": "shard_min_doc_count", - "required": false, + "name": "index_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "size", - "required": false, + "name": "index_uuid", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Uuid", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/get_data_stream/IndicesGetDataStreamResponse.ts#L54-L57" }, { "kind": "interface", "name": { - "name": "VertexInclude", - "namespace": "graph._types" + "name": "IndicesGetDataStreamItemTimestampField", + "namespace": "indices.get_data_stream" }, "properties": [ { - "name": "boost", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/get_data_stream/IndicesGetDataStreamResponse.ts#L50-L52" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns data streams.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.get_data_stream" + }, + "path": [ { - "name": "term", - "required": true, + "description": "A comma-separated list of data streams to get; use `*` to get all data streams", + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L23-L35" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "connections", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Hop", - "namespace": "graph._types" - } - } - }, - { - "name": "controls", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExploreControls", - "namespace": "graph._types" - } - } - }, - { - "name": "query", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "vertices", - "required": false, + "name": "data_streams", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "VertexDefinition", - "namespace": "graph._types" + "name": "IndicesGetDataStreamItem", + "namespace": "indices.get_data_stream" } } } } ] }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_data_stream" + }, + "specLocation": "indices/get_data_stream/IndicesGetDataStreamResponse.ts#L31-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns mapping for one or more fields.", "inherits": { "type": { "name": "RequestBase", @@ -81487,12 +101347,25 @@ "kind": "request", "name": { "name": "Request", - "namespace": "graph.explore" + "namespace": "indices.get_field_mapping" }, "path": [ { - "name": "index", + "description": "A comma-separated list of fields", + "name": "fields", "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of index names", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { @@ -81502,6 +101375,7 @@ } }, { + "description": "A comma-separated list of document types", "name": "type", "required": false, "type": { @@ -81515,276 +101389,268 @@ ], "query": [ { - "name": "routing", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "timeout", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "ExpandWildcards", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "connections", - "required": true, + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Connection", - "namespace": "graph._types" - } - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "failures", - "required": true, + } + }, + { + "description": "Whether the default mapping values should be returned as well", + "name": "include_defaults", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardFailure", - "namespace": "_types" - } - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "timed_out", - "required": true, + } + }, + { + "description": "Whether a type should be returned in the body of the mappings.", + "name": "include_type_name", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } - }, + } + }, + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/get_field_mapping/IndicesGetFieldMappingRequest.ts#L23-L42" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "generics": [ { - "name": "took", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "IndexName", + "namespace": "_types" } }, { - "name": "vertices", - "required": true, + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Vertex", - "namespace": "graph._types" - } - } + "name": "TypeFieldMappings", + "namespace": "indices.get_field_mapping" } } - ] + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "graph.explore" - } + "namespace": "indices.get_field_mapping" + }, + "specLocation": "indices/get_field_mapping/IndicesGetFieldMappingResponse.ts#L24-L27" }, { "kind": "interface", "name": { - "name": "Action", - "namespace": "ilm._types" + "name": "TypeFieldMappings", + "namespace": "indices.get_field_mapping" }, - "properties": [] + "properties": [ + { + "name": "mappings", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "FieldMapping", + "namespace": "_types.mapping" + } + } + } + } + ], + "specLocation": "indices/get_field_mapping/types.ts#L24-L26" }, { "kind": "interface", "name": { - "name": "Phase", - "namespace": "ilm._types" + "name": "IndexTemplate", + "namespace": "indices.get_index_template" }, "properties": [ { - "name": "actions", + "name": "index_patterns", "required": true, "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Action", - "namespace": "ilm._types" - } - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } - ], - "kind": "union_of" + } } }, { - "name": "min_age", - "required": false, + "name": "composed_of", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Phases", - "namespace": "ilm._types" - }, - "properties": [ + }, { - "name": "cold", + "name": "template", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Phase", - "namespace": "ilm._types" + "name": "IndexTemplateSummary", + "namespace": "indices.get_index_template" } } }, { - "name": "delete", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Phase", - "namespace": "ilm._types" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "name": "hot", + "name": "priority", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Phase", - "namespace": "ilm._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "warm", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Phase", - "namespace": "ilm._types" + "name": "Metadata", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Policy", - "namespace": "ilm._types" - }, - "properties": [ + }, { - "name": "phases", - "required": true, + "name": "allow_auto_create", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Phases", - "namespace": "ilm._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "name", + "name": "data_stream", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } } - ] + ], + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L38-L48" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ilm.delete_lifecycle" + "name": "IndexTemplateItem", + "namespace": "indices.get_index_template" }, - "path": [ + "properties": [ { - "name": "policy", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { @@ -81794,78 +101660,103 @@ } }, { - "name": "policy_id", + "name": "index_template", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "IndexTemplate", + "namespace": "indices.get_index_template" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ilm.delete_lifecycle" - } + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L33-L36" }, { "kind": "interface", "name": { - "name": "LifecycleExplain", - "namespace": "ilm.explain_lifecycle" + "name": "IndexTemplateSummary", + "namespace": "indices.get_index_template" }, "properties": [ { - "name": "action", - "required": true, + "name": "aliases", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } } } }, { - "name": "action_time_millis", - "required": true, + "name": "mappings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "age", - "required": true, + "name": "settings", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L50-L54" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns an index template.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.get_index_template" + }, + "path": [ { - "name": "failed_step", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "name": "name", "required": false, "type": { "kind": "instance_of", @@ -81874,240 +101765,277 @@ "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "failed_step_retry_count", + "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "name": "local", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index", - "required": true, + "description": "If true, returns settings in flat format.", + "name": "flat_settings", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "is_auto_retryable_error", + "description": "If true, a mapping type is expected in the body of mappings.", + "name": "include_type_name", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "lifecycle_date_millis", - "required": true, + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Time", "namespace": "_types" } } - }, - { - "name": "managed", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L56" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "index_templates", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexTemplateItem", + "namespace": "indices.get_index_template" + } + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_index_template" + }, + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L27-L31" + }, + { + "kind": "interface", + "name": { + "name": "IndexMappingRecord", + "namespace": "indices.get_mapping" + }, + "properties": [ { - "name": "phase", - "required": true, + "name": "item", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "phase_time_millis", + "name": "mappings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } - }, + } + ], + "specLocation": "indices/get_mapping/IndicesGetMappingResponse.ts#L29-L32" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns mappings for one or more indices.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.get_mapping" + }, + "path": [ { - "name": "policy", - "required": true, + "description": "A comma-separated list of index names", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Indices", "namespace": "_types" } } }, { - "name": "step", - "required": true, + "description": "A comma-separated list of document types", + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Types", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "step_info", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "step_time_millis", - "required": true, + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "phase_execution", - "required": true, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "LifecycleExplainPhaseExecution", - "namespace": "ilm.explain_lifecycle" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "LifecycleExplainPhaseExecution", - "namespace": "ilm.explain_lifecycle" - }, - "properties": [ + }, { - "name": "policy", - "required": true, + "description": "Whether to add the type name to the response (default: false)", + "name": "include_type_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", - "required": true, + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "modified_date_in_millis", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Time", "namespace": "_types" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "LifecycleExplainProject", - "namespace": "ilm.explain_lifecycle" - }, - "properties": [ - { - "name": "project", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "LifecycleExplainProjectSummary", - "namespace": "ilm.explain_lifecycle" - } - } - } - ] + ], + "specLocation": "indices/get_mapping/IndicesGetMappingRequest.ts#L24-L42" }, - { - "kind": "interface", - "name": { - "name": "LifecycleExplainProjectSummary", - "namespace": "ilm.explain_lifecycle" + { + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ - { - "name": "index", - "required": true, - "type": { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { "name": "IndexName", "namespace": "_types" } - } - }, - { - "name": "managed", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexMappingRecord", + "namespace": "indices.get_mapping" } } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_mapping" + }, + "specLocation": "indices/get_mapping/IndicesGetMappingResponse.ts#L24-L27" }, { "attachedBehaviors": [ @@ -82116,6 +102044,7 @@ "body": { "kind": "no_body" }, + "description": "Returns settings for one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -82125,16 +102054,29 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.explain_lifecycle" + "namespace": "indices.get_settings" }, "path": [ { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "The name of the settings that should be included", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", "namespace": "_types" } } @@ -82142,116 +102084,125 @@ ], "query": [ { - "name": "only_errors", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "only_managed", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "indices", - "required": true, + }, + { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, + "type": { + "kind": "instance_of", "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "LifecycleExplain", - "namespace": "ilm.explain_lifecycle" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "LifecycleExplainProject", - "namespace": "ilm.explain_lifecycle" - } - } - ], - "kind": "union_of" + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ilm.explain_lifecycle" - } - }, - { - "kind": "interface", - "name": { - "name": "Lifecycle", - "namespace": "ilm.get_lifecycle" - }, - "properties": [ + }, { - "name": "modified_date", - "required": true, + "description": "Whether to return all default setting for each of the indices.", + "name": "include_defaults", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "policy", - "required": true, + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Policy", - "namespace": "ilm._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/get_settings/IndicesGetSettingsRequest.ts#L24-L43" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "IndexName", "namespace": "_types" } + }, + { + "kind": "instance_of", + "type": { + "name": "IndexState", + "namespace": "indices._types" + } } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_settings" + }, + "specLocation": "indices/get_settings/IndicesGetSettingsResponse.ts#L24-L24" }, { "attachedBehaviors": [ @@ -82260,6 +102211,7 @@ "body": { "kind": "no_body" }, + "description": "Returns an index template.", "inherits": { "type": { "name": "RequestBase", @@ -82269,33 +102221,73 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.get_lifecycle" + "namespace": "indices.get_template" }, "path": [ { - "name": "policy", + "description": "The comma separated names of the index templates", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Names", "namespace": "_types" } } + } + ], + "query": [ + { + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "policy_id", + "description": "Whether a type should be returned in the body of the mappings.", + "name": "include_type_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } ], - "query": [] + "specLocation": "indices/get_template/IndicesGetTemplateRequest.ts#L24-L39" }, { "body": { @@ -82308,14 +102300,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { - "name": "Lifecycle", - "namespace": "ilm.get_lifecycle" + "name": "TemplateMapping", + "namespace": "indices._types" } } ], @@ -82327,8 +102319,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ilm.get_lifecycle" - } + "namespace": "indices.get_template" + }, + "specLocation": "indices/get_template/IndicesGetTemplateResponse.ts#L23-L23" }, { "attachedBehaviors": [ @@ -82337,6 +102330,7 @@ "body": { "kind": "no_body" }, + "description": "DEPRECATED Returns a progress status of current upgrade.", "inherits": { "type": { "name": "RequestBase", @@ -82346,65 +102340,73 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.get_status" + "namespace": "indices.get_upgrade" }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "operation_mode", - "required": true, + "path": [ + { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "LifecycleOperationMode", - "namespace": "_types" - } + "name": "IndexName", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ilm.get_status" - } + } + ], + "query": [], + "specLocation": "indices/get_upgrade/IndicesGetUpgradeRequest.ts#L23-L32" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "current_step", + "description": "Any templates that were superseded by the specified template.", + "name": "overlapping", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "StepKey", - "namespace": "ilm.move_to_step" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "OverlappingIndexTemplate", + "namespace": "indices._types" + } } } }, { - "name": "next_step", + "description": "The settings, mappings, and aliases that would be applied to matching indices.", + "name": "template", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StepKey", - "namespace": "ilm.move_to_step" + "name": "TemplateMapping", + "namespace": "indices._types" } } } ] }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_upgrade" + }, + "specLocation": "indices/get_upgrade/IndicesGetUpgradeResponse.ts#L23-L30" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Migrates an alias to a data stream", "inherits": { "type": { "name": "RequestBase", @@ -82414,11 +102416,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.move_to_step" + "namespace": "indices.migrate_to_data_stream" }, "path": [ { - "name": "index", + "description": "The name of the alias to migrate", + "name": "name", "required": true, "type": { "kind": "instance_of", @@ -82429,7 +102432,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L23-L32" }, { "body": { @@ -82445,112 +102449,135 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ilm.move_to_step" - } + "namespace": "indices.migrate_to_data_stream" + }, + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamResponse.ts#L22-L22" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Opens an index.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "StepKey", - "namespace": "ilm.move_to_step" + "name": "Request", + "namespace": "indices.open" }, - "properties": [ + "path": [ { - "name": "action", + "description": "A comma separated list of indices to open", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "name", - "required": true, + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "name": "phase", - "required": true, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "policy", - "required": false, + }, + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Policy", - "namespace": "ilm._types" - } + "name": "Time", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ilm.put_lifecycle" - }, - "path": [ + }, { - "name": "policy", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Time", "namespace": "_types" } } }, { - "name": "policy_id", + "description": "Sets the number of active shards to wait for before the operation returns.", + "name": "wait_for_active_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "WaitForActiveShards", "namespace": "_types" } } } ], - "query": [] + "specLocation": "indices/open/IndicesOpenRequest.ts#L24-L41" }, { "body": { "kind": "properties", - "properties": [] + "properties": [ + { + "name": "shards_acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] }, "inherits": { "type": { @@ -82561,8 +102588,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ilm.put_lifecycle" - } + "namespace": "indices.open" + }, + "specLocation": "indices/open/IndicesOpenResponse.ts#L22-L26" }, { "attachedBehaviors": [ @@ -82571,6 +102599,7 @@ "body": { "kind": "no_body" }, + "description": "Promotes a data stream from a replicated data stream managed by CCR to a regular data stream", "inherits": { "type": { "name": "RequestBase", @@ -82580,11 +102609,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.remove_policy" + "namespace": "indices.promote_data_stream" }, "path": [ { - "name": "index", + "description": "The name of the data stream", + "name": "name", "required": true, "type": { "kind": "instance_of", @@ -82595,52 +102625,88 @@ } } ], - "query": [] + "query": [], + "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "user_defined_value" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.promote_data_stream" + }, + "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "failed_indexes", - "required": true, + "name": "filter", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "has_failures", - "required": true, + "name": "index_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "name": "is_write_index", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "name": "search_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ilm.remove_policy" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, + "description": "Creates or updates an alias.", "inherits": { "type": { "name": "RequestBase", @@ -82650,22 +102716,61 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.retry" + "namespace": "indices.put_alias" }, "path": [ { + "description": "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "The name of the alias to be created or updated", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Explicit timestamp for the document", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } ], - "query": [] + "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L46" }, { "body": { @@ -82681,8 +102786,63 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ilm.retry" - } + "namespace": "indices.put_alias" + }, + "specLocation": "indices/put_alias/IndicesPutAliasResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "IndexTemplateMapping", + "namespace": "indices.put_index_template" + }, + "properties": [ + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } + } + } + }, + { + "name": "mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L57-L61" }, { "attachedBehaviors": [ @@ -82692,18 +102852,89 @@ "kind": "properties", "properties": [ { - "name": "stub", - "required": true, + "name": "index_patterns", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "name": "composed_of", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + }, + { + "name": "template", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexTemplateMapping", + "namespace": "indices.put_index_template" + } + } + }, + { + "name": "data_stream", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStream", + "namespace": "indices._types" + } + } + }, + { + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" } } } ] }, + "description": "Creates or updates an index template.", "inherits": { "type": { "name": "RequestBase", @@ -82713,10 +102944,24 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ilm.start" + "namespace": "indices.put_index_template" }, - "path": [], - "query": [] + "path": [ + { + "description": "Index or template name", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L35-L55" }, { "body": { @@ -82732,8 +102977,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ilm.start" - } + "namespace": "indices.put_index_template" + }, + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -82743,918 +102989,694 @@ "kind": "properties", "properties": [ { - "name": "stub", - "required": true, + "description": "Controls whether dynamic date detection is enabled.", + "name": "date_detection", + "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ilm.stop" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ilm.stop" - } - }, - { - "kind": "interface", - "name": { - "name": "Alias", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "index_routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Controls whether new fields are added dynamically.", + "name": "dynamic", + "required": false, "type": { - "name": "Routing", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "DynamicMapping", + "namespace": "_types.mapping" + } } - } - }, - { - "name": "is_hidden", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.", + "name": "dynamic_date_formats", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } - }, - { - "name": "is_write_index", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Specify dynamic templates for the mapping.", + "name": "dynamic_templates", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "items": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "DynamicTemplate", + "namespace": "_types.mapping" + } + } + }, + { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "DynamicTemplate", + "namespace": "_types.mapping" + } + } + } + } + ], + "kind": "union_of" } - } - }, - { - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Control whether field names are enabled for the index.", + "name": "_field_names", + "required": false, "type": { - "name": "Routing", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "FieldNamesField", + "namespace": "_types.mapping" + } } - } - }, - { - "name": "search_routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.", + "name": "_meta", + "required": false, "type": { - "name": "Routing", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "AliasDefinition", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Automatically map strings into numeric data types for all fields.", + "name": "numeric_detection", + "required": false, + "serverDefault": false, "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "name": "index_routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters", + "name": "properties", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } + } } - } - }, - { - "name": "is_write_index", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Enable making a routing value required on indexed documents.", + "name": "_routing", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "RoutingField", + "namespace": "_types.mapping" + } } - } - }, - { - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Control whether the _source field is enabled on the index.", + "name": "_source", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "SourceField", + "namespace": "_types.mapping" + } } - } - }, - { - "name": "search_routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Mapping of runtime fields for the index.", + "name": "runtime", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "description": "All shards are assigned.", - "name": "GREEN" - }, - { - "description": "All shards are assigned.", - "name": "green" - }, - { - "description": "All primary shards are assigned, but one or more replica shards are unassigned.", - "name": "YELLOW" - }, - { - "description": "All primary shards are assigned, but one or more replica shards are unassigned.", - "name": "yellow" - }, - { - "description": "One or more primary shards are unassigned, so some data is unavailable.", - "name": "RED" - }, - { - "description": "One or more primary shards are unassigned, so some data is unavailable.", - "name": "red" - } - ], - "name": { - "name": "DataStreamHealthStatus", - "namespace": "indices._types" - } - }, - { - "kind": "interface", + ] + }, + "description": "Updates the index mappings.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "FielddataFrequencyFilter", - "namespace": "indices._types" + "name": "Request", + "namespace": "indices.put_mapping" }, - "properties": [ + "path": [ { - "name": "max", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Indices", "namespace": "_types" } } }, { - "name": "min", - "required": true, + "description": "The name of the document type", + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Type", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "min_segment_size", - "required": true, + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "false" }, { - "name": "checksum" - }, - { - "name": "true" - } - ], - "name": { - "name": "IndexCheckOnStartup", - "namespace": "indices._types" - } - }, - { - "kind": "interface", - "name": { - "name": "IndexRouting", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "allocation", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocation", - "namespace": "indices._types" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "name": "rebalance", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingRebalance", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocation", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "enable", + "description": "Whether a type should be expected in the body of the mappings.", + "name": "include_type_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationOptions", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "include", + "description": "Specify timeout for connection to master", + "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationInclude", - "namespace": "indices._types" + "name": "Time", + "namespace": "_types" } } }, { - "name": "initial_recovery", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationInitialRecovery", - "namespace": "indices._types" + "name": "Time", + "namespace": "_types" } } }, { - "name": "disk", + "description": "When true, applies mappings only to the write index of an alias or data stream", + "name": "write_index_only", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationDisk", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L37-L113" }, { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocationDisk", - "namespace": "indices._types" + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ - { - "name": "threshold_enabled", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } + "inherits": { + "type": { + "name": "IndicesResponseBase", + "namespace": "_types" } - ] - }, - { - "kind": "interface", + }, + "kind": "response", "name": { - "name": "IndexRoutingAllocationInclude", - "namespace": "indices._types" + "name": "Response", + "namespace": "indices.put_mapping" }, - "properties": [ - { - "name": "_tier_preference", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ] + "specLocation": "indices/put_mapping/IndicesPutMappingResponse.ts#L22-L22" }, { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocationInitialRecovery", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "_id", - "required": false, + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "settings", + "kind": "value", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "IndexSettings", + "namespace": "indices._types" } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "all" - }, - { - "name": "primaries" - }, - { - "name": "new_primaries" - }, - { - "name": "none" + }, + "description": "Updates the index settings.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ], - "name": { - "name": "IndexRoutingAllocationOptions", - "namespace": "indices._types" - } - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "IndexRoutingRebalance", - "namespace": "indices._types" + "name": "Request", + "namespace": "indices.put_settings" }, - "properties": [ + "path": [ { - "name": "enable", - "required": true, + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingRebalanceOptions", - "namespace": "indices._types" + "name": "Indices", + "namespace": "_types" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "all" - }, - { - "name": "primaries" - }, - { - "name": "replicas" - }, - { - "name": "none" - } ], - "name": { - "name": "IndexRoutingRebalanceOptions", - "namespace": "indices._types" - } - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingBlocks", - "namespace": "indices._types" - }, - "properties": [ + "query": [ { - "aliases": [ - "index.blocks.read_only" - ], - "name": "read_only", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "index.blocks.read_only_allow_delete" - ], - "name": "read_only_allow_delete", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "aliases": [ - "index.blocks.read" - ], - "name": "read", + "description": "Return settings in flat format (default: false)", + "name": "flat_settings", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "aliases": [ - "index.blocks.write" - ], - "name": "write", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "index.blocks.metadata" - ], - "name": "metadata", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/7.8/index-modules.html#index-modules-settings", - "kind": "interface", - "name": { - "name": "IndexSettings", - "namespace": "indices._types" - }, - "properties": [ - { - "aliases": [ - "index.number_of_shards" - ], - "description": "server_default 1", - "name": "number_of_shards", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "index.number_of_replicas" - ], - "description": "server_default 0", - "name": "number_of_replicas", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } }, { - "aliases": [ - "index.number_of_routing_shards" - ], - "name": "number_of_routing_shards", + "description": "Specify timeout for connection to master", + "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } }, { - "aliases": [ - "index.check_on_startup" - ], - "name": "check_on_startup", + "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`", + "name": "preserve_existing", "required": false, - "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "IndexCheckOnStartup", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "index.codec" - ], - "name": "codec", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, - "serverDefault": "LZ4", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } - }, - { - "aliases": [ - "index.routing_partition_size" - ], - "description": "server_default 1", - "name": "routing_partition_size", - "required": false, - "type": { - "items": [ - { + } + ], + "specLocation": "indices/put_settings/IndicesPutSettingsRequest.ts#L25-L45" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.put_settings" + }, + "specLocation": "indices/put_settings/IndicesPutSettingsResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Aliases for the index.", + "name": "aliases", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } }, - { + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Alias", + "namespace": "indices._types" } } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "index.soft_deletes.retention_lease.period" - ], - "name": "soft_deletes.retention_lease.period", - "required": false, - "serverDefault": "12h", - "type": { - "kind": "instance_of", + } + }, + { + "description": "Array of wildcard expressions used to match the names\nof indices during creation.", + "name": "index_patterns", + "required": false, "type": { - "name": "Time", - "namespace": "_types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } - } - }, - { - "aliases": [ - "index.load_fixed_bitset_filters_eagerly" - ], - "name": "load_fixed_bitset_filters_eagerly", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "description": "Mapping for fields in the index.", + "name": "mappings", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" + } } - } - }, - { - "aliases": [ - "index.hidden" - ], - "description": "server_default false", - "name": "hidden", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { + }, + { + "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Configuration options for the index.", + "name": "settings", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "index.auto_expand_replicas" - ], - "name": "auto_expand_replicas", - "required": false, - "serverDefault": "false", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" } - } - }, - { - "aliases": [ - "index.search.idle.after" - ], - "name": "search.idle.after", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", + }, + { + "description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.", + "name": "version", + "required": false, "type": { - "name": "Time", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } } } - }, + ] + }, + "description": "Creates or updates an index template.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.put_template" + }, + "path": [ { - "aliases": [ - "index.refresh_interval" - ], - "name": "refresh_interval", - "required": false, - "serverDefault": "1s", + "description": "The name of the template", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Name", "namespace": "_types" } } - }, + } + ], + "query": [ { - "aliases": [ - "index.max_result_window" - ], - "name": "max_result_window", + "description": "If true, this request cannot replace or update existing index templates.", + "name": "create", "required": false, - "serverDefault": "10000", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "index.max_inner_result_window" - ], - "name": "max_inner_result_window", + "name": "flat_settings", "required": false, - "serverDefault": "100", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "index.max_rescore_window" - ], - "name": "max_rescore_window", + "description": "Whether a type should be returned in the body of the mappings.", + "name": "include_type_name", "required": false, - "serverDefault": "10000", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "aliases": [ - "index.max_docvalue_fields_search" - ], - "name": "max_docvalue_fields_search", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", "required": false, - "serverDefault": "100", + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } }, { - "aliases": [ - "index.max_script_fields" - ], - "name": "max_script_fields", + "name": "timeout", "required": false, - "serverDefault": "32", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } }, { - "aliases": [ - "index.max_ngram_diff" - ], - "name": "max_ngram_diff", + "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", + "name": "order", "required": false, - "serverDefault": "1", "type": { "kind": "instance_of", "type": { @@ -83662,802 +103684,554 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L94" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.put_template" + }, + "specLocation": "indices/put_template/IndicesPutTemplateResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "FileDetails", + "namespace": "indices.recovery" + }, + "properties": [ { - "aliases": [ - "index.max_shingle_diff" - ], - "name": "max_shingle_diff", - "required": false, - "serverDefault": "3", + "name": "length", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "aliases": [ - "index.blocks" - ], - "name": "blocks", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettingBlocks", - "namespace": "indices._types" - } - } - }, - { - "aliases": [ - "index.max_refresh_listeners" - ], - "name": "max_refresh_listeners", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "index.analyze.max_token_count" - ], - "name": "analyze.max_token_count", - "required": false, - "serverDefault": "10000", + "name": "recovered", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/recovery/types.ts#L45-L49" + }, + { + "kind": "interface", + "name": { + "name": "RecoveryBytes", + "namespace": "indices.recovery" + }, + "properties": [ { - "aliases": [ - "index.highlight.max_analyzed_offset" - ], - "name": "highlight.max_analyzed_offset", - "required": false, - "serverDefault": "1000000", + "name": "percent", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Percentage", "namespace": "_types" } } }, { - "aliases": [ - "index.max_terms_count" - ], - "name": "max_terms_count", + "name": "recovered", "required": false, - "serverDefault": "65536", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.max_regex_length" - ], - "name": "max_regex_length", - "required": false, - "serverDefault": "1000", + "name": "recovered_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.routing" - ], - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexRouting", - "namespace": "indices._types" - } - } - }, - { - "aliases": [ - "index.gc_deletes" - ], - "name": "gc_deletes", + "name": "recovered_from_snapshot", "required": false, - "serverDefault": "60s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.default_pipeline" - ], - "name": "default_pipeline", + "name": "recovered_from_snapshot_in_bytes", "required": false, - "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "PipelineName", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.final_pipeline" - ], - "name": "final_pipeline", + "name": "reused", "required": false, - "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "PipelineName", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.lifecycle" - ], - "name": "lifecycle", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettingsLifecycle", - "namespace": "indices._types" - } - } - }, - { - "aliases": [ - "index.provided_name" - ], - "name": "provided_name", - "required": false, + "name": "reused_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.creation_date" - ], - "name": "creation_date", + "name": "total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "ByteSize", "namespace": "_types" } } }, { - "aliases": [ - "index.uuid" - ], - "name": "uuid", - "required": false, + "name": "total_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "ByteSize", "namespace": "_types" } } - }, - { - "aliases": [ - "index.version" - ], - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexVersioning", - "namespace": "indices._types" - } - } - }, - { - "aliases": [ - "index.verified_before_close" - ], - "name": "verified_before_close", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, + } + ], + "specLocation": "indices/recovery/types.ts#L33-L43" + }, + { + "kind": "interface", + "name": { + "name": "RecoveryFiles", + "namespace": "indices.recovery" + }, + "properties": [ { - "aliases": [ - "index.format" - ], - "name": "format", + "name": "details", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FileDetails", + "namespace": "indices.recovery" } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "index.max_slices_per_scroll" - ], - "name": "max_slices_per_scroll", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" } } }, { - "aliases": [ - "index.translog.durability" - ], - "name": "translog.durability", - "required": false, + "name": "percent", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Percentage", + "namespace": "_types" } } }, { - "aliases": [ - "index.query_string.lenient" - ], - "name": "query_string.lenient", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "aliases": [ - "index.priority" - ], - "name": "priority", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "top_metrics_max_size", - "required": false, + "name": "recovered", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, - { - "name": "analysis", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettingsAnalysis", - "namespace": "indices._types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsAnalysis", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "char_filter", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "CharFilter", - "namespace": "_types.analysis" - } + { + "name": "reused", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsLifecycle", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "name", + "name": "total", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/recovery/types.ts#L51-L57" }, { "kind": "interface", "name": { - "name": "IndexState", - "namespace": "indices._types" + "name": "RecoveryIndexStatus", + "namespace": "indices.recovery" }, "properties": [ { - "name": "aliases", + "name": "bytes", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "RecoveryBytes", + "namespace": "indices.recovery" } } }, { - "name": "mappings", - "required": false, + "name": "files", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "RecoveryFiles", + "namespace": "indices.recovery" } } }, { - "name": "settings", + "name": "size", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "IndexStatePrefixedSettings", - "namespace": "indices._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "RecoveryBytes", + "namespace": "indices.recovery" + } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndexStatePrefixedSettings", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "index", - "required": true, + "name": "source_throttle_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "Time", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndexVersioning", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "created", + "name": "source_throttle_time_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "EpochMillis", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "NumericFielddata", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "format", - "required": true, + "name": "target_throttle_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "NumericFielddataFormat", - "namespace": "indices._types" + "name": "Time", + "namespace": "_types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "array" }, { - "name": "disabled" - } - ], - "name": { - "name": "NumericFielddataFormat", - "namespace": "indices._types" - } - }, - { - "kind": "interface", - "name": { - "name": "OverlappingIndexTemplate", - "namespace": "indices._types" - }, - "properties": [ + "name": "target_throttle_time_in_millis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, { - "name": "name", + "name": "total_time_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "index_patterns", + "name": "total_time", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/recovery/types.ts#L59-L69" }, { "kind": "interface", "name": { - "name": "StringFielddata", - "namespace": "indices._types" + "name": "RecoveryOrigin", + "namespace": "indices.recovery" }, "properties": [ { - "name": "format", - "required": true, + "name": "hostname", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "StringFielddataFormat", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "paged_bytes" }, { - "name": "disabled" - } - ], - "name": { - "name": "StringFielddataFormat", - "namespace": "indices._types" - } - }, - { - "kind": "interface", - "name": { - "name": "TemplateMapping", - "namespace": "indices._types" - }, - "properties": [ + "name": "host", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Host", + "namespace": "_types" + } + } + }, { - "name": "aliases", - "required": true, + "name": "transport_address", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "TransportAddress", + "namespace": "_types" } } }, { - "name": "index_patterns", - "required": true, + "name": "id", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } }, { - "name": "mappings", - "required": true, + "name": "ip", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "Ip", + "namespace": "_types" } } }, { - "name": "order", - "required": true, + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "settings", - "required": true, + "name": "bootstrap_new_history_uuid", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", + "name": "repository", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Name", "namespace": "_types" } } - } - ] - }, - { - "kind": "enum", - "members": [ + }, { - "name": "metadata" + "name": "snapshot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "name": "read" + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } }, { - "name": "read_only" + "name": "restoreUUID", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Uuid", + "namespace": "_types" + } + } }, { - "name": "write" + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } } ], - "name": { - "name": "IndicesBlockOptions", - "namespace": "indices.add_block" - } + "specLocation": "indices/recovery/types.ts#L71-L84" }, { "kind": "interface", "name": { - "name": "IndicesBlockStatus", - "namespace": "indices.add_block" + "name": "RecoveryStartStatus", + "namespace": "indices.recovery" }, "properties": [ { - "name": "name", + "name": "check_index_time", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "long", "namespace": "_types" } } }, { - "name": "blocked", + "name": "total_time_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/recovery/types.ts#L86-L89" + }, + { + "kind": "interface", + "name": { + "name": "RecoveryStatus", + "namespace": "indices.recovery" + }, + "properties": [ + { + "name": "shards", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardRecovery", + "namespace": "indices.recovery" + } } } } - ] + ], + "specLocation": "indices/recovery/types.ts#L91-L93" }, { "attachedBehaviors": [ @@ -84466,6 +104240,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about ongoing index shard recoveries.", "inherits": { "type": { "name": "RequestBase", @@ -84475,399 +104250,290 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.add_block" + "namespace": "indices.recovery" }, "path": [ { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Indices", "namespace": "_types" } } - }, - { - "name": "block", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndicesBlockOptions", - "namespace": "indices.add_block" - } - } } ], "query": [ { - "name": "allow_no_indices", + "description": "Display only those recoveries that are currently on-going", + "name": "active_only", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "namespace": "_builtins" } } }, { - "name": "ignore_unavailable", + "description": "Whether to display detailed information about shard recovery", + "name": "detailed", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/recovery/IndicesRecoveryRequest.ts#L23-L36" }, { "body": { "kind": "properties", - "properties": [ + "properties": [] + }, + "inherits": { + "generics": [ { - "name": "shards_acknowledged", - "required": true, + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "IndexName", + "namespace": "_types" } }, { - "name": "indices", - "required": true, + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesBlockStatus", - "namespace": "indices.add_block" - } - } + "name": "RecoveryStatus", + "namespace": "indices.recovery" } } - ] - }, - "inherits": { + ], "type": { - "name": "AcknowledgedResponseBase", + "name": "DictionaryResponseBase", "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.add_block" - } + "namespace": "indices.recovery" + }, + "specLocation": "indices/recovery/IndicesRecoveryResponse.ts#L24-L27" }, { "kind": "interface", "name": { - "name": "AnalyzeDetail", - "namespace": "indices.analyze" + "name": "ShardRecovery", + "namespace": "indices.recovery" }, "properties": [ { - "name": "analyzer", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalyzerDetail", - "namespace": "indices.analyze" + "name": "long", + "namespace": "_types" } } }, { - "name": "charfilters", - "required": false, + "name": "index", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CharFilterDetail", - "namespace": "indices.analyze" - } + "kind": "instance_of", + "type": { + "name": "RecoveryIndexStatus", + "namespace": "indices.recovery" } } }, { - "name": "custom_analyzer", + "name": "primary", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "tokenfilters", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TokenDetail", - "namespace": "indices.analyze" - } + "namespace": "_builtins" } } }, { - "name": "tokenizer", - "required": false, + "name": "source", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TokenDetail", - "namespace": "indices.analyze" + "name": "RecoveryOrigin", + "namespace": "indices.recovery" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "AnalyzeToken", - "namespace": "indices.analyze" - }, - "properties": [ + }, { - "name": "end_offset", + "name": "stage", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "position", - "required": true, + "name": "start", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "RecoveryStartStatus", + "namespace": "indices.recovery" } } }, { - "name": "position_length", + "name": "start_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateString", "namespace": "_types" } } }, { - "name": "start_offset", + "name": "start_time_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "token", - "required": true, + "name": "stop_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DateString", + "namespace": "_types" } } }, { - "name": "type", - "required": true, + "name": "stop_time_in_millis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "AnalyzerDetail", - "namespace": "indices.analyze" - }, - "properties": [ + }, { - "name": "name", + "name": "target", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "RecoveryOrigin", + "namespace": "indices.recovery" } } }, { - "name": "tokens", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExplainAnalyzeToken", - "namespace": "indices.analyze" - } - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "CharFilterDetail", - "namespace": "indices.analyze" - }, - "properties": [ - { - "name": "filtered_text", - "required": true, + "name": "total_time", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" } } }, { - "name": "name", + "name": "total_time_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ExplainAnalyzeToken", - "namespace": "indices.analyze" - }, - "properties": [ + }, { - "name": "bytes", + "name": "translog", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TranslogStatus", + "namespace": "indices.recovery" } } }, { - "name": "end_offset", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Type", "namespace": "_types" } } }, { - "name": "keyword", - "required": false, + "name": "verify_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VerifyIndex", + "namespace": "indices.recovery" } } - }, + } + ], + "specLocation": "indices/recovery/types.ts#L111-L128" + }, + { + "kind": "interface", + "name": { + "name": "TranslogStatus", + "namespace": "indices.recovery" + }, + "properties": [ { - "name": "position", + "name": "percent", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Percentage", "namespace": "_types" } } }, { - "name": "positionLength", + "name": "recovered", "required": true, "type": { "kind": "instance_of", @@ -84878,7 +104544,7 @@ } }, { - "name": "start_offset", + "name": "total", "required": true, "type": { "kind": "instance_of", @@ -84889,7 +104555,7 @@ } }, { - "name": "termFrequency", + "name": "total_on_start", "required": true, "type": { "kind": "instance_of", @@ -84900,307 +104566,83 @@ } }, { - "name": "token", - "required": true, + "name": "total_time", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "type", + "name": "total_time_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/recovery/types.ts#L95-L102" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "attributes", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "char_filter", - "required": false, - "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CharFilter", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" - } - } - }, - { - "name": "explain", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "filter", - "required": false, - "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TokenFilter", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" - } - } - }, - { - "name": "normalizer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "text", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TextToAnalyze", - "namespace": "indices.analyze" - } - } - }, - { - "name": "tokenizer", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Tokenizer", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.analyze" + "name": "VerifyIndex", + "namespace": "indices.recovery" }, - "path": [ + "properties": [ { - "name": "index", + "name": "check_index_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Time", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "detail", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalyzeDetail", - "namespace": "indices.analyze" - } - } - }, - { - "name": "tokens", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AnalyzeToken", - "namespace": "indices.analyze" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.analyze" - } - }, - { - "kind": "type_alias", - "name": { - "name": "TextToAnalyze", - "namespace": "indices.analyze" - }, - "type": { - "items": [ - { + }, + { + "name": "check_index_time_in_millis", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "EpochMillis", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "TokenDetail", - "namespace": "indices.analyze" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "name": "total_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "tokens", + "name": "total_time_in_millis", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExplainAnalyzeToken", - "namespace": "indices.analyze" - } + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/recovery/types.ts#L104-L109" }, { "attachedBehaviors": [ @@ -85209,6 +104651,7 @@ "body": { "kind": "no_body" }, + "description": "Performs the refresh operation in one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -85218,10 +104661,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.clear_cache" + "namespace": "indices.refresh" }, "path": [ { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": false, "type": { @@ -85235,17 +104679,19 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -85257,61 +104703,19 @@ } }, { - "name": "fielddata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "query", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "request", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/refresh/IndicesRefreshRequest.ts#L23-L37" }, { "body": { @@ -85327,58 +104731,67 @@ "kind": "response", "name": { "name": "Response", - "namespace": "indices.clear_cache" - } + "namespace": "indices.refresh" + }, + "specLocation": "indices/refresh/IndicesRefreshResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "ReloadDetails", + "namespace": "indices.reload_search_analyzers" + }, + "properties": [ + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "reloaded_analyzers", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "reloaded_node_ids", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "indices/reload_search_analyzers/types.ts#L20-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "aliases", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] + "kind": "no_body" }, + "description": "Reloads an index's search analyzers and their resources.", "inherits": { "type": { "name": "RequestBase", @@ -85388,27 +104801,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.clone" + "namespace": "indices.reload_search_analyzers" }, "path": [ { + "description": "A comma-separated list of index names to reload analyzers for", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "target", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", + "name": "Indices", "namespace": "_types" } } @@ -85416,166 +104819,151 @@ ], "query": [ { - "name": "master_timeout", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "timeout", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "wait_for_active_shards", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L37" }, { "body": { "kind": "properties", "properties": [ { - "name": "index", + "name": "reload_details", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ReloadDetails", + "namespace": "indices.reload_search_analyzers" + } } } }, { - "name": "shards_acknowledged", + "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardStatistics", + "namespace": "_types" } } } ] }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.clone" - } + "namespace": "indices.reload_search_analyzers" + }, + "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersResponse.ts#L23-L25" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns information about any matching indices, aliases, and data streams", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "CloseIndexResult", - "namespace": "indices.close" + "name": "Request", + "namespace": "indices.resolve_index" }, - "properties": [ + "path": [ { - "name": "closed", + "description": "A comma-separated list of names or wildcard expressions", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Names", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "shards", + "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "name": "expand_wildcards", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "CloseShardResult", - "namespace": "indices.close" - } + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L35" }, { "kind": "interface", "name": { - "name": "CloseShardResult", - "namespace": "indices.close" + "name": "ResolveIndexAliasItem", + "namespace": "indices.resolve_index" }, "properties": [ { - "name": "failures", + "name": "name", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardFailure", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.close" - }, - "path": [ + }, { - "name": "index", + "name": "indices", "required": true, "type": { "kind": "instance_of", @@ -85586,74 +104974,110 @@ } } ], - "query": [ + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L37-L40" + }, + { + "kind": "interface", + "name": { + "name": "ResolveIndexDataStreamsItem", + "namespace": "indices.resolve_index" + }, + "properties": [ { - "name": "allow_no_indices", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DataStreamName", + "namespace": "_types" } } }, { - "name": "expand_wildcards", - "required": false, + "name": "timestamp_field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "Field", "namespace": "_types" } } }, { - "name": "ignore_unavailable", - "required": false, + "name": "backing_indices", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Indices", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L42-L46" + }, + { + "kind": "interface", + "name": { + "name": "ResolveIndexItem", + "namespace": "indices.resolve_index" + }, + "properties": [ { - "name": "master_timeout", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Name", "namespace": "_types" } } }, { - "name": "timeout", + "name": "aliases", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "wait_for_active_shards", + "name": "attributes", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "data_stream", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "DataStreamName", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L30-L35" }, { "body": { @@ -85663,47 +105087,93 @@ "name": "indices", "required": true, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "ResolveIndexItem", + "namespace": "indices.resolve_index" } - }, - "kind": "dictionary_of", - "singleKey": false, + } + } + }, + { + "name": "aliases", + "required": true, + "type": { + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "CloseIndexResult", - "namespace": "indices.close" + "name": "ResolveIndexAliasItem", + "namespace": "indices.resolve_index" } } } }, { - "name": "shards_acknowledged", + "name": "data_streams", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ResolveIndexDataStreamsItem", + "namespace": "indices.resolve_index" + } } } } ] }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.close" + "namespace": "indices.resolve_index" + }, + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L22-L28" + }, + { + "codegenNames": [ + "single", + "by_type" + ], + "kind": "type_alias", + "name": { + "name": "IndexRolloverMapping", + "namespace": "indices.rollover" + }, + "specLocation": "indices/rollover/types.ts#L38-L41", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" + } + }, + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" + } + } + } + ], + "kind": "union_of" } }, { @@ -85735,38 +105205,26 @@ } } }, + { + "name": "conditions", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RolloverConditions", + "namespace": "indices.rollover" + } + } + }, { "name": "mappings", "required": false, "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndexRolloverMapping", + "namespace": "indices.rollover" + } } }, { @@ -85777,7 +105235,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -85789,6 +105247,7 @@ } ] }, + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", "inherits": { "type": { "name": "RequestBase", @@ -85798,12 +105257,25 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.create" + "namespace": "indices.rollover" }, "path": [ { - "name": "index", + "description": "The name of the alias to rollover", + "name": "alias", "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } + }, + { + "description": "The name of the rollover index", + "name": "new_index", + "required": false, "type": { "kind": "instance_of", "type": { @@ -85815,17 +105287,31 @@ ], "query": [ { + "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false", + "name": "dry_run", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether a type should be included in the body of the mappings.", "name": "include_type_name", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, "type": { @@ -85837,6 +105323,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -85848,6 +105335,7 @@ } }, { + "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", "name": "wait_for_active_shards", "required": false, "type": { @@ -85858,20 +105346,76 @@ } } } - ] + ], + "specLocation": "indices/rollover/IndicesRolloverRequest.ts#L29-L53" }, { "body": { "kind": "properties", "properties": [ { - "name": "index", + "name": "conditions", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + }, + { + "name": "dry_run", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "new_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "old_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "rolled_over", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, @@ -85882,7 +105426,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -85897,90 +105441,52 @@ "kind": "response", "name": { "name": "Response", - "namespace": "indices.create" - } + "namespace": "indices.rollover" + }, + "specLocation": "indices/rollover/IndicesRolloverResponse.ts#L23-L32" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.create_data_stream" + "name": "RolloverConditions", + "namespace": "indices.rollover" }, - "path": [ + "properties": [ { - "name": "name", - "required": true, + "name": "max_age", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "Time", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.create_data_stream" - } - }, - { - "kind": "interface", - "name": { - "name": "DataStreamsStatsItem", - "namespace": "indices.data_streams_stats" - }, - "properties": [ + }, { - "name": "backing_indices", - "required": true, + "name": "max_docs", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "data_stream", - "required": true, + "name": "max_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "store_size", + "name": "min_size", "required": false, "type": { "kind": "instance_of", @@ -85991,154 +105497,109 @@ } }, { - "name": "store_size_bytes", - "required": true, + "name": "max_size_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "maximum_timestamp", - "required": true, + "name": "max_primary_shard_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.data_streams_stats" - }, - "path": [ + }, { - "name": "name", + "name": "min_primary_shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "ByteSize", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "expand_wildcards", + "name": "max_primary_shard_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "min_primary_shard_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/rollover/types.ts#L26-L36" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardStatistics", - "namespace": "_types" - } - } - }, - { - "name": "backing_indices", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "data_stream_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "total_store_sizes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "total_store_size_bytes", - "required": true, - "type": { + "kind": "interface", + "name": { + "name": "IndexSegment", + "namespace": "indices.segments" + }, + "properties": [ + { + "name": "shards", + "required": true, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "data_streams", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataStreamsStatsItem", - "namespace": "indices.data_streams_stats" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ShardsSegment", + "namespace": "indices.segments" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardsSegment", + "namespace": "indices.segments" + } + } } - } + ], + "kind": "union_of" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.data_streams_stats" - } + } + ], + "specLocation": "indices/segments/types.ts#L24-L26" }, { "attachedBehaviors": [ @@ -86147,6 +105608,7 @@ "body": { "kind": "no_body" }, + "description": "Provides low-level information about segments in a Lucene index.", "inherits": { "type": { "name": "RequestBase", @@ -86156,12 +105618,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.delete" + "namespace": "indices.segments" }, "path": [ { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "name": "index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -86173,17 +105636,19 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -86195,423 +105660,348 @@ } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "namespace": "_builtins" } } }, { - "name": "timeout", + "description": "Includes detailed memory usage by Lucene.", + "name": "verbose", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/segments/IndicesSegmentsRequest.ts#L23-L38" }, { "body": { "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "IndicesResponseBase", - "namespace": "_types" - } + "properties": [ + { + "name": "indices", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexSegment", + "namespace": "indices.segments" + } + } + } + }, + { + "name": "_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" + } + } + } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.delete" - } + "namespace": "indices.segments" + }, + "specLocation": "indices/segments/IndicesSegmentsResponse.ts#L24-L29" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.delete_alias" + "name": "Segment", + "namespace": "indices.segments" }, - "path": [ + "properties": [ { - "name": "index", + "name": "attributes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "committed", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "name", + "name": "compound", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "master_timeout", - "required": false, + "name": "deleted_docs", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } }, { - "name": "timeout", - "required": false, + "name": "generation", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.delete_alias" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.delete_data_stream" - }, - "path": [ + }, { - "name": "name", + "name": "memory_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "double", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.delete_data_stream" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.delete_index_template" - }, - "path": [ + }, { - "name": "name", + "name": "search", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.delete_index_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.delete_template" - }, - "path": [ + }, { - "name": "name", + "name": "size_in_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "double", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "master_timeout", - "required": false, + "name": "num_docs", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } }, { - "name": "timeout", - "required": false, + "name": "version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "VersionString", "namespace": "_types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.delete_template" - } + ], + "specLocation": "indices/segments/types.ts#L28-L39" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.exists" + "name": "ShardSegmentRouting", + "namespace": "indices.segments" }, - "path": [ + "properties": [ { - "name": "index", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", - "required": false, + "name": "primary", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "expand_wildcards", - "required": false, + "name": "state", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/segments/types.ts#L41-L45" + }, + { + "kind": "interface", + "name": { + "name": "ShardsSegment", + "namespace": "indices.segments" + }, + "properties": [ { - "name": "flat_settings", - "required": false, + "name": "num_committed_segments", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "ignore_unavailable", - "required": false, + "name": "routing", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardSegmentRouting", + "namespace": "indices.segments" } } }, { - "name": "include_defaults", - "required": false, + "name": "num_search_segments", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "local", - "required": false, + "name": "segments", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Segment", + "namespace": "indices.segments" + } } } } - ] + ], + "specLocation": "indices/segments/types.ts#L47-L52" }, { - "body": { - "kind": "no_body" - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "indices.exists" - } + "name": "IndicesShardStores", + "namespace": "indices.shard_stores" + }, + "properties": [ + { + "name": "shards", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ShardStoreWrapper", + "namespace": "indices.shard_stores" + } + } + } + } + ], + "specLocation": "indices/shard_stores/types.ts#L25-L27" }, { "attachedBehaviors": [ @@ -86620,6 +106010,7 @@ "body": { "kind": "no_body" }, + "description": "Provides store information for shard copies of indices.", "inherits": { "type": { "name": "RequestBase", @@ -86629,21 +106020,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.exists_alias" + "namespace": "indices.shard_stores" }, "path": [ { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - }, - { + "description": "List of data streams, indices, and aliases used to limit the request.", "name": "index", "required": false, "type": { @@ -86657,19 +106038,22 @@ ], "query": [ { + "description": "If false, the request returns an error if any wildcard expression, index alias, or _all\nvalue targets only missing or closed indices. This behavior applies even if the request\ntargets other open indices.", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Type of index that wildcard patterns can match. If the request can target data streams,\nthis argument determines whether wildcard expressions match hidden data streams.", "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -86679,201 +106063,222 @@ } }, { + "description": "If true, missing or closed indices are not included in the response.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "local", + "description": "List of shard health statuses used to limit the request.", + "name": "status", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ShardStoreStatus", + "namespace": "indices.shard_stores" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardStoreStatus", + "namespace": "indices.shard_stores" + } + } + } + ], + "kind": "union_of" } } - ] + ], + "specLocation": "indices/shard_stores/IndicesShardStoresRequest.ts#L24-L59" }, { "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "name": "indices", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesShardStores", + "namespace": "indices.shard_stores" + } + } + } + } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.exists_alias" - } + "namespace": "indices.shard_stores" + }, + "specLocation": "indices/shard_stores/IndicesShardStoresResponse.ts#L24-L26" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.exists_index_template" + "name": "ShardStore", + "namespace": "indices.shard_stores" }, - "path": [ + "properties": [ { - "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", - "name": "name", + "name": "allocation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "ShardStoreAllocation", + "namespace": "indices.shard_stores" + } + } + }, + { + "name": "allocation_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", "namespace": "_types" } } - } - ], - "query": [ + }, { - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "name": "attributes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Id", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "no_body" - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.exists_index_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.exists_template" - }, - "path": [ + }, { - "name": "name", + "name": "legacy_version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "VersionNumber", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "flat_settings", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } }, { - "name": "local", - "required": false, + "name": "store_exception", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardStoreException", + "namespace": "indices.shard_stores" } } }, { - "name": "master_timeout", - "required": false, + "name": "transport_address", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "TransportAddress", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/shard_stores/types.ts#L29-L38" }, { - "body": { - "kind": "no_body" - }, - "kind": "response", + "kind": "enum", + "members": [ + { + "name": "primary" + }, + { + "name": "replica" + }, + { + "name": "unused" + } + ], "name": { - "name": "Response", - "namespace": "indices.exists_template" - } + "name": "ShardStoreAllocation", + "namespace": "indices.shard_stores" + }, + "specLocation": "indices/shard_stores/types.ts#L40-L44" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.exists_type" + "name": "ShardStoreException", + "namespace": "indices.shard_stores" }, - "path": [ + "properties": [ { - "name": "index", + "name": "reason", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, @@ -86883,76 +106288,114 @@ "type": { "kind": "instance_of", "type": { - "name": "Types", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "query": [ + "specLocation": "indices/shard_stores/types.ts#L46-L49" + }, + { + "kind": "enum", + "members": [ { - "name": "allow_no_indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "description": "The primary shard and all replica shards are assigned.", + "name": "green" }, { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } + "description": "One or more replica shards are unassigned.", + "name": "yellow" }, { - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "description": "The primary shard is unassigned.", + "name": "red" }, { - "name": "local", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "description": "Return all shards, regardless of health status.", + "name": "all" } - ] + ], + "name": { + "name": "ShardStoreStatus", + "namespace": "indices.shard_stores" + }, + "specLocation": "indices/shard_stores/types.ts#L55-L64" }, { - "body": { - "kind": "no_body" - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "indices.exists_type" - } + "name": "ShardStoreWrapper", + "namespace": "indices.shard_stores" + }, + "properties": [ + { + "name": "stores", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardStore", + "namespace": "indices.shard_stores" + } + } + } + } + ], + "specLocation": "indices/shard_stores/types.ts#L51-L53" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] }, + "description": "Allow to shrink an existing index into a new index with fewer primary shards.", "inherits": { "type": { "name": "RequestBase", @@ -86962,215 +106405,217 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.flush" + "namespace": "indices.shrink" }, "path": [ { + "description": "The name of the source index to shrink", "name": "index", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "IndexName", "namespace": "_types" } } - } - ], - "query": [ - { - "name": "allow_no_indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } }, { - "name": "expand_wildcards", - "required": false, + "description": "The name of the target index to shrink into", + "name": "target", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "IndexName", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "force", + "description": "Specify timeout for connection to master", + "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "ignore_unavailable", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "wait_if_ongoing", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", + "name": "wait_for_active_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "WaitForActiveShards", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/shrink/IndicesShrinkRequest.ts#L27-L46" }, { "body": { "kind": "properties", - "properties": [] + "properties": [ + { + "name": "shards_acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ] }, "inherits": { "type": { - "name": "ShardsOperationResponseBase", + "name": "AcknowledgedResponseBase", "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.flush" - } + "namespace": "indices.shrink" + }, + "specLocation": "indices/shrink/IndicesShrinkResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.flush_synced" - }, - "path": [ - { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "name": "allow_auto_create", + "required": false, "type": { - "name": "Indices", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - } - ], - "query": [ - { - "name": "allow_no_indices", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "index_patterns", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } } - } - }, - { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "composed_of", + "required": false, "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } } - } - }, - { - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "template", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "IndexTemplateMapping", + "namespace": "indices.put_index_template" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "_shards", - "required": true, + "name": "data_stream", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "DataStream", + "namespace": "indices._types" + } + } + }, + { + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } - } - ] - }, - "inherits": { - "generics": [ + }, { - "kind": "instance_of", + "name": "version", + "required": false, "type": { - "name": "IndexName", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } } }, { - "kind": "instance_of", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", + "required": false, "type": { - "name": "ShardStatistics", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.flush_synced" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + ] }, + "description": "Simulate matching the given index name against the index templates in the system", "inherits": { "type": { "name": "RequestBase", @@ -87180,16 +106625,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.forcemerge" + "namespace": "indices.simulate_index_template" }, "path": [ { - "name": "index", - "required": false, + "description": "Index or template name to simulate", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Name", "namespace": "_types" } } @@ -87197,97 +106643,97 @@ ], "query": [ { - "name": "allow_no_indices", + "description": "If `true`, the template passed in the body is only used if no existing\ntemplates match the same index patterns. If `false`, the simulation uses\nthe template with the highest priority. Note that the template is not\npermanently added or updated in either case; it is only used for the\nsimulation.", + "name": "create", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "expand_wildcards", + "description": "Period to wait for a connection to the master node. If no response is received\nbefore the timeout expires, the request fails and returns an error.", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "Time", "namespace": "_types" } } - }, - { - "name": "flush", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, + } + ], + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L33-L71" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.simulate_index_template" + }, + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateResponse.ts#L20-L22" + }, + { + "kind": "interface", + "name": { + "name": "Overlapping", + "namespace": "indices.simulate_template" + }, + "properties": [ { - "name": "max_num_segments", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Name", "namespace": "_types" } } }, { - "name": "only_expunge_deletes", - "required": false, + "name": "index_patterns", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "ShardsOperationResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.forcemerge" - } + ], + "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L39-L42" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "codegenName": "template", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexTemplate", + "namespace": "indices.get_index_template" + } + } }, + "description": "Simulate resolving the given template name or body", "inherits": { "type": { "name": "RequestBase", @@ -87297,16 +106743,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.freeze" + "namespace": "indices.simulate_template" }, "path": [ { - "name": "index", - "required": true, + "description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.", + "name": "name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Name", "namespace": "_types" } } @@ -87314,41 +106761,23 @@ ], "query": [ { - "name": "allow_no_indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "name": "ignore_unavailable", + "description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.", + "name": "create", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -87356,558 +106785,581 @@ "namespace": "_types" } } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "wait_for_active_shards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "WaitForActiveShards", - "namespace": "_types" - } - } } - ] + ], + "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L25-L49" }, { "body": { "kind": "properties", "properties": [ { - "name": "shards_acknowledged", + "name": "template", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Template", + "namespace": "indices.simulate_template" } } } ] }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.freeze" - } + "namespace": "indices.simulate_template" + }, + "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L26-L30" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.get" + "name": "Template", + "namespace": "indices.simulate_template" }, - "path": [ + "properties": [ { - "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.", - "name": "index", + "name": "aliases", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", - "required": false, - "serverDefault": true, + "name": "mappings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.", - "name": "expand_wildcards", - "required": false, - "serverDefault": "open", + "name": "settings", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "If true, returns settings in flat format.", - "name": "flat_settings", - "required": false, - "serverDefault": false, + "name": "overlapping", + "required": true, "type": { - "kind": "instance_of", + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Overlapping", + "namespace": "indices.simulate_template" + } + } + } + } + ], + "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L32-L37" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "aliases", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } + } + } + }, + { + "name": "settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } } } - }, + ] + }, + "description": "Allows you to split an existing index into a new index with more primary shards.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.split" + }, + "path": [ { - "description": "If false, requests that target a missing index return an error.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, + "description": "The name of the source index to split", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "If true, return all default settings in the response.", - "name": "include_defaults", - "required": false, - "serverDefault": false, + "description": "The name of the target index to split into", + "name": "target", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "If true, a mapping type is expected in the body of mappings.", - "name": "include_type_name", + "description": "Specify timeout for connection to master", + "name": "master_timeout", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", - "name": "local", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", + "name": "wait_for_active_shards", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "WaitForActiveShards", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/split/IndicesSplitRequest.ts#L27-L46" }, { "body": { "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ + "properties": [ { - "kind": "instance_of", + "name": "shards_acknowledged", + "required": true, "type": { - "name": "IndexName", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "kind": "instance_of", + "name": "index", + "required": true, "type": { - "name": "IndexState", - "namespace": "indices._types" + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } } } - ], + ] + }, + "inherits": { "type": { - "name": "DictionaryResponseBase", + "name": "AcknowledgedResponseBase", "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.get" - } + "namespace": "indices.split" + }, + "specLocation": "indices/split/IndicesSplitResponse.ts#L23-L28" }, { "kind": "interface", "name": { - "name": "IndexAliases", - "namespace": "indices.get_alias" + "name": "IndexStats", + "namespace": "indices.stats" }, "properties": [ { - "name": "aliases", - "required": true, + "description": "Contains statistics about completions across all shards assigned to the node.", + "name": "completion", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AliasDefinition", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "CompletionStats", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.get_alias" - }, - "path": [ + }, { - "name": "name", + "description": "Contains statistics about documents across all primary shards assigned to the node.", + "name": "docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "DocStats", "namespace": "_types" } } }, { - "name": "index", + "description": "Contains statistics about the field data cache across all shards assigned to the node.", + "name": "fielddata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "FielddataStats", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "description": "Contains statistics about flush operations for the node.", + "name": "flush", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "FlushStats", + "namespace": "_types" } } }, { - "name": "expand_wildcards", + "description": "Contains statistics about get operations for the node.", + "name": "get", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "GetStats", "namespace": "_types" } } }, { - "name": "ignore_unavailable", + "description": "Contains statistics about indexing operations for the node.", + "name": "indexing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexingStats", + "namespace": "_types" } } }, { - "name": "local", + "description": "Contains statistics about indices operations for the node.", + "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndicesStats", + "namespace": "indices.stats" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { + }, + { + "description": "Contains statistics about merge operations for the node.", + "name": "merges", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "MergesStats", "namespace": "_types" } - }, - { + } + }, + { + "description": "Contains statistics about the query cache across all shards assigned to the node.", + "name": "query_cache", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IndexAliases", - "namespace": "indices.get_alias" + "name": "QueryCacheStats", + "namespace": "_types" } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_alias" - } - }, - { - "kind": "interface", - "name": { - "name": "IndicesGetDataStreamItem", - "namespace": "indices.get_data_stream" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "description": "Contains statistics about recovery operations for the node.", + "name": "recovery", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "RecoveryStats", "namespace": "_types" } } }, { - "name": "timestamp_field", - "required": true, + "description": "Contains statistics about refresh operations for the node.", + "name": "refresh", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndicesGetDataStreamItemTimestampField", - "namespace": "indices.get_data_stream" + "name": "RefreshStats", + "namespace": "_types" } } }, { - "name": "indices", - "required": true, + "description": "Contains statistics about the request cache across all shards assigned to the node.", + "name": "request_cache", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesGetDataStreamItemIndex", - "namespace": "indices.get_data_stream" - } + "kind": "instance_of", + "type": { + "name": "RequestCacheStats", + "namespace": "_types" } } }, { - "name": "generation", - "required": true, + "description": "Contains statistics about search operations for the node.", + "name": "search", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "SearchStats", "namespace": "_types" } } }, { - "name": "template", - "required": true, + "description": "Contains statistics about segments across all shards assigned to the node.", + "name": "segments", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "SegmentsStats", "namespace": "_types" } } }, { - "name": "hidden", - "required": true, + "description": "Contains statistics about the size of shards assigned to the node.", + "name": "store", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "StoreStats", + "namespace": "_types" } } }, { - "name": "system", + "description": "Contains statistics about transaction log operations for the node.", + "name": "translog", "required": false, - "since": "7.10.0", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TranslogStats", + "namespace": "_types" } } }, { - "name": "status", - "required": true, + "description": "Contains statistics about index warming operations for the node.", + "name": "warmer", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamHealthStatus", - "namespace": "indices._types" + "name": "WarmerStats", + "namespace": "_types" } } }, { - "name": "ilm_policy", + "name": "bulk", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "BulkStats", "namespace": "_types" } } }, { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", + "name": "shard_stats", "required": false, + "since": "7.15.0", "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "ShardsTotalStats", + "namespace": "indices.stats" } } } - ] + ], + "specLocation": "indices/stats/types.ts#L43-L81" }, { "kind": "interface", "name": { - "name": "IndicesGetDataStreamItemIndex", - "namespace": "indices.get_data_stream" + "name": "IndicesStats", + "namespace": "indices.stats" }, "properties": [ { - "name": "index_name", - "required": true, + "name": "primaries", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "IndexStats", + "namespace": "indices.stats" } } }, { - "name": "index_uuid", - "required": true, + "name": "shards", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardStats", + "namespace": "indices.stats" + } + } + } + } + }, + { + "name": "total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "IndexStats", + "namespace": "indices.stats" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndicesGetDataStreamItemTimestampField", - "namespace": "indices.get_data_stream" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "name": "uuid", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Uuid", "namespace": "_types" } } } - ] + ], + "specLocation": "indices/stats/types.ts#L83-L88" }, { "attachedBehaviors": [ @@ -87916,6 +107368,7 @@ "body": { "kind": "no_body" }, + "description": "Provides statistics on operations happening in an index.", "inherits": { "type": { "name": "RequestBase", @@ -87925,83 +107378,39 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.get_data_stream" + "namespace": "indices.stats" }, "path": [ { - "name": "name", + "description": "Limit the information returned the specific metrics.", + "name": "metric", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Metrics", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "expand_wildcards", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "Indices", "namespace": "_types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "data_streams", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesGetDataStreamItem", - "namespace": "indices.get_data_stream" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_data_stream" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.get_field_mapping" - }, - "path": [ + "query": [ { - "name": "fields", - "required": true, + "description": "A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)", + "name": "completion_fields", + "required": false, "type": { "kind": "instance_of", "type": { @@ -88011,146 +107420,237 @@ } }, { - "name": "index", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "type", + "description": "A comma-separated list of fields for `fielddata` index metric (supports wildcards)", + "name": "fielddata_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Types", + "name": "Fields", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "description": "A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)", + "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } }, { - "name": "expand_wildcards", + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices", + "name": "forbid_closed_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "ignore_unavailable", + "description": "A comma-separated list of search groups for `search` index metric", + "name": "groups", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)", + "name": "include_segment_file_sizes", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "include_defaults", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory", + "name": "include_unloaded_segments", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "include_type_name", + "description": "Return stats aggregated at cluster, index or shard level", + "name": "level", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Level", + "namespace": "_types" } } }, { - "name": "local", + "description": "A comma-separated list of document types for the `indexing` index metric", + "name": "types", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Types", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/stats/IndicesStatsRequest.ts#L30-L52" }, { "body": { "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ + "properties": [ { - "kind": "instance_of", + "name": "indices", + "required": false, "type": { - "name": "IndexName", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesStats", + "namespace": "indices.stats" + } + } } }, { - "kind": "instance_of", + "name": "_shards", + "required": true, "type": { - "name": "TypeFieldMappings", - "namespace": "indices.get_field_mapping" + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" + } + } + }, + { + "name": "_all", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndicesStats", + "namespace": "indices.stats" + } } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.get_field_mapping" - } + "namespace": "indices.stats" + }, + "specLocation": "indices/stats/IndicesStatsResponse.ts#L24-L30" }, { "kind": "interface", "name": { - "name": "TypeFieldMappings", - "namespace": "indices.get_field_mapping" + "name": "ShardCommit", + "namespace": "indices.stats" }, "properties": [ { - "name": "mappings", + "name": "generation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "num_docs", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "user_data", "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -88158,73 +107658,68 @@ "value": { "kind": "instance_of", "type": { - "name": "FieldMapping", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "indices/stats/types.ts#L90-L95" }, { "kind": "interface", "name": { - "name": "IndexTemplate", - "namespace": "indices.get_index_template" + "name": "ShardFileSizeInfo", + "namespace": "indices.stats" }, "properties": [ { - "name": "index_patterns", + "name": "description", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "composed_of", + "name": "size_in_bytes", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "template", - "required": true, + "name": "min_size_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexTemplateSummary", - "namespace": "indices.get_index_template" + "name": "long", + "namespace": "_types" } } }, { - "name": "version", + "name": "max_size_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "long", "namespace": "_types" } } }, { - "name": "priority", + "name": "average_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -88235,816 +107730,674 @@ } }, { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", + "name": "count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/stats/types.ts#L102-L109" + }, + { + "kind": "interface", + "name": { + "name": "ShardLease", + "namespace": "indices.stats" + }, + "properties": [ + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", "namespace": "_types" } } }, { - "name": "allow_auto_create", - "required": false, + "name": "retaining_seq_no", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "name": "data_stream", - "required": false, + "name": "timestamp", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/stats/types.ts#L111-L116" }, { "kind": "interface", "name": { - "name": "IndexTemplateItem", - "namespace": "indices.get_index_template" + "name": "ShardPath", + "namespace": "indices.stats" }, "properties": [ { - "name": "name", + "name": "data_path", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index_template", + "name": "is_custom_data_path", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexTemplate", - "namespace": "indices.get_index_template" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "state_path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/stats/types.ts#L118-L122" }, { "kind": "interface", "name": { - "name": "IndexTemplateSummary", - "namespace": "indices.get_index_template" + "name": "ShardQueryCache", + "namespace": "indices.stats" }, "properties": [ { - "name": "aliases", - "required": false, + "name": "cache_count", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "mappings", - "required": false, + "name": "cache_size", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "long", + "namespace": "_types" } } }, { - "name": "settings", - "required": false, + "name": "evictions", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "If true, returns settings in flat format.", - "name": "flat_settings", - "required": false, - "serverDefault": false, + }, + { + "name": "hit_count", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "If true, a mapping type is expected in the body of mappings.", - "name": "include_type_name", - "required": false, - "serverDefault": false, + } + }, + { + "name": "memory_size_in_bytes", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + } + }, + { + "name": "miss_count", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.get_index_template" - }, - "path": [ + }, { - "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", - "name": "name", - "required": false, + "name": "total_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "long", "namespace": "_types" } } } ], - "query": [ + "specLocation": "indices/stats/types.ts#L124-L132" + }, + { + "kind": "interface", + "name": { + "name": "ShardRetentionLeases", + "namespace": "indices.stats" + }, + "properties": [ { - "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", - "name": "local", - "required": false, - "serverDefault": false, + "name": "primary_term", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "index_templates", - "required": true, + }, + { + "name": "version", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexTemplateItem", - "namespace": "indices.get_index_template" - } + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "leases", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardLease", + "namespace": "indices.stats" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_index_template" - } + } + ], + "specLocation": "indices/stats/types.ts#L134-L138" }, { "kind": "interface", "name": { - "name": "IndexMappingRecord", - "namespace": "indices.get_mapping" + "name": "ShardRouting", + "namespace": "indices.stats" }, "properties": [ { - "name": "item", + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "primary", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "relocating_node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "mappings", + "name": "state", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "ShardRoutingState", + "namespace": "indices.stats" } } } - ] + ], + "specLocation": "indices/stats/types.ts#L140-L145" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "kind": "enum", + "members": [ + { + "name": "UNASSIGNED" + }, + { + "name": "INITIALIZING" + }, + { + "name": "STARTED" + }, + { + "name": "RELOCATING" } + ], + "name": { + "name": "ShardRoutingState", + "namespace": "indices.stats" }, - "kind": "request", + "specLocation": "indices/stats/types.ts#L147-L152" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.get_mapping" + "name": "ShardSequenceNumber", + "namespace": "indices.stats" }, - "path": [ + "properties": [ { - "name": "index", - "required": false, + "name": "global_checkpoint", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "long", "namespace": "_types" } } }, { - "name": "type", - "required": false, + "name": "local_checkpoint", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Types", + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "max_seq_no", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", "namespace": "_types" } } } ], - "query": [ + "specLocation": "indices/stats/types.ts#L154-L158" + }, + { + "kind": "interface", + "name": { + "name": "ShardStats", + "namespace": "indices.stats" + }, + "properties": [ { - "name": "allow_no_indices", + "name": "commit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardCommit", + "namespace": "indices.stats" } } }, { - "name": "expand_wildcards", + "name": "completion", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "CompletionStats", "namespace": "_types" } } }, { - "name": "ignore_unavailable", + "name": "docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DocStats", + "namespace": "_types" } } }, { - "name": "include_type_name", + "name": "fielddata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "FielddataStats", + "namespace": "_types" } } }, { - "name": "local", + "name": "flush", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "FlushStats", + "namespace": "_types" } } }, { - "name": "master_timeout", + "name": "get", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "GetStats", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { + }, + { + "name": "indexing", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "IndexingStats", "namespace": "_types" } - }, - { - "kind": "instance_of", - "type": { - "name": "IndexMappingRecord", - "namespace": "indices.get_mapping" - } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_mapping" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.get_settings" - }, - "path": [ + }, { - "name": "index", + "name": "merges", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "MergesStats", "namespace": "_types" } } }, { - "name": "name", + "name": "shard_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "ShardPath", + "namespace": "indices.stats" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "name": "query_cache", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardQueryCache", + "namespace": "indices.stats" } } }, { - "name": "expand_wildcards", + "name": "recovery", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "RecoveryStats", "namespace": "_types" } } }, { - "name": "flat_settings", + "name": "refresh", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "RefreshStats", + "namespace": "_types" } } }, { - "name": "ignore_unavailable", + "name": "request_cache", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "RequestCacheStats", + "namespace": "_types" } } }, { - "name": "include_defaults", + "name": "retention_leases", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardRetentionLeases", + "namespace": "indices.stats" } } }, { - "name": "local", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ShardRouting", + "namespace": "indices.stats" } } }, { - "name": "master_timeout", + "name": "search", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "SearchStats", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { + }, + { + "name": "segments", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "SegmentsStats", "namespace": "_types" } - }, - { - "kind": "instance_of", - "type": { - "name": "IndexState", - "namespace": "indices._types" - } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_settings" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.get_template" - }, - "path": [ + }, { - "name": "name", + "name": "seq_no", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "ShardSequenceNumber", + "namespace": "indices.stats" } } - } - ], - "query": [ + }, { - "name": "flat_settings", + "name": "store", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "StoreStats", + "namespace": "_types" } } }, { - "name": "include_type_name", + "name": "translog", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TranslogStats", + "namespace": "_types" } } }, { - "name": "local", + "name": "warmer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "WarmerStats", + "namespace": "_types" } } }, { - "name": "master_timeout", + "name": "bulk", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "BulkStats", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { + }, + { + "name": "shards", + "required": false, + "since": "7.15.0", + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ShardsTotalStats", + "namespace": "indices.stats" } - }, - { + } + }, + { + "name": "shard_stats", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TemplateMapping", - "namespace": "indices._types" + "name": "ShardsTotalStats", + "namespace": "indices.stats" } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.get_upgrade" - }, - "path": [ + }, { - "name": "stub", - "required": true, + "name": "indices", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndicesStats", + "namespace": "indices.stats" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "Any templates that were superseded by the specified template.", - "name": "overlapping", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "OverlappingIndexTemplate", - "namespace": "indices._types" - } - } - } - }, - { - "description": "The settings, mappings, and aliases that would be applied to matching indices.", - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TemplateMapping", - "namespace": "indices._types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.get_upgrade" - } + "specLocation": "indices/stats/types.ts#L164-L191" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.migrate_to_data_stream" + "name": "ShardsTotalStats", + "namespace": "indices.stats" }, - "path": [ + "properties": [ { - "name": "name", + "name": "total_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "long", "namespace": "_types" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.migrate_to_data_stream" - } + "specLocation": "indices/stats/types.ts#L160-L162" }, { "attachedBehaviors": [ @@ -89053,6 +108406,7 @@ "body": { "kind": "no_body" }, + "description": "Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.", "inherits": { "type": { "name": "RequestBase", @@ -89062,16 +108416,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.open" + "namespace": "indices.unfreeze" }, "path": [ { + "description": "The name of the index to unfreeze", "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "IndexName", "namespace": "_types" } } @@ -89079,17 +108434,19 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -89101,17 +108458,19 @@ } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, "type": { @@ -89123,6 +108482,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -89134,17 +108494,19 @@ } }, { + "description": "Sets the number of active shards to wait for before the operation returns.", "name": "wait_for_active_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/unfreeze/IndicesUnfreezeRequest.ts#L24-L41" }, { "body": { @@ -89157,7 +108519,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -89172,144 +108534,125 @@ "kind": "response", "name": { "name": "Response", - "namespace": "indices.open" - } + "namespace": "indices.unfreeze" + }, + "specLocation": "indices/unfreeze/IndicesUnfreezeResponse.ts#L22-L26" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.promote_data_stream" + "name": "Action", + "namespace": "indices.update_aliases" }, - "path": [ + "properties": [ { - "name": "name", - "required": true, + "name": "add", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "AddAction", + "namespace": "indices.update_aliases" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + }, + { + "name": "remove", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "RemoveAction", + "namespace": "indices.update_aliases" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.promote_data_stream" + }, + { + "name": "remove_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RemoveIndexAction", + "namespace": "indices.update_aliases" + } + } + } + ], + "specLocation": "indices/update_aliases/types.ts#L23-L28", + "variants": { + "kind": "container" } }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "index_routing", - "required": false, + "kind": "interface", + "name": { + "name": "AddAction", + "namespace": "indices.update_aliases" + }, + "properties": [ + { + "name": "alias", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } + "name": "IndexAlias", + "namespace": "_types" } - }, - { - "name": "is_write_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + } + }, + { + "name": "aliases", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } } - } - }, - { - "name": "routing", - "required": false, + ], + "kind": "union_of" + } + }, + { + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } + "name": "QueryContainer", + "namespace": "_types.query_dsl" } - }, - { - "name": "search_routing", - "required": false, + } + }, + { + "name": "index", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } + "name": "IndexName", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.put_alias" - }, - "path": [ + }, { - "name": "index", - "required": true, + "name": "indices", + "required": false, "type": { "kind": "instance_of", "type": { @@ -89319,111 +108662,176 @@ } }, { - "name": "name", - "required": true, + "name": "index_routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Routing", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "master_timeout", + "name": "is_hidden", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "is_write_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", "namespace": "_types" } } }, { - "name": "timeout", + "name": "search_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Routing", "namespace": "_types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.put_alias" - } + ], + "specLocation": "indices/update_aliases/types.ts#L30-L42" }, { "kind": "interface", "name": { - "name": "IndexTemplateMapping", - "namespace": "indices.put_index_template" + "name": "RemoveAction", + "namespace": "indices.update_aliases" }, "properties": [ + { + "name": "alias", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } + }, { "name": "aliases", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } } + ], + "kind": "union_of" + } + }, + { + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "mappings", + "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "Indices", + "namespace": "_types" } } }, { - "name": "settings", + "name": "must_exist", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/update_aliases/types.ts#L44-L51" + }, + { + "kind": "interface", + "name": { + "name": "RemoveIndexAction", + "namespace": "indices.update_aliases" + }, + "properties": [ + { + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" } } } - ] + ], + "specLocation": "indices/update_aliases/types.ts#L53-L56" }, { "attachedBehaviors": [ @@ -89433,88 +108841,22 @@ "kind": "properties", "properties": [ { - "name": "index_patterns", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "name": "composed_of", + "name": "actions", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "Action", + "namespace": "indices.update_aliases" } } } - }, - { - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexTemplateMapping", - "namespace": "indices.put_index_template" - } - } - }, - { - "name": "data_stream", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } - } - }, - { - "name": "priority", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } } ] }, + "description": "Updates index aliases.", "inherits": { "type": { "name": "RequestBase", @@ -89524,23 +108866,36 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.put_index_template" + "namespace": "indices.update_aliases" }, - "path": [ + "path": [], + "query": [ { - "description": "Index or template name", - "name": "name", - "required": true, + "description": "Specify timeout for connection to master", + "name": "master_timeout", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Request timeout", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } ], - "query": [] + "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L37" }, { "body": { @@ -89556,242 +108911,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "indices.put_index_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "all_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AllField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "date_detection", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "dynamic", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DynamicMapping", - "namespace": "_types.mapping" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "dynamic_date_formats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "dynamic_templates", - "required": false, - "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - } - } - }, - { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - } - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "field_names_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldNamesField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "index_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "meta", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "numeric_detection", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "properties", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } - } - } - }, - { - "name": "routing_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RoutingField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "size_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SizeField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "source_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceField", - "namespace": "_types.mapping" - } - } - }, - { - "name": "runtime", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } - } - ] + "namespace": "indices.update_aliases" }, + "specLocation": "indices/update_aliases/IndicesUpdateAliasesResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "DEPRECATED Upgrades to the current version of Lucene.", "inherits": { "type": { "name": "RequestBase", @@ -89801,27 +108932,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.put_mapping" + "namespace": "indices.upgrade" }, "path": [ { + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "name": "type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Type", + "name": "IndexName", "namespace": "_types" } } @@ -89829,17 +108950,19 @@ ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -89851,61 +108974,43 @@ } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "include_type_name", + "description": "Specify whether the request should block until the all segments are upgraded (default: false)", + "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "namespace": "_builtins" } } }, { - "name": "write_index_only", + "description": "If true, only ancient (an older Lucene major release) segments will be upgraded", + "name": "only_ancient_segments", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/upgrade/IndicesUpgradeRequest.ts#L23-L39" }, { "body": { @@ -89914,56 +109019,92 @@ }, "inherits": { "type": { - "name": "IndicesResponseBase", + "name": "AcknowledgedResponseBase", "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.put_mapping" - } + "namespace": "indices.upgrade" + }, + "specLocation": "indices/upgrade/IndicesUpgradeResponse.ts#L22-L22" }, { - "inherits": { - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - }, "kind": "interface", "name": { - "name": "IndexSettingsBody", - "namespace": "indices.put_settings" + "name": "IndicesValidationExplanation", + "namespace": "indices.validate_query" }, "properties": [ { - "name": "settings", + "name": "error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "explanation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "valid", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "indices/validate_query/IndicesValidateQueryResponse.ts#L32-L37" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexSettingsBody", - "namespace": "indices.put_settings" + "kind": "properties", + "properties": [ + { + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } } - } + ] }, + "description": "Allows a user to validate a potentially expensive query without executing it.", "inherits": { "type": { "name": "RequestBase", @@ -89973,10 +109114,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.put_settings" + "namespace": "indices.validate_query" }, "path": [ { + "description": "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices", "name": "index", "required": false, "type": { @@ -89986,21 +109128,95 @@ "namespace": "_types" } } + }, + { + "description": "A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Types", + "namespace": "_types" + } + } } ], "query": [ { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Execute validation on all shards instead of one random shard per index", + "name": "all_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The analyzer to use for the query string", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "name": "analyze_wildcard", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The default operator for query string query (AND or OR)", + "name": "default_operator", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Operator", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "The field to use as default where no field prefix is given in the query string", + "name": "df", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -90012,318 +109228,214 @@ } }, { - "name": "flat_settings", + "description": "Return detailed information about the error", + "name": "explain", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "master_timeout", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "name": "lenient", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "preserve_existing", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "timeout", + "description": "Query in the Lucene query string syntax", + "name": "q", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.put_settings" - } + ], + "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L52" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "aliases", + "name": "explanations", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Alias", - "namespace": "indices._types" + "name": "IndicesValidationExplanation", + "namespace": "indices.validate_query" } } } }, { - "name": "index_patterns", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "mappings", + "name": "_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "ShardStatistics", + "namespace": "_types" } } }, { - "name": "order", - "required": false, + "name": "valid", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", + "name": "error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ] }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.validate_query" + }, + "specLocation": "indices/validate_query/IndicesValidateQueryResponse.ts#L23-L30" + }, + { "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.put_template" + "name": "AppendProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "name", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Field", "namespace": "_types" } } - } - ], - "query": [ - { - "name": "create", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } }, { - "name": "flat_settings", - "required": false, + "name": "value", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "user_defined_value" } } }, { - "name": "include_type_name", + "name": "allow_duplicates", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L89-L93" }, { - "body": { - "kind": "properties", - "properties": [] - }, "inherits": { "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.put_template" - } - }, - { "kind": "interface", "name": { - "name": "FileDetails", - "namespace": "indices.recovery" + "name": "AttachmentProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "length", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "name", - "required": true, + "name": "ignore_missing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "recovered", - "required": true, + "name": "indexed_chars", + "required": false, "type": { "kind": "instance_of", "type": { @@ -90331,985 +109443,965 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RecoveryBytes", - "namespace": "indices.recovery" - }, - "properties": [ - { - "name": "percent", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Percentage", - "namespace": "_types" - } - } }, { - "name": "recovered", + "name": "indexed_chars_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "name": "recovered_in_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", + "name": "Field", "namespace": "_types" } } }, { - "name": "reused", + "name": "properties", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "reused_in_bytes", - "required": true, + "name": "target_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "Field", "namespace": "_types" } } }, { - "name": "total", + "name": "remove_binary", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "total_in_bytes", - "required": true, + "name": "resource_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L95-L104" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "RecoveryFiles", - "namespace": "indices.recovery" + "name": "BytesProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "details", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FileDetails", - "namespace": "indices.recovery" - } - } - } - }, - { - "name": "percent", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Percentage", - "namespace": "_types" - } - } - }, - { - "name": "recovered", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "reused", - "required": true, + "name": "ignore_missing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "total", - "required": true, + "name": "target_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L123-L127" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "RecoveryIndexStatus", - "namespace": "indices.recovery" + "name": "CircleProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RecoveryBytes", - "namespace": "indices.recovery" - } - } - }, - { - "name": "files", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "RecoveryFiles", - "namespace": "indices.recovery" - } - } - }, - { - "name": "size", + "name": "error_distance", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RecoveryBytes", - "namespace": "indices.recovery" - } - } - }, - { - "name": "source_throttle_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", + "name": "double", "namespace": "_types" } } }, { - "name": "source_throttle_time_in_millis", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } }, { - "name": "target_throttle_time", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "target_throttle_time_in_millis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "total_time_in_millis", + "name": "shape_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "ShapeType", + "namespace": "ingest._types" } } }, { - "name": "total_time", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L129-L135" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "RecoveryOrigin", - "namespace": "indices.recovery" + "name": "ConvertProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "hostname", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "name": "host", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Host", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "transport_address", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", + "name": "Field", "namespace": "_types" } } }, { - "name": "id", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "ConvertType", + "namespace": "ingest._types" } } + } + ], + "specLocation": "ingest/_types/Processors.ts#L147-L152" + }, + { + "kind": "enum", + "members": [ + { + "name": "integer" }, { - "name": "ip", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ip", - "namespace": "_types" - } - } + "name": "long" }, { - "name": "name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "name": "float" }, { - "name": "bootstrap_new_history_uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "double" }, { - "name": "repository", + "name": "string" + }, + { + "name": "boolean" + }, + { + "name": "auto" + } + ], + "name": { + "name": "ConvertType", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L137-L145" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "CsvProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "name": "empty_value", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "kind": "user_defined_value" } }, { - "name": "snapshot", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Field", "namespace": "_types" } } }, { - "name": "version", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "restoreUUID", + "name": "quote", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index", + "name": "separator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "RecoveryStartStatus", - "namespace": "indices.recovery" - }, - "properties": [ + }, { - "name": "check_index_time", + "name": "target_fields", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Fields", "namespace": "_types" } } }, { - "name": "total_time_in_millis", - "required": true, + "name": "trim", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L154-L162" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "RecoveryStatus", - "namespace": "indices.recovery" + "name": "DateIndexNameProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "shards", + "name": "date_formats", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ShardRecovery", - "namespace": "indices.recovery" + "name": "string", + "namespace": "_builtins" } } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.recovery" - }, - "path": [ + }, { - "name": "index", - "required": false, + "description": "How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets.", + "name": "date_rounding", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "active_only", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "name": "detailed", + "name": "index_name_format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RecoveryStatus", - "namespace": "indices.recovery" + "name": "string", + "namespace": "_builtins" } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.recovery" - } - }, - { - "kind": "interface", - "name": { - "name": "ShardRecovery", - "namespace": "indices.recovery" - }, - "properties": [ + }, { - "name": "id", - "required": true, + "name": "index_name_prefix", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index", - "required": true, + "name": "locale", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "RecoveryIndexStatus", - "namespace": "indices.recovery" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "primary", - "required": true, + "name": "timezone", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L164-L177" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "DateProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "source", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RecoveryOrigin", - "namespace": "indices.recovery" + "name": "Field", + "namespace": "_types" } } }, { - "name": "stage", + "name": "formats", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "start", + "name": "locale", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RecoveryStartStatus", - "namespace": "indices.recovery" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "start_time", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "Field", "namespace": "_types" } } }, { - "name": "start_time_in_millis", - "required": true, + "name": "timezone", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L179-L185" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "DissectProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "stop_time", + "name": "append_separator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "stop_time_in_millis", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } }, { - "name": "target", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "RecoveryOrigin", - "namespace": "indices.recovery" - } - } - }, - { - "name": "total_time", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" - } - } - }, - { - "name": "total_time_in_millis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "translog", + "name": "pattern", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TranslogStatus", - "namespace": "indices.recovery" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L187-L192" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "DotExpanderProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "type", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Type", + "name": "Field", "namespace": "_types" } } }, { - "name": "verify_index", - "required": true, + "name": "path", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VerifyIndex", - "namespace": "indices.recovery" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L194-L197" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "TranslogStatus", - "namespace": "indices.recovery" + "name": "DropProcessor", + "namespace": "ingest._types" + }, + "properties": [], + "specLocation": "ingest/_types/Processors.ts#L199-L199" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "EnrichProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "percent", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Percentage", + "name": "Field", "namespace": "_types" } } }, { - "name": "recovered", - "required": true, + "name": "ignore_missing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "total", - "required": true, + "name": "max_matches", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_on_start", + "name": "override", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "policy_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total_time", + "name": "shape_relation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "GeoShapeRelation", + "namespace": "_types" } } }, { - "name": "total_time_in_millis", + "name": "target_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L201-L209" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "VerifyIndex", - "namespace": "indices.recovery" + "name": "FailProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "check_index_time", - "required": false, + "name": "message", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L211-L213" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "ForeachProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "check_index_time_in_millis", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } }, { - "name": "total_time", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "total_time_in_millis", + "name": "processor", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "ProcessorContainer", + "namespace": "ingest._types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L215-L219" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.refresh" + "name": "GeoIpProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "index", + "name": "database_file", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "name": "first_only", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "expand_wildcards", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "ignore_unavailable", + "name": "properties", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L106-L113" }, { - "body": { - "kind": "properties", - "properties": [] - }, "inherits": { "type": { - "name": "ShardsOperationResponseBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.refresh" - } - }, - { "kind": "interface", "name": { - "name": "ReloadDetails", - "namespace": "indices.reload_search_analyzers" + "name": "GrokProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "index", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "name": "reloaded_analyzers", - "required": true, + "name": "ignore_missing", + "required": false, "type": { - "kind": "array_of", + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "pattern_definitions", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "reloaded_node_ids", + "name": "patterns", "required": true, "type": { "kind": "array_of", @@ -91317,2212 +110409,1804 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } + }, + { + "name": "trace_match", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L221-L227" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.reload_search_analyzers" + "name": "GsubProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "index", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Field", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "expand_wildcards", - "required": false, + "name": "pattern", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ignore_unavailable", - "required": false, + "name": "replacement", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "reload_details", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ReloadDetails", - "namespace": "indices.reload_search_analyzers" - } - } - } - }, - { - "name": "_shards", - "required": true, + }, + { + "name": "target_field", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ShardStatistics", - "namespace": "_types" - } + "name": "Field", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.reload_search_analyzers" - } + } + ], + "specLocation": "ingest/_types/Processors.ts#L229-L235" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.resolve_index" + "name": "InferenceConfig", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "name", - "required": true, + "name": "regression", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", - "namespace": "_types" + "name": "InferenceConfigRegression", + "namespace": "ingest._types" } } } ], - "query": [ + "specLocation": "ingest/_types/Processors.ts#L244-L246" + }, + { + "kind": "interface", + "name": { + "name": "InferenceConfigRegression", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "expand_wildcards", - "required": false, + "name": "results_field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L248-L250" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "ResolveIndexAliasItem", - "namespace": "indices.resolve_index" + "name": "InferenceProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "name", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } }, { - "name": "indices", - "required": true, + "name": "target_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Field", "namespace": "_types" } } + }, + { + "name": "field_map", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "inference_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceConfig", + "namespace": "ingest._types" + } + } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L237-L242" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "ResolveIndexDataStreamsItem", - "namespace": "indices.resolve_index" + "name": "JoinProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "name", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "Field", "namespace": "_types" } } }, { - "name": "timestamp_field", + "name": "separator", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "backing_indices", - "required": true, + "name": "target_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L252-L256" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "ResolveIndexItem", - "namespace": "indices.resolve_index" + "name": "JsonProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "name", - "required": true, + "name": "add_to_root", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "aliases", + "name": "add_to_root_conflict_strategy", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "JsonProcessorConflictStrategy", + "namespace": "ingest._types" } } }, { - "name": "attributes", + "name": "allow_duplicate_keys", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "field", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } }, { - "name": "data_stream", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L258-L264" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ResolveIndexItem", - "namespace": "indices.resolve_index" - } - } - } - }, - { - "name": "aliases", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ResolveIndexAliasItem", - "namespace": "indices.resolve_index" - } - } - } - }, - { - "name": "data_streams", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ResolveIndexDataStreamsItem", - "namespace": "indices.resolve_index" - } - } - } - } - ] - }, - "kind": "response", + "kind": "enum", + "members": [ + { + "description": "Root fields that conflict with fields from the parsed JSON will be overridden.", + "name": "replace" + }, + { + "description": "Conflicting fields will be merged.", + "name": "merge" + } + ], "name": { - "name": "Response", - "namespace": "indices.resolve_index" - } + "name": "JsonProcessorConflictStrategy", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L266-L271" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "aliases", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } - } - } - }, - { - "name": "conditions", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RolloverConditions", - "namespace": "indices.rollover" - } - } - }, - { - "name": "mappings", - "required": false, - "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.rollover" + "name": "KeyValueProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "alias", + "name": "exclude_keys", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexAlias", + "name": "Field", "namespace": "_types" } } }, { - "name": "new_index", - "required": false, + "name": "field_split", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "dry_run", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "include_type_name", + "name": "include_keys", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "master_timeout", + "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "timeout", + "name": "strip_brackets", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "wait_for_active_shards", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "Field", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "conditions", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - }, - { - "name": "dry_run", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "new_index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "old_index", - "required": true, + }, + { + "name": "trim_key", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "rolled_over", - "required": true, + } + }, + { + "name": "trim_value", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "shards_acknowledged", - "required": true, + } + }, + { + "name": "value_split", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } } - ] - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L273-L285" + }, + { "inherits": { "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.rollover" - } - }, - { "kind": "interface", "name": { - "name": "RolloverConditions", - "namespace": "indices.rollover" + "name": "LowercaseProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "max_age", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Field", "namespace": "_types" } } }, { - "name": "max_docs", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_size", + "name": "target_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L287-L291" + }, + { + "kind": "interface", + "name": { + "name": "Pipeline", + "namespace": "ingest._types" + }, + "properties": [ + { + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "max_primary_shard_size", + "name": "on_failure", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } + } + } + }, + { + "name": "processors", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } + } + } + }, + { + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "VersionNumber", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Pipeline.ts#L23-L28" }, { "kind": "interface", "name": { - "name": "IndexSegment", - "namespace": "indices.segments" + "name": "PipelineConfig", + "namespace": "ingest._types" }, "properties": [ { - "name": "shards", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "processors", "required": true, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ProcessorContainer", + "namespace": "ingest._types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ShardsSegment", - "namespace": "indices.segments" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardsSegment", - "namespace": "indices.segments" - } - } - } - ], - "kind": "union_of" } } } - ] + ], + "specLocation": "ingest/_types/Pipeline.ts#L44-L48" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.segments" + "name": "PipelineProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "index", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Name", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "name": "ignore_missing_pipeline", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L293-L296" + }, + { + "kind": "interface", + "name": { + "name": "ProcessorBase", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "expand_wildcards", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ignore_unavailable", + "name": "if", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "verbose", + "name": "ignore_failure", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "indices", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndexSegment", - "namespace": "indices.segments" - } - } - } - }, - { - "name": "_shards", - "required": true, - "type": { + }, + { + "name": "on_failure", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "ProcessorContainer", + "namespace": "ingest._types" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.segments" - } + }, + { + "name": "tag", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L68-L74" }, { "kind": "interface", "name": { - "name": "Segment", - "namespace": "indices.segments" + "name": "ProcessorContainer", + "namespace": "ingest._types" }, "properties": [ { - "name": "attributes", - "required": true, + "name": "attachment", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "AttachmentProcessor", + "namespace": "ingest._types" } } }, { - "name": "committed", - "required": true, + "name": "append", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "AppendProcessor", + "namespace": "ingest._types" } } }, { - "name": "compound", - "required": true, + "name": "csv", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "CsvProcessor", + "namespace": "ingest._types" } } }, { - "name": "deleted_docs", - "required": true, + "name": "convert", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ConvertProcessor", + "namespace": "ingest._types" } } }, { - "name": "generation", - "required": true, + "name": "date", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DateProcessor", + "namespace": "ingest._types" } } }, { - "name": "memory_in_bytes", - "required": true, + "name": "date_index_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DateIndexNameProcessor", + "namespace": "ingest._types" } } }, { - "name": "search", - "required": true, + "name": "dot_expander", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DotExpanderProcessor", + "namespace": "ingest._types" } } }, { - "name": "size_in_bytes", - "required": true, + "name": "enrich", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "EnrichProcessor", + "namespace": "ingest._types" } } }, { - "name": "num_docs", - "required": true, + "name": "fail", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "FailProcessor", + "namespace": "ingest._types" } } }, { - "name": "version", - "required": true, + "name": "foreach", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "ForeachProcessor", + "namespace": "ingest._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ShardSegmentRouting", - "namespace": "indices.segments" - }, - "properties": [ + }, { - "name": "node", - "required": true, + "name": "json", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "JsonProcessor", + "namespace": "ingest._types" } } }, { - "name": "primary", - "required": true, + "name": "user_agent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "UserAgentProcessor", + "namespace": "ingest._types" } } }, { - "name": "state", - "required": true, + "name": "kv", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "KeyValueProcessor", + "namespace": "ingest._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ShardsSegment", - "namespace": "indices.segments" - }, - "properties": [ + }, { - "name": "num_committed_segments", - "required": true, + "name": "geoip", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "GeoIpProcessor", + "namespace": "ingest._types" } } }, { - "name": "routing", - "required": true, + "name": "grok", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardSegmentRouting", - "namespace": "indices.segments" + "name": "GrokProcessor", + "namespace": "ingest._types" } } }, { - "name": "num_search_segments", - "required": true, + "name": "gsub", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "GsubProcessor", + "namespace": "ingest._types" } } }, { - "name": "segments", - "required": true, + "name": "join", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Segment", - "namespace": "indices.segments" - } + "kind": "instance_of", + "type": { + "name": "JoinProcessor", + "namespace": "ingest._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndicesShardStores", - "namespace": "indices.shard_stores" - }, - "properties": [ + }, { - "name": "shards", - "required": true, + "name": "lowercase", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ShardStoreWrapper", - "namespace": "indices.shard_stores" - } + "kind": "instance_of", + "type": { + "name": "LowercaseProcessor", + "namespace": "ingest._types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.shard_stores" - }, - "path": [ + }, { - "name": "index", + "name": "remove", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "RemoveProcessor", + "namespace": "ingest._types" } } - } - ], - "query": [ + }, { - "name": "allow_no_indices", + "name": "rename", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "RenameProcessor", + "namespace": "ingest._types" } } }, { - "name": "expand_wildcards", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "name": "ScriptProcessor", + "namespace": "ingest._types" } } }, { - "name": "ignore_unavailable", + "name": "set", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "SetProcessor", + "namespace": "ingest._types" } } }, { - "name": "status", + "name": "sort", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "indices", - "required": true, + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesShardStores", - "namespace": "indices.shard_stores" - } - } + "name": "SortProcessor", + "namespace": "ingest._types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.shard_stores" - } - }, - { - "kind": "interface", - "name": { - "name": "ShardStore", - "namespace": "indices.shard_stores" - }, - "properties": [ + }, { - "name": "allocation", - "required": true, + "name": "split", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStoreAllocation", - "namespace": "indices.shard_stores" + "name": "SplitProcessor", + "namespace": "ingest._types" } } }, { - "name": "allocation_id", - "required": true, + "name": "trim", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "TrimProcessor", + "namespace": "ingest._types" } } }, { - "name": "attributes", - "required": true, + "name": "uppercase", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "UppercaseProcessor", + "namespace": "ingest._types" } } }, { - "name": "id", - "required": true, + "name": "urldecode", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "UrlDecodeProcessor", + "namespace": "ingest._types" } } }, { - "name": "legacy_version", - "required": true, + "name": "bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "BytesProcessor", + "namespace": "ingest._types" } } }, { - "name": "name", - "required": true, + "name": "dissect", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "DissectProcessor", + "namespace": "ingest._types" } } }, { - "name": "store_exception", - "required": true, + "name": "set_security_user", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStoreException", - "namespace": "indices.shard_stores" + "name": "SetSecurityUserProcessor", + "namespace": "ingest._types" } } }, { - "name": "transport_address", - "required": true, + "name": "pipeline", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", - "namespace": "_types" + "name": "PipelineProcessor", + "namespace": "ingest._types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "primary" - }, - { - "name": "replica" }, { - "name": "unused" - } - ], - "name": { - "name": "ShardStoreAllocation", - "namespace": "indices.shard_stores" - } - }, - { - "kind": "interface", - "name": { - "name": "ShardStoreException", - "namespace": "indices.shard_stores" - }, - "properties": [ - { - "name": "reason", - "required": true, + "name": "drop", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DropProcessor", + "namespace": "ingest._types" } } }, { - "name": "type", - "required": true, + "name": "circle", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CircleProcessor", + "namespace": "ingest._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ShardStoreWrapper", - "namespace": "indices.shard_stores" - }, - "properties": [ + }, { - "name": "stores", - "required": true, + "name": "inference", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardStore", - "namespace": "indices.shard_stores" - } + "kind": "instance_of", + "type": { + "name": "InferenceProcessor", + "namespace": "ingest._types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L27-L66", + "variants": { + "kind": "container", + "nonExhaustive": true + } }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "aliases", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.shrink" + "name": "RemoveProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "index", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Fields", "namespace": "_types" } } }, { - "name": "target", - "required": true, + "name": "ignore_missing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "query": [ + "specLocation": "ingest/_types/Processors.ts#L298-L301" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "RenameProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "name": "master_timeout", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Field", "namespace": "_types" } } }, { - "name": "timeout", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "wait_for_active_shards", - "required": false, + "name": "target_field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "Field", "namespace": "_types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "shards_acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.shrink" - } + ], + "specLocation": "ingest/_types/Processors.ts#L303-L307" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "index_patterns", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - }, - { - "name": "composed_of", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - }, - { - "description": "Any overlapping templates that would have matched, but have lower priority", - "name": "overlapping", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "OverlappingIndexTemplate", - "namespace": "indices._types" - } - } - } - }, - { - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TemplateMapping", - "namespace": "indices._types" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.simulate_index_template" + "name": "ScriptProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "description": "Index or template name to simulate", - "name": "name", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.simulate_index_template" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexTemplate", - "namespace": "indices.get_index_template" - } - } - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "indices.simulate_template" - }, - "path": [ + }, { - "description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.", - "name": "name", + "name": "lang", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.", - "name": "create", + "name": "params", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", + "name": "source", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.simulate_template" - } + ], + "specLocation": "ingest/_types/Processors.ts#L309-L314" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "aliases", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "indices.split" + "name": "SetProcessor", + "namespace": "ingest._types" }, - "path": [ + "properties": [ { - "name": "index", - "required": true, + "name": "copy_from", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Field", "namespace": "_types" } } }, { - "name": "target", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Field", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "master_timeout", + "name": "ignore_empty_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "timeout", + "name": "media_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "wait_for_active_shards", + "name": "override", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } + }, + { + "name": "value", + "required": false, + "type": { + "kind": "user_defined_value" + } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L316-L323" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "shards_acknowledged", - "required": true, + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "SetSecurityUserProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "name": "field", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "Field", + "namespace": "_types" } - }, - { - "name": "index", - "required": true, - "type": { + } + }, + { + "name": "properties", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + } + ], + "specLocation": "ingest/_types/Processors.ts#L325-L328" + }, + { + "kind": "enum", + "members": [ + { + "name": "geo_shape" + }, + { + "name": "shape" + } + ], + "name": { + "name": "ShapeType", + "namespace": "ingest._types" }, + "specLocation": "ingest/_types/Processors.ts#L330-L333" + }, + { "inherits": { "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "ProcessorBase", + "namespace": "ingest._types" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.split" - } - }, - { "kind": "interface", "name": { - "name": "IndexStats", - "namespace": "indices.stats" + "name": "SortProcessor", + "namespace": "ingest._types" }, "properties": [ { - "description": "Contains statistics about completions across all shards assigned to the node.", - "name": "completion", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CompletionStats", + "name": "Field", "namespace": "_types" } } }, { - "description": "Contains statistics about documents across all primary shards assigned to the node.", - "name": "docs", + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DocStats", + "name": "SortOrder", "namespace": "_types" } } }, { - "description": "Contains statistics about the field data cache across all shards assigned to the node.", - "name": "fielddata", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FielddataStats", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L335-L339" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "SplitProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "description": "Contains statistics about flush operations for the node.", - "name": "flush", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "FlushStats", + "name": "Field", "namespace": "_types" } } }, { - "description": "Contains statistics about get operations for the node.", - "name": "get", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GetStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about indexing operations for the node.", - "name": "indexing", + "name": "preserve_trailing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexingStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about merge operations for the node.", - "name": "merges", - "required": false, + "name": "separator", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MergesStats", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the query cache across all shards assigned to the node.", - "name": "query_cache", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryCacheStats", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L341-L347" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "TrimProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "description": "Contains statistics about recovery operations for the node.", - "name": "recovery", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RecoveryStats", + "name": "Field", "namespace": "_types" } } }, { - "description": "Contains statistics about refresh operations for the node.", - "name": "refresh", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RefreshStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the request cache across all shards assigned to the node.", - "name": "request_cache", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RequestCacheStats", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L349-L353" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "UppercaseProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "description": "Contains statistics about search operations for the node.", - "name": "search", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SearchStats", + "name": "Field", "namespace": "_types" } } }, { - "description": "Contains statistics about segments across all shards assigned to the node.", - "name": "segments", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SegmentsStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains statistics about the size of shards assigned to the node.", - "name": "store", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StoreStats", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L355-L359" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "UrlDecodeProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "description": "Contains statistics about transaction log operations for the node.", - "name": "translog", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TranslogStats", + "name": "Field", "namespace": "_types" } } }, { - "description": "Contains statistics about index warming operations for the node.", - "name": "warmer", + "name": "ignore_missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WarmerStats", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "bulk", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "BulkStats", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L361-L365" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "IndicesStats", - "namespace": "indices.stats" + "name": "UserAgentProcessor", + "namespace": "ingest._types" }, "properties": [ { - "name": "primaries", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexStats", - "namespace": "indices.stats" + "name": "Field", + "namespace": "_types" } } }, { - "name": "shards", + "name": "ignore_missing", "required": false, "type": { - "key": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "options", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardStats", - "namespace": "indices.stats" - } + "name": "UserAgentProperty", + "namespace": "ingest._types" } } } }, { - "name": "total", - "required": true, + "name": "regex_file", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexStats", - "namespace": "indices.stats" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "uuid", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "Field", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/_types/Processors.ts#L115-L121" + }, + { + "kind": "enum", + "members": [ + { + "name": "NAME" + }, + { + "name": "MAJOR" + }, + { + "name": "MINOR" + }, + { + "name": "PATCH" + }, + { + "name": "OS" + }, + { + "name": "OS_NAME" + }, + { + "name": "OS_MAJOR" + }, + { + "name": "OS_MINOR" + }, + { + "name": "DEVICE" + }, + { + "name": "BUILD" + } + ], + "name": { + "name": "UserAgentProperty", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L76-L87" }, { "attachedBehaviors": [ @@ -93531,6 +112215,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -93540,27 +112225,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.stats" + "namespace": "ingest.delete_pipeline" }, "path": [ { - "name": "metric", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metrics", - "namespace": "_types" - } - } - }, - { - "name": "index", - "required": false, + "description": "Pipeline ID", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Id", "namespace": "_types" } } @@ -93568,145 +112243,232 @@ ], "query": [ { - "name": "completion_fields", + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Time", "namespace": "_types" } } }, { - "name": "expand_wildcards", + "description": "Explicit operation timeout", + "name": "timeout", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L37" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ingest.delete_pipeline" + }, + "specLocation": "ingest/delete_pipeline/DeletePipelineResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "GeoIpDownloadStatistics", + "namespace": "ingest.geo_ip_stats" + }, + "properties": [ { - "name": "fielddata_fields", - "required": false, + "description": "Total number of successful database downloads.", + "name": "successful_downloads", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "integer", "namespace": "_types" } } }, { - "name": "fields", - "required": false, + "description": "Total number of failed database downloads.", + "name": "failed_downloads", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "integer", "namespace": "_types" } } }, { - "name": "forbid_closed_indices", - "required": false, + "description": "Total milliseconds spent downloading databases.", + "name": "total_download_time", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "groups", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "include_segment_file_sizes", - "required": false, + "description": "Current number of databases available for use.", + "name": "database_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "include_unloaded_segments", - "required": false, + "description": "Total number of database updates skipped.", + "name": "skipped_updates", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/geo_ip_stats/types.ts#L23-L34" + }, + { + "kind": "interface", + "name": { + "name": "GeoIpNodeDatabaseName", + "namespace": "ingest.geo_ip_stats" + }, + "properties": [ { - "name": "level", - "required": false, + "description": "Name of the database.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Level", + "name": "Name", "namespace": "_types" } } + } + ], + "specLocation": "ingest/geo_ip_stats/types.ts#L44-L47" + }, + { + "description": "Downloaded databases for the node. The field key is the node ID.", + "kind": "interface", + "name": { + "name": "GeoIpNodeDatabases", + "namespace": "ingest.geo_ip_stats" + }, + "properties": [ + { + "description": "Downloaded databases for the node.", + "name": "databases", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GeoIpNodeDatabaseName", + "namespace": "ingest.geo_ip_stats" + } + } + } }, { - "name": "types", - "required": false, + "description": "Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/.", + "name": "files_in_temp", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Types", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - ] + ], + "specLocation": "ingest/geo_ip_stats/types.ts#L36-L42" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns statistical information about geoip databases", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ingest.geo_ip_stats" + }, + "path": [], + "query": [], + "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L27" }, { "body": { "kind": "properties", "properties": [ { - "name": "indices", - "required": false, + "description": "Download statistics for all GeoIP2 databases.", + "name": "stats", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoIpDownloadStatistics", + "namespace": "ingest.geo_ip_stats" + } + } + }, + { + "description": "Downloaded GeoIP2 databases for each node.", + "name": "nodes", + "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } }, "kind": "dictionary_of", @@ -93714,63 +112476,45 @@ "value": { "kind": "instance_of", "type": { - "name": "IndicesStats", - "namespace": "indices.stats" + "name": "GeoIpNodeDatabases", + "namespace": "ingest.geo_ip_stats" } } } - }, - { - "name": "_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardStatistics", - "namespace": "_types" - } - } - }, - { - "name": "_all", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndicesStats", - "namespace": "indices.stats" - } - } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.stats" - } + "namespace": "ingest.geo_ip_stats" + }, + "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsResponse.ts#L24-L31" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a pipeline.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ShardCommit", - "namespace": "indices.stats" + "name": "Request", + "namespace": "ingest.get_pipeline" }, - "properties": [ - { - "name": "generation", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, + "path": [ { + "description": "Comma separated list of pipeline ids. Wildcards supported", "name": "id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -93778,125 +112522,217 @@ "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "num_docs", - "required": true, + "description": "Explicit operation timeout for connection to master node", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } }, { - "name": "user_data", - "required": true, + "description": "Return pipelines without their definitions (default: false)", + "name": "summary", + "required": false, + "serverDefault": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L39" }, { - "kind": "interface", - "name": { - "name": "ShardFileSizeInfo", - "namespace": "indices.stats" + "body": { + "kind": "properties", + "properties": [] }, - "properties": [ - { - "name": "description", - "required": true, - "type": { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } - } - }, - { - "name": "size_in_bytes", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Pipeline", + "namespace": "ingest._types" } } - }, - { - "name": "min_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ingest.get_pipeline" + }, + "specLocation": "ingest/get_pipeline/GetPipelineResponse.ts#L23-L23" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns a list of the built-in patterns.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ingest.processor_grok" + }, + "path": [], + "query": [], + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "patterns", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - }, - { - "name": "max_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ingest.processor_grok" + }, + "specLocation": "ingest/processor_grok/GrokProcessorPatternsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", + "name": "_meta", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } } - } - }, - { - "name": "average_size_in_bytes", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Description of the ingest pipeline.", + "name": "description", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "name": "count", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "on_failure", + "required": false, "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } + } + } + }, + { + "name": "processors", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } } } + ] + }, + "description": "Creates or updates a pipeline.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ] - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "ShardLease", - "namespace": "indices.stats" + "name": "Request", + "namespace": "ingest.put_pipeline" }, - "properties": [ + "path": [ { + "description": "Pipeline ID", "name": "id", "required": true, "type": { @@ -93906,581 +112742,801 @@ "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "retaining_seq_no", - "required": true, + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", + "name": "Time", "namespace": "_types" } } }, { - "name": "timestamp", - "required": true, + "description": "Explicit operation timeout", + "name": "timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } - }, - { - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } } - ] + ], + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L56" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ingest.put_pipeline" + }, + "specLocation": "ingest/put_pipeline/PutPipelineResponse.ts#L22-L22" }, { "kind": "interface", "name": { - "name": "ShardPath", - "namespace": "indices.stats" + "name": "Document", + "namespace": "ingest.simulate" }, "properties": [ { - "name": "data_path", - "required": true, + "name": "_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "is_custom_data_path", - "required": true, + "name": "_index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "state_path", + "name": "_source", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "user_defined_value" } } - ] + ], + "specLocation": "ingest/simulate/types.ts#L48-L52" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "description": "The simulated document, with optional metadata.", "kind": "interface", "name": { - "name": "ShardQueryCache", - "namespace": "indices.stats" + "name": "DocumentSimulation", + "namespace": "ingest.simulate" }, "properties": [ { - "name": "cache_count", + "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "cache_size", + "name": "_index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "evictions", + "name": "_ingest", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Ingest", + "namespace": "ingest.simulate" } } }, { - "name": "hit_count", - "required": true, + "name": "_routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "memory_size_in_bytes", + "name": "_source", "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Type", "namespace": "_types" } } }, { - "name": "miss_count", - "required": true, + "name": "_version", + "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "total_count", - "required": true, + "name": "_version_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "VersionType", "namespace": "_types" } } } - ] + ], + "specLocation": "ingest/simulate/types.ts#L54-L68" }, { "kind": "interface", "name": { - "name": "ShardRetentionLeases", - "namespace": "indices.stats" + "name": "Ingest", + "namespace": "ingest.simulate" }, "properties": [ { - "name": "primary_term", + "name": "timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateString", "namespace": "_types" } } }, { - "name": "version", - "required": true, + "name": "pipeline", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Name", "namespace": "_types" } } - }, - { - "name": "leases", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardLease", - "namespace": "indices.stats" - } - } - } } - ] + ], + "specLocation": "ingest/simulate/types.ts#L35-L38" }, { "kind": "interface", "name": { - "name": "ShardRouting", - "namespace": "indices.stats" + "name": "PipelineSimulation", + "namespace": "ingest.simulate" }, "properties": [ { - "name": "node", - "required": true, + "name": "doc", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DocumentSimulation", + "namespace": "ingest.simulate" } } }, { - "name": "primary", - "required": true, + "name": "processor_results", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PipelineSimulation", + "namespace": "ingest.simulate" + } } } }, { - "name": "relocating_node", + "name": "tag", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "state", - "required": true, + "name": "processor_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardRoutingState", - "namespace": "indices.stats" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "UNASSIGNED" - }, - { - "name": "INITIALIZING" - }, - { - "name": "STARTED" }, { - "name": "RELOCATING" + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ActionStatusOptions", + "namespace": "watcher._types" + } + } } ], - "name": { - "name": "ShardRoutingState", - "namespace": "indices.stats" - } + "specLocation": "ingest/simulate/types.ts#L40-L46" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "docs", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Document", + "namespace": "ingest.simulate" + } + } + } + }, + { + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Pipeline", + "namespace": "ingest._types" + } + } + } + ] + }, + "description": "Allows to simulate a pipeline with example documents.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "ShardSequenceNumber", - "namespace": "indices.stats" + "name": "Request", + "namespace": "ingest.simulate" }, - "properties": [ - { - "name": "global_checkpoint", - "required": true, + "path": [ + { + "description": "Pipeline ID", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "local_checkpoint", - "required": true, + "description": "Verbose mode. Display data output for each processor in executed pipeline", + "name": "verbose", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, - { - "name": "max_seq_no", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L41" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "docs", + "required": true, "type": { - "name": "SequenceNumber", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PipelineSimulation", + "namespace": "ingest.simulate" + } + } } } - } - ] + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ingest.simulate" + }, + "specLocation": "ingest/simulate/SimulatePipelineResponse.ts#L22-L24" }, { "kind": "interface", "name": { - "name": "ShardStats", - "namespace": "indices.stats" + "name": "License", + "namespace": "license._types" }, "properties": [ { - "name": "commit", + "name": "expiry_date_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardCommit", - "namespace": "indices.stats" + "name": "EpochMillis", + "namespace": "_types" } } }, { - "name": "completion", + "name": "issue_date_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "CompletionStats", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "docs", + "name": "issued_to", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DocStats", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "fielddata", + "name": "issuer", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FielddataStats", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "flush", - "required": true, + "name": "max_nodes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FlushStats", + "name": "long", "namespace": "_types" } } }, { - "name": "get", - "required": true, + "name": "max_resource_units", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "GetStats", + "name": "long", "namespace": "_types" } } }, { - "name": "indexing", + "name": "signature", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexingStats", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "merges", + "name": "start_date_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "MergesStats", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "shard_path", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardPath", - "namespace": "indices.stats" + "name": "LicenseType", + "namespace": "license._types" } } }, { - "name": "query_cache", + "name": "uid", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardQueryCache", - "namespace": "indices.stats" + "name": "string", + "namespace": "_builtins" } } + } + ], + "specLocation": "license/_types/License.ts#L42-L53" + }, + { + "kind": "enum", + "members": [ + { + "name": "active" }, { - "name": "recovery", + "name": "valid" + }, + { + "name": "invalid" + }, + { + "name": "expired" + } + ], + "name": { + "name": "LicenseStatus", + "namespace": "license._types" + }, + "specLocation": "license/_types/License.ts#L35-L40" + }, + { + "kind": "enum", + "members": [ + { + "name": "missing" + }, + { + "name": "trial" + }, + { + "name": "basic" + }, + { + "name": "standard" + }, + { + "name": "dev" + }, + { + "name": "silver" + }, + { + "name": "gold" + }, + { + "name": "platinum" + }, + { + "name": "enterprise" + } + ], + "name": { + "name": "LicenseType", + "namespace": "license._types" + }, + "specLocation": "license/_types/License.ts#L23-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes licensing information for the cluster", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "license.delete" + }, + "path": [], + "query": [], + "specLocation": "license/delete/DeleteLicenseRequest.ts#L22-L27" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "license.delete" + }, + "specLocation": "license/delete/DeleteLicenseResponse.ts#L22-L22" + }, + { + "kind": "interface", + "name": { + "name": "LicenseInformation", + "namespace": "license.get" + }, + "properties": [ + { + "name": "expiry_date", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RecoveryStats", + "name": "DateString", "namespace": "_types" } } }, { - "name": "refresh", + "name": "expiry_date_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RefreshStats", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "request_cache", + "name": "issue_date", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RequestCacheStats", + "name": "DateString", "namespace": "_types" } } }, { - "name": "retention_leases", + "name": "issue_date_in_millis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardRetentionLeases", - "namespace": "indices.stats" + "name": "EpochMillis", + "namespace": "_types" } } }, { - "name": "routing", + "name": "issued_to", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardRouting", - "namespace": "indices.stats" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "search", + "name": "issuer", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SearchStats", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "segments", + "name": "max_nodes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SegmentsStats", + "name": "long", "namespace": "_types" } } }, { - "name": "seq_no", - "required": true, + "name": "max_resource_units", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardSequenceNumber", - "namespace": "indices.stats" + "name": "integer", + "namespace": "_types" } } }, { - "name": "store", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "StoreStats", - "namespace": "_types" + "name": "LicenseStatus", + "namespace": "license._types" } } }, { - "name": "translog", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TranslogStats", - "namespace": "_types" + "name": "LicenseType", + "namespace": "license._types" } } }, { - "name": "warmer", + "name": "uid", "required": true, "type": { "kind": "instance_of", "type": { - "name": "WarmerStats", + "name": "Uuid", "namespace": "_types" } } }, { - "name": "bulk", - "required": false, + "name": "start_date_in_millis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "BulkStats", + "name": "EpochMillis", "namespace": "_types" } } } - ] + ], + "specLocation": "license/get/types.ts#L25-L38" }, { "attachedBehaviors": [ @@ -94489,6 +113545,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves licensing information for the cluster", "inherits": { "type": { "name": "RequestBase", @@ -94498,150 +113555,69 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.unfreeze" + "namespace": "license.get" }, - "path": [ - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ], + "path": [], "query": [ { - "name": "allow_no_indices", + "description": "If the active license is an enterprise license, return type as 'enterprise' (default: false)", + "name": "accept_enterprise", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "namespace": "_builtins" } } }, { - "name": "ignore_unavailable", + "description": "Return local information, do not retrieve the state from master node (default: false)", + "name": "local", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "wait_for_active_shards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "license/get/GetLicenseRequest.ts#L22-L32" }, { "body": { "kind": "properties", "properties": [ { - "name": "shards_acknowledged", + "name": "license", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "LicenseInformation", + "namespace": "license.get" } } } ] }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "indices.unfreeze" - } - }, - { - "kind": "interface", - "name": { - "name": "IndicesUpdateAliasBulk", - "namespace": "indices.update_aliases" + "namespace": "license.get" }, - "properties": [] + "specLocation": "license/get/GetLicenseResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "actions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesUpdateAliasBulk", - "namespace": "indices.update_aliases" - } - } - } - } - ] + "kind": "no_body" }, + "description": "Retrieves information about the status of the basic license.", "inherits": { "type": { "name": "RequestBase", @@ -94651,71 +113627,44 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.update_aliases" + "namespace": "license.get_basic_status" }, "path": [], - "query": [ - { - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "indices.update_aliases" - } + "query": [], + "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L27" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "stub_c", + "name": "eligible_to_start_basic", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "license.get_basic_status" + }, + "specLocation": "license/get_basic_status/GetBasicLicenseStatusResponse.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves information about the status of the trial license.", "inherits": { "type": { "name": "RequestBase", @@ -94725,47 +113674,24 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.upgrade" + "namespace": "license.get_trial_status" }, - "path": [ - { - "name": "stub_b", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "stub_a", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] + "path": [], + "query": [], + "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L27" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "eligible_to_start_trial", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } @@ -94774,61 +113700,44 @@ "kind": "response", "name": { "name": "Response", - "namespace": "indices.upgrade" - } + "namespace": "license.get_trial_status" + }, + "specLocation": "license/get_trial_status/GetTrialLicenseStatusResponse.ts#L20-L22" }, { "kind": "interface", "name": { - "name": "IndicesValidationExplanation", - "namespace": "indices.validate_query" + "name": "Acknowledgement", + "namespace": "license.post" }, "properties": [ { - "name": "error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "explanation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "index", + "name": "license", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "valid", + "name": "message", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "license/post/types.ts#L20-L23" }, { "attachedBehaviors": [ @@ -94838,18 +113747,33 @@ "kind": "properties", "properties": [ { - "name": "query", + "name": "license", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "License", + "namespace": "license._types" + } + } + }, + { + "name": "licenses", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "License", + "namespace": "license._types" + } } } } ] }, + "description": "Updates the license for the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -94859,226 +113783,59 @@ "kind": "request", "name": { "name": "Request", - "namespace": "indices.validate_query" + "namespace": "license.post" }, - "path": [ - { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "name": "type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Types", - "namespace": "_types" - } - } - } - ], + "path": [], "query": [ { - "name": "allow_no_indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "all_shards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "analyze_wildcard", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "default_operator", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DefaultOperator", - "namespace": "_types" - } - } - }, - { - "name": "df", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "name": "explain", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "ignore_unavailable", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "lenient", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "query_on_query_string", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "rewrite", + "description": "whether the user has acknowledged acknowledge messages (default: false)", + "name": "acknowledge", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "q", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "license/post/PostLicenseRequest.ts#L23-L36" }, { "body": { "kind": "properties", "properties": [ { - "name": "explanations", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndicesValidationExplanation", - "namespace": "indices.validate_query" - } - } - } - }, - { - "name": "_shards", + "name": "acknowledge", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "Acknowledgement", + "namespace": "license.post" } } }, { - "name": "valid", + "name": "acknowledged", "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "error", - "required": false, + "name": "license_status", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "LicenseStatus", + "namespace": "license._types" } } } @@ -95087,1177 +113844,1185 @@ "kind": "response", "name": { "name": "Response", - "namespace": "indices.validate_query" - } + "namespace": "license.post" + }, + "specLocation": "license/post/PostLicenseResponse.ts#L23-L29" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Starts an indefinite basic license.", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "request", "name": { - "name": "AppendProcessor", - "namespace": "ingest._types" + "name": "Request", + "namespace": "license.post_start_basic" }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } - }, + "path": [], + "query": [ { - "name": "allow_duplicates", + "description": "whether the user has acknowledged acknowledge messages (default: false)", + "name": "acknowledge", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L22-L31" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "AttachmentProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "ignore_missing", - "required": false, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "acknowledge", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } } - } - }, - { - "name": "indexed_chars", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "basic_was_started", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "name": "indexed_chars_field", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "error_message", + "required": true, "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "properties", - "required": false, - "type": { - "kind": "array_of", - "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - }, - { - "name": "target_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "resource_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "BytesProcessor", - "namespace": "ingest._types" + ] }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "ignore_missing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "target_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ] - }, - { "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "AcknowledgedResponseBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "response", "name": { - "name": "CircleProcessor", - "namespace": "ingest._types" + "name": "Response", + "namespace": "license.post_start_basic" }, - "properties": [ - { - "name": "error_distance", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "ignore_missing", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "shape_type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShapeType", - "namespace": "ingest._types" - } - } - }, - { - "name": "target_field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ] + "specLocation": "license/post_start_basic/StartBasicLicenseResponse.ts#L23-L29" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "starts a limited time trial license.", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "ConvertProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "license.post_start_trial" + }, + "path": [], + "query": [ { - "name": "ignore_missing", + "description": "whether the user has acknowledged acknowledge messages (default: false)", + "name": "acknowledge", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "target_field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "name": "type_query_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ConvertType", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "integer" - }, - { - "name": "long" - }, - { - "name": "float" - }, - { - "name": "double" - }, - { - "name": "string" - }, - { - "name": "boolean" - }, - { - "name": "auto" - } ], - "name": { - "name": "ConvertType", - "namespace": "ingest._types" - } + "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L22-L32" }, { + "body": { + "kind": "properties", + "properties": [ + { + "name": "error_message", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "trial_was_started", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "LicenseType", + "namespace": "license._types" + } + } + } + ] + }, "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "AcknowledgedResponseBase", + "namespace": "_types" } }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "license.post_start_trial" + }, + "specLocation": "license/post_start_trial/StartTrialLicenseResponse.ts#L23-L29" + }, + { "kind": "interface", "name": { - "name": "CsvProcessor", - "namespace": "ingest._types" + "name": "Pipeline", + "namespace": "logstash._types" }, "properties": [ - { - "name": "empty_value", - "required": true, - "type": { - "kind": "user_defined_value" - } - }, { "name": "description", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "field", + "name": "last_modified", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Timestamp", "namespace": "_types" } } }, { - "name": "ignore_missing", - "required": false, + "name": "pipeline_metadata", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "PipelineMetadata", + "namespace": "logstash._types" } } }, { - "name": "quote", - "required": false, + "name": "username", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "separator", - "required": false, + "name": "pipeline", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "target_fields", + "name": "pipeline_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "PipelineSettings", + "namespace": "logstash._types" + } + } + } + ], + "specLocation": "logstash/_types/Pipeline.ts#L37-L44" + }, + { + "kind": "interface", + "name": { + "name": "PipelineMetadata", + "namespace": "logstash._types" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "trim", + "name": "version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "logstash/_types/Pipeline.ts#L23-L26" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "DateIndexNameProcessor", - "namespace": "ingest._types" + "name": "PipelineSettings", + "namespace": "logstash._types" }, "properties": [ { - "name": "date_formats", + "name": "pipeline.workers", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "date_rounding", + "name": "pipeline.batch.size", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateRounding", - "namespace": "ingest._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } }, { - "name": "field", + "name": "pipeline.batch.delay", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "name": "index_name_format", + "name": "queue.type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "index_name_prefix", + "name": "queue.max_bytes.number", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "locale", + "name": "queue.max_bytes.units", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "timezone", + "name": "queue.checkpoint.writes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } } - ] + ], + "specLocation": "logstash/_types/Pipeline.ts#L28-L36" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes Logstash Pipelines used by Central Management", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "request", "name": { - "name": "DateProcessor", - "namespace": "ingest._types" + "name": "Request", + "namespace": "logstash.delete_pipeline" }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, + "path": [ { - "name": "formats", + "description": "The ID of the Pipeline", + "name": "id", "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "locale", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "target_field", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "timezone", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } } - ] + ], + "query": [], + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L32" }, { - "kind": "enum", - "members": [ - { - "identifier": "Second", - "name": "s" - }, - { - "identifier": "Minute", - "name": "m" - }, - { - "identifier": "Hour", - "name": "h" - }, - { - "identifier": "Day", - "name": "d" - }, - { - "identifier": "Week", - "name": "w" - }, - { - "identifier": "Month", - "name": "M" - }, - { - "identifier": "Year", - "name": "y" - } - ], + "body": { + "kind": "no_body" + }, + "kind": "response", "name": { - "name": "DateRounding", - "namespace": "ingest._types" - } + "name": "Response", + "namespace": "logstash.delete_pipeline" + }, + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves Logstash Pipelines used by Central Management", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "request", "name": { - "name": "DissectProcessor", - "namespace": "ingest._types" + "name": "Request", + "namespace": "logstash.get_pipeline" }, - "properties": [ - { - "name": "append_separator", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, + "path": [ { - "name": "field", + "description": "A comma-separated list of Pipeline IDs", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Ids", "namespace": "_types" } } - }, - { - "name": "ignore_missing", - "required": true, - "type": { + } + ], + "query": [], + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L32" + }, + { + "body": { + "kind": "value", + "value": { + "key": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } - } - }, - { - "name": "pattern", - "required": true, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Pipeline", + "namespace": "logstash._types" } } } - ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "logstash.get_pipeline" + }, + "specLocation": "logstash/get_pipeline/LogstashGetPipelineResponse.ts#L24-L26" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "pipeline", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "Pipeline", + "namespace": "logstash._types" + } + } + }, + "description": "Adds and updates Logstash Pipelines used for Central Management", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "request", "name": { - "name": "DotExpanderProcessor", - "namespace": "ingest._types" + "name": "Request", + "namespace": "logstash.put_pipeline" }, - "properties": [ + "path": [ { - "name": "field", + "description": "The ID of the Pipeline", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } - }, - { - "name": "path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } } - ] + ], + "query": [], + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L35" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } + "body": { + "kind": "no_body" }, - "kind": "interface", + "kind": "response", "name": { - "name": "DropProcessor", - "namespace": "ingest._types" + "name": "Response", + "namespace": "logstash.put_pipeline" }, - "properties": [] + "specLocation": "logstash/put_pipeline/LogstashPutPipelineResponse.ts#L22-L24" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "EnrichProcessor", - "namespace": "ingest._types" + "name": "Deprecation", + "namespace": "migration.deprecations" }, "properties": [ { - "name": "field", + "name": "details", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "ignore_missing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_matches", - "required": false, + "description": "The level property describes the significance of the issue.", + "name": "level", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DeprecationLevel", + "namespace": "migration.deprecations" } } }, { - "name": "override", - "required": false, + "name": "message", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "policy_name", + "name": "url", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } + } + ], + "specLocation": "migration/deprecations/types.ts#L29-L35" + }, + { + "kind": "enum", + "members": [ + { + "name": "none" }, { - "name": "shape_relation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoShapeRelation", - "namespace": "_types" - } - } + "name": "info" }, { - "name": "target_field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "description": "You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.", + "name": "warning" + }, + { + "description": "You cannot upgrade without fixing this problem.", + "name": "critical" } - ] + ], + "name": { + "name": "DeprecationLevel", + "namespace": "migration.deprecations" + }, + "specLocation": "migration/deprecations/types.ts#L20-L27" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "RequestBase", + "namespace": "_types" } }, - "kind": "interface", + "kind": "request", "name": { - "name": "FailProcessor", - "namespace": "ingest._types" + "name": "Request", + "namespace": "migration.deprecations" }, - "properties": [ + "path": [ { - "name": "message", - "required": true, + "description": "Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L33" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } + "body": { + "kind": "properties", + "properties": [ + { + "name": "cluster_settings", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Deprecation", + "namespace": "migration.deprecations" + } + } + } + }, + { + "name": "index_settings", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Deprecation", + "namespace": "migration.deprecations" + } + } + } + } + }, + { + "name": "node_settings", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Deprecation", + "namespace": "migration.deprecations" + } + } + } + }, + { + "name": "ml_settings", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Deprecation", + "namespace": "migration.deprecations" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "migration.deprecations" }, + "specLocation": "migration/deprecations/DeprecationInfoResponse.ts#L23-L30" + }, + { "kind": "interface", "name": { - "name": "ForeachProcessor", - "namespace": "ingest._types" + "name": "MigrationFeature", + "namespace": "migration.get_feature_upgrade_status" }, "properties": [ { - "name": "field", + "name": "feature_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ignore_missing", - "required": false, + "name": "minimum_index_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "processor", + "name": "migration_status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" + "name": "MigrationStatus", + "namespace": "migration.get_feature_upgrade_status" + } + } + }, + { + "name": "indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MigrationFeatureIndexInfo", + "namespace": "migration.get_feature_upgrade_status" + } } } } - ] + ], + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L37-L42" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "GeoIpProcessor", - "namespace": "ingest._types" + "name": "MigrationFeatureIndexInfo", + "namespace": "migration.get_feature_upgrade_status" }, "properties": [ { - "name": "database_file", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "field", + "name": "version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "VersionString", "namespace": "_types" } } }, { - "name": "first_only", - "required": true, + "name": "failure_cause", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ErrorCause", + "namespace": "_types" } } + } + ], + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L44-L48" + }, + { + "kind": "enum", + "members": [ + { + "name": "NO_MIGRATION_NEEDED" }, { - "name": "ignore_missing", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "MIGRATION_NEEDED" }, { - "name": "properties", - "required": true, - "type": { - "kind": "array_of", - "value": { + "name": "IN_PROGRESS" + }, + { + "name": "ERROR" + } + ], + "name": { + "name": "MigrationStatus", + "namespace": "migration.get_feature_upgrade_status" + }, + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L30-L35" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Find out whether system features need to be upgraded or not", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "migration.get_feature_upgrade_status" + }, + "path": [], + "query": [], + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L28" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "features", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MigrationFeature", + "namespace": "migration.get_feature_upgrade_status" + } + } + } + }, + { + "name": "migration_status", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "MigrationStatus", + "namespace": "migration.get_feature_upgrade_status" } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "migration.get_feature_upgrade_status" + }, + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L23-L28" + }, + { + "kind": "interface", + "name": { + "name": "MigrationFeature", + "namespace": "migration.post_feature_upgrade" + }, + "properties": [ { - "name": "target_field", + "name": "feature_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts#L27-L29" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Begin upgrades for system features", "inherits": { "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "name": "RequestBase", + "namespace": "_types" } }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "migration.post_feature_upgrade" + }, + "path": [], + "query": [], + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L28" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "accepted", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "features", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MigrationFeature", + "namespace": "migration.post_feature_upgrade" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "migration.post_feature_upgrade" + }, + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts#L20-L25" + }, + { "kind": "interface", "name": { - "name": "GrokProcessor", - "namespace": "ingest._types" + "name": "AnalysisConfig", + "namespace": "ml._types" }, "properties": [ { - "name": "field", + "description": "The size of the interval that the analysis is aggregated into, typically between 5m and 1h. If the anomaly detection job uses a datafeed with aggregations, this value must be divisible by the interval of the date histogram aggregation.\n* @server_default 5m", + "name": "bucket_span", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "TimeSpan", "namespace": "_types" } } }, { - "name": "ignore_missing", + "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string it must refer to a built-in analyzer or one added by another plugin.", + "name": "categorization_analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "CategorizationAnalyzer", + "namespace": "ml._types" } } }, { - "name": "pattern_definitions", - "required": true, + "description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", + "name": "categorization_field_name", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.", + "name": "categorization_filters", + "required": false, + "type": { + "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "patterns", + "description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.", + "name": "detectors", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Detector", + "namespace": "ml._types" } } } }, { - "name": "trace_match", + "description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.", + "name": "influencers", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "GsubProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "field", - "required": true, + "description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. Typically, set to `30d` or longer. If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.", + "name": "model_prune_window", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Time", "namespace": "_types" } } }, { - "name": "ignore_missing", + "description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is only applicable when you send data by using the post data API.", + "name": "latency", "required": false, + "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "pattern", - "required": true, + "description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.", + "name": "multivariate_by_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "replacement", - "required": true, + "description": "Settings related to how categorization interacts with partition fields.", + "name": "per_partition_categorization", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "PerPartitionCategorization", + "namespace": "ml._types" } } }, { - "name": "target_field", + "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.", + "name": "summary_count_field_name", "required": false, "type": { "kind": "instance_of", @@ -96267,75 +115032,64 @@ } } } - ] + ], + "specLocation": "ml/_types/Analysis.ts#L29-L76" }, { - "kind": "interface", - "name": { - "name": "InferenceConfig", - "namespace": "ingest._types" - }, - "properties": [ + "attachedBehaviors": [ + "OverloadOf" + ], + "behaviors": [ { - "name": "regression", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "InferenceConfigRegression", - "namespace": "ingest._types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "AnalysisConfig", + "namespace": "ml._types" + } } + ], + "type": { + "name": "OverloadOf", + "namespace": "_spec_utils" } } - ] - }, - { + ], "kind": "interface", "name": { - "name": "InferenceConfigRegression", - "namespace": "ingest._types" + "name": "AnalysisConfigRead", + "namespace": "ml._types" }, "properties": [ { - "name": "results_field", + "description": "The size of the interval that the analysis is aggregated into, typically between 5m and 1h. If the anomaly detection job uses a datafeed with aggregations, this value must be divisible by the interval of the date histogram aggregation.\n* @server_default 5m", + "name": "bucket_span", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TimeSpan", + "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "InferenceProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "model_id", - "required": true, + "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string it must refer to a built-in analyzer or one added by another plugin.", + "name": "categorization_analyzer", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "CategorizationAnalyzer", + "namespace": "ml._types" } } }, { - "name": "target_field", - "required": true, + "description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", + "name": "categorization_field_name", + "required": false, "type": { "kind": "instance_of", "type": { @@ -96345,73 +115099,102 @@ } }, { - "name": "field_map", + "description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.", + "name": "categorization_filters", "required": false, "type": { - "key": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.", + "name": "detectors", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DetectorRead", + "namespace": "ml._types" + } + } + } + }, + { + "description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.", + "name": "influencers", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" } } }, { - "name": "inference_config", + "description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. Typically, set to `30d` or longer. If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.", + "name": "model_prune_window", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InferenceConfig", - "namespace": "ingest._types" - } - } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "JoinProcessor", - "namespace": "ingest._types" - }, - "properties": [ + "name": "Time", + "namespace": "_types" + } + } + }, { - "name": "field", - "required": true, + "description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is only applicable when you send data by using the post data API.", + "name": "latency", + "required": false, + "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Time", "namespace": "_types" } } }, { - "name": "separator", - "required": true, + "description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.", + "name": "multivariate_by_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "target_field", + "description": "Settings related to how categorization interacts with partition fields.", + "name": "per_partition_categorization", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PerPartitionCategorization", + "namespace": "ml._types" + } + } + }, + { + "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.", + "name": "summary_count_field_name", "required": false, "type": { "kind": "instance_of", @@ -96421,1967 +115204,1597 @@ } } } - ] + ], + "specLocation": "ml/_types/Analysis.ts#L78-L90" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "JsonProcessor", - "namespace": "ingest._types" + "name": "AnalysisLimits", + "namespace": "ml._types" }, "properties": [ { - "name": "add_to_root", - "required": true, + "description": "The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization.", + "name": "categorization_examples_limit", + "required": false, + "serverDefault": 4, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "field", - "required": true, + "description": "The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value.", + "name": "model_memory_limit", + "required": false, + "serverDefault": "1024mb", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/_types/Analysis.ts#L103-L114" + }, + { + "kind": "interface", + "name": { + "name": "AnalysisMemoryLimit", + "namespace": "ml._types" + }, + "properties": [ { - "name": "target_field", + "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "name": "model_memory_limit", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/_types/Analysis.ts#L116-L121" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "KeyValueProcessor", - "namespace": "ingest._types" + "name": "Anomaly", + "namespace": "ml._types" }, "properties": [ { - "name": "exclude_keys", + "name": "actual", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } } }, { - "name": "field", + "name": "bucket_span", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Time", "namespace": "_types" } } }, { - "name": "field_split", - "required": true, + "name": "by_field_name", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "ignore_missing", + "name": "by_field_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "include_keys", + "name": "causes", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "AnomalyCause", + "namespace": "ml._types" } } } }, { - "name": "prefix", - "required": false, + "name": "detector_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "strip_brackets", + "name": "field_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "target_field", + "name": "function", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "trim_key", + "name": "function_description", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "trim_value", + "name": "influencers", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Influence", + "namespace": "ml._types" + } } } }, { - "name": "value_split", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "LowercaseProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "field", + "name": "initial_record_score", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "double", "namespace": "_types" } } }, { - "name": "ignore_missing", - "required": false, + "name": "is_interim", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "target_field", - "required": false, + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Pipeline", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "description", + "name": "over_field_name", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "on_failure", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } - } - } - }, - { - "name": "processors", + "name": "over_field_value", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "version", + "name": "partition_field_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "PipelineConfig", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "description", + "name": "partition_field_value", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "version", - "required": false, + "name": "probability", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "double", "namespace": "_types" } } }, { - "name": "processors", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } - } - } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "PipelineProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "name", + "name": "record_score", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "double", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ProcessorBase", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "if", - "required": false, + "name": "result_type", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "ignore_failure", - "required": false, + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } }, { - "name": "on_failure", + "name": "typical", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } } - }, - { - "name": "tag", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } } - ] + ], + "specLocation": "ml/_types/Anomaly.ts#L24-L47" }, { "kind": "interface", "name": { - "name": "ProcessorContainer", - "namespace": "ingest._types" + "name": "AnomalyCause", + "namespace": "ml._types" }, "properties": [ { - "name": "attachment", - "required": false, + "name": "actual", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "AttachmentProcessor", - "namespace": "ingest._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } }, { - "name": "append", - "required": false, + "name": "by_field_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AppendProcessor", - "namespace": "ingest._types" + "name": "Name", + "namespace": "_types" } } }, { - "name": "csv", - "required": false, + "name": "by_field_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CsvProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "convert", - "required": false, + "name": "correlated_by_field_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ConvertProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "date", - "required": false, + "name": "field_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateProcessor", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } }, { - "name": "date_index_name", - "required": false, + "name": "function", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateIndexNameProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "dot_expander", - "required": false, + "name": "function_description", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DotExpanderProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "enrich", - "required": false, + "name": "influencers", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "EnrichProcessor", - "namespace": "ingest._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Influence", + "namespace": "ml._types" + } } } }, { - "name": "fail", - "required": false, + "name": "over_field_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "FailProcessor", - "namespace": "ingest._types" + "name": "Name", + "namespace": "_types" } } }, { - "name": "foreach", - "required": false, + "name": "over_field_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ForeachProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "json", - "required": false, + "name": "partition_field_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "JsonProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "user_agent", - "required": false, + "name": "partition_field_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "UserAgentProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "kv", - "required": false, + "name": "probability", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "KeyValueProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "geoip", - "required": false, + "name": "typical", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "GeoIpProcessor", - "namespace": "ingest._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } + } + ], + "specLocation": "ml/_types/Anomaly.ts#L49-L64" + }, + { + "kind": "enum", + "members": [ + { + "name": "actual" }, { - "name": "grok", - "required": false, + "name": "typical" + }, + { + "name": "diff_from_typical" + }, + { + "name": "time" + } + ], + "name": { + "name": "AppliesTo", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Rule.ts#L67-L72" + }, + { + "kind": "interface", + "name": { + "name": "BucketInfluencer", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as\nnewer data is analyzed.", + "name": "anomaly_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GrokProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "gsub", - "required": false, + "description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.", + "name": "bucket_span", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GsubProcessor", - "namespace": "ingest._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "join", - "required": false, + "description": "The field name of the influencer.", + "name": "influencer_field_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "JoinProcessor", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } }, { - "name": "lowercase", - "required": false, + "description": "The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the\ntime the bucket was processed.", + "name": "initial_anomaly_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "LowercaseProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "remove", - "required": false, + "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", + "name": "is_interim", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RemoveProcessor", - "namespace": "ingest._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "rename", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RenameProcessor", - "namespace": "ingest._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "script", - "required": false, + "description": "The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision\nof over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of\nthis.", + "name": "probability", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "double", "namespace": "_types" } } }, { - "name": "set", - "required": false, + "description": "Internal.", + "name": "raw_anomaly_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SetProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "sort", - "required": false, + "description": "Internal. This value is always set to `bucket_influencer`.", + "name": "result_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SortProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "split", - "required": false, + "description": "The start time of the bucket for which these results were calculated.", + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SplitProcessor", - "namespace": "ingest._types" + "name": "Time", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/Bucket.ts#L68-L112" + }, + { + "kind": "interface", + "name": { + "name": "BucketSummary", + "namespace": "ml._types" + }, + "properties": [ { - "name": "trim", - "required": false, + "description": "The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited\nscore for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as\nnew data is analyzed.", + "name": "anomaly_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TrimProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "uppercase", - "required": false, + "name": "bucket_influencers", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "UppercaseProcessor", - "namespace": "ingest._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "BucketInfluencer", + "namespace": "ml._types" + } } } }, { - "name": "urldecode", - "required": false, + "description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.", + "name": "bucket_span", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "UrlDecodeProcessor", - "namespace": "ingest._types" + "name": "Time", + "namespace": "_types" } } }, { - "name": "bytes", - "required": false, + "description": "The number of input data records processed in this bucket.", + "name": "event_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "BytesProcessor", - "namespace": "ingest._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "dissect", - "required": false, + "description": "The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the\ntime the bucket was processed.", + "name": "initial_anomaly_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DissectProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "set_security_user", - "required": false, + "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", + "name": "is_interim", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SetSecurityUserProcessor", - "namespace": "ingest._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "pipeline", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineProcessor", - "namespace": "ingest._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "drop", - "required": false, + "description": "The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results.", + "name": "processing_time_ms", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DropProcessor", - "namespace": "ingest._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "circle", - "required": false, + "description": "Internal. This value is always set to bucket.", + "name": "result_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CircleProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "inference", - "required": false, + "description": "The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket.", + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "InferenceProcessor", - "namespace": "ingest._types" + "name": "Time", + "namespace": "_types" } } } ], - "variants": { - "kind": "container" - } + "specLocation": "ml/_types/Bucket.ts#L24-L66" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "RemoveProcessor", - "namespace": "ingest._types" + "name": "CalendarEvent", + "namespace": "ml._types" }, "properties": [ { - "name": "field", - "required": true, + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Id", "namespace": "_types" } } }, { - "name": "ignore_missing", + "name": "event_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "RenameProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "field", + "description": "A description of the scheduled event.", + "name": "description", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ignore_missing", - "required": false, + "description": "The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.", + "name": "end_time", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "EpochMillis", + "namespace": "_types" } } }, { - "name": "target_field", + "description": "The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.", + "name": "start_time", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "EpochMillis", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/CalendarEvent.ts#L23-L33" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", + "codegenNames": [ + "name", + "definition" + ], + "kind": "type_alias", "name": { - "name": "SetProcessor", - "namespace": "ingest._types" + "name": "CategorizationAnalyzer", + "namespace": "ml._types" }, - "properties": [ - { - "name": "field", - "required": true, - "type": { + "specLocation": "ml/_types/Analysis.ts#L123-L124", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "override", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "CategorizationAnalyzerDefinition", + "namespace": "ml._types" } } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "user_defined_value" - } - } - ] + ], + "kind": "union_of" + } }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "SetSecurityUserProcessor", - "namespace": "ingest._types" + "name": "CategorizationAnalyzerDefinition", + "namespace": "ml._types" }, "properties": [ { - "name": "field", - "required": true, + "description": "One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters.", + "name": "char_filter", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CharFilter", + "namespace": "_types.analysis" + } } } }, { - "name": "properties", + "description": "One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization.", + "name": "filter", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TokenFilter", + "namespace": "_types.analysis" } } } + }, + { + "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.", + "name": "tokenizer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Tokenizer", + "namespace": "_types.analysis" + } + } } - ] + ], + "specLocation": "ml/_types/Analysis.ts#L126-L139" }, { "kind": "enum", "members": [ { - "name": "geo_shape" + "name": "ok" }, { - "name": "shape" + "name": "warn" } ], "name": { - "name": "ShapeType", - "namespace": "ingest._types" - } + "name": "CategorizationStatus", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Model.ts#L80-L83" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "SortProcessor", - "namespace": "ingest._types" + "name": "Category", + "namespace": "ml._types" }, "properties": [ { - "name": "field", + "description": "A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.", + "name": "category_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "ulong", "namespace": "_types" } } }, { - "name": "order", + "description": "A list of examples of actual values that matched the category.", + "name": "examples", "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.", + "name": "grok_pattern", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "target_field", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "SplitProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "field", + "description": "The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.", + "name": "max_matching_length", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "ulong", "namespace": "_types" } } }, { - "name": "ignore_missing", + "description": "If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.", + "name": "partition_field_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "preserve_trailing", + "description": "If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled.", + "name": "partition_field_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "separator", + "description": "A regular expression that is used to search for values that match the category.", + "name": "regex", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "target_field", + "description": "A space separated list of the common tokens that are matched in values of the category.", + "name": "terms", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close", + "name": "num_matches", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } + }, + { + "description": "A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close", + "name": "preferred_to_categories", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "name": "p", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "result_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "mlcategory", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "ml/_types/Category.ts#L23-L49" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "TrimProcessor", - "namespace": "ingest._types" + "name": "ChunkingConfig", + "namespace": "ml._types" }, "properties": [ { - "name": "field", + "description": "If the mode is `auto`, the chunk size is dynamically calculated; this is the recommended value when the datafeed does not use aggregations. If the mode is `manual`, chunking is applied according to the specified `time_span`; use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied.", + "name": "mode", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "ChunkingMode", + "namespace": "ml._types" } } }, { - "name": "ignore_missing", + "description": "The time span that each search will be querying. This setting is only applicable when the `mode` is set to `manual`.", + "name": "time_span", "required": false, + "serverDefault": "3h", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } + } + ], + "specLocation": "ml/_types/Datafeed.ts#L156-L166" + }, + { + "kind": "enum", + "members": [ + { + "name": "auto" }, { - "name": "target_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "name": "manual" + }, + { + "name": "off" } - ] + ], + "name": { + "name": "ChunkingMode", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Datafeed.ts#L150-L154" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" + "kind": "enum", + "members": [ + { + "name": "gt" + }, + { + "name": "gte" + }, + { + "name": "lt" + }, + { + "name": "lte" } + ], + "name": { + "name": "ConditionOperator", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Rule.ts#L74-L79" + }, + { + "description": "Custom metadata about the job", + "kind": "type_alias", + "name": { + "name": "CustomSettings", + "namespace": "ml._types" }, + "specLocation": "ml/_types/Settings.ts#L22-L27", + "type": { + "kind": "user_defined_value" + } + }, + { "kind": "interface", "name": { - "name": "UppercaseProcessor", - "namespace": "ingest._types" + "name": "DataCounts", + "namespace": "ml._types" }, "properties": [ { - "name": "field", + "name": "bucket_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "name": "ignore_missing", + "name": "earliest_record_timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "target_field", - "required": false, + "name": "empty_bucket_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "UrlDecodeProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "field", + "name": "input_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "name": "ignore_missing", - "required": false, + "name": "input_field_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "target_field", - "required": false, + "name": "input_record_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "UserAgentProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "name": "field", + "name": "invalid_date_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "name": "ignore_missing", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "options", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "UserAgentProperty", - "namespace": "ingest._types" - } + "name": "Id", + "namespace": "_types" } } }, { - "name": "regex_file", - "required": true, + "name": "last_data_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "target_field", - "required": true, + "name": "latest_empty_bucket_timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "NAME" - }, - { - "name": "MAJOR" - }, - { - "name": "MINOR" - }, - { - "name": "PATCH" - }, - { - "name": "OS" - }, - { - "name": "OS_NAME" - }, - { - "name": "OS_MAJOR" - }, - { - "name": "OS_MINOR" }, { - "name": "DEVICE" - }, - { - "name": "BUILD" - } - ], - "name": { - "name": "UserAgentProperty", - "namespace": "ingest._types" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ingest.delete_pipeline" - }, - "path": [ - { - "name": "id", - "required": true, + "name": "latest_record_timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "master_timeout", + "name": "latest_sparse_bucket_timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } }, { - "name": "timeout", + "name": "latest_bucket_timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ingest.delete_pipeline" - } - }, - { - "kind": "interface", - "name": { - "name": "GeoIpDownloadStatistics", - "namespace": "ingest.geo_ip_stats" - }, - "properties": [ + }, { - "description": "Total number of successful database downloads.", - "name": "successful_downloads", - "required": true, + "name": "log_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "Total number of failed database downloads.", - "name": "failed_downloads", + "name": "missing_field_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "Total milliseconds spent downloading databases.", - "name": "total_download_time", + "name": "out_of_order_timestamp_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "Current number of databases available for use.", - "name": "database_count", + "name": "processed_field_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "Total number of database updates skipped.", - "name": "skipped_updates", + "name": "processed_record_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "GeoIpNodeDatabaseName", - "namespace": "ingest.geo_ip_stats" - }, - "properties": [ + }, { - "description": "Name of the database.", - "name": "name", + "name": "sparse_bucket_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Job.ts#L124-L144" }, { - "description": "Downloaded databases for the node. The field key is the node ID.", "kind": "interface", "name": { - "name": "GeoIpNodeDatabases", - "namespace": "ingest.geo_ip_stats" + "name": "DataDescription", + "namespace": "ml._types" }, "properties": [ { - "description": "Downloaded databases for the node.", - "name": "databases", - "required": true, + "description": "Only JSON format is supported at this time.", + "name": "format", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GeoIpNodeDatabaseName", - "namespace": "ingest.geo_ip_stats" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/.", - "name": "files_in_temp", + "description": "The name of the field that contains the timestamp.", + "name": "time_field", "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ingest.geo_ip_stats" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "Download statistics for all GeoIP2 databases.", - "name": "stats", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoIpDownloadStatistics", - "namespace": "ingest.geo_ip_stats" - } - } - }, - { - "description": "Downloaded GeoIP2 databases for each node.", - "name": "nodes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "GeoIpNodeDatabases", - "namespace": "ingest.geo_ip_stats" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ingest.geo_ip_stats" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ingest.get_pipeline" - }, - "path": [ - { - "name": "id", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "master_timeout", + "description": "The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.", + "name": "time_format", "required": false, - "serverDefault": "30s", + "serverDefault": "epoch", "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "summary", + "name": "field_delimiter", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Pipeline", - "namespace": "ingest._types" + "namespace": "_builtins" } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ingest.get_pipeline" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ingest.processor_grok" - }, - "path": [], - "query": [] + "specLocation": "ml/_types/Job.ts#L146-L161" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "patterns", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - } - ] - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "ingest.processor_grok" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "description", - "required": false, - "type": { + "name": "Datafeed", + "namespace": "ml._types" + }, + "properties": [ + { + "aliases": [ + "aggs" + ], + "name": "aggregations", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "on_failure", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } + "namespace": "_builtins" } - } - }, - { - "name": "processors", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } - } - } - }, - { - "name": "version", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "AggregationContainer", + "namespace": "_types.aggregations" } } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ingest.put_pipeline" - }, - "path": [ + }, { - "name": "id", - "required": true, + "name": "chunking_config", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "ChunkingConfig", + "namespace": "ml._types" } } - } - ], - "query": [ + }, { - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "name": "datafeed_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Id", "namespace": "_types" } } }, { - "name": "timeout", + "name": "frequency", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Timestamp", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ingest.put_pipeline" - } - }, - { - "kind": "interface", - "name": { - "name": "Document", - "namespace": "ingest.simulate_pipeline" - }, - "properties": [ + }, { - "name": "_id", - "required": false, + "name": "indices", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "_index", + "name": "indexes", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "_source", - "required": true, - "type": { - "kind": "user_defined_value" - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DocumentSimulation", - "namespace": "ingest.simulate_pipeline" - }, - "properties": [ - { - "name": "_id", + "name": "job_id", "required": true, "type": { "kind": "instance_of", @@ -98392,565 +116805,466 @@ } }, { - "name": "_index", - "required": true, + "name": "max_empty_searches", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "_ingest", + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ingest", - "namespace": "ingest.simulate_pipeline" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "_parent", + "name": "query_delay", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Timestamp", + "namespace": "_types" } } }, { - "name": "_routing", + "name": "script_fields", "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "_source", - "required": true, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } } } }, { - "name": "_type", + "name": "scroll_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Type", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Ingest", - "namespace": "ingest.simulate_pipeline" - }, - "properties": [ + }, { - "name": "timestamp", + "name": "delayed_data_check_config", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" } } }, { - "name": "pipeline", + "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "name": "indices_options", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndicesOptions", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Datafeed.ts#L30-L47" }, { "kind": "interface", "name": { - "name": "PipelineSimulation", - "namespace": "ingest.simulate_pipeline" + "name": "DatafeedConfig", + "namespace": "ml._types" }, "properties": [ { - "name": "doc", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DocumentSimulation", - "namespace": "ingest.simulate_pipeline" - } - } - }, - { - "name": "processor_results", + "aliases": [ + "aggs" + ], + "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.", + "name": "aggregations", "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "PipelineSimulation", - "namespace": "ingest.simulate_pipeline" + "name": "AggregationContainer", + "namespace": "_types.aggregations" } } } }, { - "name": "tag", + "description": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.", + "name": "chunking_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ChunkingConfig", + "namespace": "ml._types" } } }, { - "name": "processor_type", + "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "name": "datafeed_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "status", + "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.", + "name": "delayed_data_check_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ActionStatusOptions", - "namespace": "watcher._types" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "docs", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Document", - "namespace": "ingest.simulate_pipeline" - } - } - } - }, - { - "name": "pipeline", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Pipeline", - "namespace": "ingest._types" - } + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ingest.simulate_pipeline" - }, - "path": [ + }, { - "name": "id", + "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.", + "name": "frequency", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Timestamp", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "verbose", + "name": "indexes", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "docs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PipelineSimulation", - "namespace": "ingest.simulate_pipeline" - } + }, + { + "description": "An array of index names. Wildcards are supported.", + "name": "indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ingest.simulate_pipeline" - } - }, - { - "kind": "interface", - "name": { - "name": "License", - "namespace": "license._types" - }, - "properties": [ + }, { - "name": "expiry_date_in_millis", - "required": true, + "description": "Specifies index expansion options that are used during search.", + "name": "indices_options", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "IndicesOptions", "namespace": "_types" } } }, { - "name": "issue_date_in_millis", - "required": true, + "name": "job_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Id", "namespace": "_types" } } }, { - "name": "issued_to", - "required": true, + "description": "If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.", + "name": "max_empty_searches", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "issuer", + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.", + "name": "query", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "max_nodes", + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.", + "name": "query_delay", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Timestamp", "namespace": "_types" } } }, { - "name": "max_resource_units", + "description": "Specifies runtime fields for the datafeed search.", + "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "RuntimeFields", + "namespace": "_types.mapping" } } }, { - "name": "signature", - "required": true, + "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.", + "name": "script_fields", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } } } }, { - "name": "start_date_in_millis", - "required": true, + "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default.", + "name": "scroll_size", + "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/Datafeed.ts#L49-L106" + }, + { + "kind": "interface", + "name": { + "name": "DatafeedRunningState", + "namespace": "ml._types" + }, + "properties": [ { - "name": "type", + "name": "real_time_configured", "required": true, "type": { "kind": "instance_of", "type": { - "name": "LicenseType", - "namespace": "license._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "uid", + "name": "real_time_running", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "active" - }, - { - "name": "valid" - }, - { - "name": "invalid" - }, - { - "name": "expired" - } ], - "name": { - "name": "LicenseStatus", - "namespace": "license._types" - } + "specLocation": "ml/_types/Datafeed.ts#L145-L148" }, { "kind": "enum", "members": [ { - "name": "missing" - }, - { - "name": "trial" - }, - { - "name": "basic" - }, - { - "name": "standard" - }, - { - "name": "dev" - }, - { - "name": "silver" - }, - { - "name": "gold" + "name": "started" }, { - "name": "platinum" + "name": "stopped" }, { - "name": "enterprise" - } - ], - "name": { - "name": "LicenseType", - "namespace": "license._types" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "starting" + }, + { + "name": "stopping" } - }, - "kind": "request", + ], "name": { - "name": "Request", - "namespace": "license.delete" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } + "name": "DatafeedState", + "namespace": "ml._types" }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.delete" - } + "specLocation": "ml/_types/Datafeed.ts#L120-L125" }, { "kind": "interface", "name": { - "name": "LicenseInformation", - "namespace": "license.get" + "name": "DatafeedStats", + "namespace": "ml._types" }, "properties": [ { - "name": "expiry_date", - "required": true, + "name": "assignment_explanation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "expiry_date_in_millis", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Id", "namespace": "_types" } } }, { - "name": "issue_date", - "required": true, + "name": "node", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "DiscoveryNode", + "namespace": "ml._types" } } }, { - "name": "issue_date_in_millis", + "name": "state", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "DatafeedState", + "namespace": "ml._types" } } }, { - "name": "issued_to", + "name": "timing_stats", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DatafeedTimingStats", + "namespace": "ml._types" } } }, { - "name": "issuer", - "required": true, + "name": "running_state", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DatafeedRunningState", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/Datafeed.ts#L127-L134" + }, + { + "kind": "interface", + "name": { + "name": "DatafeedTimingStats", + "namespace": "ml._types" + }, + "properties": [ { - "name": "max_nodes", + "name": "bucket_count", "required": true, "type": { "kind": "instance_of", @@ -98961,1052 +117275,608 @@ } }, { - "name": "max_resource_units", - "required": false, + "name": "exponential_average_search_time_per_hour_ms", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "status", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "LicenseStatus", - "namespace": "license._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "type", + "name": "search_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "LicenseType", - "namespace": "license._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "uid", + "name": "total_search_time_ms", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", + "name": "double", "namespace": "_types" } } }, { - "name": "start_date_in_millis", - "required": true, + "name": "average_search_time_per_bucket_ms", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "number", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/_types/Datafeed.ts#L136-L143" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "license.get" + "name": "DataframeAnalysis", + "namespace": "ml._types" }, - "path": [], - "query": [ + "properties": [ { - "name": "accept_enterprise", + "description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.", + "name": "alpha", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "local", - "required": false, + "description": "Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric.", + "name": "dependent_variable", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "license", - "required": true, + }, + { + "description": "Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.", + "name": "downsample_factor", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "LicenseInformation", - "namespace": "license.get" - } + "name": "double", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.get" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "license.get_basic_status" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "eligible_to_start_basic", - "required": true, + }, + { + "description": "Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.", + "name": "early_stopping_enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.get_basic_status" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "license.get_trial_status" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "eligible_to_start_trial", - "required": true, + }, + { + "description": "Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.", + "name": "eta", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "double", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.get_trial_status" - } - }, - { - "kind": "interface", - "name": { - "name": "Acknowledgement", - "namespace": "license.post" - }, - "properties": [ + }, { - "name": "license", - "required": true, + "description": "Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2.", + "name": "eta_growth_rate_per_tree", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } }, { - "name": "message", - "required": true, + "description": "Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.", + "name": "feature_bag_fraction", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "license", - "required": false, - "type": { + }, + { + "description": "Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields.", + "name": "feature_processors", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "License", - "namespace": "license._types" - } - } - }, - { - "name": "licenses", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "License", - "namespace": "license._types" - } + "name": "DataframeAnalysisFeatureProcessor", + "namespace": "ml._types" } } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "license.post" - }, - "path": [], - "query": [ + }, { - "name": "acknowledge", + "description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.", + "name": "gamma", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledge", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Acknowledgement", - "namespace": "license.post" - } - } - }, - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "license_status", - "required": true, + }, + { + "description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.", + "name": "lambda", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "LicenseStatus", - "namespace": "license._types" - } + "name": "double", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.post" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "license.post_start_basic" - }, - "path": [], - "query": [ + }, { - "name": "acknowledge", + "description": "Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.", + "name": "max_optimization_rounds_per_hyperparameter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledge", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "kind": "union_of" - } - } - }, - { - "name": "basic_was_started", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "error_message", - "required": true, + }, + { + "aliases": [ + "maximum_number_trees" + ], + "description": "Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.", + "name": "max_trees", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.post_start_basic" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "license.post_start_trial" - }, - "path": [], - "query": [ + }, { - "name": "acknowledge", + "description": "Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.", + "name": "num_top_feature_importance_values", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "type_query_string", + "description": "Defines the name of the prediction field in the results. Defaults to `_prediction`.", + "name": "prediction_field_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "error_message", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "trial_was_started", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "type", - "required": true, + }, + { + "description": "Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same).", + "name": "randomize_seed", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "LicenseType", - "namespace": "license._types" - } + "name": "double", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.post_start_trial" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, + }, + { + "description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.", + "name": "soft_tree_depth_limit", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "integer", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "logstash.pipeline_delete" - }, - "path": [ + }, { - "name": "stub_a", - "required": true, + "description": "Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01.", + "name": "soft_tree_depth_tolerance", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub_b", - "required": true, + "description": "Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.", + "name": "training_percent", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Percentage", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L133-L212" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { + "kind": "interface", + "name": { + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.", + "name": "includes", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "logstash.pipeline_delete" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { + }, + { + "description": "An array of strings that defines the fields that will be included in the analysis.", + "name": "excludes", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] - }, + } + ], + "shortcutProperty": "includes", + "specLocation": "ml/_types/DataframeAnalytics.ts#L237-L243" + }, + { "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "DataframeAnalysis", + "namespace": "ml._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "logstash.pipeline_get" + "name": "DataframeAnalysisClassification", + "namespace": "ml._types" }, - "path": [ + "properties": [ { - "name": "stub_a", - "required": true, + "name": "class_assignment_objective", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "stub_b", - "required": true, + "description": "Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories.", + "name": "num_top_classes", + "required": false, + "serverDefault": 2, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "logstash.pipeline_get" - } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L226-L235" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "logstash.pipeline_put" + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" }, - "path": [ + "properties": [ { - "name": "stub_a", - "required": true, + "description": "The configuration information necessary to perform classification.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html", + "name": "classification", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalysisClassification", + "namespace": "ml._types" } } - } - ], - "query": [ + }, { - "name": "stub_b", - "required": true, + "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html", + "name": "outlier_detection", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalysisOutlierDetection", + "namespace": "ml._types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + }, + { + "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-regression.html", + "name": "regression", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "DataframeAnalysisRegression", + "namespace": "ml._types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "logstash.pipeline_put" + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L83-L100", + "variants": { + "kind": "container" } }, { "kind": "interface", "name": { - "name": "Deprecation", - "namespace": "migration.deprecation_info" + "name": "DataframeAnalysisFeatureProcessor", + "namespace": "ml._types" }, "properties": [ { - "name": "details", - "required": true, + "description": "The configuration information necessary to perform frequency encoding.", + "name": "frequency_encoding", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalysisFeatureProcessorFrequencyEncoding", + "namespace": "ml._types" } } }, { - "description": "The level property describes the significance of the issue.", - "name": "level", - "required": true, + "description": "The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.", + "name": "multi_encoding", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DeprecationLevel", - "namespace": "migration.deprecation_info" + "name": "DataframeAnalysisFeatureProcessorMultiEncoding", + "namespace": "ml._types" } } }, { - "name": "message", - "required": true, + "description": "The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: .. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11.", + "name": "n_gram_encoding", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalysisFeatureProcessorNGramEncoding", + "namespace": "ml._types" } } }, { - "name": "url", - "required": true, + "description": "The configuration information necessary to perform one hot encoding.", + "name": "one_hot_encoding", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalysisFeatureProcessorOneHotEncoding", + "namespace": "ml._types" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "none" - }, - { - "name": "info" - }, - { - "description": "You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.", - "name": "warning" }, { - "description": "You cannot upgrade without fixing this problem.", - "name": "critical" + "description": "The configuration information necessary to perform target mean encoding.", + "name": "target_mean_encoding", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisFeatureProcessorTargetMeanEncoding", + "namespace": "ml._types" + } + } } ], - "name": { - "name": "DeprecationLevel", - "namespace": "migration.deprecation_info" + "specLocation": "ml/_types/DataframeAnalytics.ts#L245-L257", + "variants": { + "kind": "container" } }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "migration.deprecation_info" + "name": "DataframeAnalysisFeatureProcessorFrequencyEncoding", + "namespace": "ml._types" }, - "path": [ + "properties": [ { - "description": "Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.", - "name": "index", - "required": false, + "description": "The resulting feature name.", + "name": "feature_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Name", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "cluster_settings", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Deprecation", - "namespace": "migration.deprecation_info" - } - } - } - }, - { - "name": "index_settings", - "required": true, + }, + { + "name": "field", + "required": true, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Deprecation", - "namespace": "migration.deprecation_info" - } - } - } + "name": "Field", + "namespace": "_types" } - }, - { - "name": "node_settings", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Deprecation", - "namespace": "migration.deprecation_info" - } + } + }, + { + "description": "The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.", + "name": "frequency_map", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "ml_settings", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Deprecation", - "namespace": "migration.deprecation_info" - } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "migration.deprecation_info" - } + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L259-L266" }, { "kind": "interface", "name": { - "name": "AnalysisConfig", + "name": "DataframeAnalysisFeatureProcessorMultiEncoding", "namespace": "ml._types" }, "properties": [ { - "description": " The size of the interval that the analysis is aggregated into, typically between 5m and 1h. If the anomaly detection job uses a datafeed with aggregations, this value must be divisible by the interval of the date histogram aggregation.\n* @server_default 5m", - "name": "bucket_span", + "description": "The ordered array of custom processors to execute. Must be more than 1.", + "name": "processors", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "TimeSpan", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L268-L271" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalysisFeatureProcessorNGramEncoding", + "namespace": "ml._types" + }, + "properties": [ { - "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string it must refer to a built-in analyzer or one added by another plugin.", - "name": "categorization_analyzer", + "description": "The feature name prefix. Defaults to ngram__.", + "name": "feature_prefix", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CategorizationAnalyzer", - "namespace": "ml._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", - "name": "categorization_field_name", - "required": false, + "description": "The name of the text field to encode.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { @@ -100016,1374 +117886,1642 @@ } }, { - "description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.", - "name": "categorization_filters", + "description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.", + "name": "length", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.", - "name": "detectors", + "description": "Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.", + "name": "n_grams", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Detector", - "namespace": "ml._types" - } - } - } - }, - { - "description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.", - "name": "influencers", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } } }, { - "description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is only applicable when you send data by using the post data API.", - "name": "latency", + "description": "Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.", + "name": "start", "required": false, - "serverDefault": "0", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "integer", "namespace": "_types" } } }, { - "description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.", - "name": "multivariate_by_fields", + "name": "custom", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L273-L285" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalysisFeatureProcessorOneHotEncoding", + "namespace": "ml._types" + }, + "properties": [ { - "description": "Settings related to how categorization interacts with partition fields.", - "name": "per_partition_categorization", - "required": false, + "description": "The name of the field to encode.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "PerPartitionCategorization", - "namespace": "ml._types" + "name": "Field", + "namespace": "_types" } } }, { - "description": " If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.", - "name": "summary_count_field_name", - "required": false, + "description": "The one hot map mapping the field value with the column name.", + "name": "hot_map", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L287-L292" }, { "kind": "interface", "name": { - "name": "AnalysisLimits", + "name": "DataframeAnalysisFeatureProcessorTargetMeanEncoding", "namespace": "ml._types" }, "properties": [ { - "description": "The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization.", - "name": "categorization_examples_limit", - "required": false, - "serverDefault": "4", + "description": "The default value if field value is not found in the target_map.", + "name": "default_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value.", - "name": "model_memory_limit", - "required": false, - "serverDefault": "1024mb", + "description": "The resulting feature name.", + "name": "feature_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "AnalysisMemoryLimit", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", - "name": "model_memory_limit", + "description": "The name of the field to encode.", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The field value to target mean transition map.", + "name": "target_map", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } } - ] + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L294-L303" }, { "kind": "interface", "name": { - "name": "Anomaly", + "name": "DataframeAnalysisOutlierDetection", "namespace": "ml._types" }, "properties": [ { - "name": "actual", + "description": "Specifies whether the feature influence calculation is enabled.", + "name": "compute_feature_influence", "required": false, + "serverDefault": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "bucket_span", - "required": true, + "description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1.", + "name": "feature_influence_threshold", + "required": false, + "serverDefault": 0.1, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "double", "namespace": "_types" } } }, { - "name": "by_field_name", + "description": "The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.", + "name": "method", "required": false, + "serverDefault": "ensemble", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "by_field_value", + "description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.", + "name": "n_neighbors", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "causes", + "description": "The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.", + "name": "outlier_fraction", "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AnomalyCause", - "namespace": "ml._types" - } - } - } - }, - { - "name": "detector_index", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "field_name", + "description": "If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`.", + "name": "standardization_enabled", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L102-L131" + }, + { + "inherits": { + "type": { + "name": "DataframeAnalysis", + "namespace": "ml._types" + } + }, + "kind": "interface", + "name": { + "name": "DataframeAnalysisRegression", + "namespace": "ml._types" + }, + "properties": [ { - "name": "function", + "description": "The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss).", + "name": "loss_function", "required": false, + "serverDefault": "mse", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "function_description", + "description": "A positive number that is used as a parameter to the `loss_function`.", + "name": "loss_function_parameter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L214-L224" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalytics", + "namespace": "ml._types" + }, + "properties": [ { - "name": "influencers", + "description": "An object containing information about the analysis job.", + "name": "analysis_stats", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Influence", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsStatsContainer", + "namespace": "ml._types" } } }, { - "name": "initial_record_score", - "required": true, + "description": "For running jobs only, contains messages relating to the selection of a node to run the job.", + "name": "assignment_explanation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "is_interim", + "description": "An object that provides counts for the quantity of documents skipped, used in training, or available for testing.", + "name": "data_counts", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DataframeAnalyticsStatsDataCounts", + "namespace": "ml._types" } } }, { - "name": "job_id", + "description": "The unique identifier of the data frame analytics job.", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "over_field_name", - "required": false, + "description": "An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.", + "name": "memory_usage", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalyticsStatsMemoryUsage", + "namespace": "ml._types" } } }, { - "name": "over_field_value", + "description": "Contains properties for the node that runs the job. This information is available only for running jobs.", + "name": "node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodeAttributes", + "namespace": "_types" } } }, { - "name": "partition_field_name", - "required": false, + "description": "The progress report of the data frame analytics job by phase.", + "name": "progress", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsStatsProgress", + "namespace": "ml._types" + } } } }, { - "name": "partition_field_value", - "required": false, + "description": "The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.", + "name": "state", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeState", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L319-L336" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsDestination", + "namespace": "ml._types" + }, + "properties": [ { - "name": "probability", + "description": "Defines the destination index to store the results of the data frame analytics job.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "record_score", - "required": true, + "description": "Defines the name of the field in which to store the results of the analysis. Defaults to `ml`.", + "name": "results_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L76-L81" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsFieldSelection", + "namespace": "ml._types" + }, + "properties": [ { - "name": "result_type", + "description": "Whether the field is selected to be included in the analysis.", + "name": "is_included", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "timestamp", + "description": "Whether the field is required.", + "name": "is_required", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "typical", + "description": "The feature type of this field for the analysis. May be categorical or numerical.", + "name": "feature_type", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "AnomalyCause", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "actual", + "description": "The mapping types of the field.", + "name": "mapping_types", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "by_field_name", + "description": "The field name.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Field", "namespace": "_types" } } }, { - "name": "by_field_value", + "description": "The reason a field is not selected to be included in the analysis.", + "name": "reason", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L54-L67" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsMemoryEstimation", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics.", + "name": "expected_memory_with_disk", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "correlated_by_field_value", + "description": "Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk).", + "name": "expected_memory_without_disk", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L69-L74" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" + }, + "properties": [ { - "name": "field_name", + "description": "Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Indices", "namespace": "_types" } } }, { - "name": "function", - "required": true, + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "name": "query", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "function_description", - "required": true, + "description": "Definitions of runtime fields that will become part of the mapping of the destination index.", + "name": "runtime_mappings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "RuntimeFields", + "namespace": "_types.mapping" } } }, { - "name": "influencers", - "required": true, + "description": "Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.", + "name": "_source", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Influence", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L38-L52" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsStatsContainer", + "namespace": "ml._types" + }, + "properties": [ { - "name": "over_field_name", - "required": true, + "description": "An object containing information about the classification analysis job.", + "name": "classification_stats", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "DataframeAnalyticsStatsHyperparameters", + "namespace": "ml._types" } } }, { - "name": "over_field_value", - "required": true, + "description": "An object containing information about the outlier detection job.", + "name": "outlier_detection_stats", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalyticsStatsOutlierDetection", + "namespace": "ml._types" } } }, { - "name": "partition_field_name", - "required": true, + "description": "An object containing information about the regression analysis.", + "name": "regression_stats", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalyticsStatsHyperparameters", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L365-L373", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsStatsDataCounts", + "namespace": "ml._types" + }, + "properties": [ { - "name": "partition_field_value", + "description": "The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.", + "name": "skipped_docs_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "probability", + "description": "The number of documents that are not used for training the model and can be used for testing.", + "name": "test_docs_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "typical", + "description": "The number of documents that are used for training the model.", + "name": "training_docs_count", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "actual" - }, - { - "name": "typical" - }, - { - "name": "diff_from_typical" - }, - { - "name": "time" - } ], - "name": { - "name": "AppliesTo", - "namespace": "ml._types" - } + "specLocation": "ml/_types/DataframeAnalytics.ts#L356-L363" }, { "kind": "interface", "name": { - "name": "BucketInfluencer", + "name": "DataframeAnalyticsStatsHyperparameters", "namespace": "ml._types" }, "properties": [ { - "description": "The length of the bucket in seconds. This value matches the bucket_span that is specified in the job.", - "name": "bucket_span", + "name": "hyperparameters", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Hyperparameters", + "namespace": "ml._types" } } }, { - "description": "A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors. Unlike initial_influencer_score, this value will be updated by a re-normalization process as new data is analyzed.", - "name": "influencer_score", + "description": "The number of iterations on the analysis.", + "name": "iteration", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "description": "The field name of the influencer.", - "name": "influencer_field_name", + "name": "timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "DateString", "namespace": "_types" } } }, { - "description": "The entity that influenced, contributed to, or was to blame for the anomaly.", - "name": "influencer_field_value", + "name": "timing_stats", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TimingStats", + "namespace": "ml._types" } } }, { - "description": "A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed.", - "name": "initial_influencer_score", + "name": "validation_loss", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "ValidationLoss", + "namespace": "ml._types" + } + } + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L375-L382" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsStatsMemoryUsage", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.", + "name": "memory_reestimate_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } }, { - "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", - "name": "is_interim", + "description": "The number of bytes used at the highest peak of memory usage.", + "name": "peak_usage_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", + "description": "The memory usage status.", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so the influencer_score is provided as a human-readable and friendly interpretation of this.", - "name": "probability", - "required": true, + "description": "The timestamp when memory usage was calculated.", + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "DateString", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L345-L354" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsStatsOutlierDetection", + "namespace": "ml._types" + }, + "properties": [ { - "description": "Internal. This value is always set to influencer.", - "name": "result_type", + "name": "parameters", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "OutlierDetectionParameters", + "namespace": "ml._types" } } }, { - "description": "The start time of the bucket for which these results were calculated.", "name": "timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "DateString", "namespace": "_types" } } }, { - "name": "foo", - "required": false, + "name": "timing_stats", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TimingStats", + "namespace": "ml._types" } } } - ] + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L384-L388" }, { "kind": "interface", "name": { - "name": "BucketSummary", + "name": "DataframeAnalyticsStatsProgress", "namespace": "ml._types" }, "properties": [ { - "name": "anomaly_score", + "description": "Defines the phase of the data frame analytics job.", + "name": "phase", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "bucket_influencers", + "description": "The progress that the data frame analytics job has made expressed in percentage.", + "name": "progress_percent", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "BucketInfluencer", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L338-L343" + }, + { + "kind": "interface", + "name": { + "name": "DataframeAnalyticsSummary", + "namespace": "ml._types" + }, + "properties": [ { - "name": "bucket_span", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Id", "namespace": "_types" } } }, { - "name": "event_count", + "name": "source", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" } } }, { - "name": "initial_anomaly_score", + "name": "dest", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DataframeAnalyticsDestination", + "namespace": "ml._types" } } }, { - "name": "is_interim", + "name": "analysis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" } } }, { - "name": "job_id", - "required": true, + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "partition_scores", + "name": "model_memory_limit", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PartitionScore", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "processing_time_ms", - "required": true, + "name": "max_num_threads", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "result_type", - "required": true, + "name": "analyzed_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" } } }, { - "name": "timestamp", - "required": true, + "name": "allow_lazy_start", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "CalendarEvent", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "calendar_id", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } }, { - "name": "event_id", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "VersionString", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L305-L317" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationClassification", + "namespace": "ml._types" + }, + "properties": [ { - "description": "A description of the scheduled event.", - "name": "description", + "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", + "name": "actual_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "description": "The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.", - "name": "end_time", - "required": true, + "description": "The field in the index which contains the predicted value, in other words the results of the classification analysis.", + "name": "predicted_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } }, { - "description": "The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.", - "name": "start_time", - "required": true, + "description": "The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings.", + "name": "top_classes_field", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EpochMillis", + "name": "Field", "namespace": "_types" } } + }, + { + "description": "Specifies the metrics that are used for the evaluation.", + "name": "metrics", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationClassificationMetrics", + "namespace": "ml._types" + } + } } - ] + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L35-L44" }, { + "inherits": { + "type": { + "name": "DataframeEvaluationMetrics", + "namespace": "ml._types" + } + }, "kind": "interface", "name": { - "name": "CategorizationAnalyzer", + "name": "DataframeEvaluationClassificationMetrics", "namespace": "ml._types" }, "properties": [ { - "name": "char_filter", + "description": "Accuracy of predictions (per-class and overall).", + "name": "accuracy", "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CharFilter", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" + "kind": "user_defined_value" } } }, { - "description": "One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters.", - "name": "filter", + "description": "Multiclass confusion matrix.", + "name": "multiclass_confusion_matrix", "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TokenFilter", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" + "kind": "user_defined_value" + } + } + } + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L73-L78" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationClassificationMetricsAucRoc", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes.", + "name": "class_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "description": "One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization.", - "name": "tokenizer", + "description": "Whether or not the curve should be returned in addition to the score. Default value is false.", + "name": "include_curve", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Tokenizer", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - ] + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L85-L90" }, { - "kind": "enum", - "members": [ + "kind": "interface", + "name": { + "name": "DataframeEvaluationContainer", + "namespace": "ml._types" + }, + "properties": [ { - "name": "ok" + "description": "Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs.", + "name": "classification", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationClassification", + "namespace": "ml._types" + } + } }, { - "name": "warn" + "description": "Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier.", + "name": "outlier_detection", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationOutlierDetection", + "namespace": "ml._types" + } + } + }, + { + "description": "Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values.", + "name": "regression", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationRegression", + "namespace": "ml._types" + } + } } ], - "name": { - "name": "CategorizationStatus", - "namespace": "ml._types" + "specLocation": "ml/_types/DataframeEvaluation.ts#L25-L33", + "variants": { + "kind": "container" } }, { "kind": "interface", "name": { - "name": "Category", + "name": "DataframeEvaluationMetrics", "namespace": "ml._types" }, "properties": [ { - "description": "A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.", - "name": "category_id", - "required": true, + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive.", + "name": "auc_roc", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ulong", - "namespace": "_types" + "name": "DataframeEvaluationClassificationMetricsAucRoc", + "namespace": "ml._types" } } - }, - { - "description": "A list of examples of actual values that matched the category.", - "name": "examples", - "required": true, + }, + { + "description": "Precision of predictions (per-class and average).", + "name": "precision", + "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.", - "name": "grok_pattern", + "description": "Recall of predictions (per-class and average).", + "name": "recall", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L64-L71" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationOutlierDetection", + "namespace": "ml._types" + }, + "properties": [ { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", + "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", + "name": "actual_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } }, { - "description": "The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.", - "name": "max_matching_length", + "description": "The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.", + "name": "predicted_probability_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ulong", + "name": "Field", "namespace": "_types" } } }, { - "description": "If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.", - "name": "partition_field_name", + "description": "Specifies the metrics that are used for the evaluation.", + "name": "metrics", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeEvaluationOutlierDetectionMetrics", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L46-L53" + }, + { + "inherits": { + "type": { + "name": "DataframeEvaluationMetrics", + "namespace": "ml._types" + } + }, + "kind": "interface", + "name": { + "name": "DataframeEvaluationOutlierDetectionMetrics", + "namespace": "ml._types" + }, + "properties": [ { - "description": "If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled.", - "name": "partition_field_value", + "description": "Accuracy of predictions (per-class and overall).", + "name": "confusion_matrix", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L80-L83" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationRegression", + "namespace": "ml._types" + }, + "properties": [ { - "description": "A regular expression that is used to search for values that match the category.", - "name": "regex", + "description": "The field of the index which contains the ground truth. The data type of this field must be numerical.", + "name": "actual_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "description": "A space separated list of the common tokens that are matched in values of the category.", - "name": "terms", + "description": "The field in the index that contains the predicted value, in other words the results of the regression analysis.", + "name": "predicted_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "description": "The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close", - "name": "num_matches", + "description": "Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.", + "name": "metrics", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DataframeEvaluationRegressionMetrics", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L55-L62" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationRegressionMetrics", + "namespace": "ml._types" + }, + "properties": [ { - "description": "A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close", - "name": "preferred_to_categories", + "description": "Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article.", + "docUrl": "https://en.wikipedia.org/wiki/Mean_squared_error", + "name": "mse", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "name": "p", + "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value.", + "name": "msle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeEvaluationRegressionMetricsMsle", + "namespace": "ml._types" } } }, { - "name": "result_type", - "required": true, + "description": "Pseudo Huber loss function.", + "docUrl": "https://en.wikipedia.org/wiki/Huber_loss#Pseudo-Huber_loss_function", + "name": "huber", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataframeEvaluationRegressionMetricsHuber", + "namespace": "ml._types" } } }, { - "name": "mlcategory", - "required": true, + "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", + "docUrl": "https://en.wikipedia.org/wiki/Coefficient_of_determination", + "name": "r_squared", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } } - ] + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L92-L110" }, { "kind": "interface", "name": { - "name": "ChunkingConfig", + "name": "DataframeEvaluationRegressionMetricsHuber", "namespace": "ml._types" }, "properties": [ { - "description": "If the mode is `auto`, the chunk size is dynamically calculated; this is the recommended value when the datafeed does not use aggregations. If the mode is `manual`, chunking is applied according to the specified `time_span`; use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied.", - "name": "mode", - "required": true, + "description": "Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0.", + "name": "delta", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ChunkingMode", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L117-L120" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationRegressionMetricsMsle", + "namespace": "ml._types" + }, + "properties": [ { - "description": "The time span that each search will be querying. This setting is only applicable when the `mode` is set to `manual`.", - "name": "time_span", + "description": "Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1.", + "name": "offset", "required": false, - "serverDefault": "3h", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "double", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/DataframeEvaluation.ts#L112-L115" }, { "kind": "enum", "members": [ { - "name": "auto" - }, - { - "name": "manual" + "name": "started" }, { - "name": "off" - } - ], - "name": { - "name": "ChunkingMode", - "namespace": "ml._types" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "gt" + "name": "stopped" }, { - "name": "gte" + "name": "starting" }, { - "name": "lt" + "name": "stopping" }, { - "name": "lte" + "name": "failed" } ], "name": { - "name": "ConditionOperator", + "name": "DataframeState", "namespace": "ml._types" - } + }, + "specLocation": "ml/_types/Dataframe.ts#L20-L26" }, { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + "kind": "interface", + "name": { + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" + }, + "properties": [ { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "user_defined_value" + "description": "The window of time that is searched for late data. This window of time ends with the latest finalized bucket. It defaults to null, which causes an appropriate check_window to be calculated when the real-time datafeed runs. In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`.", + "name": "check_window", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } - ], + } + }, + { + "description": "Specifies whether the datafeed periodically checks for delayed data.", + "name": "enabled", + "required": true, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } ], + "specLocation": "ml/_types/Datafeed.ts#L108-L117" + }, + { "kind": "interface", "name": { - "name": "CustomSettings", + "name": "DetectionRule", "namespace": "ml._types" }, "properties": [ { - "name": "custom_urls", + "description": "The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.", + "name": "actions", "required": false, + "serverDefault": [ + "skip_result" + ], "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "UrlConfig", - "namespace": "xpack.usage" + "name": "RuleAction", + "namespace": "ml._types" } } } }, { - "name": "created_by", + "description": "An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND.", + "name": "conditions", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RuleCondition", + "namespace": "ml._types" + } } } }, { - "name": "job_tags", + "description": "A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`.", + "name": "scope", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } }, "kind": "dictionary_of", @@ -101391,244 +119529,267 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "FilterRef", + "namespace": "ml._types" } } } } - ] + ], + "specLocation": "ml/_types/Rule.ts#L25-L39" }, { "kind": "interface", "name": { - "name": "DataCounts", + "name": "Detector", "namespace": "ml._types" }, "properties": [ { - "name": "bucket_count", - "required": true, + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.", + "name": "by_field_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "earliest_record_timestamp", + "description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.", + "name": "custom_rules", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DetectionRule", + "namespace": "ml._types" + } } } }, { - "name": "empty_bucket_count", - "required": true, + "description": "A description of the detector.", + "name": "detector_description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "input_bytes", - "required": true, + "description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.", + "name": "detector_index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "input_field_count", - "required": true, + "description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.", + "name": "exclude_frequent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ExcludeFrequent", + "namespace": "ml._types" } } }, { - "name": "input_record_count", - "required": true, + "description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.", + "name": "field_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "invalid_date_count", + "description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.", + "name": "function", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "job_id", - "required": true, + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.", + "name": "over_field_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } }, { - "name": "last_data_time", + "description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.", + "name": "partition_field_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "latest_empty_bucket_timestamp", + "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", + "name": "use_null", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/_types/Detector.ts#L25-L67" + }, + { + "attachedBehaviors": [ + "OverloadOf" + ], + "behaviors": [ { - "name": "latest_record_timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Detector", + "namespace": "ml._types" + } } + ], + "type": { + "name": "OverloadOf", + "namespace": "_spec_utils" } - }, + } + ], + "kind": "interface", + "name": { + "name": "DetectorRead", + "namespace": "ml._types" + }, + "properties": [ { - "name": "latest_sparse_bucket_timestamp", + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.", + "name": "by_field_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "latest_bucket_timestamp", + "description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.", + "name": "custom_rules", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DetectionRule", + "namespace": "ml._types" + } } } }, { - "name": "missing_field_count", - "required": true, + "description": "A description of the detector.", + "name": "detector_description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "out_of_order_timestamp_count", - "required": true, + "description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.", + "name": "detector_index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "processed_field_count", - "required": true, + "description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.", + "name": "exclude_frequent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ExcludeFrequent", + "namespace": "ml._types" } } }, { - "name": "processed_record_count", - "required": true, + "description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.", + "name": "field_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "sparse_bucket_count", + "description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.", + "name": "function", "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataDescription", - "namespace": "ml._types" - }, - "properties": [ - { - "description": "Only JSON format is supported at this time.", - "name": "format", - "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "The name of the field that contains the timestamp.", - "name": "time_field", - "required": true, + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.", + "name": "over_field_name", + "required": false, "type": { "kind": "instance_of", "type": { @@ -101638,95 +119799,75 @@ } }, { - "description": "The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.", - "name": "time_format", + "description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.", + "name": "partition_field_name", "required": false, - "serverDefault": "epoch", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "name": "field_delimiter", + "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", + "name": "use_null", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/_types/Detector.ts#L69-L80" }, { "kind": "interface", "name": { - "name": "Datafeed", + "name": "DiscoveryNode", "namespace": "ml._types" }, "properties": [ { - "name": "aggregations", - "required": false, + "name": "attributes", + "required": true, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, - { - "name": "aggs", - "required": false, - "type": { - "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" + "namespace": "_builtins" } } } }, { - "name": "chunking_config", - "required": false, + "name": "ephemeral_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ChunkingConfig", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "datafeed_id", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -101737,378 +119878,321 @@ } }, { - "name": "frequency", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Timestamp", + "name": "Name", "namespace": "_types" } } }, { - "name": "indices", + "name": "transport_address", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "TransportAddress", + "namespace": "_types" } } + } + ], + "specLocation": "ml/_types/DiscoveryNode.ts#L24-L30" + }, + { + "kind": "enum", + "members": [ + { + "name": "all" }, { - "name": "indexes", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } + "name": "none" }, { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } + "name": "by" }, { - "name": "max_empty_searches", + "name": "over" + } + ], + "name": { + "name": "ExcludeFrequent", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Detector.ts#L82-L87" + }, + { + "kind": "interface", + "name": { + "name": "Filter", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "A description of the filter.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "query", + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "query_delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Timestamp", + "name": "Id", "namespace": "_types" } } }, { - "name": "script_fields", - "required": false, + "description": "An array of strings which is the filter item list.", + "name": "items", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ScriptField", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - }, + } + ], + "specLocation": "ml/_types/Filter.ts#L22-L29" + }, + { + "kind": "interface", + "name": { + "name": "FilterRef", + "namespace": "ml._types" + }, + "properties": [ { - "name": "scroll_size", - "required": false, + "description": "The identifier for the filter.", + "name": "filter_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "name": "delayed_data_check_config", - "required": true, + "description": "If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter.", + "name": "filter_type", + "required": false, + "serverDefault": "include", "type": { "kind": "instance_of", "type": { - "name": "DelayedDataCheckConfig", + "name": "FilterType", "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/Filter.ts#L31-L41" + }, + { + "kind": "enum", + "members": [ { - "name": "runtime_mappings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } + "name": "include" }, { - "name": "indices_options", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DatafeedIndicesOptions", - "namespace": "ml._types" - } - } + "name": "exclude" } - ] + ], + "name": { + "name": "FilterType", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Filter.ts#L43-L46" }, { "kind": "interface", "name": { - "name": "DatafeedConfig", + "name": "Hyperparameter", "namespace": "ml._types" }, "properties": [ { - "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.", - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, - { - "name": "aggs", + "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/7.12/dfa-regression.html#dfa-regression-lossfunction", + "name": "absolute_importance", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } }, { - "description": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.", - "name": "chunking_config", - "required": false, + "description": "Name of the hyperparameter.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ChunkingConfig", - "namespace": "ml._types" + "name": "Name", + "namespace": "_types" } } }, { - "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", - "name": "datafeed_id", + "description": "A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", + "name": "relative_importance", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "double", "namespace": "_types" } } }, { - "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.", - "name": "delayed_data_check_config", - "required": false, + "description": "Indicates if the hyperparameter is specified by the user (true) or optimized (false).", + "name": "supplied", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DelayedDataCheckConfig", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.", - "name": "frequency", - "required": false, + "description": "The value of the hyperparameter, either optimized or specified by the user.", + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Timestamp", + "name": "double", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/TrainedModel.ts#L102-L116" + }, + { + "kind": "interface", + "name": { + "name": "Hyperparameters", + "namespace": "ml._types" + }, + "properties": [ { - "name": "indexes", + "name": "alpha", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "double", "namespace": "_types" } } }, { - "description": "An array of index names. Wildcards are supported.", - "name": "indices", + "name": "lambda", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "double", "namespace": "_types" } } }, { - "description": "Specifies index expansion options that are used during search.", - "name": "indices_options", + "name": "gamma", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedIndicesOptions", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "job_id", + "name": "eta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "double", "namespace": "_types" } } }, { - "description": "If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.", - "name": "max_empty_searches", + "name": "eta_growth_rate_per_tree", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.", - "name": "query", + "name": "feature_bag_fraction", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } }, { - "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.", - "name": "query_delay", + "name": "downsample_factor", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Timestamp", + "name": "double", "namespace": "_types" } } }, { - "description": "Specifies runtime fields for the datafeed search.", - "name": "runtime_mappings", + "name": "max_attempts_to_add_tree", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } - }, - { - "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.", - "name": "script_fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } } }, { - "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default.", - "name": "scroll_size", + "name": "max_optimization_rounds_per_hyperparameter", "required": false, - "serverDefault": "1000", "type": { "kind": "instance_of", "type": { @@ -102116,408 +120200,409 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DatafeedIndicesOptions", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "allow_no_indices", + "name": "max_trees", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "expand_wildcards", + "name": "num_folds", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "integer", "namespace": "_types" } } }, { - "name": "ignore_unavailable", + "name": "num_splits_per_feature", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "ignore_throttled", + "name": "soft_tree_depth_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DatafeedRunningState", - "namespace": "ml._types" - }, - "properties": [ - { - "name": "real_time_configured", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "real_time_running", - "required": true, + "name": "soft_tree_depth_tolerance", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L390-L405" }, { "kind": "enum", "members": [ { - "name": "started" + "description": "Includes the model definition.", + "name": "definition" }, { - "name": "stopped" + "description": "Includes the baseline for feature importance values.", + "name": "feature_importance_baseline" }, { - "name": "starting" + "description": "Includes the information about hyperparameters used to train the model.\nThis information consists of the value, the absolute and relative\nimportance of the hyperparameter as well as an indicator of whether it was\nspecified by the user or tuned during hyperparameter optimization.", + "name": "hyperparameters" }, { - "name": "stopping" + "description": "Includes the total feature importance for the training data set. The\nbaseline and total feature importance values are returned in the metadata\nfield in the response body.", + "name": "total_feature_importance" } ], "name": { - "name": "DatafeedState", + "name": "Include", "namespace": "ml._types" - } + }, + "specLocation": "ml/_types/Include.ts#L20-L42" }, { "kind": "interface", "name": { - "name": "DatafeedStats", + "name": "Influence", "namespace": "ml._types" }, "properties": [ { - "name": "assignment_explanation", - "required": false, + "name": "influencer_field_name", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "datafeed_id", + "name": "influencer_field_values", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "ml/_types/Anomaly.ts#L66-L69" + }, + { + "kind": "interface", + "name": { + "name": "Influencer", + "namespace": "ml._types" + }, + "properties": [ + { + "description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.", + "name": "bucket_span", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } }, { - "name": "node", - "required": false, + "description": "A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated\nacross detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new\ndata is analyzed.", + "name": "influencer_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DiscoveryNode", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "state", + "description": "The field name of the influencer.", + "name": "influencer_field_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DatafeedState", - "namespace": "ml._types" + "name": "Field", + "namespace": "_types" } } }, { - "name": "timing_stats", + "description": "The entity that influenced, contributed to, or was to blame for the anomaly.", + "name": "influencer_field_value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DatafeedTimingStats", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "running_state", - "required": false, + "description": "A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.\nThis is the initial value that was calculated at the time the bucket was processed.", + "name": "initial_influencer_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DatafeedRunningState", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DatafeedTimingStats", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "bucket_count", + "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", + "name": "is_interim", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "exponential_average_search_time_per_hour_ms", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } }, { - "name": "job_id", + "description": "The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high\nprecision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly\ninterpretation of this value.", + "name": "probability", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "double", "namespace": "_types" } } }, { - "name": "search_count", + "description": "Internal. This value is always set to `influencer`.", + "name": "result_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total_search_time_ms", + "description": "The start time of the bucket for which these results were calculated.", + "name": "timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Time", "namespace": "_types" } } }, { - "name": "average_search_time_per_bucket_ms", + "description": "Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s\nanalyzing `user_name` as an influencer, a field `user_name` is added to the result document. This\ninformation enables you to filter the anomaly results more easily.", + "name": "foo", "required": false, "type": { "kind": "instance_of", "type": { - "name": "number", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/_types/Influencer.ts#L24-L76" }, { "kind": "interface", "name": { - "name": "DataframeAnalysis", + "name": "Job", "namespace": "ml._types" }, "properties": [ { - "name": "dependent_variable", + "name": "allow_lazy_open", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "prediction_field_name", - "required": false, + "name": "analysis_config", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "AnalysisConfig", + "namespace": "ml._types" } } }, { - "name": "alpha", + "name": "analysis_limits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "AnalysisLimits", + "namespace": "ml._types" } } }, { - "name": "lambda", + "name": "background_persist_interval", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Time", "namespace": "_types" } } }, { - "name": "gamma", + "name": "blocked", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "JobBlocked", + "namespace": "ml._types" } } }, { - "name": "eta", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "eta_growth_rate_per_tree", + "name": "custom_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "CustomSettings", + "namespace": "ml._types" } } }, { - "name": "feature_bag_fraction", + "name": "daily_model_snapshot_retention_after_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "aliases": [ - "maximum_number_trees" - ], - "name": "max_trees", - "required": false, + "name": "data_description", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DataDescription", + "namespace": "ml._types" } } }, { - "name": "soft_tree_depth_limit", + "name": "datafeed_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Datafeed", + "namespace": "ml._types" } } }, { - "name": "soft_tree_depth_tolerance", + "name": "deleting", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "downsample_factor", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_optimization_rounds_per_hyperparameter", + "name": "finished_time", "required": false, "type": { "kind": "instance_of", @@ -102528,606 +120613,494 @@ } }, { - "name": "early_stopping_enabled", + "name": "groups", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "num_top_feature_importance_values", - "required": false, + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "name": "feature_processors", + "name": "job_type", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisFeatureProcessor", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "randomize_seed", + "name": "job_version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "VersionString", "namespace": "_types" } } }, { - "name": "training_percent", + "name": "model_plot_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Percentage", - "namespace": "_types" + "name": "ModelPlotConfig", + "namespace": "ml._types" } } - } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" - }, - "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { + }, + { + "name": "model_snapshot_id", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisAnalyzedFieldsIncludeExclude", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalysisAnalyzedFieldsIncludeExclude", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.", - "name": "includes", + "name": "model_snapshot_retention_days", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "description": "An array of strings that defines the fields that will be included in the analysis.", - "name": "excludes", - "required": true, + "name": "renormalization_window_days", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "DataframeAnalysis", - "namespace": "ml._types" - } - }, - "kind": "interface", - "name": { - "name": "DataframeAnalysisClassification", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "class_assignment_objective", - "required": false, + "name": "results_index_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "num_top_classes", + "name": "results_retention_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Job.ts#L46-L70" }, { "kind": "interface", "name": { - "name": "DataframeAnalysisContainer", + "name": "JobBlocked", "namespace": "ml._types" }, "properties": [ { - "description": "The configuration information necessary to perform outlier detection", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html", - "name": "outlier_detection", - "required": false, + "name": "reason", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisOutlierDetection", + "name": "JobBlockedReason", "namespace": "ml._types" } } }, { - "description": "The configuration information necessary to perform regression.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-regression.html", - "name": "regression", + "name": "task_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisRegression", - "namespace": "ml._types" + "name": "TaskId", + "namespace": "_types" } } + } + ], + "specLocation": "ml/_types/Job.ts#L163-L166" + }, + { + "kind": "enum", + "members": [ + { + "name": "delete" }, { - "description": "The configuration information necessary to perform classification.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html", - "name": "classification", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisClassification", - "namespace": "ml._types" - } - } + "name": "reset" + }, + { + "name": "revert" } ], - "variants": { - "kind": "container" - } + "name": { + "name": "JobBlockedReason", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Job.ts#L168-L172" }, { "kind": "interface", "name": { - "name": "DataframeAnalysisFeatureProcessor", + "name": "JobConfig", "namespace": "ml._types" }, "properties": [ { - "description": "The configuration information necessary to perform frequency encoding.", - "name": "frequency_encoding", + "name": "allow_lazy_open", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisFeatureProcessorFrequencyEncoding", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.", - "name": "multi_encoding", - "required": false, + "name": "analysis_config", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisFeatureProcessorMultiEncoding", + "name": "AnalysisConfig", "namespace": "ml._types" } } }, { - "description": "The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: .. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11.", - "name": "n_gram_encoding", + "name": "analysis_limits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisFeatureProcessorNGramEncoding", + "name": "AnalysisLimits", "namespace": "ml._types" } } }, { - "description": "The configuration information necessary to perform one hot encoding.", - "name": "one_hot_encoding", + "name": "background_persist_interval", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisFeatureProcessorOneHotEncoding", - "namespace": "ml._types" + "name": "Time", + "namespace": "_types" } } }, { - "description": "The configuration information necessary to perform target mean encoding.", - "name": "target_mean_encoding", + "name": "custom_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisFeatureProcessorTargetMeanEncoding", + "name": "CustomSettings", "namespace": "ml._types" } } - } - ], - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalysisFeatureProcessorFrequencyEncoding", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The resulting feature name.", - "name": "feature_name", - "required": true, + "name": "daily_model_snapshot_retention_after_days", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "long", "namespace": "_types" } } }, { - "name": "field", + "name": "data_description", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "DataDescription", + "namespace": "ml._types" } } }, { - "description": "The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.", - "name": "frequency_map", - "required": true, + "name": "datafeed_config", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "DatafeedConfig", + "namespace": "ml._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalysisFeatureProcessorMultiEncoding", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The ordered array of custom processors to execute. Must be more than 1.", - "name": "processors", - "required": true, + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "groups", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalysisFeatureProcessorNGramEncoding", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The feature name prefix. Defaults to ngram__.", - "name": "feature_prefix", + "name": "job_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The name of the text field to encode.", - "name": "field", - "required": true, + "name": "job_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.", - "name": "length", + "name": "model_plot_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.", - "name": "n_grams", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "ModelPlotConfig", + "namespace": "ml._types" } } }, { - "description": "Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.", - "name": "start", + "name": "model_snapshot_retention_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "custom", + "name": "renormalization_window_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalysisFeatureProcessorOneHotEncoding", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The name of the field to encode.", - "name": "field", - "required": true, + "name": "results_index_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "IndexName", "namespace": "_types" } } }, { - "description": "The one hot map mapping the field value with the column name.", - "name": "hot_map", - "required": true, + "name": "results_retention_days", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Job.ts#L72-L90" }, { "kind": "interface", "name": { - "name": "DataframeAnalysisFeatureProcessorTargetMeanEncoding", + "name": "JobForecastStatistics", "namespace": "ml._types" }, "properties": [ { - "description": "The default value if field value is not found in the target_map.", - "name": "default_value", - "required": true, + "name": "memory_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "JobStatistics", + "namespace": "ml._types" } } }, { - "description": "The resulting feature name.", - "name": "feature_name", - "required": true, + "name": "processing_time_ms", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "JobStatistics", + "namespace": "ml._types" } } }, { - "description": "The name of the field to encode.", - "name": "field", - "required": true, + "name": "records", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "JobStatistics", + "namespace": "ml._types" } } }, { - "description": "The field value to target mean transition map.", - "name": "target_map", - "required": true, + "name": "status", + "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalysisOutlierDetection", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "n_neighbors", - "required": false, + "name": "total", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "method", - "required": false, + "name": "forecasted_jobs", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } + } + ], + "specLocation": "ml/_types/Job.ts#L115-L122" + }, + { + "kind": "enum", + "members": [ + { + "name": "closing" }, { - "name": "feature_influence_threshold", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "name": "closed" }, { - "name": "compute_feature_influence", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } + "name": "opened" }, { - "name": "outlier_fraction", - "required": false, + "name": "failed" + }, + { + "name": "opening" + } + ], + "name": { + "name": "JobState", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Job.ts#L31-L37" + }, + { + "kind": "interface", + "name": { + "name": "JobStatistics", + "namespace": "ml._types" + }, + "properties": [ + { + "name": "avg", + "required": true, "type": { "kind": "instance_of", "type": { @@ -103137,45 +121110,30 @@ } }, { - "name": "standardization_enabled", - "required": false, + "name": "max", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - } - ] - }, - { - "inherits": { - "type": { - "name": "DataframeAnalysis", - "namespace": "ml._types" - } - }, - "kind": "interface", - "name": { - "name": "DataframeAnalysisRegression", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "loss_function", - "required": false, + "name": "min", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "loss_function_parameter", - "required": false, + "name": "total", + "required": true, "type": { "kind": "instance_of", "type": { @@ -103184,492 +121142,429 @@ } } } - ] + ], + "specLocation": "ml/_types/Job.ts#L39-L44" }, { "kind": "interface", "name": { - "name": "DataframeAnalytics", + "name": "JobStats", "namespace": "ml._types" }, "properties": [ { - "description": "An object containing information about the analysis job.", - "name": "analysis_stats", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsStatsContainer", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "For running jobs only, contains messages relating to the selection of a node to run the job.", - "name": "assignment_explanation", - "required": false, + "name": "data_counts", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DataCounts", + "namespace": "ml._types" } } }, { - "description": "An object that provides counts for the quantity of documents skipped, used in training, or available for testing.", - "name": "data_counts", + "name": "forecasts_stats", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsStatsDataCounts", + "name": "JobForecastStatistics", "namespace": "ml._types" } } }, { - "description": "The unique identifier of the data frame analytics job.", - "name": "id", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.", - "name": "memory_usage", + "name": "model_size_stats", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsStatsMemoryUsage", + "name": "ModelSizeStats", "namespace": "ml._types" } } }, { - "description": "Contains properties for the node that runs the job. This information is available only for running jobs.", "name": "node", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeAttributes", - "namespace": "_types" + "name": "DiscoveryNode", + "namespace": "ml._types" } } }, { - "description": "The progress report of the data frame analytics job by phase.", - "name": "progress", - "required": true, + "name": "open_time", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsStatsProgress", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" } } }, { - "description": "The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.", "name": "state", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeState", + "name": "JobState", "namespace": "ml._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Defines the destination index to store the results of the data frame analytics job.", - "name": "index", + "name": "timing_stats", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "JobTimingStats", + "namespace": "ml._types" } } }, { - "description": "Defines the name of the field in which to store the results of the analysis. Defaults to ml.", - "name": "results_field", + "name": "deleting", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/_types/Job.ts#L91-L102" }, { "kind": "interface", "name": { - "name": "DataframeAnalyticsFieldSelection", + "name": "JobTimingStats", "namespace": "ml._types" }, "properties": [ { - "description": "Whether the field is selected to be included in the analysis.", - "name": "is_included", - "required": true, + "name": "average_bucket_processing_time_ms", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "description": "Whether the field is required.", - "name": "is_required", + "name": "bucket_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "The feature type of this field for the analysis. May be categorical or numerical.", - "name": "feature_type", + "name": "exponential_average_bucket_processing_time_ms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "description": "The mapping types of the field.", - "name": "mapping_types", + "name": "exponential_average_bucket_processing_time_per_hour_ms", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } }, { - "description": "The field name.", - "name": "name", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "The reason a field is not selected to be included in the analysis.", - "name": "reason", - "required": false, + "name": "total_bucket_processing_time_ms", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsMemoryEstimation", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics.", - "name": "expected_memory_with_disk", - "required": true, + "name": "maximum_bucket_processing_time_ms", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "description": "Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk).", - "name": "expected_memory_without_disk", - "required": true, + "name": "minimum_bucket_processing_time_ms", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Job.ts#L104-L113" + }, + { + "kind": "enum", + "members": [ + { + "name": "ok" + }, + { + "name": "soft_limit" + }, + { + "name": "hard_limit" + } + ], + "name": { + "name": "MemoryStatus", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Model.ts#L85-L89" }, { + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html#ml-apimodelplotconfig", "kind": "interface", "name": { - "name": "DataframeAnalyticsSource", + "name": "ModelPlotConfig", "namespace": "ml._types" }, "properties": [ { - "description": "Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns.", - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", - "name": "query", + "description": "If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.", + "name": "annotations_enabled", "required": false, + "serverDefault": true, + "since": "7.9.0", "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Specify includes and/or excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.", - "name": "_source", + "description": "If true, enables calculation and storage of the model bounds for each entity that is being analyzed.", + "name": "enabled", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "runtime_mappings", + "description": "Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.", + "name": "terms", "required": false, + "since": "7.9.0", + "stability": "experimental", "type": { "kind": "instance_of", "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" + "name": "Field", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/ModelPlot.ts#L23-L44" }, { "kind": "interface", "name": { - "name": "DataframeAnalyticsStatsContainer", + "name": "ModelSizeStats", "namespace": "ml._types" }, "properties": [ { - "description": "An object containing information about the classification analysis job.", - "name": "classification_stats", - "required": false, + "name": "bucket_allocation_failures_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsStatsHyperparameters", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "An object containing information about the outlier detection job.", - "name": "outlier_detection_stats", - "required": false, + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsStatsOutlierDetection", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "description": "An object containing information about the regression analysis.", - "name": "regression_stats", - "required": false, + "name": "log_time", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsStatsHyperparameters", - "namespace": "ml._types" + "name": "Time", + "namespace": "_types" } } - } - ], - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsStatsDataCounts", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.", - "name": "skipped_docs_count", + "name": "memory_status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "MemoryStatus", + "namespace": "ml._types" } } }, { - "description": "The number of documents that are not used for training the model and can be used for testing.", - "name": "test_docs_count", + "name": "model_bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "description": "The number of documents that are used for training the model.", - "name": "training_docs_count", - "required": true, + "name": "model_bytes_exceeded", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsStatsHyperparameters", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "hyperparameters", - "required": true, + "name": "model_bytes_memory_limit", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Hyperparameters", - "namespace": "ml._types" + "name": "ByteSize", + "namespace": "_types" } } }, { - "description": "The number of iterations on the analysis.", - "name": "iteration", - "required": true, + "name": "peak_model_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "timestamp", - "required": true, + "name": "assignment_memory_basis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "timing_stats", + "name": "result_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimingStats", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "validation_loss", + "name": "total_by_field_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ValidationLoss", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsStatsMemoryUsage", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.", - "name": "memory_reestimate_bytes", - "required": false, + "name": "total_over_field_count", + "required": true, "type": { "kind": "instance_of", "type": { @@ -103679,8 +121574,7 @@ } }, { - "description": "The number of bytes used at the highest peak of memory usage.", - "name": "peak_usage_bytes", + "name": "total_partition_field_count", "required": true, "type": { "kind": "instance_of", @@ -103691,95 +121585,73 @@ } }, { - "description": "The memory usage status.", - "name": "status", + "name": "categorization_status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "CategorizationStatus", + "namespace": "ml._types" } } }, { - "description": "The timestamp when memory usage was calculated.", - "name": "timestamp", - "required": false, + "name": "categorized_doc_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsStatsOutlierDetection", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "parameters", + "name": "dead_category_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "OutlierDetectionParameters", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "timestamp", + "name": "failed_category_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "integer", "namespace": "_types" } } }, { - "name": "timing_stats", + "name": "frequent_category_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimingStats", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsStatsProgress", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Defines the phase of the data frame analytics job.", - "name": "phase", + "name": "rare_category_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The progress that the data frame analytics job has made expressed in percentage.", - "name": "progress_percent", + "name": "total_category_count", "required": true, "type": { "kind": "instance_of", @@ -103788,619 +121660,532 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeAnalyticsSummary", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "id", - "required": true, + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/Model.ts#L56-L78" + }, + { + "kind": "interface", + "name": { + "name": "ModelSnapshot", + "namespace": "ml._types" + }, + "properties": [ { - "name": "source", - "required": true, + "description": "An optional description of the job.", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "dest", + "description": "A numerical character string that uniquely identifies the job that the snapshot was created for.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "analysis", - "required": true, + "description": "The timestamp of the latest processed record.", + "name": "latest_record_time_stamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "description", + "description": "The timestamp of the latest bucket result.", + "name": "latest_result_time_stamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "model_memory_limit", - "required": false, + "description": "The minimum version required to be able to restore the model snapshot.", + "name": "min_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "max_num_threads", + "description": "Summary information describing the model.", + "name": "model_size_stats", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ModelSizeStats", + "namespace": "ml._types" } } }, { - "name": "analyzed_fields", - "required": false, + "description": "If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false.", + "name": "retain", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "allow_lazy_start", - "required": false, + "description": "For internal use only.", + "name": "snapshot_doc_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "create_time", - "required": false, + "description": "A numerical character string that uniquely identifies the model snapshot.", + "name": "snapshot_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "version", - "required": false, + "description": "The creation timestamp for the snapshot.", + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Model.ts#L25-L46" }, { "kind": "interface", "name": { - "name": "DataframeEvaluationClassification", + "name": "ModelSnapshotUpgrade", "namespace": "ml._types" }, "properties": [ { - "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", - "name": "actual_field", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "The field in the index which contains the predicted value, in other words the results of the classification analysis.", - "name": "predicted_field", - "required": false, + "name": "snapshot_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings.", - "name": "top_classes_field", - "required": false, + "name": "state", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "SnapshotUpgradeState", + "namespace": "ml._types" } } }, { - "description": "Specifies the metrics that are used for the evaluation.", - "name": "metrics", - "required": false, + "name": "node", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationClassificationMetrics", + "name": "DiscoveryNode", "namespace": "ml._types" } } + }, + { + "name": "assignment_explanation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "ml/_types/Model.ts#L48-L54" }, { - "inherits": { - "type": { - "name": "DataframeEvaluationMetrics", - "namespace": "ml._types" - } - }, "kind": "interface", "name": { - "name": "DataframeEvaluationClassificationMetrics", + "name": "OutlierDetectionParameters", "namespace": "ml._types" }, "properties": [ { - "description": "Accuracy of predictions (per-class and overall).", - "name": "accuracy", + "name": "compute_feature_influence", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Multiclass confusion matrix.", - "name": "multiclass_confusion_matrix", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeEvaluationClassificationMetricsAucRoc", - "namespace": "ml._types" - }, - "properties": [ - { - "description": "Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes.", - "name": "class_name", + "name": "feature_influence_threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "double", "namespace": "_types" } } }, { - "description": "Whether or not the curve should be returned in addition to the score. Default value is false.", - "name": "include_curve", + "name": "method", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeEvaluationContainer", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs.", - "name": "classification", + "name": "n_neighbors", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationClassification", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier.", - "name": "outlier_detection", + "name": "outlier_fraction", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationOutlierDetection", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } }, { - "description": "Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values.", - "name": "regression", + "name": "standardization_enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationRegression", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "variants": { - "kind": "container" - } + "specLocation": "ml/_types/DataframeAnalytics.ts#L407-L414" }, { "kind": "interface", "name": { - "name": "DataframeEvaluationMetrics", + "name": "OverallBucket", "namespace": "ml._types" }, "properties": [ { - "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive.", - "name": "auc_roc", - "required": false, + "description": "The length of the bucket in seconds. Matches the job with the longest bucket_span value.", + "name": "bucket_span", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationClassificationMetricsAucRoc", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "Precision of predictions (per-class and average).", - "name": "precision", - "required": false, + "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", + "name": "is_interim", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Recall of predictions (per-class and average).", - "name": "recall", - "required": false, + "description": "An array of objects that contain the max_anomaly_score per job_id.", + "name": "jobs", + "required": true, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "OverallBucketJob", + "namespace": "ml._types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeEvaluationOutlierDetection", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", - "name": "actual_field", + "description": "The top_n average of the maximum bucket anomaly_score per job.", + "name": "overall_score", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "double", "namespace": "_types" } } }, { - "description": "The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.", - "name": "predicted_probability_field", + "description": "Internal. This is always set to overall_bucket.", + "name": "result_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Specifies the metrics that are used for the evaluation.", - "name": "metrics", - "required": false, + "description": "The start time of the bucket for which these results were calculated.", + "name": "timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationOutlierDetectionMetrics", - "namespace": "ml._types" + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Bucket.ts#L114-L127" }, { - "inherits": { - "type": { - "name": "DataframeEvaluationMetrics", - "namespace": "ml._types" - } - }, "kind": "interface", "name": { - "name": "DataframeEvaluationOutlierDetectionMetrics", + "name": "OverallBucketJob", "namespace": "ml._types" }, "properties": [ { - "description": "Accuracy of predictions (per-class and overall).", - "name": "confusion_matrix", - "required": false, + "name": "job_id", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeEvaluationRegression", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The field of the index which contains the ground truth. The data type of this field must be numerical.", - "name": "actual_field", + "name": "max_anomaly_score", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "double", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/Bucket.ts#L128-L131" + }, + { + "kind": "interface", + "name": { + "name": "Page", + "namespace": "ml._types" + }, + "properties": [ { - "description": "The field in the index that contains the predicted value, in other words the results of the regression analysis.", - "name": "predicted_field", - "required": true, + "description": "Skips the specified number of items.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "description": "Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.", - "name": "metrics", + "description": "Specifies the maximum number of items to obtain.", + "name": "size", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationRegressionMetrics", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/Page.ts#L22-L33" }, { "kind": "interface", "name": { - "name": "DataframeEvaluationRegressionMetrics", + "name": "PerPartitionCategorization", "namespace": "ml._types" }, "properties": [ { - "description": "Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article.", - "docUrl": "https://en.wikipedia.org/wiki/Mean_squared_error", - "name": "mse", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value.", - "name": "msle", + "description": "To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails.", + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationRegressionMetricsMsle", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Pseudo Huber loss function.", - "docUrl": "https://en.wikipedia.org/wiki/Huber_loss#Pseudo-Huber_loss_function", - "name": "huber", + "description": "This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.", + "name": "stop_on_warn", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationRegressionMetricsHuber", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } + } + ], + "specLocation": "ml/_types/Analysis.ts#L92-L101" + }, + { + "kind": "enum", + "members": [ + { + "description": "The result will not be created. This is the default value. Unless you also specify `skip_model_update`, the model will be updated as usual with the corresponding series value.", + "name": "skip_result" }, { - "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", - "docUrl": "https://en.wikipedia.org/wiki/Coefficient_of_determination", - "name": "r_squared", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } + "description": "The value for that series will not be used to update the model. Unless you also specify `skip_result`, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results.", + "name": "skip_model_update" } - ] + ], + "name": { + "name": "RuleAction", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Rule.ts#L41-L50" }, { "kind": "interface", "name": { - "name": "DataframeEvaluationRegressionMetricsHuber", + "name": "RuleCondition", "namespace": "ml._types" }, "properties": [ { - "description": "Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0.", - "name": "delta", - "required": false, + "description": "Specifies the result property to which the condition applies. If your detector uses lat_long, metric, rare, or freq_rare functions, you can only specify conditions that apply to time.", + "name": "applies_to", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "AppliesTo", + "namespace": "ml._types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeEvaluationRegressionMetricsMsle", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1.", - "name": "offset", - "required": false, + "description": "Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals.", + "name": "operator", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ConditionOperator", + "namespace": "ml._types" + } + } + }, + { + "description": "The value that is compared against the `applies_to` field using the operator.", + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { @@ -104409,177 +122194,177 @@ } } } - ] + ], + "specLocation": "ml/_types/Rule.ts#L52-L65" }, { "kind": "enum", "members": [ { - "name": "started" - }, - { - "name": "stopped" + "name": "loading_old_state" }, { - "name": "starting" + "name": "saving_new_state" }, { - "name": "stopping" + "name": "stopped" }, { "name": "failed" } ], "name": { - "name": "DataframeState", + "name": "SnapshotUpgradeState", "namespace": "ml._types" - } + }, + "specLocation": "ml/_types/Model.ts#L91-L96" }, { "kind": "interface", "name": { - "name": "DelayedDataCheckConfig", + "name": "TimingStats", "namespace": "ml._types" }, "properties": [ { - "description": "The window of time that is searched for late data. This window of time ends with the latest finalized bucket. It defaults to null, which causes an appropriate check_window to be calculated when the real-time datafeed runs. In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`.", - "name": "check_window", - "required": false, + "description": "Runtime of the analysis in milliseconds.", + "name": "elapsed_time", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "integer", "namespace": "_types" } } }, { - "description": "Specifies whether the datafeed periodically checks for delayed data.", - "name": "enabled", - "required": true, + "description": "Runtime of the latest iteration of the analysis in milliseconds.", + "name": "iteration_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L416-L421" }, { "kind": "interface", "name": { - "name": "DetectionRule", + "name": "TotalFeatureImportance", "namespace": "ml._types" }, "properties": [ { - "description": "The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.", - "name": "actions", - "required": false, + "description": "The feature for which this importance was calculated.", + "name": "feature_name", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RuleAction", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "description": "An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND.", - "name": "conditions", - "required": false, + "description": "A collection of feature importance statistics related to the training data set for this particular feature.", + "name": "importance", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "RuleCondition", + "name": "TotalFeatureImportanceStatistics", "namespace": "ml._types" } } } }, { - "description": "A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`.", - "name": "scope", - "required": false, + "description": "If the trained model is a classification model, feature importance statistics are gathered per target class value.", + "name": "classes", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "FilterRef", + "name": "TotalFeatureImportanceClass", "namespace": "ml._types" } } } } - ] + ], + "specLocation": "ml/_types/TrainedModel.ts#L118-L125" }, { "kind": "interface", "name": { - "name": "Detector", + "name": "TotalFeatureImportanceClass", "namespace": "ml._types" }, "properties": [ { - "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.", - "name": "by_field_name", - "required": false, + "description": "The target class value. Could be a string, boolean, or number.", + "name": "class_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Name", "namespace": "_types" } } }, { - "description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.", - "name": "custom_rules", - "required": false, + "description": "A collection of feature importance statistics related to the training data set for this particular feature.", + "name": "importance", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "DetectionRule", + "name": "TotalFeatureImportanceStatistics", "namespace": "ml._types" } } } - }, + } + ], + "specLocation": "ml/_types/TrainedModel.ts#L127-L132" + }, + { + "kind": "interface", + "name": { + "name": "TotalFeatureImportanceStatistics", + "namespace": "ml._types" + }, + "properties": [ { - "description": "A description of the detector.", - "name": "detector_description", - "required": false, + "description": "The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.", + "name": "mean_magnitude", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.", - "name": "detector_index", - "required": false, + "description": "The maximum importance value across all the training data for this feature.", + "name": "max", + "required": true, "type": { "kind": "instance_of", "type": { @@ -104589,107 +122374,111 @@ } }, { - "description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.", - "name": "exclude_frequent", - "required": false, + "description": "The minimum importance value across all the training data for this feature.", + "name": "min", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ExcludeFrequent", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/_types/TrainedModel.ts#L134-L141" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelConfig", + "namespace": "ml._types" + }, + "properties": [ { - "description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.", - "name": "field_name", - "required": false, + "description": "Idetifier for the trained model.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.", - "name": "function", - "required": false, + "description": "A comma delimited string of tags. A trained model can have many tags, or none.", + "name": "tags", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.", - "name": "over_field_name", + "description": "The Elasticsearch version number in which the trained model was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "VersionString", "namespace": "_types" } } }, { - "description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.", - "name": "partition_field_name", + "name": "compressed_definition", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", - "name": "use_null", + "description": "Information on the creator of the trained model.", + "name": "created_by", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "description", + "description": "The time when the trained model was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DiscoveryNode", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "attributes", - "required": true, + "description": "Any field map described in the inference configuration takes precedence.", + "name": "default_field_map", + "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -104698,605 +122487,1032 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "ephemeral_id", - "required": true, + "description": "The free-text description of the trained model.", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "id", - "required": true, + "description": "The estimated heap usage in bytes to keep the trained model in memory.", + "name": "estimated_heap_memory_usage_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } }, { - "name": "name", - "required": true, + "description": "The estimated number of operations to use the trained model.", + "name": "estimated_operations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } }, { - "name": "transport_address", + "description": "The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.", + "name": "inference_config", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", - "namespace": "_types" + "name": "InferenceConfigContainer", + "namespace": "_types.aggregations" } } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "all" }, { - "name": "none" - }, - { - "name": "by" + "description": "The input field names for the model definition.", + "name": "input", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TrainedModelConfigInput", + "namespace": "ml._types" + } + } }, { - "name": "over" - } - ], - "name": { - "name": "ExcludeFrequent", - "namespace": "ml._types" - } - }, - { - "kind": "interface", - "name": { - "name": "Filter", - "namespace": "ml._types" - }, - "properties": [ - { - "name": "description", + "description": "The license level of the trained model.", + "name": "license_level", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "filter_id", - "required": true, + "description": "An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.", + "name": "metadata", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "TrainedModelConfigMetadata", + "namespace": "ml._types" } } - }, + } + ], + "specLocation": "ml/_types/TrainedModel.ts#L57-L85" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelConfigInput", + "namespace": "ml._types" + }, + "properties": [ { - "name": "items", + "description": "An array of input field names for the model.", + "name": "field_names", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } } } - ] + ], + "specLocation": "ml/_types/TrainedModel.ts#L87-L90" }, { "kind": "interface", "name": { - "name": "FilterRef", + "name": "TrainedModelConfigMetadata", "namespace": "ml._types" }, "properties": [ { - "description": "The identifier for the filter.", - "name": "filter_id", - "required": true, + "name": "model_aliases", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter.", - "name": "filter_type", + "description": "An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.", + "name": "feature_importance_baseline", "required": false, - "serverDefault": "include", "type": { - "kind": "instance_of", - "type": { - "name": "FilterType", - "namespace": "ml._types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ] - }, - { - "kind": "enum", - "members": [ + }, { - "name": "include" + "description": "List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.", + "name": "hyperparameters", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Hyperparameter", + "namespace": "ml._types" + } + } + } }, { - "name": "exclude" + "description": "An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.", + "name": "total_feature_importance", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TotalFeatureImportance", + "namespace": "ml._types" + } + } + } } ], - "name": { - "name": "FilterType", - "namespace": "ml._types" - } + "specLocation": "ml/_types/TrainedModel.ts#L92-L100" }, { "kind": "interface", "name": { - "name": "Hyperparameter", + "name": "TrainedModelInferenceStats", "namespace": "ml._types" }, "properties": [ { - "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/7.12/dfa-regression.html#dfa-regression-lossfunction", - "name": "absolute_importance", - "required": false, + "description": "The number of failures when using the model for inference.", + "name": "failure_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "description": "Name of the hyperparameter.", - "name": "name", + "description": "The total number of times the model has been called for inference. This is across all inference contexts, including all pipelines.", + "name": "inference_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "long", "namespace": "_types" } } }, { - "description": "A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", - "name": "relative_importance", - "required": false, + "description": "The number of times the model was loaded for inference and was not retrieved from the cache. If this number is close to the inference_count, then the cache is not being appropriately used. This can be solved by increasing the cache size or its time-to-live (TTL). See General machine learning settings for the appropriate settings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#general-ml-settings", + "name": "cache_miss_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "description": "Indicates if the hyperparameter is specified by the user (true) or optimized (false).", - "name": "supplied", + "description": "The number of inference calls where all the training features for the model were missing.", + "name": "missing_all_fields_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "The value of the hyperparameter, either optimized or specified by the user.", - "name": "value", + "description": "The time when the statistics were last updated.", + "name": "timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/_types/TrainedModel.ts#L41-L55" }, { "kind": "interface", "name": { - "name": "Hyperparameters", + "name": "TrainedModelStats", "namespace": "ml._types" }, "properties": [ { - "name": "alpha", - "required": false, + "description": "The unique identifier of the trained model.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } }, { - "name": "lambda", - "required": false, + "description": "The number of ingest pipelines that currently refer to the model.", + "name": "pipeline_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "gamma", + "description": "A collection of inference stats fields.", + "name": "inference_stats", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "TrainedModelInferenceStats", + "namespace": "ml._types" } } }, { - "name": "eta", + "description": "A collection of ingest stats for the model across all nodes. The values are summations of the individual node statistics. The format matches the ingest section in Nodes stats.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html", + "name": "ingest", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "ml/_types/TrainedModel.ts#L27-L39" + }, + { + "kind": "interface", + "name": { + "name": "ValidationLoss", + "namespace": "ml._types" + }, + "properties": [ { - "name": "eta_growth_rate_per_tree", - "required": false, + "description": "Validation loss values for every added decision tree during the forest growing procedure.", + "name": "fold_values", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "feature_bag_fraction", - "required": false, + "description": "The type of the loss metric. For example, binomial_logistic.", + "name": "loss_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, - { - "name": "downsample_factor", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ml/_types/DataframeAnalytics.ts#L423-L428" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { - "name": "double", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the descriptiion for the `force` query parameter.", + "name": "force", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `timeout` query parameter.", + "name": "timeout", + "required": false, + "serverDefault": "30m", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } } - }, - { - "name": "max_attempts_to_add_tree", - "required": false, + ] + }, + "description": "Closes one or more anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.close_job" + }, + "path": [ + { + "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "max_optimization_rounds_per_hyperparameter", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_trees", + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", + "name": "allow_no_jobs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "num_folds", + "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", + "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "num_splits_per_feature", + "description": "Controls the time to wait until a job has closed.", + "name": "timeout", "required": false, + "serverDefault": "30m", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } - }, - { - "name": "soft_tree_depth_limit", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L80" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "closed", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.close_job" + }, + "specLocation": "ml/close_job/MlCloseJobResponse.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Removes all scheduled events from a calendar, then deletes it.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_calendar" + }, + "path": [ { - "name": "soft_tree_depth_tolerance", - "required": false, + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L35" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", "name": { - "name": "Influence", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.delete_calendar" }, - "properties": [ + "specLocation": "ml/delete_calendar/MlDeleteCalendarResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes scheduled events from a calendar.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_calendar_event" + }, + "path": [ { - "name": "influencer_field_name", + "description": "The ID of the calendar to modify", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "influencer_field_values", + "description": "The ID of the event to remove from the calendar", + "name": "event_id", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts#L23-L34" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", "name": { - "name": "Job", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.delete_calendar_event" }, - "properties": [ + "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes anomaly detection jobs from a calendar.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_calendar_job" + }, + "path": [ { - "name": "allow_lazy_open", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "analysis_config", + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } - }, - { - "name": "analysis_limits", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts#L23-L37" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, "type": { - "name": "AnalysisLimits", - "namespace": "ml._types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - }, - { - "name": "background_persist_interval", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "A description of the calendar.", + "name": "description", + "required": false, "type": { - "name": "Time", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "name": "blocked", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "A list of anomaly detection job identifiers or group names.", + "name": "job_ids", + "required": true, "type": { - "name": "JobBlocked", - "namespace": "ml._types" + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_calendar_job" + }, + "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts#L22-L31" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes a data frame analytics job.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_data_frame_analytics" + }, + "path": [ { - "name": "create_time", - "required": false, + "description": "Identifier for the data frame analytics job.", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "custom_settings", + "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", + "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "CustomSettings", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "daily_model_snapshot_retention_after_days", + "description": "The time to wait for the job to be deleted.", + "name": "timeout", "required": false, + "serverDefault": "1m", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts#L24-L50" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_data_frame_analytics" + }, + "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an existing datafeed.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_datafeed" + }, + "path": [ { - "name": "data_description", + "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataDescription", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "datafeed_config", + "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", + "name": "force", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Datafeed", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/delete_datafeed/MlDeleteDatafeedRequest.ts#L23-L47" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_datafeed" + }, + "specLocation": "ml/delete_datafeed/MlDeleteDatafeedResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.", + "name": "requests_per_second", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "description": "How long can the underlying delete processes run until they are canceled.", + "name": "timeout", + "required": false, + "serverDefault": "8h", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ] + }, + "description": "Deletes expired and unused machine learning data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_expired_data" + }, + "path": [ { - "name": "deleting", + "description": "Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.", + "name": "job_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "description", + "description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.", + "name": "requests_per_second", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "float", + "namespace": "_types" } } }, { - "name": "finished_time", + "description": "How long can the underlying delete processes run until they are canceled.", + "name": "timeout", "required": false, + "serverDefault": "8h", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Time", "namespace": "_types" } } - }, - { - "name": "groups", - "required": false, - "type": { - "kind": "array_of", - "value": { + } + ], + "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L72" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "deleted", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_expired_data" + }, + "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataResponse.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_filter" + }, + "path": [ { - "name": "job_id", + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", "required": true, "type": { "kind": "instance_of", @@ -105305,497 +123521,734 @@ "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L39" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_filter" + }, + "specLocation": "ml/delete_filter/MlDeleteFilterResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes forecasts from a machine learning job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_forecast" + }, + "path": [ { - "name": "job_type", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "job_version", + "description": "A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.", + "name": "forecast_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "model_plot_config", + "description": "Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.", + "name": "allow_no_forecasts", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "model_snapshot_id", + "description": "Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.", + "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Time", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L65" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_forecast" + }, + "specLocation": "ml/delete_forecast/MlDeleteForecastResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_job" + }, + "path": [ { - "name": "model_snapshot_retention_days", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "renormalization_window_days", + "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", + "name": "force", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "results_index_name", - "required": true, + "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", + "name": "wait_for_completion", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L57" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_job" + }, + "specLocation": "ml/delete_job/MlDeleteJobResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an existing model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_model_snapshot" + }, + "path": [ { - "name": "results_retention_days", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "system_annotations_retention_days", - "required": false, + "description": "Identifier for the model snapshot.", + "name": "snapshot_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L44" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", "name": { - "name": "JobBlocked", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.delete_model_snapshot" }, - "properties": [ + "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes an existing trained inference model that is currently not referenced\nby an ingest pipeline.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_trained_model" + }, + "path": [ { - "name": "reason", + "description": "The unique identifier of the trained model.", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "JobBlockedReason", - "namespace": "ml._types" - } - } - }, - { - "name": "task_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskId", + "name": "Id", "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L23-L38" }, { - "kind": "enum", - "members": [ - { - "name": "delete" - }, - { - "name": "reset" - }, - { - "name": "revert" + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ], + }, + "kind": "response", "name": { - "name": "JobBlockedReason", - "namespace": "ml._types" - } + "name": "Response", + "namespace": "ml.delete_trained_model" + }, + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelResponse.ts#L22-L22" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Deletes a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "JobConfig", - "namespace": "ml._types" + "name": "Request", + "namespace": "ml.delete_trained_model_alias" }, - "properties": [ + "path": [ { - "name": "allow_lazy_open", - "required": false, + "description": "The model alias to delete.", + "name": "model_alias", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Name", + "namespace": "_types" } } }, { - "name": "analysis_config", + "description": "The trained model ID to which the model alias refers.", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } - }, - { - "name": "analysis_limits", - "required": false, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L44" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_trained_model_alias" + }, + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", + "name": "analysis_config", + "required": false, "type": { - "name": "AnalysisLimits", - "namespace": "ml._types" + "kind": "instance_of", + "type": { + "name": "AnalysisConfig", + "namespace": "ml._types" + } } - } - }, - { - "name": "background_persist_interval", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", + "name": "max_bucket_cardinality", + "required": false, "type": { - "name": "Time", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } } - } - }, - { - "name": "custom_settings", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", + "name": "overall_cardinality", + "required": false, "type": { - "name": "CustomSettings", - "namespace": "ml._types" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } } } - }, - { - "name": "daily_model_snapshot_retention_after_days", - "required": false, - "type": { - "kind": "instance_of", + ] + }, + "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.estimate_model_memory" + }, + "path": [], + "query": [], + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L61" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "model_memory_estimate", + "required": true, "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.estimate_model_memory" + }, + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryResponse.ts#L20-L24" + }, + { + "kind": "interface", + "name": { + "name": "ConfusionMatrixItem", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "data_description", + "name": "actual_class", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataDescription", - "namespace": "ml._types" - } - } - }, - { - "name": "datafeed_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DatafeedConfig", - "namespace": "ml._types" + "name": "Name", + "namespace": "_types" } } }, { - "name": "description", - "required": false, + "name": "actual_class_doc_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "groups", - "required": false, + "name": "predicted_classes", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ConfusionMatrixPrediction", + "namespace": "ml.evaluate_data_frame" } } } }, { - "name": "job_id", - "required": false, + "name": "other_predicted_class_doc_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } - }, - { - "name": "job_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L84-L89" + }, + { + "kind": "interface", + "name": { + "name": "ConfusionMatrixPrediction", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "model_plot_config", - "required": false, + "name": "predicted_class", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" + "name": "Name", + "namespace": "_types" } } }, { - "name": "model_snapshot_retention_days", - "required": false, + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L91-L94" + }, + { + "kind": "interface", + "name": { + "name": "ConfusionMatrixThreshold", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "renormalization_window_days", - "required": false, + "codegenName": "true_positive", + "description": "True Positive", + "name": "tp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "results_index_name", - "required": false, + "codegenName": "false_positive", + "description": "False Positive", + "name": "fp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "results_retention_days", - "required": false, + "codegenName": "true_negative", + "description": "True Negative", + "name": "tn", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "system_annotations_retention_days", - "required": false, + "codegenName": "false_negative", + "description": "False Negative", + "name": "fn", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L96-L117" }, { "kind": "interface", "name": { - "name": "JobForecastStatistics", - "namespace": "ml._types" + "name": "DataframeClassificationSummary", + "namespace": "ml.evaluate_data_frame" }, "properties": [ { - "name": "memory_bytes", + "name": "auc_roc", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobStatistics", - "namespace": "ml._types" + "name": "DataframeEvaluationSummaryAucRoc", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "processing_time_ms", + "name": "accuracy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobStatistics", - "namespace": "ml._types" + "name": "DataframeClassificationSummaryAccuracy", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "records", + "name": "multiclass_confusion_matrix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobStatistics", - "namespace": "ml._types" + "name": "DataframeClassificationSummaryMulticlassConfusionMatrix", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "status", + "name": "precision", "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - }, - { - "name": "total", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DataframeClassificationSummaryPrecision", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "forecasted_jobs", - "required": true, + "name": "recall", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DataframeClassificationSummaryRecall", + "namespace": "ml.evaluate_data_frame" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "closing" - }, - { - "name": "closed" - }, - { - "name": "opened" - }, - { - "name": "failed" - }, - { - "name": "opening" - } ], - "name": { - "name": "JobState", - "namespace": "ml._types" - } + "specLocation": "ml/evaluate_data_frame/types.ts#L31-L37" }, { "kind": "interface", "name": { - "name": "JobStatistics", - "namespace": "ml._types" + "name": "DataframeClassificationSummaryAccuracy", + "namespace": "ml.evaluate_data_frame" }, "properties": [ { - "name": "avg", + "name": "classes", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationClass", + "namespace": "ml.evaluate_data_frame" + } } } }, { - "name": "max", + "name": "overall_accuracy", "required": true, "type": { "kind": "instance_of", @@ -105804,331 +124257,860 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L70-L73" + }, + { + "kind": "interface", + "name": { + "name": "DataframeClassificationSummaryMulticlassConfusionMatrix", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "min", + "name": "confusion_matrix", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ConfusionMatrixItem", + "namespace": "ml.evaluate_data_frame" + } } } }, { - "name": "total", + "name": "other_actual_class_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L79-L82" }, { "kind": "interface", "name": { - "name": "JobStats", - "namespace": "ml._types" + "name": "DataframeClassificationSummaryPrecision", + "namespace": "ml.evaluate_data_frame" }, "properties": [ { - "name": "assignment_explanation", - "required": false, + "name": "classes", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationClass", + "namespace": "ml.evaluate_data_frame" + } } } }, { - "name": "data_counts", + "name": "avg_precision", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataCounts", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L60-L63" + }, + { + "kind": "interface", + "name": { + "name": "DataframeClassificationSummaryRecall", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "forecasts_stats", + "name": "classes", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "JobForecastStatistics", - "namespace": "ml._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationClass", + "namespace": "ml.evaluate_data_frame" + } } } }, { - "name": "job_id", + "name": "avg_recall", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L65-L68" + }, + { + "inherits": { + "type": { + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" + } + }, + "kind": "interface", + "name": { + "name": "DataframeEvaluationClass", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "model_size_stats", + "name": "class_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ModelSizeStats", - "namespace": "ml._types" + "name": "Name", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L75-L77" + }, + { + "inherits": { + "type": { + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" + } + }, + "kind": "interface", + "name": { + "name": "DataframeEvaluationSummaryAucRoc", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "node", + "name": "curve", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DiscoveryNode", - "namespace": "ml._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationSummaryAucRocCurveItem", + "namespace": "ml.evaluate_data_frame" + } } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L50-L52" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationSummaryAucRocCurveItem", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "open_time", - "required": false, + "name": "tpr", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "double", "namespace": "_types" } } }, { - "name": "state", + "name": "fpr", "required": true, "type": { "kind": "instance_of", "type": { - "name": "JobState", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "timing_stats", + "name": "threshold", "required": true, "type": { "kind": "instance_of", "type": { - "name": "JobTimingStats", - "namespace": "ml._types" + "name": "double", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L54-L58" + }, + { + "kind": "interface", + "name": { + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "deleting", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L46-L48" }, { "kind": "interface", "name": { - "name": "JobTimingStats", - "namespace": "ml._types" + "name": "DataframeOutlierDetectionSummary", + "namespace": "ml.evaluate_data_frame" }, "properties": [ { - "name": "average_bucket_processing_time_ms", + "name": "auc_roc", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DataframeEvaluationSummaryAucRoc", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "bucket_count", - "required": true, + "name": "precision", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } }, { - "name": "exponential_average_bucket_processing_time_ms", + "name": "recall", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } }, { - "name": "exponential_average_bucket_processing_time_per_hour_ms", - "required": true, + "name": "confusion_matrix", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ConfusionMatrixThreshold", + "namespace": "ml.evaluate_data_frame" + } } } - }, + } + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L24-L29" + }, + { + "kind": "interface", + "name": { + "name": "DataframeRegressionSummary", + "namespace": "ml.evaluate_data_frame" + }, + "properties": [ { - "name": "job_id", - "required": true, + "name": "huber", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "total_bucket_processing_time_ms", - "required": true, + "name": "mse", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "maximum_bucket_processing_time_ms", + "name": "msle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" } } }, { - "name": "minimum_bucket_processing_time_ms", + "name": "r_squared", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DataframeEvaluationValue", + "namespace": "ml.evaluate_data_frame" } } } - ] + ], + "specLocation": "ml/evaluate_data_frame/types.ts#L39-L44" }, { - "kind": "enum", - "members": [ - { - "name": "ok" - }, - { - "name": "soft_limit" - }, - { - "name": "hard_limit" - } + "attachedBehaviors": [ + "CommonQueryParameters" ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Defines the type of evaluation you want to perform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html#ml-evaluate-dfanalytics-resources", + "name": "evaluation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeEvaluationContainer", + "namespace": "ml._types" + } + } + }, + { + "description": "Defines the index in which the evaluation will be performed.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "description": "A query clause that retrieves a subset of data from the source index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ] + }, + "description": "Evaluates the data frame analytics for an annotated index.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "MemoryStatus", - "namespace": "ml._types" - } + "name": "Request", + "namespace": "ml.evaluate_data_frame" + }, + "path": [], + "query": [], + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L53" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "classification", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeClassificationSummary", + "namespace": "ml.evaluate_data_frame" + } + } + }, + { + "name": "outlier_detection", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeOutlierDetectionSummary", + "namespace": "ml.evaluate_data_frame" + } + } + }, + { + "name": "regression", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeRegressionSummary", + "namespace": "ml.evaluate_data_frame" + } + } + } + ] + }, + "kind": "response", "name": { - "name": "ModelPlotConfig", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.evaluate_data_frame" }, - "properties": [ + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameResponse.ts#L26-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.", + "name": "source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" + } + } + }, + { + "description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).", + "name": "dest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsDestination", + "namespace": "ml._types" + } + } + }, + { + "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", + "name": "analysis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" + } + } + }, + { + "description": "A description of the job.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. The default value for data frame analytics jobs is\n1gb. If your elasticsearch.yml file contains an\nxpack.ml.max_model_memory_limit setting, an error occurs when you try to\ncreate data frame analytics jobs that have model_memory_limit values\ngreater than that setting.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "name": "model_memory_limit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The maximum number of threads to be used by the analysis. The default\nvalue is 1. Using more threads may decrease the time necessary to\ncomplete the analysis at the cost of using more CPU. Note that the\nprocess may use additional threads for operational functionality other\nthan the analysis itself.", + "name": "max_num_threads", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.", + "name": "analyzed_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" + } + } + }, + { + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings", + "name": "allow_lazy_start", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Explains a data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.explain_data_frame_analytics" + }, + "path": [ { - "description": "If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.", - "name": "annotations_enabled", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "name": "id", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [], + "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L107" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "An array of objects that explain selection for each field, sorted by the field names.", + "name": "field_selection", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsFieldSelection", + "namespace": "ml._types" + } + } + } + }, + { + "description": "An array of objects that explain selection for each field, sorted by the field names.", + "name": "memory_estimation", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsMemoryEstimation", + "namespace": "ml._types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.explain_data_frame_analytics" + }, + "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsResponse.ts#L25-L32" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", + "name": "advance_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", + "name": "calc_interim", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", + "name": "end", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "description": "When used in conjunction with calc_interim, specifies the range of\nbuckets on which to calculate interim results.", + "name": "start", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + } + ] + }, + "description": "Forces any buffered data to be processed by the job.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.flush_job" + }, + "path": [ { - "description": "If true, enables calculation and storage of the model bounds for each entity that is being analyzed.", - "name": "enabled", - "required": false, - "serverDefault": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.", - "name": "terms", + "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", + "name": "skip_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L75" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "flushed", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "last_finalized_bucket_end", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", "name": { - "name": "ModelSizeStats", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.flush_job" }, - "properties": [ - { - "name": "bucket_allocation_failures_count", - "required": true, - "type": { - "kind": "instance_of", + "specLocation": "ml/flush_job/MlFlushJobResponse.ts#L22-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "A period of time that indicates how far into the future to forecast. For\nexample, `30d` corresponds to 30 days. The forecast starts at the last\nrecord that was processed.", + "name": "duration", + "required": false, + "serverDefault": "1d", "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "The period of time that forecast results are retained. After a forecast\nexpires, the results are deleted. If set to a value of 0, the forecast is\nnever automatically deleted.", + "name": "expires_in", + "required": false, + "serverDefault": "14d", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "The maximum memory the forecast can use. If the forecast needs to use\nmore than the provided amount, it will spool to disk. Default is 20mb,\nmaximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s\nconfigured memory limit, it is automatically reduced to below that\namount.", + "name": "max_model_memory", + "required": false, + "serverDefault": "20mb", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, + ] + }, + "description": "Predicts the future behavior of a time series by using its historical\nbehavior.\nYou can create a forecast job based on an anomaly detection job to\nextrapolate future behavior. You can delete a forecast by using the Delete\nforecast API.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.forecast" + }, + "path": [ { + "description": "Identifier for the anomaly detection job.", "name": "job_id", "required": true, "type": { @@ -106138,175 +125120,400 @@ "namespace": "_types" } } - }, - { - "name": "log_time", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "query": [], + "specLocation": "ml/forecast/MlForecastJobRequest.ts#L24-L67" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "forecast_id", + "required": true, "type": { - "name": "Time", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } } - }, + ] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.forecast" + }, + "specLocation": "ml/forecast/MlForecastJobResponse.ts#L23-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `anomaly_score` query parameter.", + "name": "anomaly_score", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `desc` query parameter.", + "name": "desc", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `end` query parameter.", + "name": "end", + "required": false, + "serverDefault": "-1", + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `exclude_interim` query parameter.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `expand` query parameter.", + "name": "expand", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "page", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Page", + "namespace": "ml._types" + } + } + }, + { + "description": "Refer to the desription for the `sort` query parameter.", + "name": "sort", + "required": false, + "serverDefault": "timestamp", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `start` query parameter.", + "name": "start", + "required": false, + "serverDefault": "-1", + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + } + ] + }, + "description": "Retrieves anomaly detection job results for one or more buckets.\nThe API presents a chronological view of the records, grouped by bucket.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_buckets" + }, + "path": [ { - "name": "memory_status", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "MemoryStatus", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "model_bytes", - "required": true, + "description": "The timestamp of a single bucket result. If you do not specify this\nparameter, the API returns information about all buckets.", + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Timestamp", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "model_bytes_exceeded", + "description": "Returns buckets with anomaly scores greater or equal than this value.", + "name": "anomaly_score", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "double", "namespace": "_types" } } }, { - "name": "model_bytes_memory_limit", + "description": "If `true`, the buckets are sorted in descending order.", + "name": "desc", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "peak_model_bytes", + "description": "Returns buckets with timestamps earlier than this time. `-1` means it is\nunset and results are not limited to specific timestamps.", + "name": "end", "required": false, + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateString", "namespace": "_types" } } }, { - "name": "assignment_memory_basis", + "description": "If `true`, the output excludes interim results.", + "name": "exclude_interim", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "result_type", - "required": true, + "description": "If true, the output includes anomaly records.", + "name": "expand", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "total_by_field_count", - "required": true, + "description": "Skips the specified number of buckets.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_over_field_count", - "required": true, + "description": "Specifies the maximum number of buckets to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "total_partition_field_count", - "required": true, + "description": "Specifies the sort field for the requested buckets.", + "name": "sort", + "required": false, + "serverDefault": "timestamp", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "categorization_status", - "required": true, + "description": "Returns buckets with timestamps after this time. `-1` means it is unset\nand results are not limited to specific timestamps.", + "name": "start", + "required": false, + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "CategorizationStatus", - "namespace": "ml._types" + "name": "DateString", + "namespace": "_types" } } - }, - { - "name": "categorized_doc_count", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ml/get_buckets/MlGetBucketsRequest.ts#L26-L133" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "buckets", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "BucketSummary", + "namespace": "ml._types" + } + } + } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_buckets" + }, + "specLocation": "ml/get_buckets/MlGetBucketsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves information about the scheduled events in calendars.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_calendar_events" + }, + "path": [ { - "name": "dead_category_count", + "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "failed_category_count", - "required": true, + "description": "Specifies to get events with timestamps earlier than this time.", + "name": "end", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DateString", "namespace": "_types" } } }, { - "name": "frequent_category_count", - "required": true, + "description": "Skips the specified number of events.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -106316,19 +125523,22 @@ } }, { - "name": "rare_category_count", - "required": true, + "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", + "name": "job_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "name": "total_category_count", - "required": true, + "description": "Specifies the maximum number of events to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -106338,65 +125548,160 @@ } }, { - "name": "timestamp", + "description": "Specifies to get events with timestamps after this time.", + "name": "start", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L53" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "events", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CalendarEvent", + "namespace": "ml._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_calendar_events" + }, + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsResponse.ts#L23-L28" }, { "kind": "interface", "name": { - "name": "ModelSnapshot", - "namespace": "ml._types" + "name": "Calendar", + "namespace": "ml.get_calendars" }, "properties": [ { - "description": "An optional description of the job.", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "A description of the calendar.", "name": "description", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "A numerical character string that uniquely identifies the job that the snapshot was created for.", - "name": "job_id", + "description": "An array of anomaly detection job identifiers.", + "name": "job_ids", "required": true, "type": { - "kind": "instance_of", + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + } + ], + "specLocation": "ml/get_calendars/types.ts#L22-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "This object is supported only when you omit the calendar identifier.", + "name": "page", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Page", + "namespace": "ml._types" + } } } - }, + ] + }, + "description": "Retrieves configuration information for calendars.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_calendars" + }, + "path": [ { - "description": "The timestamp of the latest processed record.", - "name": "latest_record_time_stamp", + "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", + "name": "calendar_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "The timestamp of the latest bucket result.", - "name": "latest_result_time_stamp", + "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -106406,69 +125711,148 @@ } }, { - "description": "The minimum version required to be able to restore the model snapshot.", - "name": "min_version", - "required": true, + "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", + "name": "size", + "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L51" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "calendars", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Calendar", + "namespace": "ml.get_calendars" + } + } + } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_calendars" + }, + "specLocation": "ml/get_calendars/MlGetCalendarsResponse.ts#L23-L25" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "page", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Page", + "namespace": "ml._types" + } + } + } + ] + }, + "description": "Retrieves anomaly detection job results for one or more categories.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_categories" + }, + "path": [ { - "description": "Summary information describing the model.", - "name": "model_size_stats", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ModelSizeStats", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "description": " If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false.", - "name": "retain", - "required": true, + "description": "Identifier for the category, which is unique in the job. If you specify\nneither the category ID nor the partition_field_value, the API returns\ninformation about all categories. If you specify only the\npartition_field_value, it returns information about all categories for\nthe specified partition.", + "name": "category_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "CategoryId", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "For internal use only.", - "name": "snapshot_doc_count", - "required": true, + "description": "Skips the specified number of categories.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "A numerical character string that uniquely identifies the model snapshot.", - "name": "snapshot_id", - "required": true, + "description": "Only return categories for the specified partition.", + "name": "partition_field_value", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The creation timestamp for the snapshot.", - "name": "timestamp", - "required": true, + "description": "Specifies the maximum number of categories to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -106477,51 +125861,99 @@ } } } - ] + ], + "specLocation": "ml/get_categories/MlGetCategoriesRequest.ts#L25-L66" }, { - "kind": "interface", - "name": { - "name": "OutlierDetectionParameters", - "namespace": "ml._types" - }, - "properties": [ - { - "name": "compute_feature_influence", - "required": false, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "categories", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Category", + "namespace": "ml._types" + } + } + } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_categories" + }, + "specLocation": "ml/get_categories/MlGetCategoriesResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves configuration information for data frame analytics jobs.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_data_frame_analytics" + }, + "path": [ { - "name": "feature_influence_threshold", + "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "method", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "n_neighbors", + "description": "Skips the specified number of data frame analytics jobs.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -106531,345 +125963,459 @@ } }, { - "name": "outlier_fraction", + "description": "Specifies the maximum number of data frame analytics jobs to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "standardization_enabled", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "name": "exclude_generated", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L77" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.", + "name": "data_frame_analytics", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsSummary", + "namespace": "ml._types" + } + } + } + } + ] + }, + "kind": "response", "name": { - "name": "OverallBucket", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.get_data_frame_analytics" }, - "properties": [ + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsResponse.ts#L23-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves usage information for data frame analytics jobs.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_data_frame_analytics_stats" + }, + "path": [ { - "description": "The length of the bucket in seconds. Matches the job with the longest bucket_span value.", - "name": "bucket_span", - "required": true, + "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", - "name": "is_interim", - "required": true, + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "An array of objects that contain the max_anomaly_score per job_id.", - "name": "jobs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "OverallBucketJob", - "namespace": "ml._types" - } + "namespace": "_builtins" } } }, { - "description": "The top_n average of the maximum bucket anomaly_score per job.", - "name": "overall_score", - "required": true, + "description": "Skips the specified number of data frame analytics jobs.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "description": "Internal. This is always set to overall_bucket.", - "name": "result_type", - "required": true, + "description": "Specifies the maximum number of data frame analytics jobs to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The start time of the bucket for which these results were calculated.", - "name": "timestamp", - "required": true, + "description": "Defines whether the stats response should be verbose.", + "name": "verbose", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L72" }, { - "kind": "interface", - "name": { - "name": "OverallBucketJob", - "namespace": "ml._types" - }, - "properties": [ - { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "name": "max_anomaly_score", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.", + "name": "data_frame_analytics", + "required": true, "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalytics", + "namespace": "ml._types" + } + } } } - } - ] + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_data_frame_analytics_stats" + }, + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsResponse.ts#L24-L30" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves usage information for datafeeds.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "Page", - "namespace": "ml._types" + "name": "Request", + "namespace": "ml.get_datafeed_stats" }, - "properties": [ + "path": [ { - "name": "from", + "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", + "name": "datafeed_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Ids", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "size", + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", + "name": "allow_no_datafeeds", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "PartitionScore", - "namespace": "ml._types" - }, - "properties": [ + }, { - "name": "initial_record_score", - "required": true, + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", + "name": "allow_no_match", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, - { - "name": "partition_field_name", - "required": true, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L64" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, "type": { - "name": "Field", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "name": "partition_field_value", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "datafeeds", + "required": true, "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DatafeedStats", + "namespace": "ml._types" + } + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_datafeed_stats" + }, + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves configuration information for datafeeds.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_datafeeds" + }, + "path": [ { - "name": "probability", - "required": true, + "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", + "name": "datafeed_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Ids", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "record_score", - "required": true, + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", + "name": "allow_no_datafeeds", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "PerPartitionCategorization", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails.", - "name": "enabled", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", + "name": "allow_no_match", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.", - "name": "stop_on_warn", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "name": "exclude_generated", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] - }, - { - "kind": "enum", - "members": [ - { - "description": "The result will not be created. This is the default value. Unless you also specify `skip_model_update`, the model will be updated as usual with the corresponding series value.", - "name": "skip_result" - }, - { - "description": "The value for that series will not be used to update the model. Unless you also specify `skip_result`, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results.", - "name": "skip_model_update" - } ], - "name": { - "name": "RuleAction", - "namespace": "ml._types" - } + "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L70" }, { - "kind": "interface", - "name": { - "name": "RuleCondition", - "namespace": "ml._types" - }, - "properties": [ - { - "description": "Specifies the result property to which the condition applies. If your detector uses lat_long, metric, rare, or freq_rare functions, you can only specify conditions that apply to time.", - "name": "applies_to", - "required": true, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, "type": { - "name": "AppliesTo", - "namespace": "ml._types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "description": "Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals.", - "name": "operator", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "datafeeds", + "required": true, "type": { - "name": "ConditionOperator", - "namespace": "ml._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Datafeed", + "namespace": "ml._types" + } + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_datafeeds" + }, + "specLocation": "ml/get_datafeeds/MlGetDatafeedsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves filters.\nYou can get a single filter or all filters.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_filters" + }, + "path": [ { - "description": "The value that is compared against the `applies_to` field using the operator.", - "name": "value", - "required": true, + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Ids", "namespace": "_types" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "TimingStats", - "namespace": "ml._types" - }, - "properties": [ + ], + "query": [ { - "description": "Runtime of the analysis in milliseconds.", - "name": "elapsed_time", - "required": true, + "description": "Skips the specified number of filters.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -106879,9 +126425,10 @@ } }, { - "description": "Runtime of the latest iteration of the analysis in milliseconds.", - "name": "iteration_time", + "description": "Specifies the maximum number of filters to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -106890,490 +126437,672 @@ } } } - ] + ], + "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L51" }, { - "kind": "interface", - "name": { - "name": "TotalFeatureImportance", - "namespace": "ml._types" - }, - "properties": [ - { - "description": "The feature for which this importance was calculated.", - "name": "feature_name", - "required": true, - "type": { - "kind": "instance_of", + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "A collection of feature importance statistics related to the training data set for this particular feature.", - "name": "importance", - "required": true, - "type": { - "kind": "array_of", - "value": { "kind": "instance_of", "type": { - "name": "TotalFeatureImportanceStatistics", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "filters", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Filter", + "namespace": "ml._types" + } } } } - }, - { - "description": "If the trained model is a classification model, feature importance statistics are gathered per target class value.", - "name": "classes", - "required": true, - "type": { - "kind": "array_of", - "value": { + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_filters" + }, + "specLocation": "ml/get_filters/MlGetFiltersResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "page", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TotalFeatureImportanceClass", + "name": "Page", "namespace": "ml._types" } } } + ] + }, + "description": "Retrieves anomaly detection job results for one or more influencers.\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ] - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "TotalFeatureImportanceClass", - "namespace": "ml._types" + "name": "Request", + "namespace": "ml.get_influencers" }, - "properties": [ + "path": [ { - "description": "The target class value. Could be a string, boolean, or number.", - "name": "class_name", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } - }, - { - "description": "A collection of feature importance statistics related to the training data set for this particular feature.", - "name": "importance", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TotalFeatureImportanceStatistics", - "namespace": "ml._types" - } - } - } } - ] - }, - { - "kind": "interface", - "name": { - "name": "TotalFeatureImportanceStatistics", - "namespace": "ml._types" - }, - "properties": [ + ], + "query": [ { - "description": "The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.", - "name": "mean_magnitude", - "required": true, + "description": "If true, the results are sorted in descending order.", + "name": "desc", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The maximum importance value across all the training data for this feature.", - "name": "max", - "required": true, + "description": "Returns influencers with timestamps earlier than this time.\nThe default value means it is unset and results are not limited to\nspecific timestamps.", + "name": "end", + "required": false, + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DateString", "namespace": "_types" } } }, { - "description": "The minimum importance value across all the training data for this feature.", - "name": "min", - "required": true, + "description": "If true, the output excludes interim results. By default, interim results\nare included.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "TrainedModelConfig", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "Idetifier for the trained model.", - "name": "model_id", - "required": true, + "description": "Returns influencers with anomaly scores greater than or equal to this\nvalue.", + "name": "influencer_score", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "double", "namespace": "_types" } } }, { - "description": "A comma delimited string of tags. A trained model can have many tags, or none.", - "name": "tags", - "required": true, + "description": "Skips the specified number of influencers.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "description": "The Elasticsearch version number in which the trained model was created.", - "name": "version", + "description": "Specifies the maximum number of influencers to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "integer", "namespace": "_types" } } }, { - "name": "compressed_definition", + "description": "Specifies the sort field for the requested influencers. By default, the\ninfluencers are sorted by the `influencer_score` value.", + "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Information on the creator of the trained model.", - "name": "created_by", + "description": "Returns influencers with timestamps after this time. The default value\nmeans it is unset and results are not limited to specific timestamps.", + "name": "start", "required": false, + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DateString", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/get_influencers/MlGetInfluencersRequest.ts#L26-L93" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Array of influencer objects", + "name": "influencers", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Influencer", + "namespace": "ml._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_influencers" + }, + "specLocation": "ml/get_influencers/MlGetInfluencersResponse.ts#L23-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves usage information for anomaly detection jobs.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_job_stats" + }, + "path": [ { - "description": "The time when the trained model was created.", - "name": "create_time", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.", + "name": "job_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "Any field map described in the inference configuration takes precedence.", - "name": "default_field_map", + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.", + "name": "allow_no_jobs", "required": false, + "serverDefault": true, "type": { - "key": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L57" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + } + }, + { + "name": "jobs", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "JobStats", + "namespace": "ml._types" + } } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_job_stats" + }, + "specLocation": "ml/get_job_stats/MlGetJobStatsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves configuration information for anomaly detection jobs.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_jobs" + }, + "path": [ { - "description": "The free-text description of the trained model.", - "name": "description", - "required": true, + "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.", + "name": "job_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Ids", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "The estimated heap usage in bytes to keep the trained model in memory.", - "name": "estimated_heap_memory_usage_bytes", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The estimated number of operations to use the trained model.", - "name": "estimated_operations", + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)", + "name": "allow_no_jobs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.", - "name": "inference_config", - "required": true, + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "name": "exclude_generated", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "InferenceConfigContainer", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L70" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "jobs", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Job", + "namespace": "ml._types" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_jobs" + }, + "specLocation": "ml/get_jobs/MlGetJobsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieves usage information for anomaly detection job model snapshot upgrades.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_model_snapshot_upgrade_stats" + }, + "path": [ { - "description": "The input field names for the model definition.", - "name": "input", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TrainedModelConfigInput", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The license level of the trained model.", - "name": "license_level", + "description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.", + "name": "snapshot_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.", - "name": "metadata", + "description": "Specifies what to do when the request:\n\n - Contains wildcard expressions and there are no jobs that match.\n - Contains the _all string or no identifiers and there are no matches.\n - Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty jobs array when there are no matches and the subset of results\nwhen there are partial matches. If this parameter is false, the request returns a 404 status code when there are\nno matches or only partial matches.", + "name": "allow_no_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TrainedModelConfigMetadata", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts#L23-L57" }, { - "kind": "interface", - "name": { - "name": "TrainedModelConfigInput", - "namespace": "ml._types" - }, - "properties": [ - { - "description": "An array of input field names for the model.", - "name": "field_names", - "required": true, - "type": { - "kind": "array_of", - "value": { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } + }, + { + "name": "model_snapshot_upgrades", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ModelSnapshotUpgrade", + "namespace": "ml._types" + } + } + } } - } - ] - }, - { - "kind": "interface", + ] + }, + "kind": "response", "name": { - "name": "TrainedModelConfigMetadata", - "namespace": "ml._types" + "name": "Response", + "namespace": "ml.get_model_snapshot_upgrade_stats" }, - "properties": [ - { - "name": "model_aliases", - "required": false, - "type": { - "kind": "array_of", - "value": { + "specLocation": "ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `desc` query parameter.", + "name": "desc", + "required": false, + "serverDefault": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } - } - }, - { - "description": "An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.", - "name": "feature_importance_baseline", - "required": false, - "type": { - "key": { + }, + { + "description": "Refer to the description for the `end` query parameter.", + "name": "end", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + } + }, + { + "name": "page", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Page", + "namespace": "ml._types" } } - } - }, - { - "description": "List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.", - "name": "hyperparameters", - "required": false, - "type": { - "kind": "array_of", - "value": { + }, + { + "description": "Refer to the description for the `sort` query parameter.", + "name": "sort", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "Hyperparameter", - "namespace": "ml._types" + "name": "Field", + "namespace": "_types" } } - } - }, - { - "description": "An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.", - "name": "total_feature_importance", - "required": false, - "type": { - "kind": "array_of", - "value": { + }, + { + "description": "Refer to the description for the `start` query parameter.", + "name": "start", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TotalFeatureImportance", - "namespace": "ml._types" + "name": "Time", + "namespace": "_types" } } } + ] + }, + "description": "Retrieves information about model snapshots.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ] - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "TrainedModelInferenceStats", - "namespace": "ml._types" + "name": "Request", + "namespace": "ml.get_model_snapshots" }, - "properties": [ - { - "description": "The number of failures when using the model for inference.", - "name": "failure_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, + "path": [ { - "description": "The total number of times the model has been called for inference. This is across all inference contexts, including all pipelines.", - "name": "inference_count", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "description": "The number of times the model was loaded for inference and was not retrieved from the cache. If this number is close to the inference_count, then the cache is not being appropriately used. This can be solved by increasing the cache size or its time-to-live (TTL). See General machine learning settings for the appropriate settings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#general-ml-settings", - "name": "cache_miss_count", - "required": true, + "description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.", + "name": "snapshot_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "The number of inference calls where all the training features for the model were missing.", - "name": "missing_all_fields_count", - "required": true, + "description": "If true, the results are sorted in descending order.", + "name": "desc", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The time when the statistics were last updated.", - "name": "timestamp", - "required": true, + "description": "Returns snapshots with timestamps earlier than this time.", + "name": "end", + "required": false, "type": { "kind": "instance_of", "type": { @@ -107381,32 +127110,25 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "TrainedModelStats", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The unique identifier of the trained model.", - "name": "model_id", - "required": true, + "description": "Skips the specified number of snapshots.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } }, { - "description": "The number of ingest pipelines that currently refer to the model.", - "name": "pipeline_count", - "required": true, + "description": "Specifies the maximum number of snapshots to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -107416,82 +127138,194 @@ } }, { - "description": "A collection of inference stats fields.", - "name": "inference_stats", + "description": "Specifies the sort field for the requested snapshots. By default, the\nsnapshots are sorted by their timestamp.", + "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TrainedModelInferenceStats", - "namespace": "ml._types" + "name": "Field", + "namespace": "_types" } } }, { - "description": "A collection of ingest stats for the model across all nodes. The values are summations of the individual node statistics. The format matches the ingest section in Nodes stats.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html", - "name": "ingest", + "description": "Returns snapshots with timestamps after this time.", + "name": "start", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts#L26-L96" }, { - "kind": "interface", - "name": { - "name": "ValidationLoss", - "namespace": "ml._types" - }, - "properties": [ - { - "description": "Validation loss values for every added decision tree during the forest growing procedure.", - "name": "fold_values", - "required": true, - "type": { - "kind": "array_of", - "value": { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } - } - }, - { - "description": "The type of the loss metric. For example, binomial_logistic.", - "name": "loss_type", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "model_snapshots", + "required": true, "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ModelSnapshot", + "namespace": "ml._types" + } + } } } - } - ] + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_model_snapshots" + }, + "specLocation": "ml/get_model_snapshots/MlGetModelSnapshotsResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "deprecation": { + "description": "", + "version": "7.10.0" + }, + "name": "allow_no_jobs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `bucket_span` query parameter.", + "name": "bucket_span", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `end` query parameter.", + "name": "end", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `exclude_interim` query parameter.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `overall_score` query parameter.", + "name": "overall_score", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Refer to the description for the `start` query parameter.", + "name": "start", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `top_n` query parameter.", + "name": "top_n", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] }, + "description": "Retrieves overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "inherits": { "type": { "name": "RequestBase", @@ -107501,10 +127335,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.close_job" + "namespace": "ml.get_overall_buckets" }, "path": [ { + "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the ``.", "name": "job_id", "required": true, "type": { @@ -107518,31 +127353,58 @@ ], "query": [ { - "name": "allow_no_jobs", + "description": "The span of the overall buckets. Must be greater or equal to the largest\nbucket span of the specified anomaly detection jobs, which is the default\nvalue.\n\nBy default, an overall bucket has a span equal to the largest bucket span\nof the specified anomaly detection jobs. To override that behavior, use\nthe optional `bucket_span` parameter.", + "name": "bucket_span", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "force", + "description": "Returns overall buckets with overall scores greater than or equal to this\nvalue.", + "name": "overall_score", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.", + "name": "top_n", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "timeout", + "description": "Returns overall buckets with timestamps earlier than this time.", + "name": "end", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -107550,239 +127412,186 @@ "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "closed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.close_job" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_calendar" - }, - "path": [ + }, { - "name": "calendar_id", - "required": true, + "description": "Returns overall buckets with timestamps after this time.", + "name": "start", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Time", "namespace": "_types" } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_calendar" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_calendar_event" - }, - "path": [ + }, { - "name": "calendar_id", - "required": true, + "description": "If `true`, the output excludes interim results.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "event_id", - "required": true, + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the request returns an empty `jobs` array when there are no\nmatches and the subset of results when there are partial matches. If this\nparameter is `false`, the request returns a `404` status code when there\nare no matches or only partial matches.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "query": [] + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L147" }, { "body": { "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Array of overall bucket objects", + "name": "overall_buckets", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "OverallBucket", + "namespace": "ml._types" + } + } + } + } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_calendar_event" - } + "namespace": "ml.get_overall_buckets" + }, + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsResponse.ts#L23-L29" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_calendar_job" - }, - "path": [ - { - "name": "calendar_id", - "required": true, - "type": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `desc` query parameter.", + "name": "desc", + "required": false, + "serverDefault": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Refer to the description for the `end` query parameter.", + "name": "end", + "required": false, + "serverDefault": "-1", + "type": { + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `exclude_interim` query parameter.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "page", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Page", + "namespace": "ml._types" + } } - } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "calendar_id", - "required": true, + "description": "Refer to the description for the `record_score` query parameter.", + "name": "record_score", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "double", "namespace": "_types" } } }, { - "name": "description", + "description": "Refer to the description for the `sort` query parameter.", + "name": "sort", "required": false, + "serverDefault": "record_score", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Field", + "namespace": "_types" } } }, { - "name": "job_ids", - "required": true, + "description": "Refer to the description for the `start` query parameter.", + "name": "start", + "required": false, + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "DateString", "namespace": "_types" } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_calendar_job" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, + "description": "Retrieves anomaly records for an anomaly detection job.\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", "inherits": { "type": { "name": "RequestBase", @@ -107792,11 +127601,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_data_frame_analytics" + "namespace": "ml.get_records" }, "path": [ { - "name": "id", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", @@ -107809,204 +127619,138 @@ ], "query": [ { - "name": "force", + "description": "If true, the results are sorted in descending order.", + "name": "desc", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "timeout", + "description": "Returns records with timestamps earlier than this time. The default value\nmeans results are not limited to specific timestamps.", + "name": "end", "required": false, - "serverDefault": "1m", + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "DateString", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_data_frame_analytics" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_datafeed" - }, - "path": [ + }, { - "name": "datafeed_id", - "required": true, + "description": "If `true`, the output excludes interim results.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "force", + "description": "Skips the specified number of records.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_datafeed" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "requests_per_second", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "serverDefault": "8h", + }, + { + "description": "Returns records with anomaly scores greater or equal than this value.", + "name": "record_score", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "double", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_expired_data" - }, - "path": [ + }, { - "name": "name", + "description": "Specifies the maximum number of records to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "requests_per_second", + "description": "Specifies the sort field for the requested records.", + "name": "sort", "required": false, + "serverDefault": "record_score", "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "Field", "namespace": "_types" } } }, { - "name": "timeout", + "description": "Returns records with timestamps after this time. The default value means\nresults are not limited to specific timestamps.", + "name": "start", "required": false, - "serverDefault": "8h", + "serverDefault": "-1", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "DateString", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/get_records/MlGetAnomalyRecordsRequest.ts#L26-L127" }, { "body": { "kind": "properties", "properties": [ { - "name": "deleted", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "records", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Anomaly", + "namespace": "ml._types" + } } } } @@ -108015,8 +127759,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_expired_data" - } + "namespace": "ml.get_records" + }, + "specLocation": "ml/get_records/MlGetAnomalyRecordsResponse.ts#L23-L28" }, { "attachedBehaviors": [ @@ -108025,6 +127770,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves configuration information for a trained model.", "inherits": { "type": { "name": "RequestBase", @@ -108034,12 +127780,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_filter" + "namespace": "ml.get_trained_models" }, "path": [ { - "name": "filter_id", - "required": true, + "description": "The unique identifier of the trained model.", + "name": "model_id", + "required": false, "type": { "kind": "instance_of", "type": { @@ -108049,242 +127796,137 @@ } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_filter" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_forecast" - }, - "path": [ + "query": [ { - "name": "job_id", - "required": true, + "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "forecast_id", + "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).", + "name": "decompress_definition", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "allow_no_forecasts", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "name": "exclude_generated", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "timeout", + "description": "Skips the specified number of models.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "integer", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_forecast" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_job" - }, - "path": [ + }, { - "name": "job_id", - "required": true, + "description": "A comma delimited string of optional fields to include in the response\nbody.", + "name": "include", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "Include", + "namespace": "ml._types" } } - } - ], - "query": [ + }, { - "name": "force", + "description": "Specifies the maximum number of models to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "wait_for_completion", + "description": "A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.", + "name": "tags", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L87" }, { "body": { "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_job" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_model_snapshot" - }, - "path": [ - { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", + "properties": [ + { + "name": "count", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - }, - { - "name": "snapshot_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "description": "An array of trained model resources, which are sorted by the model_id value in ascending order.", + "name": "trained_model_configs", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TrainedModelConfig", + "namespace": "ml._types" + } + } } } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_model_snapshot" - } + "namespace": "ml.get_trained_models" + }, + "specLocation": "ml/get_trained_models/MlGetTrainedModelResponse.ts#L23-L35" }, { "attachedBehaviors": [ @@ -108293,6 +127935,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves usage information for trained models.\nYou can get usage information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.", "inherits": { "type": { "name": "RequestBase", @@ -108302,12 +127945,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_trained_model" + "namespace": "ml.get_trained_models_stats" }, "path": [ { + "description": "The unique identifier of the trained model or a model alias.", "name": "model_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -108317,207 +127961,109 @@ } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_trained_model" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_trained_model_alias" - }, - "path": [ + "query": [ { - "name": "model_alias", - "required": true, + "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Skips the specified number of models.", + "name": "from", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } }, { - "name": "model_id", - "required": true, + "description": "Specifies the maximum number of models to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_trained_model_alias" - } + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L65" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "analysis_config", - "required": false, + "description": "The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.", + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" - } - } - }, - { - "name": "max_bucket_cardinality", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } } }, { - "name": "overall_cardinality", - "required": false, + "description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.", + "name": "trained_model_stats", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TrainedModelStats", + "namespace": "ml._types" } } } } ] }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.estimate_model_memory" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "model_memory_estimate", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.estimate_model_memory" - } + "namespace": "ml.get_trained_models_stats" + }, + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsResponse.ts#L23-L33" }, { "kind": "interface", "name": { - "name": "ConfusionMatrixItem", - "namespace": "ml.evaluate_data_frame" + "name": "AnomalyDetectors", + "namespace": "ml.info" }, "properties": [ { - "name": "actual_class", + "name": "categorization_analyzer", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "CategorizationAnalyzer", + "namespace": "ml._types" } } }, { - "name": "actual_class_doc_count", + "name": "categorization_examples_limit", "required": true, "type": { "kind": "instance_of", @@ -108528,52 +128074,29 @@ } }, { - "name": "predicted_classes", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ConfusionMatrixPrediction", - "namespace": "ml.evaluate_data_frame" - } - } - } - }, - { - "name": "other_predicted_class_doc_count", + "name": "model_memory_limit", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "ConfusionMatrixPrediction", - "namespace": "ml.evaluate_data_frame" - }, - "properties": [ + }, { - "name": "predicted_class", + "name": "model_snapshot_retention_days", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } }, { - "name": "count", + "name": "daily_model_snapshot_retention_after_days", "required": true, "type": { "kind": "instance_of", @@ -108583,32 +128106,18 @@ } } } - ] + ], + "specLocation": "ml/info/types.ts#L44-L50" }, { "kind": "interface", "name": { - "name": "ConfusionMatrixThreshold", - "namespace": "ml.evaluate_data_frame" + "name": "Datafeeds", + "namespace": "ml.info" }, "properties": [ { - "description": "True Positive", - "identifier": "true_positive", - "name": "tp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "False Positive", - "identifier": "false_positive", - "name": "fp", + "name": "scroll_size", "required": true, "type": { "kind": "instance_of", @@ -108617,705 +128126,710 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/info/types.ts#L40-L42" + }, + { + "kind": "interface", + "name": { + "name": "Defaults", + "namespace": "ml.info" + }, + "properties": [ { - "description": "True Negative", - "identifier": "true_negative", - "name": "tn", + "name": "anomaly_detectors", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "AnomalyDetectors", + "namespace": "ml.info" } } }, { - "description": "False Negative", - "identifier": "false_negative", - "name": "fn", + "name": "datafeeds", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Datafeeds", + "namespace": "ml.info" } } } - ] + ], + "specLocation": "ml/info/types.ts#L24-L27" }, { "kind": "interface", "name": { - "name": "DataframeClassificationSummary", - "namespace": "ml.evaluate_data_frame" + "name": "Limits", + "namespace": "ml.info" }, "properties": [ { - "name": "auc_roc", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeEvaluationSummaryAucRoc", - "namespace": "ml.evaluate_data_frame" - } - } - }, - { - "name": "accuracy", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeClassificationSummaryAccuracy", - "namespace": "ml.evaluate_data_frame" - } - } - }, - { - "name": "multiclass_confusion_matrix", + "name": "max_model_memory_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeClassificationSummaryMulticlassConfusionMatrix", - "namespace": "ml.evaluate_data_frame" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "precision", - "required": false, + "name": "effective_max_model_memory_limit", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeClassificationSummaryPrecision", - "namespace": "ml.evaluate_data_frame" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "recall", - "required": false, + "name": "total_ml_memory", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeClassificationSummaryRecall", - "namespace": "ml.evaluate_data_frame" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/info/types.ts#L34-L38" }, { "kind": "interface", "name": { - "name": "DataframeClassificationSummaryAccuracy", - "namespace": "ml.evaluate_data_frame" + "name": "NativeCode", + "namespace": "ml.info" }, "properties": [ { - "name": "classes", + "name": "build_hash", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataframeEvaluationClass", - "namespace": "ml.evaluate_data_frame" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "overall_accuracy", + "name": "version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "VersionString", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/info/types.ts#L29-L32" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Returns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "DataframeClassificationSummaryMulticlassConfusionMatrix", - "namespace": "ml.evaluate_data_frame" + "name": "Request", + "namespace": "ml.info" }, - "properties": [ - { - "name": "confusion_matrix", - "required": true, - "type": { - "kind": "array_of", - "value": { + "path": [], + "query": [], + "specLocation": "ml/info/MlInfoRequest.ts#L22-L35" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "defaults", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "ConfusionMatrixItem", - "namespace": "ml.evaluate_data_frame" + "name": "Defaults", + "namespace": "ml.info" } } - } - }, - { - "name": "other_actual_class_count", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "limits", + "required": true, "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeClassificationSummaryPrecision", - "namespace": "ml.evaluate_data_frame" - }, - "properties": [ - { - "name": "classes", - "required": true, - "type": { - "kind": "array_of", - "value": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationClass", - "namespace": "ml.evaluate_data_frame" + "name": "Limits", + "namespace": "ml.info" } } - } - }, - { - "name": "avg_precision", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "upgrade_mode", + "required": true, "type": { - "name": "double", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeClassificationSummaryRecall", - "namespace": "ml.evaluate_data_frame" - }, - "properties": [ - { - "name": "classes", - "required": true, - "type": { - "kind": "array_of", - "value": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationClass", - "namespace": "ml.evaluate_data_frame" + "name": "boolean", + "namespace": "_builtins" } } - } - }, - { - "name": "avg_recall", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "native_code", + "required": true, "type": { - "name": "double", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "NativeCode", + "namespace": "ml.info" + } } } - } - ] - }, - { - "inherits": { - "type": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" - } + ] }, - "kind": "interface", + "kind": "response", "name": { - "name": "DataframeEvaluationClass", - "namespace": "ml.evaluate_data_frame" + "name": "Response", + "namespace": "ml.info" }, - "properties": [ - { - "name": "class_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ] + "specLocation": "ml/info/MlInfoResponse.ts#L22-L29" }, { - "inherits": { - "type": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" - } - }, - "kind": "interface", - "name": { - "name": "DataframeEvaluationSummaryAucRoc", - "namespace": "ml.evaluate_data_frame" - }, - "properties": [ - { - "name": "curve", - "required": false, - "type": { - "kind": "array_of", - "value": { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `timeout` query parameter.", + "name": "timeout", + "required": false, + "serverDefault": "30m", + "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationSummaryAucRocCurveItem", - "namespace": "ml.evaluate_data_frame" + "name": "Time", + "namespace": "_types" } } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeEvaluationSummaryAucRocCurveItem", - "namespace": "ml.evaluate_data_frame" + ] }, - "properties": [ - { - "name": "tpr", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "fpr", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "name": "threshold", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "description": "Opens one or more anomaly detection jobs.\nAn anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ] - }, - { - "kind": "interface", + }, + "kind": "request", "name": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" + "name": "Request", + "namespace": "ml.open_job" }, - "properties": [ + "path": [ { - "name": "value", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "DataframeOutlierDetectionSummary", - "namespace": "ml.evaluate_data_frame" - }, - "properties": [ + ], + "query": [ { - "name": "auc_roc", + "description": "Controls the time to wait until a job has opened.", + "name": "timeout", "required": false, + "serverDefault": "30m", "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationSummaryAucRoc", - "namespace": "ml.evaluate_data_frame" + "name": "Time", + "namespace": "_types" } } - }, - { - "name": "precision", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { + } + ], + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L59" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "opened", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - }, - { - "name": "recall", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.open_job" + }, + "specLocation": "ml/open_job/MlOpenJobResponse.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", + "name": "events", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CalendarEvent", + "namespace": "ml._types" + } } } } - }, + ] + }, + "description": "Adds scheduled events to a calendar.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.post_calendar_events" + }, + "path": [ { - "name": "confusion_matrix", - "required": false, + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ConfusionMatrixThreshold", - "namespace": "ml.evaluate_data_frame" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L40" }, { - "kind": "interface", + "body": { + "kind": "properties", + "properties": [ + { + "name": "events", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CalendarEvent", + "namespace": "ml._types" + } + } + } + } + ] + }, + "kind": "response", "name": { - "name": "DataframeRegressionSummary", - "namespace": "ml.evaluate_data_frame" + "name": "Response", + "namespace": "ml.post_calendar_events" }, - "properties": [ - { - "name": "huber", - "required": false, - "type": { + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "data", + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" + "name": "TData", + "namespace": "ml.post_data" } } - }, + } + }, + "description": "Sends data to an anomaly detection job for analysis.", + "generics": [ { - "name": "mse", - "required": false, + "name": "TData", + "namespace": "ml.post_data" + } + ], + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.post_data" + }, + "path": [ + { + "description": "The name of the job receiving the data", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "msle", + "description": "Optional parameter to specify the end of the bucket resetting range", + "name": "reset_end", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" + "name": "DateString", + "namespace": "_types" } } }, { - "name": "r_squared", + "description": "Optional parameter to specify the start of the bucket resetting range", + "name": "reset_start", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationValue", - "namespace": "ml.evaluate_data_frame" + "name": "DateString", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/post_data/MlPostJobDataRequest.ts#L24-L54" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "description": "Defines the type of evaluation you want to perform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html#ml-evaluate-dfanalytics-resources", - "name": "evaluation", + "name": "bucket_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeEvaluationContainer", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "Defines the index in which the evaluation will be performed.", - "name": "index", + "name": "earliest_record_timestamp", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "long", "namespace": "_types" } } }, { - "description": "A query clause that retrieves a subset of data from the source index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", - "name": "query", - "required": false, + "name": "empty_bucket_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "long", + "namespace": "_types" } } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.evaluate_data_frame" - }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "classification", - "required": false, + "name": "input_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeClassificationSummary", - "namespace": "ml.evaluate_data_frame" + "name": "long", + "namespace": "_types" } } }, { - "name": "outlier_detection", - "required": false, + "name": "input_field_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeOutlierDetectionSummary", - "namespace": "ml.evaluate_data_frame" + "name": "long", + "namespace": "_types" } } }, { - "name": "regression", - "required": false, + "name": "input_record_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeRegressionSummary", - "namespace": "ml.evaluate_data_frame" + "name": "long", + "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.evaluate_data_frame" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified.", - "name": "source", - "required": false, + "name": "invalid_date_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "The destination configuration, consisting of index and optionally results_field (ml by default).", - "name": "dest", - "required": false, + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.", - "name": "analysis", + "name": "last_data_time", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "description": "A description of the job.", - "name": "description", - "required": false, + "name": "latest_record_timestamp", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", - "name": "model_memory_limit", - "required": false, + "name": "missing_field_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "The maximum number of threads to be used by the analysis. The default value is 1. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.", - "name": "max_num_threads", - "required": false, + "name": "out_of_order_timestamp_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis.", - "name": "analyzed_fields", - "required": false, + "name": "processed_field_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings", - "name": "allow_lazy_start", + "name": "processed_record_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "sparse_bucket_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.post_data" + }, + "specLocation": "ml/post_data/MlPostJobDataResponse.ts#L23-L41" + }, + { + "kind": "interface", + "name": { + "name": "DataframePreviewConfig", + "namespace": "ml.preview_data_frame_analytics" + }, + "properties": [ + { + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" + } + } + }, + { + "name": "analysis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" + } + } + }, + { + "name": "model_memory_limit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_num_threads", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "analyzed_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" + } + } + } + ], + "specLocation": "ml/preview_data_frame_analytics/types.ts#L27-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "A data frame analytics config as described in Create data frame analytics\njobs. Note that id and dest don’t need to be provided in the context of\nthis API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", + "name": "config", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DataframePreviewConfig", + "namespace": "ml.preview_data_frame_analytics" } } } ] }, + "description": "Previews the extracted features used by a data frame analytics config.", "inherits": { "type": { "name": "RequestBase", @@ -109325,11 +128839,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.explain_data_frame_analytics" + "namespace": "ml.preview_data_frame_analytics" }, "path": [ { - "description": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "description": "Identifier for the data frame analytics job.", "name": "id", "required": false, "type": { @@ -109341,54 +128855,80 @@ } } ], - "query": [] + "query": [], + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L47" }, { "body": { "kind": "properties", "properties": [ { - "description": "An array of objects that explain selection for each field, sorted by the field names.", - "name": "field_selection", + "description": "An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training.", + "name": "feature_values", "required": true, "type": { "kind": "array_of", "value": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsFieldSelection", - "namespace": "ml._types" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - }, - { - "description": "An array of objects that explain selection for each field, sorted by the field names.", - "name": "memory_estimation", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsMemoryEstimation", - "namespace": "ml._types" - } - } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.explain_data_frame_analytics" - } + "namespace": "ml.preview_data_frame_analytics" + }, + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "name": "job_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "JobConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "datafeed_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DatafeedConfig", + "namespace": "ml._types" + } + } + } + ] }, + "description": "Previews a datafeed.", "inherits": { "type": { "name": "RequestBase", @@ -109398,45 +128938,57 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.find_file_structure" + "namespace": "ml.preview_datafeed" }, "path": [ { - "name": "stub", - "required": true, + "description": "The ID of the datafeed to preview", + "name": "datafeed_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } } ], - "query": [] + "query": [], + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L25-L38" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "data", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "ml.preview_datafeed" + } } } } ] }, + "generics": [ + { + "name": "TDocument", + "namespace": "ml.preview_datafeed" + } + ], "kind": "response", "name": { "name": "Response", - "namespace": "ml.find_file_structure" - } + "namespace": "ml.preview_datafeed" + }, + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedResponse.ts#L20-L24" }, { "attachedBehaviors": [ @@ -109446,51 +128998,35 @@ "kind": "properties", "properties": [ { - "name": "advance_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - } - }, - { - "name": "calc_interim", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "end", + "description": "An array of anomaly detection job identifiers.", + "name": "job_ids", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } } }, { - "name": "start", + "description": "A description of the calendar.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ] }, + "description": "Creates a calendar.", "inherits": { "type": { "name": "RequestBase", @@ -109500,11 +129036,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.flush_job" + "namespace": "ml.put_calendar" }, "path": [ { - "name": "job_id", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", @@ -109515,42 +129052,45 @@ } } ], - "query": [ - { - "name": "skip_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "query": [], + "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L43" }, { "body": { "kind": "properties", "properties": [ { - "name": "flushed", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "last_finalized_bucket_end", - "required": false, + "description": "A description of the calendar.", + "name": "description", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "A list of anomaly detection job identifiers or group names.", + "name": "job_ids", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", "namespace": "_types" } } @@ -109560,40 +129100,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.flush_job" - } + "namespace": "ml.put_calendar" + }, + "specLocation": "ml/put_calendar/MlPutCalendarResponse.ts#L22-L31" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "duration", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "expires_in", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - } - ] + "kind": "no_body" }, + "description": "Adds an anomaly detection job to a calendar.", "inherits": { "type": { "name": "RequestBase", @@ -109603,10 +129121,23 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.forecast_job" + "namespace": "ml.put_calendar_job" }, "path": [ { + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", "name": "job_id", "required": true, "type": { @@ -109618,14 +129149,16 @@ } } ], - "query": [] + "query": [], + "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L37" }, { "body": { "kind": "properties", "properties": [ { - "name": "forecast_id", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", @@ -109634,20 +129167,39 @@ "namespace": "_types" } } + }, + { + "description": "A description of the calendar.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "A list of anomaly detection job identifiers or group names.", + "name": "job_ids", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } } ] }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.forecast_job" - } + "namespace": "ml.put_calendar_job" + }, + "specLocation": "ml/put_calendar_job/MlPutCalendarJobResponse.ts#L22-L31" }, { "attachedBehaviors": [ @@ -109657,86 +129209,108 @@ "kind": "properties", "properties": [ { - "name": "desc", + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to false and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to true,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings", + "name": "allow_lazy_start", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "exclude_interim", - "required": false, - "serverDefault": false, + "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", + "name": "analysis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" } } }, { - "name": "page", + "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", + "name": "analyzed_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Page", + "name": "DataframeAnalysisAnalyzedFields", "namespace": "ml._types" } } }, { - "name": "record_score", + "description": "A description of the job.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "sort", - "required": false, + "description": "The destination configuration.", + "name": "dest", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "DataframeAnalyticsDestination", + "namespace": "ml._types" } } }, { - "name": "start", + "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.", + "name": "max_num_threads", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "integer", "namespace": "_types" } } }, { - "name": "end", + "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", + "name": "model_memory_limit", "required": false, + "serverDefault": "1gb", "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The configuration of how to source the analysis data.", + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" } } } ] }, + "description": "Instantiates a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "inherits": { "type": { "name": "RequestBase", @@ -109746,11 +129320,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_anomaly_records" + "namespace": "ml.put_data_frame_analytics" }, "path": [ { - "name": "job_id", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -109761,345 +129336,131 @@ } } ], - "query": [ - { - "name": "exclude_interim", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "from", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "start", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - } - }, - { - "name": "end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - } - } - ] + "query": [], + "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L130" }, { "body": { "kind": "properties", "properties": [ { - "name": "count", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "records", + "name": "create_time", "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Anomaly", - "namespace": "ml._types" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_anomaly_records" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "anomaly_score", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "desc", - "required": false, - "serverDefault": false, + "name": "version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, { - "name": "exclude_interim", - "required": false, - "serverDefault": false, + "name": "source", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" } } }, { - "name": "expand", + "name": "description", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "page", - "required": false, + "name": "dest", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Page", + "name": "DataframeAnalyticsDestination", "namespace": "ml._types" } } }, { - "name": "sort", - "required": false, + "name": "model_memory_limit", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "start", - "required": false, + "name": "allow_lazy_start", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_buckets" - }, - "path": [ - { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Timestamp", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "from", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "exclude_interim", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "sort", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "desc", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "start", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - } - }, - { - "name": "end", - "required": false, - "type": { - "kind": "instance_of", + "name": "max_num_threads", + "required": true, "type": { - "name": "DateString", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "buckets", + "name": "analysis", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "BucketSummary", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" } } }, { - "name": "count", - "required": true, + "name": "analyzed_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" } } } @@ -110108,8 +129469,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_buckets" - } + "namespace": "ml.put_data_frame_analytics" + }, + "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsResponse.ts#L29-L43" }, { "attachedBehaviors": [ @@ -110119,18 +129481,101 @@ "kind": "properties", "properties": [ { - "name": "end", + "name": "aggregations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "chunking_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "ChunkingConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "delayed_data_check_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } }, { - "name": "from", + "aliases": [ + "indexes" + ], + "name": "indices", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "indices_options", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndicesOptions", + "namespace": "_types" + } + } + }, + { + "name": "job_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "max_empty_searches", "required": false, "type": { "kind": "instance_of", @@ -110141,18 +129586,62 @@ } }, { - "name": "start", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "size", + "name": "query_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "name": "scroll_size", "required": false, "type": { "kind": "instance_of", @@ -110164,6 +129653,7 @@ } ] }, + "description": "Instantiates a datafeed.", "inherits": { "type": { "name": "RequestBase", @@ -110173,11 +129663,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_calendar_events" + "namespace": "ml.put_datafeed" }, "path": [ { - "name": "calendar_id", + "description": "The ID of the datafeed to create", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", @@ -110190,374 +129681,235 @@ ], "query": [ { - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "end", + "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)", + "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "from", + "description": "Whether source index expressions should get expanded to open or closed indices (default: open)", + "name": "expand_wildcards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "name": "start", + "description": "Ignore indices that are marked as throttled (default: true)", + "name": "ignore_throttled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "size", + "description": "Ignore unavailable indexes (default: false)", + "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L31-L62" }, { "body": { "kind": "properties", "properties": [ { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "events", + "name": "aggregations", "required": true, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "CalendarEvent", - "namespace": "ml._types" + "name": "AggregationContainer", + "namespace": "_types.aggregations" } } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_calendar_events" - } - }, - { - "kind": "interface", - "name": { - "name": "Calendar", - "namespace": "ml.get_calendars" - }, - "properties": [ - { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "description", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "chunking_config", + "required": true, "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "description": "An array of anomaly detection job identifiers.", - "name": "job_ids", - "required": true, - "type": { - "kind": "array_of", - "value": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "ChunkingConfig", + "namespace": "ml._types" } } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "page", + "name": "delayed_data_check_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Page", + "name": "DelayedDataCheckConfig", "namespace": "ml._types" } } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_calendars" - }, - "path": [ - { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Skips the specified number of calendars.", - "name": "from", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "datafeed_id", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - }, - { - "description": "Specifies the maximum number of calendars to obtain.", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "frequency", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "calendars", + "name": "indices", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Calendar", - "namespace": "ml.get_calendars" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "count", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_calendars" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "page", + "name": "indices_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Page", - "namespace": "ml._types" + "name": "IndicesOptions", + "namespace": "_types" } } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_categories" - }, - "path": [ - { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition.", - "name": "category_id", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_empty_searches", + "required": true, "type": { - "name": "CategoryId", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - } - ], - "query": [ - { - "name": "from", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "query", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } } - } - }, - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "query_delay", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } - } - }, - { - "description": "Only return categories for the specified partition.", - "name": "partition_field_value", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "runtime_mappings", + "required": false, "type": { - "name": "string", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "categories", - "required": true, + "name": "script_fields", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "Category", - "namespace": "ml._types" + "name": "ScriptField", + "namespace": "_types" } } } }, { - "name": "count", + "name": "scroll_size", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } @@ -110567,140 +129919,45 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_categories" - } + "namespace": "ml.put_datafeed" + }, + "specLocation": "ml/put_datafeed/MlPutDatafeedResponse.ts#L30-L47" }, { "attachedBehaviors": [ "CommonQueryParameters" ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_data_frame_analytics" - }, - "path": [ - { - "description": "Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "Skips the specified number of data frame analytics jobs.", - "name": "from", - "required": false, - "serverDefault": "0", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies the maximum number of data frame analytics jobs to obtain.", - "name": "size", - "required": false, - "serverDefault": "100", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", - "name": "exclude_generated", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { "body": { "kind": "properties", "properties": [ { - "name": "count", - "required": true, + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.", - "name": "data_frame_analytics", - "required": true, + "name": "items", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsSummary", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_data_frame_analytics" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, + "description": "Instantiates a filter.", "inherits": { "type": { "name": "RequestBase", @@ -110710,13 +129967,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_data_frame_analytics_stats" + "namespace": "ml.put_filter" }, "path": [ { - "description": "Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.", - "name": "id", - "required": false, + "description": "The ID of the filter to create", + "name": "filter_id", + "required": true, "type": { "kind": "instance_of", "type": { @@ -110726,86 +129983,45 @@ } } ], - "query": [ - { - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "Skips the specified number of data frame analytics jobs.", - "name": "from", - "required": false, - "serverDefault": "0", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies the maximum number of data frame analytics jobs to obtain.", - "name": "size", - "required": false, - "serverDefault": "100", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Defines whether the stats response should be verbose.", - "name": "verbose", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] + "query": [], + "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L36" }, { "body": { "kind": "properties", "properties": [ { - "name": "count", + "name": "description", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "filter_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", "namespace": "_types" } } }, { - "description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.", - "name": "data_frame_analytics", + "name": "items", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "DataframeAnalytics", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } } @@ -110815,154 +130031,83 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_data_frame_analytics_stats" - } + "namespace": "ml.put_filter" + }, + "specLocation": "ml/put_filter/MlPutFilterResponse.ts#L22-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_datafeed_stats" - }, - "path": [ - { - "name": "datafeed_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ids", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "allow_no_datafeeds", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] - }, - { "body": { "kind": "properties", "properties": [ { - "name": "count", - "required": true, + "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "name": "allow_lazy_open", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "datafeeds", + "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", + "name": "analysis_config", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DatafeedStats", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "AnalysisConfig", + "namespace": "ml._types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_datafeed_stats" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_datafeeds" - }, - "path": [ - { - "name": "datafeed_id", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "name": "analysis_limits", + "required": false, "type": { - "name": "Ids", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AnalysisLimits", + "namespace": "ml._types" + } } - } - } - ], - "query": [ - { - "name": "allow_no_datafeeds", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", + "name": "background_persist_interval", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } - } - }, - { - "name": "exclude_generated", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option. Contains custom meta data about the job.", + "name": "custom_settings", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "CustomSettings", + "namespace": "ml._types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "count", - "required": true, + "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", + "name": "daily_model_snapshot_retention_after_days", + "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -110972,90 +130117,85 @@ } }, { - "name": "datafeeds", + "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", + "name": "data_description", "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataDescription", + "namespace": "ml._types" + } + } + }, + { + "description": "Defines a datafeed for the anomaly detection job.", + "name": "datafeed_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DatafeedConfig", + "namespace": "ml._types" + } + } + }, + { + "description": "A description of the job.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "A list of job groups. A job can belong to no groups or many.", + "name": "groups", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Datafeed", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_datafeeds" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_filters" - }, - "path": [ - { - "name": "filter_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "from", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", + "name": "model_plot_config", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "ModelPlotConfig", + "namespace": "ml._types" + } } - } - }, - { - "name": "size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", + "name": "model_snapshot_retention_days", + "required": false, + "serverDefault": 10, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "count", - "required": true, + "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", + "name": "renormalization_window_days", + "required": false, "type": { "kind": "instance_of", "type": { @@ -111065,47 +130205,33 @@ } }, { - "name": "filters", - "required": true, + "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared.", + "name": "results_index_name", + "required": false, + "serverDefault": "shared", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Filter", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_filters" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "page", + "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.", + "name": "results_retention_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Page", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } } ] }, + "description": "Instantiates an anomaly detection job.", "inherits": { "type": { "name": "RequestBase", @@ -111115,11 +130241,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_influencers" + "namespace": "ml.put_job" }, "path": [ { - "description": "Identifier for the anomaly detection job.", + "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", "name": "job_id", "required": true, "type": { @@ -111131,112 +130257,81 @@ } } ], - "query": [ - { - "description": "If true, the results are sorted in descending order.", - "name": "desc", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "Returns influencers with timestamps earlier than this time.", - "name": "end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - } - }, - { - "description": "If true, the output excludes interim results. By default, interim results are included.", - "name": "exclude_interim", - "required": false, - "type": { - "kind": "instance_of", + "query": [], + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L108" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "allow_lazy_open", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "description": "Returns influencers with anomaly scores greater than or equal to this value.", - "name": "influencer_score", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "analysis_config", + "required": true, "type": { - "name": "double", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AnalysisConfigRead", + "namespace": "ml._types" + } } - } - }, - { - "description": "Skips the specified number of influencers.", - "name": "from", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "analysis_limits", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AnalysisLimits", + "namespace": "ml._types" + } } - } - }, - { - "description": "Specifies the maximum number of influencers to obtain.", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "background_persist_interval", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } } - } - }, - { - "description": "Specifies the sort field for the requested influencers. By default, the influencers are sorted by the influencer_score value.", - "name": "sort", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "create_time", + "required": true, "type": { - "name": "Field", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } } - } - }, - { - "description": "Returns influencers with timestamps after this time.", - "name": "start", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "custom_settings", + "required": false, "type": { - "name": "DateString", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "CustomSettings", + "namespace": "ml._types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "count", + "name": "daily_model_snapshot_retention_after_days", "required": true, "type": { "kind": "instance_of", @@ -111247,586 +130342,582 @@ } }, { - "description": "Array of influencer objects", - "name": "influencers", + "name": "data_description", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "BucketInfluencer", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "DataDescription", + "namespace": "ml._types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_influencers" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_job_stats" - }, - "path": [ - { - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "allow_no_jobs", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "datafeed_config", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "Datafeed", + "namespace": "ml._types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "count", - "required": true, + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "jobs", - "required": true, + "name": "groups", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "JobStats", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_job_stats" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.get_jobs" - }, - "path": [ - { - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "job_id", + "required": true, "type": { - "name": "Ids", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - } - ], - "query": [ - { - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "job_type", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "name": "allow_no_jobs", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "job_version", + "required": true, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "name": "exclude_generated", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + }, + { + "name": "model_plot_config", + "required": false, "type": { - "name": "boolean", - "namespace": "internal" + "kind": "instance_of", + "type": { + "name": "ModelPlotConfig", + "namespace": "ml._types" + } } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "count", - "required": true, + "name": "model_snapshot_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "name": "jobs", + "name": "model_snapshot_retention_days", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Job", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_jobs" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "start", + "name": "renormalization_window_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } }, { - "name": "end", + "name": "results_index_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "results_retention_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } } ] }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.put_job" }, - "kind": "request", + "specLocation": "ml/put_job/MlPutJobResponse.ts#L29-L52" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.get_model_snapshots" + "name": "AggregateOutput", + "namespace": "ml.put_trained_model" }, - "path": [ + "properties": [ { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", - "required": true, + "name": "logistic_regression", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "Weights", + "namespace": "ml.put_trained_model" } } }, { - "description": "A numerical character string that uniquely identifies the model snapshot.", - "name": "snapshot_id", + "name": "weighted_sum", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "Weights", + "namespace": "ml.put_trained_model" } } - } - ], - "query": [ + }, { - "description": "If true, the results are sorted in descending order.", - "name": "desc", + "name": "weighted_mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "Weights", + "namespace": "ml.put_trained_model" } } }, { - "description": "Returns snapshots with timestamps earlier than this time.", - "name": "end", + "name": "exponent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "Weights", + "namespace": "ml.put_trained_model" } } - }, + } + ], + "specLocation": "ml/put_trained_model/types.ts#L101-L106" + }, + { + "kind": "interface", + "name": { + "name": "Definition", + "namespace": "ml.put_trained_model" + }, + "properties": [ { - "description": "Skips the specified number of snapshots.", - "name": "from", + "description": "Collection of preprocessors", + "name": "preprocessors", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Preprocessor", + "namespace": "ml.put_trained_model" + } } } }, { - "description": "Specifies the maximum number of snapshots to obtain.", - "name": "size", - "required": false, + "description": "The definition of the trained model.", + "name": "trained_model", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TrainedModel", + "namespace": "ml.put_trained_model" } } - }, + } + ], + "specLocation": "ml/put_trained_model/types.ts#L24-L29" + }, + { + "kind": "interface", + "name": { + "name": "Ensemble", + "namespace": "ml.put_trained_model" + }, + "properties": [ { - "description": "Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp.", - "name": "sort", + "name": "aggregate_output", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "AggregateOutput", + "namespace": "ml.put_trained_model" } } }, { - "description": "Returns snapshots with timestamps after this time.", - "name": "start", + "name": "classification_labels", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { + }, + { + "name": "feature_names", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, - { - "name": "model_snapshots", - "required": true, + } + }, + { + "name": "target_type", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ModelSnapshot", - "namespace": "ml._types" - } - } + "name": "string", + "namespace": "_builtins" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_model_snapshots" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "allow_no_jobs", - "required": false, - "type": { + }, + { + "name": "trained_models", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TrainedModel", + "namespace": "ml.put_trained_model" } } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", + ], + "specLocation": "ml/put_trained_model/types.ts#L93-L99" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.get_overall_buckets" + "name": "FrequencyEncodingPreprocessor", + "namespace": "ml.put_trained_model" }, - "path": [ + "properties": [ { - "description": " Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression.", - "name": "job_id", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "The span of the overall buckets. Must be greater or equal to the largest bucket span of the specified anomaly detection jobs, which is the default value.", - "name": "bucket_span", - "required": false, + "name": "feature_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Returns overall buckets with overall scores greater than or equal to this value.", - "name": "overall_score", - "required": false, + "name": "frequency_map", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } } - }, + } + ], + "specLocation": "ml/put_trained_model/types.ts#L38-L42" + }, + { + "kind": "interface", + "name": { + "name": "Input", + "namespace": "ml.put_trained_model" + }, + "properties": [ { - "description": "The number of top anomaly detection job bucket scores to be used in the overall_score calculation.", - "name": "top_n", - "required": false, - "serverDefault": "1", + "name": "field_names", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Names", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/put_trained_model/types.ts#L56-L58" + }, + { + "kind": "interface", + "name": { + "name": "OneHotEncodingPreprocessor", + "namespace": "ml.put_trained_model" + }, + "properties": [ { - "description": "Returns overall buckets with timestamps earlier than this time.", - "name": "end", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Returns overall buckets with timestamps after this time.", - "name": "start", + "name": "hot_map", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "ml/put_trained_model/types.ts#L44-L47" + }, + { + "kind": "interface", + "name": { + "name": "Preprocessor", + "namespace": "ml.put_trained_model" + }, + "properties": [ + { + "name": "frequency_encoding", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "FrequencyEncodingPreprocessor", + "namespace": "ml.put_trained_model" } } }, { - "description": " If true, the output excludes interim results. By default, interim results are included.", - "name": "exclude_interim", + "name": "one_hot_encoding", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "OneHotEncodingPreprocessor", + "namespace": "ml.put_trained_model" } } }, { - "name": "allow_no_match", + "name": "target_mean_encoding", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TargetMeanEncodingPreprocessor", + "namespace": "ml.put_trained_model" } } } - ] + ], + "specLocation": "ml/put_trained_model/types.ts#L31-L36", + "variants": { + "kind": "container" + } }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "count", + "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", + "name": "compressed_definition", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", + "name": "definition", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Definition", + "namespace": "ml.put_trained_model" + } + } + }, + { + "description": "A human-readable description of the inference trained model.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type.", + "name": "inference_config", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "InferenceConfigContainer", + "namespace": "_types.aggregations" } } }, { - "description": "Array of overall bucket objects", - "name": "overall_buckets", + "description": "The input field names for the model definition.", + "name": "input", "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Input", + "namespace": "ml.put_trained_model" + } + } + }, + { + "description": "An object map that contains metadata about the model.", + "name": "metadata", + "required": false, + "type": { + "kind": "user_defined_value" + } + }, + { + "description": "An array of tags to organize the model.", + "name": "tags", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "OverallBucket", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_overall_buckets" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, + "description": "Enables you to supply a trained model that is not created by data frame analytics.", "inherits": { "type": { "name": "RequestBase", @@ -111836,13 +130927,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_trained_models" + "namespace": "ml.put_trained_model" }, "path": [ { "description": "The unique identifier of the trained model.", "name": "model_id", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -111852,290 +130943,244 @@ } } ], - "query": [ + "query": [], + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L26-L75" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "TrainedModelConfig", + "namespace": "ml._types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.put_trained_model" + }, + "specLocation": "ml/put_trained_model/MlPutTrainedModelResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "TargetMeanEncodingPreprocessor", + "namespace": "ml.put_trained_model" + }, + "properties": [ { - "description": "Specifies what to do when the request:\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.", - "name": "allow_no_match", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).", - "name": "decompress_definition", - "required": false, - "serverDefault": true, + "name": "feature_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.", - "name": "exclude_generated", - "required": false, - "serverDefault": false, + "name": "target_map", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } }, { - "description": "Skips the specified number of models.", - "name": "from", - "required": false, - "serverDefault": "false", + "name": "default_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/put_trained_model/types.ts#L49-L54" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModel", + "namespace": "ml.put_trained_model" + }, + "properties": [ { - "description": "A comma delimited string of optional fields to include in the response body.", - "name": "include", + "description": "The definition for a binary decision tree.", + "name": "tree", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "TrainedModelTree", + "namespace": "ml.put_trained_model" } } }, { - "description": "Specifies the maximum number of models to obtain.", - "name": "size", + "description": "The definition of a node in a tree.\nThere are two major types of nodes: leaf nodes and not-leaf nodes.\n- Leaf nodes only need node_index and leaf_value defined.\n- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined.", + "name": "tree_node", "required": false, - "serverDefault": "100", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TrainedModelTreeNode", + "namespace": "ml.put_trained_model" } } }, { - "description": "A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.", - "name": "tags", + "description": "The definition for an ensemble model", + "name": "ensemble", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Ensemble", + "namespace": "ml.put_trained_model" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "An array of trained model resources, which are sorted by the model_id value in ascending order.", - "name": "trained_model_configs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TrainedModelConfig", - "namespace": "ml._types" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_trained_models" - } + ], + "specLocation": "ml/put_trained_model/types.ts#L60-L72" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.get_trained_models_stats" + "name": "TrainedModelTree", + "namespace": "ml.put_trained_model" }, - "path": [ + "properties": [ { - "description": "The unique identifier of the trained model.", - "name": "model_id", + "name": "classification_labels", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ], - "query": [ + }, { - "description": "Specifies what to do when the request:\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.", - "name": "allow_no_match", - "required": false, + "name": "feature_names", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Skips the specified number of models.", - "name": "from", + "name": "target_type", "required": false, - "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Specifies the maximum number of models to obtain.", - "name": "size", - "required": false, - "serverDefault": "100", + "name": "tree_structure", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.", - "name": "count", - "required": true, - "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.", - "name": "trained_model_stats", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TrainedModelStats", - "namespace": "ml._types" - } + "name": "TrainedModelTreeNode", + "namespace": "ml.put_trained_model" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_trained_models_stats" - } + } + ], + "specLocation": "ml/put_trained_model/types.ts#L74-L79" }, { "kind": "interface", "name": { - "name": "AnomalyDetectors", - "namespace": "ml.info" + "name": "TrainedModelTreeNode", + "namespace": "ml.put_trained_model" }, "properties": [ { - "name": "categorization_analyzer", - "required": true, + "name": "decision_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "CategorizationAnalyzer", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "categorization_examples_limit", - "required": true, + "name": "default_left", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "model_memory_limit", - "required": true, + "name": "leaf_value", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } }, { - "name": "model_snapshot_retention_days", - "required": true, + "name": "left_child", + "required": false, "type": { "kind": "instance_of", "type": { @@ -112145,7 +131190,7 @@ } }, { - "name": "daily_model_snapshot_retention_after_days", + "name": "node_index", "required": true, "type": { "kind": "instance_of", @@ -112154,19 +131199,10 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Datafeeds", - "namespace": "ml.info" - }, - "properties": [ + }, { - "name": "scroll_size", - "required": true, + "name": "right_child", + "required": false, "type": { "kind": "instance_of", "type": { @@ -112174,112 +131210,63 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Defaults", - "namespace": "ml.info" - }, - "properties": [ - { - "name": "anomaly_detectors", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AnomalyDetectors", - "namespace": "ml.info" - } - } }, { - "name": "datafeeds", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Datafeeds", - "namespace": "ml.info" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Limits", - "namespace": "ml.info" - }, - "properties": [ - { - "name": "max_model_memory_limit", + "name": "split_feature", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "effective_max_model_memory_limit", - "required": true, + "name": "split_gain", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } }, { - "name": "total_ml_memory", - "required": true, + "name": "threshold", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "double", + "namespace": "_types" } } } - ] + ], + "specLocation": "ml/put_trained_model/types.ts#L81-L91" }, { "kind": "interface", "name": { - "name": "NativeCode", - "namespace": "ml.info" + "name": "Weights", + "namespace": "ml.put_trained_model" }, "properties": [ { - "name": "build_hash", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "version", + "name": "weights", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "double", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/put_trained_model/types.ts#L108-L110" }, { "attachedBehaviors": [ @@ -112288,6 +131275,7 @@ "body": { "kind": "no_body" }, + "description": "Creates or updates a trained model alias. A trained model alias is a logical\nname used to reference a single trained model.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "inherits": { "type": { "name": "RequestBase", @@ -112297,87 +131285,77 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.info" + "namespace": "ml.put_trained_model_alias" }, - "path": [], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "defaults", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Defaults", - "namespace": "ml.info" - } - } - }, - { - "name": "limits", - "required": true, + "path": [ + { + "description": "The alias to create or update. This value cannot end in numbers.", + "name": "model_alias", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Limits", - "namespace": "ml.info" - } + "name": "Name", + "namespace": "_types" } - }, - { - "name": "upgrade_mode", - "required": true, + } + }, + { + "description": "The identifier for the trained model that the alias refers to.", + "name": "model_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "Id", + "namespace": "_types" } - }, - { - "name": "native_code", - "required": true, + } + } + ], + "query": [ + { + "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", + "name": "reassign", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "NativeCode", - "namespace": "ml.info" - } + "name": "boolean", + "namespace": "_builtins" } } - ] + } + ], + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L65" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.info" - } + "namespace": "ml.put_trained_model_alias" + }, + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - } - ] + "kind": "no_body" }, + "description": "Resets an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "inherits": { "type": { "name": "RequestBase", @@ -112387,10 +131365,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.open_job" + "namespace": "ml.reset_job" }, "path": [ { + "description": "The ID of the job to reset.", "name": "job_id", "required": true, "type": { @@ -112402,41 +131381,40 @@ } } ], - "query": [] + "query": [ + { + "description": "Should this request wait until the operation has completed before\nreturning.", + "name": "wait_for_completion", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L49" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "opened", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.open_job" - } + "namespace": "ml.reset_job" + }, + "specLocation": "ml/reset_job/MlResetJobResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -112446,22 +131424,21 @@ "kind": "properties", "properties": [ { - "description": "A list of one of more scheduled events. The event’s start and end times may be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", - "name": "events", - "required": true, + "description": "If true, deletes the results in the time period between the latest\nresults and the time of the reverted snapshot. It also resets the model\nto accept records for this time period. If you choose not to delete\nintervening results when reverting a snapshot, the job will not accept\ninput data that is older than the current time. If you want to resend\ndata, then delete the intervening results.", + "name": "delete_intervening_results", + "required": false, + "serverDefault": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CalendarEvent", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "description": "Reverts to a specific snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "inherits": { "type": { "name": "RequestBase", @@ -112471,13 +131448,25 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.post_calendar_events" + "namespace": "ml.revert_model_snapshot" }, "path": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "You can specify `empty` as the . Reverting to the empty\nsnapshot means the anomaly detection job starts learning a new model from\nscratch when it is started.", + "name": "snapshot_id", + "required": true, "type": { "kind": "instance_of", "type": { @@ -112487,23 +131476,21 @@ } } ], - "query": [] + "query": [], + "specLocation": "ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L62" }, { "body": { "kind": "properties", "properties": [ { - "name": "events", + "name": "model", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CalendarEvent", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "ModelSnapshot", + "namespace": "ml._types" } } } @@ -112512,64 +131499,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.post_calendar_events" - } - }, - { - "kind": "type_alias", - "name": { - "name": "Input", - "namespace": "ml.post_data" - }, - "type": { - "items": [ - { - "kind": "user_defined_value" - }, - { - "kind": "instance_of", - "type": { - "name": "MultipleInputs", - "namespace": "ml.post_data" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "MultipleInputs", - "namespace": "ml.post_data" + "namespace": "ml.revert_model_snapshot" }, - "properties": [ - { - "name": "data", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } - } - ] + "specLocation": "ml/revert_model_snapshot/MlRevertModelSnapshotResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "Input", - "namespace": "ml.post_data" - } - } + "kind": "no_body" }, + "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "inherits": { "type": { "name": "RequestBase", @@ -112579,309 +131520,65 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.post_data" + "namespace": "ml.set_upgrade_mode" }, - "path": [ - { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], + "path": [], "query": [ { - "name": "reset_end", + "description": "When `true`, it enables `upgrade_mode` which temporarily halts all job\nand datafeed tasks and prohibits new job and datafeed tasks from\nstarting.", + "name": "enabled", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DateString", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "reset_start", + "description": "The time to wait for the request to be completed.", + "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L56" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "bucket_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "earliest_record_timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "empty_bucket_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "input_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "input_field_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "input_record_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "invalid_date_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "last_data_time", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "latest_record_timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "missing_field_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "out_of_order_timestamp_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "processed_field_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "processed_record_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "sparse_bucket_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.post_data" - } - }, - { - "kind": "interface", - "name": { - "name": "DataframePreviewConfig", - "namespace": "ml.preview_data_frame_analytics" + "namespace": "ml.set_upgrade_mode" }, - "properties": [ - { - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" - } - } - }, - { - "name": "analysis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" - } - } - }, - { - "name": "model_memory_limit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "max_num_threads", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "analyzed_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" - } - } - } - ] + "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "A data frame analytics config as described in Create data frame analytics jobs. Note that id and dest don’t need to be provided in the context of this API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", - "name": "config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframePreviewConfig", - "namespace": "ml.preview_data_frame_analytics" - } - } - } - ] + "kind": "no_body" }, + "description": "Starts a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "inherits": { "type": { "name": "RequestBase", @@ -112891,13 +131588,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.preview_data_frame_analytics" + "namespace": "ml.start_data_frame_analytics" }, "path": [ { - "description": "Identifier for the data frame analytics job.", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", "name": "id", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -112907,45 +131604,53 @@ } } ], - "query": [] + "query": [ + { + "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.", + "name": "timeout", + "required": false, + "serverDefault": "20s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L60" }, { "body": { "kind": "properties", "properties": [ { - "description": "An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training.", - "name": "feature_values", + "description": "The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.", + "name": "node", "required": true, "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" } } } ] }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.preview_data_frame_analytics" - } + "namespace": "ml.start_data_frame_analytics" + }, + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsResponse.ts#L23-L28" }, { "attachedBehaviors": [ @@ -112955,29 +131660,42 @@ "kind": "properties", "properties": [ { - "name": "job_config", + "name": "end", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobConfig", - "namespace": "ml._types" + "name": "Time", + "namespace": "_types" } } }, { - "name": "datafeed_config", + "name": "start", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedConfig", - "namespace": "ml._types" + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "timeout", + "required": false, + "serverDefault": "20s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } ] }, + "description": "Starts one or more datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -112987,12 +131705,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.preview_datafeed" + "namespace": "ml.start_datafeed" }, "path": [ { + "description": "The ID of the datafeed to start", "name": "datafeed_id", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -113002,65 +131721,65 @@ } } ], - "query": [] - }, - { - "body": { - "kind": "value", - "value": { - "kind": "array_of", - "value": { + "query": [ + { + "description": "The start time from where the datafeed should begin", + "name": "start", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "ml.preview_datafeed" + "name": "Time", + "namespace": "_types" } } } - }, - "generics": [ - { - "name": "TDocument", - "namespace": "ml.preview_datafeed" - } ], - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.preview_datafeed" - } + "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L42" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "job_ids", - "required": false, + "name": "node", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "NodeIds", "namespace": "_types" } } }, { - "name": "description", - "required": false, + "name": "started", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.start_datafeed" + }, + "specLocation": "ml/start_datafeed/MlStartDatafeedResponse.ts#L22-L27" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Stops one or more data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -113070,11 +131789,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_calendar" + "namespace": "ml.stop_data_frame_analytics" }, "path": [ { - "name": "calendar_id", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -113085,60 +131805,107 @@ } } ], - "query": [] + "query": [ + { + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, the data frame analytics job is stopped forcefully.", + "name": "force", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", + "name": "timeout", + "required": false, + "serverDefault": "20s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L70" }, { "body": { "kind": "properties", "properties": [ { - "name": "calendar_id", + "name": "stopped", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.stop_data_frame_analytics" + }, + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsResponse.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "name": "description", + "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "job_ids", - "required": true, + "name": "timeout", + "required": false, + "serverDefault": "20s", "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Time", "namespace": "_types" } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.put_calendar" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, + "description": "Stops one or more datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -113148,12 +131915,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_calendar_job" + "namespace": "ml.stop_datafeed" }, "path": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", + "description": "The ID of the datafeed to stop", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", @@ -113162,56 +131929,66 @@ "namespace": "_types" } } + } + ], + "query": [ + { + "deprecation": { + "description": "Use `allow_no_match` instead.", + "version": "7.10.0" + }, + "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", + "name": "allow_no_datafeeds", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", - "name": "job_id", - "required": true, + "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "True if the datafeed should be forcefully stopped.", + "name": "force", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "query": [] + "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L49" }, { "body": { "kind": "properties", "properties": [ { - "name": "calendar_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "job_ids", + "name": "stopped", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } @@ -113220,8 +131997,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_calendar_job" - } + "namespace": "ml.stop_datafeed" + }, + "specLocation": "ml/stop_datafeed/MlStopDatafeedResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -113230,42 +132008,6 @@ "body": { "kind": "properties", "properties": [ - { - "description": "The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified.", - "name": "source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" - } - } - }, - { - "description": "The destination configuration, consisting of index and optionally results_field (ml by default).", - "name": "dest", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" - } - } - }, - { - "description": "The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.", - "name": "analysis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" - } - } - }, { "description": "A description of the job.", "name": "description", @@ -113274,12 +132016,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting.", + "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. The default value for data frame analytics jobs is\n1gb. If your elasticsearch.yml file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have model_memory_limit values\ngreater than that setting.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", "name": "model_memory_limit", "required": false, @@ -113287,14 +132029,15 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "The maximum number of threads to be used by the analysis. The default value is 1. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.", + "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.", "name": "max_num_threads", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -113304,19 +132047,7 @@ } }, { - "description": "Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis.", - "name": "analyzed_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" - } - } - }, - { - "description": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings", "name": "allow_lazy_start", "required": false, @@ -113325,12 +132056,13 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Updates an existing data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -113340,11 +132072,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_data_frame_analytics" + "namespace": "ml.update_data_frame_analytics" }, "path": [ { - "description": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", "name": "id", "required": true, "type": { @@ -113356,7 +132088,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L72" }, { "body": { @@ -113413,7 +132146,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -113435,7 +132168,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -113446,7 +132179,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -113482,45 +132215,25 @@ "namespace": "ml._types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.put_data_frame_analytics" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "aggs", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.update_data_frame_analytics" + }, + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsResponse.ts#L29-L43" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { + "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.", "name": "aggregations", "required": false, "type": { @@ -113528,7 +132241,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -113543,6 +132256,7 @@ } }, { + "description": "Datafeeds might search over long time periods, for several months or years. This search is split into time\nchunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of\nthese time chunks are calculated; it is an advanced configuration option.", "name": "chunking_config", "required": false, "type": { @@ -113554,6 +132268,7 @@ } }, { + "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally\nsearch over indices that have already been read in an effort to determine whether any data has subsequently been\nadded to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and\nthe data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time\ndatafeeds.", "name": "delayed_data_check_config", "required": false, "type": { @@ -113565,6 +132280,7 @@ } }, { + "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is\neither the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket\nspan. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are\nwritten then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value\nmust be divisible by the interval of the date histogram aggregation.", "name": "frequency", "required": false, "type": { @@ -113576,50 +132292,37 @@ } }, { + "aliases": [ + "indexes" + ], + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.", "name": "indices", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "name": "indexes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { + "description": "Specifies index expansion options that are used during search.", "name": "indices_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedIndicesOptions", - "namespace": "ml._types" - } - } - }, - { - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", + "name": "IndicesOptions", "namespace": "_types" } } }, { + "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "name": "max_empty_searches", "required": false, "type": { @@ -113631,8 +132334,10 @@ } }, { + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also\nchanged. Therefore, the time required to learn might be long and the understandability of the results is\nunpredictable. If you want to make significant changes to the source data, it is recommended that you\nclone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one\nwhen you are satisfied with the results of the job.", "name": "query", "required": false, + "serverDefault": "{\"match_all\": {\"boost\": 1}}", "type": { "kind": "instance_of", "type": { @@ -113642,6 +132347,7 @@ } }, { + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", "name": "query_delay", "required": false, "type": { @@ -113653,6 +132359,7 @@ } }, { + "description": "Specifies runtime fields for the datafeed search.", "name": "runtime_mappings", "required": false, "type": { @@ -113664,6 +132371,7 @@ } }, { + "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", "name": "script_fields", "required": false, "type": { @@ -113671,7 +132379,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -113686,8 +132394,10 @@ } }, { + "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`.", "name": "scroll_size", "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { @@ -113698,6 +132408,7 @@ } ] }, + "description": "Updates the properties of a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "inherits": { "type": { "name": "RequestBase", @@ -113707,10 +132418,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_datafeed" + "namespace": "ml.update_datafeed" }, "path": [ { + "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", "name": "datafeed_id", "required": true, "type": { @@ -113724,19 +132436,23 @@ ], "query": [ { + "description": "If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the\n`_all` string or when no indices are specified.", "name": "allow_no_indices", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\n* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.\n* `none`: Wildcard patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -113746,28 +132462,37 @@ } }, { + "deprecation": { + "description": "", + "version": "7.16.0" + }, + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", "name": "ignore_throttled", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true`, unavailable indices (missing or closed) are ignored.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L161" }, { "body": { @@ -113775,13 +132500,13 @@ "properties": [ { "name": "aggregations", - "required": false, + "required": true, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -113830,7 +132555,7 @@ }, { "name": "frequency", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -113848,7 +132573,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -113870,14 +132595,14 @@ "type": { "kind": "instance_of", "type": { - "name": "DatafeedIndicesOptions", - "namespace": "ml._types" + "name": "IndicesOptions", + "namespace": "_types" } } }, { "name": "max_empty_searches", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -113927,7 +132652,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -113957,8 +132682,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_datafeed" - } + "namespace": "ml.update_datafeed" + }, + "specLocation": "ml/update_datafeed/MlUpdateDatafeedResponse.ts#L30-L47" }, { "attachedBehaviors": [ @@ -113967,6 +132693,20 @@ "body": { "kind": "properties", "properties": [ + { + "name": "add_items", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, { "name": "description", "required": false, @@ -113974,12 +132714,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "items", + "name": "remove_items", "required": false, "type": { "kind": "array_of", @@ -113987,13 +132727,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } ] }, + "description": "Updates the description of a filter, adds items, or removes items.", "inherits": { "type": { "name": "RequestBase", @@ -114003,10 +132744,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_filter" + "namespace": "ml.update_filter" }, "path": [ { + "description": "The ID of the filter to update", "name": "filter_id", "required": true, "type": { @@ -114018,7 +132760,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L37" }, { "body": { @@ -114026,12 +132769,12 @@ "properties": [ { "name": "description", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -114055,7 +132798,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -114065,8 +132808,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_filter" - } + "namespace": "ml.update_filter" + }, + "specLocation": "ml/update_filter/MlUpdateFilterResponse.ts#L22-L28" }, { "attachedBehaviors": [ @@ -114076,7 +132820,8 @@ "kind": "properties", "properties": [ { - "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-settings.html#advanced-ml-settings", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -114084,38 +132829,25 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", - "name": "analysis_config", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" + "namespace": "_builtins" } } }, { - "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", "name": "analysis_limits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AnalysisLimits", + "name": "AnalysisMemoryLimit", "namespace": "ml._types" } } }, { - "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", + "description": "Advanced configuration option. The time between each periodic persistence\nof the model.\nThe default value is a randomized value between 3 to 4 hours, which\navoids all jobs persisting at exactly the same time. The smallest allowed\nvalue is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes,\nso do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed,\nclose the job, then reopen the job and restart the datafeed for the\nchanges to take effect.", "name": "background_persist_interval", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -114125,98 +132857,94 @@ } }, { - "description": " Advanced configuration option. Contains custom meta data about the job.", + "description": "Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.", + "docId": "ml.customUrls", "name": "custom_settings", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "CustomSettings", - "namespace": "ml._types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", - "name": "daily_model_snapshot_retention_after_days", + "name": "categorization_filters", "required": false, - "serverDefault": "1", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", - "name": "data_description", - "required": true, + "description": "A description of the job.", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataDescription", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Defines a datafeed for the anomaly detection job.", - "name": "datafeed_config", + "name": "model_plot_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedConfig", + "name": "ModelPlotConfig", "namespace": "ml._types" } } }, { - "description": " A description of the job.", - "name": "description", + "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html#ml-ad-model-snapshots", + "name": "daily_model_snapshot_retention_after_days", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "description": "A list of job groups. A job can belong to no groups or many.", - "name": "groups", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } } }, { - "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", - "name": "model_plot_config", + "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html#ml-ad-model-snapshots", + "name": "model_snapshot_retention_days", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", - "name": "model_snapshot_retention_days", + "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.", + "name": "renormalization_window_days", "required": false, - "serverDefault": "10", "type": { "kind": "instance_of", "type": { @@ -114226,8 +132954,8 @@ } }, { - "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", - "name": "renormalization_window_days", + "description": "Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.", + "name": "results_retention_days", "required": false, "type": { "kind": "instance_of", @@ -114238,44 +132966,50 @@ } }, { - "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named .ml-anomalies-shared.", - "name": "results_index_name", + "description": "A list of job groups. A job can belong to no groups or many.", + "name": "groups", "required": false, - "serverDefault": "shared", "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.", - "name": "results_retention_days", + "description": "An array of detector update objects.", + "name": "detectors", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Detector", + "namespace": "ml._types" + } } } }, { - "description": "Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.", - "name": "system_annotations_retention_days", + "description": "Settings related to how categorization interacts with partition fields.", + "name": "per_partition_categorization", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "PerPartitionCategorization", + "namespace": "ml._types" } } } ] }, + "description": "Updates certain properties of an anomaly detection job.", "inherits": { "type": { "name": "RequestBase", @@ -114285,11 +133019,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_job" + "namespace": "ml.update_job" }, "path": [ { - "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "description": "Identifier for the job.", "name": "job_id", "required": true, "type": { @@ -114301,7 +133035,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L137" }, { "body": { @@ -114314,7 +133049,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -114324,7 +133059,7 @@ "type": { "kind": "instance_of", "type": { - "name": "AnalysisConfig", + "name": "AnalysisConfigRead", "namespace": "ml._types" } } @@ -114357,19 +133092,41 @@ "type": { "kind": "instance_of", "type": { - "name": "DateString", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "custom_settings", + "name": "finished_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CustomSettings", - "namespace": "ml._types" + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "custom_settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, @@ -114413,7 +133170,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -114426,7 +133183,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -114449,7 +133206,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -114459,8 +133216,8 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionString", + "namespace": "_types" } } }, @@ -114514,24 +133271,13 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "results_retention_days", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "system_annotations_retention_days", + "name": "results_retention_days", "required": false, "type": { "kind": "instance_of", @@ -114546,8 +133292,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_job" - } + "namespace": "ml.update_job" + }, + "specLocation": "ml/update_job/MlUpdateJobResponse.ts#L29-L53" }, { "attachedBehaviors": [ @@ -114557,18 +133304,33 @@ "kind": "properties", "properties": [ { - "name": "stub", + "description": "A description of the model snapshot.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, this snapshot will not be deleted during automatic cleanup of\nsnapshots older than `model_snapshot_retention_days`. However, this\nsnapshot will be deleted when the job is deleted.", + "name": "retain", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "description": "Updates certain properties of a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -114578,57 +133340,66 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_trained_model" + "namespace": "ml.update_model_snapshot" }, "path": [ { - "name": "stub", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub", - "required": false, + "description": "Identifier for the model snapshot.", + "name": "snapshot_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } } - ] + ], + "query": [], + "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L54" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "model", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "ModelSnapshot", + "namespace": "ml._types" } } } ] }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_trained_model" - } + "namespace": "ml.update_model_snapshot" + }, + "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotResponse.ts#L23-L27" }, { "attachedBehaviors": [ @@ -114637,6 +133408,7 @@ "body": { "kind": "no_body" }, + "description": "Upgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "inherits": { "type": { "name": "RequestBase", @@ -114646,24 +133418,24 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_trained_model_alias" + "namespace": "ml.upgrade_job_snapshot" }, "path": [ { - "description": "The alias to create or update. This value cannot end in numbers.", - "name": "model_alias", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The identifier for the trained model that the alias refers to.", - "name": "model_id", + "description": "A numerical character string that uniquely identifies the model snapshot.", + "name": "snapshot_id", "required": true, "type": { "kind": "instance_of", @@ -114676,19 +133448,183 @@ ], "query": [ { - "description": "Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error.", - "name": "reassign", + "description": "When true, the API won’t respond until the upgrade is complete.\nOtherwise, it responds as soon as the upgrade task is assigned to a node.", + "name": "wait_for_completion", "required": false, "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Controls the time to wait for the request to complete.", + "name": "timeout", + "required": false, + "serverDefault": "30m", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L63" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "The ID of the assigned node for the upgrade task if it is still running.", + "name": "node", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + }, + { + "description": "When true, this means the task is complete. When false, it is still running.", + "name": "completed", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.upgrade_job_snapshot" + }, + "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotResponse.ts#L22-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "job_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "analysis_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AnalysisConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "analysis_limits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AnalysisLimits", + "namespace": "ml._types" + } + } + }, + { + "name": "data_description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataDescription", + "namespace": "ml._types" + } + } + }, + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "model_plot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ModelPlotConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "model_snapshot_retention_days", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "results_index_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } } } + ] + }, + "description": "Validates an anomaly detection job.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ] + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.validate" + }, + "path": [], + "query": [], + "specLocation": "ml/validate/MlValidateJobRequest.ts#L27-L44" }, { "body": { @@ -114704,16 +133640,26 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_trained_model_alias" - } + "namespace": "ml.validate" + }, + "specLocation": "ml/validate/MlValidateJobResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "codegenName": "detector", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "Detector", + "namespace": "ml._types" + } + } }, + "description": "Validates an anomaly detection detector.", "inherits": { "type": { "name": "RequestBase", @@ -114723,37 +133669,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.reset_job" + "namespace": "ml.validate_detector" }, - "path": [ - { - "description": "The ID of the job to reset.", - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Should this request wait until the operation has completed before returning.", - "name": "wait_for_completion", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] + "path": [], + "query": [], + "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L32" }, { "body": { @@ -114769,1858 +133689,1877 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.reset_job" - } + "namespace": "ml.validate_detector" + }, + "specLocation": "ml/validate_detector/MlValidateDetectorResponse.ts#L22-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], + "body": { + "codegenName": "operations", + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "OperationContainer", + "namespace": "_global.bulk" + } + }, + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "monitoring.bulk" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TPartialDocument", + "namespace": "monitoring.bulk" + } + } + ], + "kind": "instance_of", + "type": { + "name": "UpdateAction", + "namespace": "_global.bulk" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "monitoring.bulk" + } + } + ], + "kind": "union_of" + } + } + }, + "description": "Used by the monitoring features to send monitoring data.", + "generics": [ + { + "name": "TDocument", + "namespace": "monitoring.bulk" + }, + { + "name": "TPartialDocument", + "namespace": "monitoring.bulk" + } + ], + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "monitoring.bulk" + }, + "path": [ + { + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "description": "Default document type for items which don't provide one", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "query": [ + { + "description": "Identifier of the monitored system", + "name": "system_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "", + "name": "system_api_version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Collection interval (e.g., '10s' or '10000ms') of the payload", + "name": "interval", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeSpan", + "namespace": "_types" + } + } + } + ], + "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L60" + }, + { "body": { "kind": "properties", "properties": [ { - "name": "delete_intervening_results", + "name": "error", "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + }, + { + "description": "True if there is was an error", + "name": "errors", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Was collection disabled?", + "name": "ignored", + "required": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "took", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } } ] }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "kind": "response", + "name": { + "name": "Response", + "namespace": "monitoring.bulk" + }, + "specLocation": "monitoring/bulk/BulkMonitoringResponse.ts#L23-L32" + }, + { + "kind": "interface", + "name": { + "name": "AdaptiveSelection", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "avg_queue_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "avg_response_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "avg_response_time_ns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "avg_service_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "avg_service_time_ns", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "outgoing_searches", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "rank", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } + ], + "specLocation": "nodes/_types/Stats.ts#L162-L170" + }, + { + "kind": "interface", + "name": { + "name": "Breaker", + "namespace": "nodes._types" }, - "kind": "request", + "properties": [ + { + "name": "estimated_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "estimated_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "limit_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "limit_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "overhead", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "name": "tripped", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L172-L179" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.revert_model_snapshot" + "name": "Cgroup", + "namespace": "nodes._types" }, - "path": [ + "properties": [ + { + "name": "cpuacct", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CpuAcct", + "namespace": "nodes._types" + } + } + }, + { + "name": "cpu", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CgroupCpu", + "namespace": "nodes._types" + } + } + }, + { + "name": "memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CgroupMemory", + "namespace": "nodes._types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L181-L185" + }, + { + "kind": "interface", + "name": { + "name": "CgroupCpu", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "control_group", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "cfs_period_micros", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "cfs_quota_micros", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "stat", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CgroupCpuStat", + "namespace": "nodes._types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L192-L197" + }, + { + "kind": "interface", + "name": { + "name": "CgroupCpuStat", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "number_of_elapsed_periods", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "number_of_times_throttled", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "time_throttled_nanos", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L199-L203" + }, + { + "kind": "interface", + "name": { + "name": "CgroupMemory", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "control_group", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "limit_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "usage_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L205-L209" + }, + { + "kind": "interface", + "name": { + "name": "Client", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "agent", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { - "name": "job_id", - "required": true, + "name": "local_address", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "snapshot_id", - "required": true, + "name": "remote_address", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "name": "delete_intervening_results", + "name": "last_uri", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "model", - "required": true, + }, + { + "name": "opened_time_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ModelSnapshot", - "namespace": "ml._types" - } + "name": "long", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.revert_model_snapshot" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.set_upgrade_mode" - }, - "path": [], - "query": [ + }, { - "name": "enabled", + "name": "closed_time_millis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "timeout", + "name": "last_request_time_millis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.set_upgrade_mode" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.start_data_frame_analytics" - }, - "path": [ + }, { - "name": "id", - "required": true, + "name": "request_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - } - ], - "query": [ + }, { - "description": "Controls the amount of time to wait until the data frame analytics job starts.", - "name": "timeout", + "name": "request_size_bytes", "required": false, - "serverDefault": "20s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.", - "name": "node", - "required": true, + }, + { + "name": "x_opaque_id", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "NodeId", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } } - ] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.start_data_frame_analytics" - } + ], + "specLocation": "nodes/_types/Stats.ts#L265-L277" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "start", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "timeout", - "required": false, - "serverDefault": "20s", - "type": { + "kind": "interface", + "name": { + "name": "ClusterAppliedStats", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "recordings", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "Recording", + "namespace": "nodes._types" } } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", + ], + "specLocation": "nodes/_types/Stats.ts#L83-L85" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.start_datafeed" + "name": "ClusterStateQueue", + "namespace": "nodes._types" }, - "path": [ + "properties": [ { - "name": "datafeed_id", - "required": true, + "name": "total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "start", + "name": "pending", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeIds", - "namespace": "_types" - } - } - }, - { - "name": "started", - "required": true, + }, + { + "name": "committed", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.start_datafeed" - } + } + ], + "specLocation": "nodes/_types/Stats.ts#L107-L111" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.stop_data_frame_analytics" + "name": "ClusterStateUpdate", + "namespace": "nodes._types" }, - "path": [ + "properties": [ { - "description": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", - "name": "id", - "required": true, + "name": "count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_match", + "name": "computation_time", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If true, the data frame analytics job is stopped forcefully.", - "name": "force", + "name": "computation_time_millis", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "description": "Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.", - "name": "timeout", + "name": "publication_time", "required": false, - "serverDefault": "20s", "type": { "kind": "instance_of", "type": { - "name": "Time", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stopped", - "required": true, + }, + { + "name": "publication_time_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.stop_data_frame_analytics" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "force", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "timeout", - "required": false, - "serverDefault": "20s", + }, + { + "name": "context_construction_time", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.stop_datafeed" - }, - "path": [ + }, { - "name": "datafeed_id", - "required": true, + "name": "context_construction_time_millis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "allow_no_match", + "name": "commit_time", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "force", + "name": "commit_time_millis", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stopped", - "required": true, + }, + { + "name": "completion_time", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.stop_datafeed" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "A description of the job.", - "name": "description", - "required": false, + }, + { + "name": "completion_time_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", - "name": "model_memory_limit", - "required": false, + } + }, + { + "name": "master_apply_time", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "description": "The maximum number of threads to be used by the analysis. The default value is 1. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.", - "name": "max_num_threads", - "required": false, + } + }, + { + "name": "master_apply_time_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings", - "name": "allow_lazy_start", - "required": false, - "serverDefault": false, + } + }, + { + "name": "notification_time", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.update_data_frame_analytics" - }, - "path": [ + }, { - "description": "Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", - "name": "id", - "required": true, + "name": "notification_time_millis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } } ], - "query": [] + "specLocation": "nodes/_types/Stats.ts#L119-L135" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "create_time", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } - }, - { - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" - } - } - }, - { - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "dest", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" - } - } - }, - { - "name": "model_memory_limit", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "allow_lazy_start", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "max_num_threads", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "analysis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" - } - } - }, - { - "name": "analyzed_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" - } - } - } - ] - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "ml.update_data_frame_analytics" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "add_items", - "required": false, + "name": "Context", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "context", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "description", - "required": false, + } + }, + { + "name": "compilations", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "remove_items", - "required": false, + } + }, + { + "name": "cache_evictions", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "name": "long", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.update_filter" - }, - "path": [ + }, { - "name": "filter_id", - "required": true, + "name": "compilation_limit_triggered", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } } ], - "query": [] + "specLocation": "nodes/_types/Stats.ts#L389-L394" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "filter_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "items", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - } - ] - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "ml.update_filter" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "allow_lazy_open", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "analysis_limits", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisMemoryLimit", - "namespace": "ml._types" - } - } - }, - { - "description": "Advanced configuration option. The time between each periodic persistence of the model. See Job resources.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html", - "name": "background_persist_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "description": "Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/7.12/ml-configuring-url.html", - "name": "custom_settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "categorization_filters", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "description": "A description of the job. See Job resources.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "model_plot_config", - "required": false, + "name": "Cpu", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "percent", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "daily_model_snapshot_retention_after_days", - "required": false, - "serverDefault": "1", + } + }, + { + "name": "sys", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job.", - "name": "model_snapshot_retention_days", - "required": false, - "serverDefault": "10", + } + }, + { + "name": "sys_in_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen.", - "name": "renormalization_window_days", - "required": false, + } + }, + { + "name": "total", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.", - "name": "results_retention_days", - "required": false, + } + }, + { + "name": "total_in_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "A list of job groups. A job can belong to no groups or many.", - "name": "groups", - "required": false, + } + }, + { + "name": "user", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "name": "string", + "namespace": "_builtins" } - }, - { - "description": "An array of detector update objects.", - "name": "detectors", - "required": false, + } + }, + { + "name": "user_in_millis", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Detector", - "namespace": "ml._types" - } - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "Settings related to how categorization interacts with partition fields.", - "name": "per_partition_categorization", - "required": false, - "type": { + } + }, + { + "name": "load_average", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "PerPartitionCategorization", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "description": "Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.", - "name": "system_annotations_retention_days", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "long", + "name": "double", "namespace": "_types" } } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", + ], + "specLocation": "nodes/_types/Stats.ts#L211-L220" + }, + { + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.update_job" + "name": "CpuAcct", + "namespace": "nodes._types" }, - "path": [ + "properties": [ { - "description": "Identifier for the job", - "name": "job_id", - "required": true, + "name": "control_group", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "usage_nanos", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } } ], - "query": [] + "specLocation": "nodes/_types/Stats.ts#L187-L190" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "allow_lazy_open", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "analysis_config", - "required": true, + "kind": "interface", + "name": { + "name": "DataPathStats", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "available", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "analysis_limits", - "required": true, + } + }, + { + "name": "available_in_bytes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisLimits", - "namespace": "ml._types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "background_persist_interval", - "required": false, + } + }, + { + "name": "disk_queue", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "create_time", - "required": true, + } + }, + { + "name": "disk_reads", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "custom_settings", - "required": false, + } + }, + { + "name": "disk_read_size", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "CustomSettings", - "namespace": "ml._types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "daily_model_snapshot_retention_after_days", - "required": true, + } + }, + { + "name": "disk_read_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "data_description", - "required": true, + } + }, + { + "name": "disk_writes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataDescription", - "namespace": "ml._types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "datafeed_config", - "required": false, + } + }, + { + "name": "disk_write_size", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Datafeed", - "namespace": "ml._types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "description", - "required": false, + } + }, + { + "name": "disk_write_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "groups", - "required": false, + } + }, + { + "name": "free", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "job_id", - "required": true, + } + }, + { + "name": "free_in_bytes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "job_type", - "required": true, + } + }, + { + "name": "mount", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "job_version", - "required": true, + } + }, + { + "name": "path", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "finished_time", - "required": false, + } + }, + { + "name": "total", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "model_plot_config", - "required": false, + } + }, + { + "name": "total_in_bytes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "model_snapshot_id", - "required": false, + } + }, + { + "name": "type", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "name": "model_snapshot_retention_days", - "required": true, + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L222-L239" + }, + { + "kind": "interface", + "name": { + "name": "Discovery", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "cluster_state_queue", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "ClusterStateQueue", + "namespace": "nodes._types" } - }, - { - "name": "renormalization_window_days", - "required": false, + } + }, + { + "name": "published_cluster_states", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "PublishedClusterStates", + "namespace": "nodes._types" } - }, - { - "name": "results_index_name", - "required": true, - "type": { + } + }, + { + "name": "cluster_state_update", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } - } - }, - { - "name": "results_retention_days", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "ClusterStateUpdate", + "namespace": "nodes._types" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.update_job" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "description", - "required": false, + }, + { + "name": "serialized_cluster_states", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "SerializedClusterState", + "namespace": "nodes._types" } - }, - { - "name": "retain", - "required": false, + } + }, + { + "name": "cluster_applier_stats", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } + "name": "ClusterAppliedStats", + "namespace": "nodes._types" } } - ] - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L75-L81" + }, + { "inherits": { "type": { - "name": "RequestBase", - "namespace": "_types" + "name": "MemoryStats", + "namespace": "nodes._types" } }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.update_model_snapshot" + "name": "ExtendedMemoryStats", + "namespace": "nodes._types" }, - "path": [ + "properties": [ { - "name": "job_id", - "required": true, + "name": "free_percent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } }, { - "name": "snapshot_id", - "required": true, + "name": "used_percent", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } } ], - "query": [] + "specLocation": "nodes/_types/Stats.ts#L254-L257" }, { - "body": { - "kind": "properties", - "properties": [ - { - "name": "model", - "required": true, - "type": { + "kind": "interface", + "name": { + "name": "FileSystem", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "data", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "ModelSnapshot", - "namespace": "ml._types" + "name": "DataPathStats", + "namespace": "nodes._types" } } } - ] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + }, + { + "name": "timestamp", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FileSystemTotal", + "namespace": "nodes._types" + } + } + }, + { + "name": "io_stats", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IoStats", + "namespace": "nodes._types" + } + } } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.update_model_snapshot" - } + ], + "specLocation": "nodes/_types/Stats.ts#L279-L284" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", + "kind": "interface", "name": { - "name": "Request", - "namespace": "ml.upgrade_job_snapshot" + "name": "FileSystemTotal", + "namespace": "nodes._types" }, - "path": [ + "properties": [ { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", - "required": true, + "name": "available", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "available_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } }, { - "description": "A numerical character string that uniquely identifies the model snapshot.", - "name": "snapshot_id", - "required": true, + "name": "free", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "free_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } - } - ], - "query": [ + }, { - "description": "When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node.", - "name": "wait_for_completion", + "name": "total", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Controls the time to wait for the request to complete.", - "name": "timeout", + "name": "total_in_bytes", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Time", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L300-L307" }, { - "body": { - "kind": "properties", - "properties": [ - { - "description": "The ID of the assigned node for the upgrade task if it is still running.", - "name": "node", - "required": true, - "type": { + "kind": "interface", + "name": { + "name": "GarbageCollector", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "collectors", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "description": "When true, this means the task is complete. When false, it is still running.", - "name": "completed", - "required": true, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "GarbageCollectorTotal", + "namespace": "nodes._types" } } } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.upgrade_job_snapshot" - } + } + ], + "specLocation": "nodes/_types/Stats.ts#L356-L358" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "value": { - "kind": "instance_of", + "kind": "interface", + "name": { + "name": "GarbageCollectorTotal", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "collection_count", + "required": false, "type": { - "name": "Detector", - "namespace": "ml._types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "collection_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "collection_time_in_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.validate_detector" - }, - "path": [], - "query": [] + ], + "specLocation": "nodes/_types/Stats.ts#L360-L364" }, { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "ml.validate_detector" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "job_id", - "required": false, + "name": "Http", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "current_open", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "name": "analysis_config", - "required": false, + } + }, + { + "name": "total_opened", + "required": false, + "type": { + "kind": "instance_of", "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "clients", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" + "name": "Client", + "namespace": "nodes._types" } } - }, - { - "name": "analysis_limits", - "required": false, + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L259-L263" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressure", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "memory", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisLimits", - "namespace": "ml._types" - } + "name": "IndexingPressureMemory", + "namespace": "nodes._types" } - }, - { - "name": "data_description", - "required": false, + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L54-L56" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressureMemory", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "limit_in_bytes", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataDescription", - "namespace": "ml._types" - } + "name": "long", + "namespace": "_types" } - }, - { - "name": "description", - "required": false, + } + }, + { + "name": "current", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "PressureMemory", + "namespace": "nodes._types" } - }, - { - "name": "model_plot", - "required": false, + } + }, + { + "name": "total", + "required": false, + "type": { + "kind": "instance_of", "type": { + "name": "PressureMemory", + "namespace": "nodes._types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L58-L62" + }, + { + "kind": "interface", + "name": { + "name": "Ingest", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "pipelines", + "required": false, + "type": { + "key": { "kind": "instance_of", "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "model_snapshot_retention_days", - "required": false, - "type": { + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "IngestTotal", + "namespace": "nodes._types" } } - }, - { - "name": "results_index_name", - "required": false, + } + }, + { + "name": "total", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "name": "IngestTotal", + "namespace": "nodes._types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.validate_job" - }, - "path": [], - "query": [] + ], + "specLocation": "nodes/_types/Stats.ts#L137-L140" }, { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", + "kind": "interface", "name": { - "name": "Response", - "namespace": "ml.validate_job" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, + "name": "IngestTotal", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "count", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "long", + "namespace": "_types" } } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "monitoring.bulk" - }, - "path": [ + }, { - "name": "stub_a", - "required": true, + "name": "current", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } - } - ], - "query": [ + }, { - "name": "stub_b", - "required": true, + "name": "failed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "processors", + "required": false, + "type": { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "KeyedProcessor", + "namespace": "nodes._types" + } + } + } + } + }, + { + "name": "time_in_millis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "monitoring.bulk" - } + ], + "specLocation": "nodes/_types/Stats.ts#L142-L148" }, { "kind": "interface", "name": { - "name": "AdaptiveSelection", + "name": "IoStatDevice", "namespace": "nodes._types" }, "properties": [ { - "name": "avg_queue_size", - "required": true, + "name": "device_name", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "avg_response_time", - "required": true, + "name": "operations", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116630,8 +135569,8 @@ } }, { - "name": "avg_response_time_ns", - "required": true, + "name": "read_kilobytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116641,19 +135580,19 @@ } }, { - "name": "avg_service_time", - "required": true, + "name": "read_operations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "avg_service_time_ns", - "required": true, + "name": "write_kilobytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116663,8 +135602,8 @@ } }, { - "name": "outgoing_searches", - "required": true, + "name": "write_operations", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116672,63 +135611,121 @@ "namespace": "_types" } } + } + ], + "specLocation": "nodes/_types/Stats.ts#L291-L298" + }, + { + "kind": "interface", + "name": { + "name": "IoStats", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "devices", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IoStatDevice", + "namespace": "nodes._types" + } + } + } }, { - "name": "rank", - "required": true, + "name": "total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IoStatDevice", + "namespace": "nodes._types" } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L286-L289" }, { "kind": "interface", "name": { - "name": "Breaker", + "name": "Jvm", "namespace": "nodes._types" }, "properties": [ { - "name": "estimated_size", - "required": true, + "name": "buffer_pools", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "NodeBufferPool", + "namespace": "nodes._types" + } + } + } + }, + { + "name": "classes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "JvmClasses", + "namespace": "nodes._types" } } }, { - "name": "estimated_size_in_bytes", - "required": true, + "name": "gc", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "GarbageCollector", + "namespace": "nodes._types" } } }, { - "name": "limit_size", - "required": true, + "name": "mem", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "JvmMemoryStats", + "namespace": "nodes._types" } } }, { - "name": "limit_size_in_bytes", - "required": true, + "name": "threads", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "JvmThreads", + "namespace": "nodes._types" + } + } + }, + { + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116738,60 +135735,82 @@ } }, { - "name": "overhead", - "required": true, + "name": "uptime", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "tripped", - "required": true, + "name": "uptime_in_millis", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L317-L326" }, { "kind": "interface", "name": { - "name": "Cpu", + "name": "JvmClasses", "namespace": "nodes._types" }, "properties": [ { - "name": "percent", - "required": true, + "name": "current_loaded_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "sys", + "name": "total_loaded_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "sys_in_millis", + "name": "total_unloaded_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L350-L354" + }, + { + "kind": "interface", + "name": { + "name": "JvmMemoryStats", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "heap_used_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -116802,18 +135821,18 @@ } }, { - "name": "total", + "name": "heap_used_percent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "total_in_millis", + "name": "heap_committed_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -116824,18 +135843,18 @@ } }, { - "name": "user", + "name": "heap_max_in_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "user_in_millis", + "name": "non_heap_used_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -116846,14 +135865,25 @@ } }, { - "name": "load_average", + "name": "non_heap_committed_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "pools", "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -116861,35 +135891,25 @@ "value": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "Pool", + "namespace": "nodes._types" } } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L328-L336" }, { "kind": "interface", "name": { - "name": "DataPathStats", + "name": "JvmThreads", "namespace": "nodes._types" }, "properties": [ { - "name": "available", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "available_in_bytes", - "required": true, + "name": "count", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116899,19 +135919,8 @@ } }, { - "name": "disk_queue", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "disk_reads", - "required": true, + "name": "peak_count", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116919,32 +135928,52 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L345-L348" + }, + { + "kind": "interface", + "name": { + "name": "KeyedProcessor", + "namespace": "nodes._types" + }, + "properties": [ { - "name": "disk_read_size", - "required": true, + "name": "stats", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Processor", + "namespace": "nodes._types" } } }, { - "name": "disk_read_size_in_bytes", - "required": true, + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L150-L153" + }, + { + "kind": "interface", + "name": { + "name": "MemoryStats", + "namespace": "nodes._types" + }, + "properties": [ { - "name": "disk_writes", - "required": true, + "name": "adjusted_total_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116954,19 +135983,19 @@ } }, { - "name": "disk_write_size", - "required": true, + "name": "resident", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "disk_write_size_in_bytes", - "required": true, + "name": "resident_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116976,19 +136005,19 @@ } }, { - "name": "free", - "required": true, + "name": "share", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "free_in_bytes", - "required": true, + "name": "share_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -116998,41 +136027,41 @@ } }, { - "name": "mount", - "required": true, + "name": "total_virtual", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "path", - "required": true, + "name": "total_virtual_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "total", - "required": true, + "name": "total_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "total_in_bytes", - "required": true, + "name": "free_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117042,198 +136071,225 @@ } }, { - "name": "type", - "required": true, + "name": "used_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L241-L252" }, { - "inherits": { - "type": { - "name": "MemoryStats", - "namespace": "nodes._types" - } - }, "kind": "interface", "name": { - "name": "ExtendedMemoryStats", + "name": "NodeBufferPool", "namespace": "nodes._types" }, "properties": [ { - "name": "free_percent", - "required": true, + "name": "count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "used_percent", - "required": true, + "name": "total_capacity", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "total_in_bytes", - "required": true, + "name": "total_capacity_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "free_in_bytes", - "required": true, + "name": "used", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "name": "used_in_bytes", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L309-L315" }, { "kind": "interface", "name": { - "name": "FileSystem", + "name": "NodeReloadError", "namespace": "nodes._types" }, "properties": [ { - "name": "data", + "name": "name", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataPathStats", - "namespace": "nodes._types" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "name": "timestamp", - "required": true, + "name": "reload_exception", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ErrorCause", "namespace": "_types" } } - }, - { - "name": "total", - "required": true, - "type": { + } + ], + "specLocation": "nodes/_types/NodeReloadResult.ts#L24-L27" + }, + { + "codegenNames": [ + "stats", + "error" + ], + "kind": "type_alias", + "name": { + "name": "NodeReloadResult", + "namespace": "nodes._types" + }, + "specLocation": "nodes/_types/NodeReloadResult.ts#L29-L30", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "FileSystemTotal", + "name": "Stats", + "namespace": "nodes._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NodeReloadError", "namespace": "nodes._types" } } - } - ] + ], + "kind": "union_of" + } }, { "kind": "interface", "name": { - "name": "FileSystemTotal", + "name": "NodesResponseBase", "namespace": "nodes._types" }, "properties": [ { - "name": "available", - "required": true, + "codegenName": "node_stats", + "description": "Contains statistics about the number of nodes selected by the request’s node filters.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "name": "_nodes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodeStatistics", + "namespace": "_types" } } - }, + } + ], + "specLocation": "nodes/_types/NodesResponseBase.ts#L22-L29" + }, + { + "kind": "interface", + "name": { + "name": "OperatingSystem", + "namespace": "nodes._types" + }, + "properties": [ { - "name": "available_in_bytes", - "required": true, + "name": "cpu", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Cpu", + "namespace": "nodes._types" } } }, { - "name": "free", - "required": true, + "name": "mem", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ExtendedMemoryStats", + "namespace": "nodes._types" } } }, { - "name": "free_in_bytes", - "required": true, + "name": "swap", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "MemoryStats", + "namespace": "nodes._types" } } }, { - "name": "total", - "required": true, + "name": "cgroup", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Cgroup", + "namespace": "nodes._types" } } }, { - "name": "total_in_bytes", - "required": true, + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117242,49 +136298,30 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L366-L372" }, { "kind": "interface", "name": { - "name": "GarbageCollector", + "name": "Pool", "namespace": "nodes._types" }, "properties": [ { - "name": "collectors", - "required": true, + "name": "used_in_bytes", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "GarbageCollectorTotal", - "namespace": "nodes._types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "GarbageCollectorTotal", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "name": "collection_count", - "required": true, + "name": "max_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117294,19 +136331,19 @@ } }, { - "name": "collection_time", - "required": true, + "name": "peak_used_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "collection_time_in_millis", - "required": true, + "name": "peak_max_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117315,29 +136352,30 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L338-L343" }, { "kind": "interface", "name": { - "name": "Http", + "name": "PressureMemory", "namespace": "nodes._types" }, "properties": [ { - "name": "current_open", - "required": true, + "name": "combined_coordinating_and_primary_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "total_opened", - "required": true, + "name": "coordinating_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117345,61 +136383,21 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Ingest", - "namespace": "nodes._types" - }, - "properties": [ - { - "name": "pipelines", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IngestTotal", - "namespace": "nodes._types" - } - } - } }, { - "name": "total", - "required": true, + "name": "primary_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IngestTotal", - "namespace": "nodes._types" + "name": "long", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "IngestTotal", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "name": "count", - "required": true, + "name": "replica_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117409,8 +136407,8 @@ } }, { - "name": "current", - "required": true, + "name": "all_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117420,8 +136418,8 @@ } }, { - "name": "failed", - "required": true, + "name": "coordinating_rejections", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117431,22 +136429,19 @@ } }, { - "name": "processors", - "required": true, + "name": "primary_rejections", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "KeyedProcessor", - "namespace": "nodes._types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "time_in_millis", - "required": true, + "name": "replica_rejections", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117455,84 +136450,95 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L64-L73" }, { "kind": "interface", "name": { - "name": "Jvm", + "name": "Process", "namespace": "nodes._types" }, "properties": [ { - "name": "buffer_pools", - "required": true, + "name": "cpu", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeBufferPool", - "namespace": "nodes._types" - } + "kind": "instance_of", + "type": { + "name": "Cpu", + "namespace": "nodes._types" } } }, { - "name": "classes", - "required": true, + "name": "mem", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "JvmClasses", + "name": "MemoryStats", "namespace": "nodes._types" } } }, { - "name": "gc", - "required": true, + "name": "open_file_descriptors", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "GarbageCollector", - "namespace": "nodes._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "mem", - "required": true, + "name": "max_file_descriptors", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "MemoryStats", - "namespace": "nodes._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "threads", - "required": true, + "name": "timestamp", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "JvmThreads", - "namespace": "nodes._types" + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L374-L380" + }, + { + "kind": "interface", + "name": { + "name": "Processor", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "timestamp", - "required": true, + "name": "current", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117542,19 +136548,19 @@ } }, { - "name": "uptime", - "required": true, + "name": "failed", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "uptime_in_millis", - "required": true, + "name": "time_in_millis", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117563,18 +136569,19 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L155-L160" }, { "kind": "interface", "name": { - "name": "JvmClasses", + "name": "PublishedClusterStates", "namespace": "nodes._types" }, "properties": [ { - "name": "current_loaded_count", - "required": true, + "name": "full_states", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117584,8 +136591,8 @@ } }, { - "name": "total_loaded_count", - "required": true, + "name": "incompatible_diffs", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117595,8 +136602,8 @@ } }, { - "name": "total_unloaded_count", - "required": true, + "name": "compatible_diffs", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117605,18 +136612,30 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L113-L117" }, { "kind": "interface", "name": { - "name": "JvmThreads", + "name": "Recording", "namespace": "nodes._types" }, "properties": [ { - "name": "count", - "required": true, + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "cumulative_execution_count", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117626,8 +136645,19 @@ } }, { - "name": "peak_count", - "required": true, + "name": "cumulative_execution_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "cumulative_execution_time_millis", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117636,81 +136666,182 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L87-L92" }, { "kind": "interface", "name": { - "name": "KeyedProcessor", + "name": "RepositoryLocation", "namespace": "nodes._types" }, "properties": [ { - "name": "statistics", + "name": "base_path", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Process", - "namespace": "nodes._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, + "description": "Container name (Azure)", + "name": "container", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Bucket name (GCP, S3)", + "name": "bucket", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/_types/RepositoryMeteringInformation.ts#L68-L74" }, { "kind": "interface", "name": { - "name": "MemoryStats", + "name": "RepositoryMeteringInformation", "namespace": "nodes._types" }, "properties": [ { - "name": "resident", - "required": false, + "description": "Repository name.", + "name": "repository_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "description": "Repository type.", + "name": "repository_type", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "resident_in_bytes", + "description": "Represents an unique location within the repository.", + "name": "repository_location", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RepositoryLocation", + "namespace": "nodes._types" + } + } + }, + { + "description": "An identifier that changes every time the repository is updated.", + "name": "repository_ephemeral_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch.", + "name": "repository_started_at", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "description": "Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch.", + "name": "repository_stopped_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "EpochMillis", "namespace": "_types" } } }, { - "name": "share", + "description": "A flag that tells whether or not this object has been archived. When a repository is closed or updated the\nrepository metering information is archived and kept for a certain period of time. This allows retrieving the\nrepository metering information of previous repository instantiations.", + "name": "archived", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The cluster state version when this object was archived, this field can be used as a logical timestamp to delete\nall the archived metrics up to an observed version. This field is only present for archived repository metering\ninformation objects. The main purpose of this field is to avoid possible race conditions during repository metering\ninformation deletions, i.e. deleting archived repositories metering information that we haven’t observed yet.", + "name": "cluster_version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "name": "share_in_bytes", + "description": "An object with the number of request performed against the repository grouped by request type.", + "name": "request_counts", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RequestCounts", + "namespace": "nodes._types" + } + } + } + ], + "specLocation": "nodes/_types/RepositoryMeteringInformation.ts#L24-L66" + }, + { + "kind": "interface", + "name": { + "name": "RequestCounts", + "namespace": "nodes._types" + }, + "properties": [ + { + "description": "Number of Get Blob Properties requests (Azure)", + "name": "GetBlobProperties", "required": false, "type": { "kind": "instance_of", @@ -117721,18 +136852,20 @@ } }, { - "name": "total_virtual", + "description": "Number of Get Blob requests (Azure)", + "name": "GetBlob", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "total_virtual_in_bytes", + "description": "Number of List Blobs requests (Azure)", + "name": "ListBlobs", "required": false, "type": { "kind": "instance_of", @@ -117743,8 +136876,9 @@ } }, { - "name": "total_in_bytes", - "required": true, + "description": "Number of Put Blob requests (Azure)", + "name": "PutBlob", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117754,8 +136888,9 @@ } }, { - "name": "free_in_bytes", - "required": true, + "description": "Number of Put Block (Azure)", + "name": "PutBlock", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117765,8 +136900,9 @@ } }, { - "name": "used_in_bytes", - "required": true, + "description": "Number of Put Block List requests", + "name": "PutBlockList", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117774,19 +136910,11 @@ "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "NodeBufferPool", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "name": "count", - "required": true, + "description": "Number of get object requests (GCP, S3)", + "name": "GetObject", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117796,19 +136924,21 @@ } }, { - "name": "total_capacity", - "required": true, + "description": "Number of list objects requests (GCP, S3)", + "name": "ListObjects", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "total_capacity_in_bytes", - "required": true, + "description": "Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads\ncan perform multiple http requests to insert a single object but they are considered as a single request\nsince they are billed as an individual operation. (GCP)", + "name": "InsertObject", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117818,19 +136948,21 @@ } }, { - "name": "used", - "required": true, + "description": "Number of PutObject requests (S3)", + "name": "PutObject", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } }, { - "name": "used_in_bytes", - "required": true, + "description": "Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)", + "name": "PutMultipartObject", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117839,147 +136971,184 @@ } } } - ] + ], + "specLocation": "nodes/_types/RepositoryMeteringInformation.ts#L76-L103" }, { "kind": "interface", "name": { - "name": "NodesResponseBase", + "name": "ScriptCache", "namespace": "nodes._types" }, "properties": [ { - "description": "Contains statistics about the number of nodes selected by the request’s node filters.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", - "identifier": "node_stats", - "name": "_nodes", - "required": true, + "name": "cache_evictions", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeStatistics", + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "compilation_limit_triggered", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } + }, + { + "name": "compilations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "context", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L405-L410" }, { "kind": "interface", "name": { - "name": "OperatingSystem", + "name": "Scripting", "namespace": "nodes._types" }, "properties": [ { - "name": "cpu", - "required": true, + "name": "cache_evictions", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Cpu", - "namespace": "nodes._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "mem", - "required": true, + "name": "compilations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ExtendedMemoryStats", - "namespace": "nodes._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "swap", - "required": true, + "name": "compilation_limit_triggered", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "MemoryStats", - "namespace": "nodes._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "timestamp", - "required": true, + "name": "contexts", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Context", + "namespace": "nodes._types" + } } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L382-L387" }, { "kind": "interface", "name": { - "name": "Process", + "name": "SerializedClusterState", "namespace": "nodes._types" }, "properties": [ { - "name": "cpu", - "required": true, + "name": "full_states", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Cpu", + "name": "SerializedClusterStateDetail", "namespace": "nodes._types" } } }, { - "name": "mem", - "required": true, + "name": "diffs", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "MemoryStats", + "name": "SerializedClusterStateDetail", "namespace": "nodes._types" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L94-L97" + }, + { + "kind": "interface", + "name": { + "name": "SerializedClusterStateDetail", + "namespace": "nodes._types" + }, + "properties": [ { - "name": "open_file_descriptors", - "required": true, + "name": "count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "timestamp", - "required": true, + "name": "uncompressed_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Scripting", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "name": "cache_evictions", - "required": true, + "name": "uncompressed_size_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117989,8 +137158,19 @@ } }, { - "name": "compilations", - "required": true, + "name": "compressed_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "compressed_size_in_bytes", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117999,7 +137179,8 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L99-L105" }, { "kind": "interface", @@ -118010,13 +137191,13 @@ "properties": [ { "name": "adaptive_selection", - "required": true, + "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -118032,13 +137213,13 @@ }, { "name": "breakers", - "required": true, + "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -118054,7 +137235,7 @@ }, { "name": "fs", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118065,7 +137246,7 @@ }, { "name": "host", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118076,7 +137257,7 @@ }, { "name": "http", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118085,20 +137266,9 @@ } } }, - { - "name": "indices", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexStats", - "namespace": "indices.stats" - } - } - }, { "name": "ingest", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118109,7 +137279,7 @@ }, { "name": "ip", - "required": true, + "required": false, "type": { "items": [ { @@ -118135,7 +137305,7 @@ }, { "name": "jvm", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118146,7 +137316,7 @@ }, { "name": "name", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118157,7 +137327,7 @@ }, { "name": "os", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118168,7 +137338,7 @@ }, { "name": "process", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118179,7 +137349,7 @@ }, { "name": "roles", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118190,7 +137360,7 @@ }, { "name": "script", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118199,15 +137369,52 @@ } } }, + { + "name": "script_cache", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ScriptCache", + "namespace": "nodes._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptCache", + "namespace": "nodes._types" + } + } + } + ], + "kind": "union_of" + } + } + }, { "name": "thread_pool", - "required": true, + "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -118223,7 +137430,7 @@ }, { "name": "timestamp", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118234,7 +137441,7 @@ }, { "name": "transport", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118245,7 +137452,7 @@ }, { "name": "transport_address", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118256,7 +137463,7 @@ }, { "name": "attributes", - "required": true, + "required": false, "type": { "key": { "kind": "instance_of", @@ -118271,12 +137478,46 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } + }, + { + "name": "discovery", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Discovery", + "namespace": "nodes._types" + } + } + }, + { + "name": "indexing_pressure", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexingPressure", + "namespace": "nodes._types" + } + } + }, + { + "name": "indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ShardStats", + "namespace": "indices.stats" + } + } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L29-L52" }, { "kind": "interface", @@ -118287,7 +137528,7 @@ "properties": [ { "name": "active", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118298,7 +137539,7 @@ }, { "name": "completed", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118309,7 +137550,7 @@ }, { "name": "largest", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118320,7 +137561,7 @@ }, { "name": "queue", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118331,7 +137572,7 @@ }, { "name": "rejected", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118342,7 +137583,7 @@ }, { "name": "threads", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118351,7 +137592,8 @@ } } } - ] + ], + "specLocation": "nodes/_types/Stats.ts#L396-L403" }, { "kind": "interface", @@ -118360,9 +137602,37 @@ "namespace": "nodes._types" }, "properties": [ + { + "name": "inbound_handling_time_histogram", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TransportHistogram", + "namespace": "nodes._types" + } + } + } + }, + { + "name": "outbound_handling_time_histogram", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TransportHistogram", + "namespace": "nodes._types" + } + } + } + }, { "name": "rx_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118373,18 +137643,18 @@ }, { "name": "rx_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "rx_size_in_bytes", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118395,7 +137665,7 @@ }, { "name": "server_open", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118406,7 +137676,7 @@ }, { "name": "tx_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -118417,17 +137687,118 @@ }, { "name": "tx_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "tx_size_in_bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "total_outbound_connections", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L412-L423" + }, + { + "kind": "interface", + "name": { + "name": "TransportHistogram", + "namespace": "nodes._types" + }, + "properties": [ + { + "name": "count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "lt_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "ge_millis", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L425-L429" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "You can use this API to clear the archived repositories metering information in the cluster.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "nodes.clear_repositories_metering_archive" + }, + "path": [ + { + "description": "Comma-separated list of node IDs or names used to limit returned information.\nAll the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).", + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeIds", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive.", + "name": "max_archive_version", "required": true, "type": { "kind": "instance_of", @@ -118437,7 +137808,153 @@ } } } - ] + ], + "query": [], + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).", + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "description": "Contains repositories metering information for the nodes selected by the request.", + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RepositoryMeteringInformation", + "namespace": "nodes._types" + } + } + } + } + ] + }, + "inherits": { + "type": { + "name": "NodesResponseBase", + "namespace": "nodes._types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "nodes.clear_repositories_metering_archive" + }, + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L26-L37" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.\nThis API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the\ninformation needed to compute aggregations over a period of time. Additionally, the information exposed by this\nAPI is volatile, meaning that it won’t be present after node restarts.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "nodes.get_repositories_metering_info" + }, + "path": [ + { + "description": "Comma-separated list of node IDs or names used to limit returned information.\nAll the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).", + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeIds", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L41" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).", + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "description": "Contains repositories metering information for the nodes selected by the request.", + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RepositoryMeteringInformation", + "namespace": "nodes._types" + } + } + } + } + ] + }, + "inherits": { + "type": { + "name": "NodesResponseBase", + "namespace": "nodes._types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "nodes.get_repositories_metering_info" + }, + "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts#L26-L37" }, { "kind": "interface", @@ -118491,12 +138008,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "nodes/hot_threads/types.ts#L23-L28" }, { "attachedBehaviors": [ @@ -118505,6 +138023,7 @@ "body": { "kind": "no_body" }, + "description": "This API yields a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of each node’s top hot threads.", "inherits": { "type": { "name": "RequestBase", @@ -118518,6 +138037,7 @@ }, "path": [ { + "description": "List of node IDs or names used to limit returned information.", "name": "node_id", "required": false, "type": { @@ -118531,19 +138051,23 @@ ], "query": [ { + "description": "If true, known idle threads (e.g. waiting in a socket select, or to get\na task from an empty queue) are filtered out.", "name": "ignore_idle_threads", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "The interval to do the second sampling of threads.", "name": "interval", "required": false, + "serverDefault": "500ms", "type": { "kind": "instance_of", "type": { @@ -118553,8 +138077,10 @@ } }, { + "description": "Number of samples of thread stacktrace.", "name": "snapshots", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { @@ -118564,30 +138090,36 @@ } }, { - "name": "threads", + "description": "Period to wait for a connection to the master node. If no response\nis received before the timeout expires, the request fails and\nreturns an error.", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Time", "namespace": "_types" } } }, { - "name": "thread_type", + "description": "Specifies the number of hot threads to provide information for.", + "name": "threads", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "ThreadType", + "name": "long", "namespace": "_types" } } }, { + "description": "Period to wait for a response. If no response is received\nbefore the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -118595,8 +138127,22 @@ "namespace": "_types" } } + }, + { + "description": "The type to sample.", + "name": "type", + "required": false, + "serverDefault": "cpu", + "type": { + "kind": "instance_of", + "type": { + "name": "ThreadType", + "namespace": "_types" + } + } } - ] + ], + "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L81" }, { "body": { @@ -118622,7 +138168,41 @@ "name": { "name": "Response", "namespace": "nodes.hot_threads" - } + }, + "specLocation": "nodes/hot_threads/NodesHotThreadsResponse.ts#L22-L24" + }, + { + "kind": "interface", + "name": { + "name": "DeprecationIndexing", + "namespace": "nodes.info" + }, + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "nodes/info/types.ts#L142-L144" }, { "kind": "interface", @@ -118639,7 +138219,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -118648,7 +138228,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -118660,7 +138240,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -118672,7 +138252,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -118683,7 +138263,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -118822,7 +138402,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -118929,7 +138509,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -118943,7 +138523,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L32-L68" }, { "kind": "interface", @@ -118959,11 +138540,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L179-L181" }, { "kind": "interface", @@ -118981,12 +138563,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "nodes/info/types.ts#L230-L232" }, { "kind": "interface", @@ -119002,11 +138585,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L199-L201" }, { "kind": "interface", @@ -119022,13 +138606,37 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L183-L185" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], "kind": "interface", "name": { "name": "NodeInfoDiscover", @@ -119037,16 +138645,45 @@ "properties": [ { "name": "seed_hosts", - "required": true, + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "seed_providers", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - ] + ], + "specLocation": "nodes/info/types.ts#L171-L177" }, { "kind": "interface", @@ -119064,7 +138701,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -119098,11 +138735,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L301-L306" }, { "kind": "interface", @@ -119125,7 +138763,50 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L222-L224" + }, + { + "kind": "interface", + "name": { + "name": "NodeInfoIngestDownloader", + "namespace": "nodes.info" + }, + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "nodes/info/types.ts#L129-L131" + }, + { + "kind": "interface", + "name": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + }, + "properties": [ + { + "name": "downloader", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestDownloader", + "namespace": "nodes.info" + } + } + } + ], + "specLocation": "nodes/info/types.ts#L125-L127" }, { "kind": "interface", @@ -119141,11 +138822,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L226-L228" }, { "kind": "interface", @@ -119264,7 +138946,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L308-L319" }, { "kind": "interface", @@ -119280,7 +138963,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119295,7 +138978,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L321-L324" }, { "kind": "interface", @@ -119326,7 +139010,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L326-L329" }, { "kind": "interface", @@ -119342,7 +139027,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119353,7 +139038,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119368,7 +139053,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L331-L335" }, { "kind": "interface", @@ -119384,7 +139070,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119428,7 +139114,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119461,11 +139147,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L337-L346" }, { "kind": "interface", @@ -119476,36 +139163,36 @@ "properties": [ { "name": "logs", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "home", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "repo", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -119519,12 +139206,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "nodes/info/types.ts#L156-L161" }, { "kind": "interface", @@ -119544,7 +139232,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L163-L165" }, { "kind": "interface", @@ -119560,11 +139249,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L167-L169" }, { "kind": "interface", @@ -119580,7 +139270,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119591,11 +139281,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L279-L282" }, { "kind": "interface", @@ -119615,7 +139306,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L284-L286" }, { "kind": "interface", @@ -119631,11 +139323,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L288-L290" }, { "kind": "interface", @@ -119668,7 +139361,7 @@ }, { "name": "path", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -119797,8 +139490,20 @@ "namespace": "nodes.info" } } + }, + { + "name": "ingest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoSettingsIngest", + "namespace": "nodes.info" + } + } } - ] + ], + "specLocation": "nodes/info/types.ts#L70-L86" }, { "kind": "interface", @@ -119843,15 +139548,31 @@ { "name": "initial_master_nodes", "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "deprecation_indexing", + "required": false, + "since": "7.16.0", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "DeprecationIndexing", + "namespace": "nodes.info" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L133-L140" }, { "kind": "interface", @@ -119871,7 +139592,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L146-L148" }, { "kind": "interface", @@ -119884,23 +139606,11 @@ "name": "type", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NodeInfoSettingsHttpType", - "namespace": "nodes.info" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "NodeInfoSettingsHttpType", + "namespace": "nodes.info" + } } }, { @@ -119910,7 +139620,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -119923,14 +139633,14 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -119953,14 +139663,15 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], "kind": "union_of" } } - ] + ], + "specLocation": "nodes/info/types.ts#L187-L192" }, { "kind": "interface", @@ -119976,11 +139687,397 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + ], + "shortcutProperty": "default", + "specLocation": "nodes/info/types.ts#L194-L197" + }, + { + "kind": "interface", + "name": { + "name": "NodeInfoSettingsIngest", + "namespace": "nodes.info" + }, + "properties": [ + { + "name": "attachment", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "append", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "csv", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "convert", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "date", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "date_index_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "dot_expander", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "enrich", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "fail", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "foreach", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "json", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "user_agent", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "kv", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "geoip", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "grok", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "gsub", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "join", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "lowercase", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "remove", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "rename", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "set", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "sort", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "split", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "trim", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "uppercase", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "urldecode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "dissect", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "set_security_user", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "drop", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "circle", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" + } + } + }, + { + "name": "inference", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeInfoIngestInfo", + "namespace": "nodes.info" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L88-L123" }, { "kind": "interface", @@ -120000,7 +140097,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L218-L220" }, { "kind": "interface", @@ -120028,7 +140126,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120045,11 +140143,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L150-L154" }, { "kind": "interface", @@ -120062,23 +140161,11 @@ "name": "type", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NodeInfoSettingsTransportType", - "namespace": "nodes.info" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "NodeInfoSettingsTransportType", + "namespace": "nodes.info" + } } }, { @@ -120088,7 +140175,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120103,7 +140190,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L203-L207" }, { "kind": "interface", @@ -120119,11 +140207,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L214-L216" }, { "kind": "interface", @@ -120139,11 +140228,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "shortcutProperty": "default", + "specLocation": "nodes/info/types.ts#L209-L212" }, { "kind": "interface", @@ -120161,7 +140252,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -120173,7 +140264,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120185,7 +140276,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120194,12 +140285,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "nodes/info/types.ts#L348-L352" }, { "kind": "interface", @@ -120238,7 +140330,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120248,7 +140340,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L234-L238" }, { "kind": "interface", @@ -120268,7 +140361,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L271-L273" }, { "kind": "interface", @@ -120284,11 +140378,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L275-L277" }, { "kind": "interface", @@ -120315,13 +140410,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "transport", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -120341,7 +140436,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L240-L245" }, { "kind": "interface", @@ -120372,7 +140468,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L251-L254" }, { "kind": "interface", @@ -120389,7 +140486,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120411,7 +140508,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120433,7 +140530,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120447,7 +140544,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L256-L260" }, { "kind": "interface", @@ -120463,7 +140561,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120474,11 +140572,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L266-L269" }, { "kind": "interface", @@ -120494,11 +140593,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L262-L264" }, { "kind": "interface", @@ -120515,7 +140615,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -120524,12 +140624,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "nodes/info/types.ts#L247-L249" }, { "kind": "interface", @@ -120547,7 +140648,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -120572,7 +140673,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -120628,7 +140729,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120650,7 +140751,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120661,7 +140762,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120674,14 +140775,14 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -120697,12 +140798,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "nodes/info/types.ts#L354-L368" }, { "kind": "interface", @@ -120719,7 +140821,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120827,7 +140929,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L370-L387" }, { "kind": "interface", @@ -120856,7 +140959,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120872,7 +140975,8 @@ } } } - ] + ], + "specLocation": "nodes/info/types.ts#L389-L396" }, { "kind": "interface", @@ -120899,7 +141003,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -120943,11 +141047,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/info/types.ts#L292-L299" }, { "attachedBehaviors": [ @@ -120956,6 +141061,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about nodes in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -121003,7 +141109,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -121033,7 +141139,8 @@ } } } - ] + ], + "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L53" }, { "body": { @@ -121058,7 +141165,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -121084,80 +141191,8 @@ "name": { "name": "Response", "namespace": "nodes.info" - } - }, - { - "kind": "interface", - "name": { - "name": "NodeReloadException", - "namespace": "nodes.reload_secure_settings" }, - "properties": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "reload_exception", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeReloadExceptionCausedBy", - "namespace": "nodes.reload_secure_settings" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "NodeReloadExceptionCausedBy", - "namespace": "nodes.reload_secure_settings" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "reason", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "caused_by", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeReloadExceptionCausedBy", - "namespace": "nodes.reload_secure_settings" - } - } - } - ] + "specLocation": "nodes/info/NodesInfoResponse.ts#L25-L30" }, { "attachedBehaviors": [ @@ -121179,6 +141214,7 @@ } ] }, + "description": "Reloads secure settings.", "inherits": { "type": { "name": "RequestBase", @@ -121192,6 +141228,7 @@ }, "path": [ { + "description": "A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", "name": "node_id", "required": false, "type": { @@ -121205,6 +141242,7 @@ ], "query": [ { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -121215,7 +141253,8 @@ } } } - ] + ], + "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L39" }, { "body": { @@ -121240,29 +141279,17 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Stats", - "namespace": "nodes._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NodeReloadException", - "namespace": "nodes.reload_secure_settings" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "NodeReloadResult", + "namespace": "nodes._types" + } } } } @@ -121278,7 +141305,8 @@ "name": { "name": "Response", "namespace": "nodes.reload_secure_settings" - } + }, + "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsResponse.ts#L25-L30" }, { "attachedBehaviors": [ @@ -121287,6 +141315,7 @@ "body": { "kind": "no_body" }, + "description": "Returns statistical information about nodes in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -121312,6 +141341,7 @@ } }, { + "description": "Limit the information returned to the specified metrics", "name": "metric", "required": false, "type": { @@ -121380,7 +141410,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -121393,7 +141423,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -121445,23 +141475,25 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory", "name": "include_unloaded_segments", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L68" }, { "body": { @@ -121469,7 +141501,7 @@ "properties": [ { "name": "cluster_name", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -121486,7 +141518,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -121512,7 +141544,8 @@ "name": { "name": "Response", "namespace": "nodes.stats" - } + }, + "specLocation": "nodes/stats/NodesStatsResponse.ts#L25-L30" }, { "kind": "interface", @@ -121529,7 +141562,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -121573,7 +141606,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -121583,7 +141616,8 @@ } } } - ] + ], + "specLocation": "nodes/usage/types.ts#L25-L30" }, { "attachedBehaviors": [ @@ -121592,6 +141626,7 @@ "body": { "kind": "no_body" }, + "description": "Returns low-level information about REST actions usage on nodes.", "inherits": { "type": { "name": "RequestBase", @@ -121605,6 +141640,7 @@ }, "path": [ { + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", "name": "node_id", "required": false, "type": { @@ -121616,6 +141652,7 @@ } }, { + "description": "Limit the information returned to the specified metrics", "name": "metric", "required": false, "type": { @@ -121629,6 +141666,7 @@ ], "query": [ { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -121639,7 +141677,8 @@ } } } - ] + ], + "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L37" }, { "body": { @@ -121653,450 +141692,27 @@ "type": { "name": "Name", "namespace": "_types" - } - } - }, - { - "name": "nodes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeUsage", - "namespace": "nodes.usage" - } - } - } - } - ] - }, - "inherits": { - "type": { - "name": "NodesResponseBase", - "namespace": "nodes._types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "nodes.usage" - } - }, - { - "kind": "interface", - "name": { - "name": "DateHistogramGrouping", - "namespace": "rollup._types" - }, - "properties": [ - { - "name": "delay", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "calendar_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "fixed_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "time_zone", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "FieldMetric", - "namespace": "rollup._types" - }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "metrics", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Metric", - "namespace": "rollup._types" - } - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Groupings", - "namespace": "rollup._types" - }, - "properties": [ - { - "name": "date_histogram", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateHistogramGrouping", - "namespace": "rollup._types" - } - } - }, - { - "name": "histogram", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "HistogramGrouping", - "namespace": "rollup._types" - } - } - }, - { - "name": "terms", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TermsGrouping", - "namespace": "rollup._types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "HistogramGrouping", - "namespace": "rollup._types" - }, - "properties": [ - { - "name": "fields", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "name": "interval", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "min" - }, - { - "name": "max" - }, - { - "name": "sum" - }, - { - "name": "avg" - }, - { - "name": "value_count" - } - ], - "name": { - "name": "Metric", - "namespace": "rollup._types" - } - }, - { - "kind": "interface", - "name": { - "name": "TermsGrouping", - "namespace": "rollup._types" - }, - "properties": [ - { - "name": "fields", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "cron", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "groups", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Groupings", - "namespace": "rollup._types" - } - } - }, - { - "name": "index_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "metrics", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldMetric", - "namespace": "rollup._types" - } - } - } - }, - { - "name": "page_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "rollup_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "rollup.create_rollup_job" - }, - "path": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [] - }, - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "rollup.create_rollup_job" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "rollup.delete_rollup_job" - }, - "path": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ + } + } + }, { - "name": "task_failures", - "required": false, + "name": "nodes", + "required": true, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "TaskFailure", - "namespace": "rollup.delete_rollup_job" + "name": "NodeUsage", + "namespace": "nodes.usage" } } } @@ -122105,282 +141721,259 @@ }, "inherits": { "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "NodesResponseBase", + "namespace": "nodes._types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "rollup.delete_rollup_job" - } + "namespace": "nodes.usage" + }, + "specLocation": "nodes/usage/NodesUsageResponse.ts#L25-L30" }, { "kind": "interface", "name": { - "name": "TaskFailure", - "namespace": "rollup.delete_rollup_job" + "name": "DateHistogramGrouping", + "namespace": "rollup._types" }, "properties": [ { - "name": "task_id", - "required": true, + "name": "delay", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TaskId", + "name": "Time", "namespace": "_types" } } }, { - "name": "node_id", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } }, { - "name": "status", - "required": true, + "name": "format", + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "reason", - "required": true, + "name": "interval", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TaskFailureReason", - "namespace": "rollup.delete_rollup_job" + "name": "Time", + "namespace": "_types" } } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "TaskFailureReason", - "namespace": "rollup.delete_rollup_job" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "calendar_interval", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } }, { - "name": "reason", - "required": true, + "name": "fixed_interval", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Time", + "namespace": "_types" } } - } - ] - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "rollup.get_rollup_capabilities" - }, - "path": [ + }, { - "name": "id", + "name": "time_zone", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "query": [] + "specLocation": "rollup/_types/Groupings.ts#L30-L38" }, { - "body": { - "kind": "properties", - "properties": [] + "kind": "interface", + "name": { + "name": "FieldMetric", + "namespace": "rollup._types" }, - "inherits": { - "generics": [ - { + "properties": [ + { + "name": "field", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Field", "namespace": "_types" } - }, - { - "kind": "instance_of", - "type": { - "name": "RollupCapabilities", - "namespace": "rollup.get_rollup_capabilities" - } } - ], - "type": { - "name": "DictionaryResponseBase", - "namespace": "_types" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "rollup.get_rollup_capabilities" - } - }, - { - "kind": "interface", - "name": { - "name": "RollupCapabilities", - "namespace": "rollup.get_rollup_capabilities" - }, - "properties": [ + }, { - "name": "rollup_jobs", + "name": "metrics", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "RollupCapabilitySummary", - "namespace": "rollup.get_rollup_capabilities" + "name": "Metric", + "namespace": "rollup._types" } } } } - ] + ], + "specLocation": "rollup/_types/Metric.ts#L30-L33" }, { "kind": "interface", "name": { - "name": "RollupCapabilitySummary", - "namespace": "rollup.get_rollup_capabilities" + "name": "Groupings", + "namespace": "rollup._types" }, "properties": [ { - "name": "fields", - "required": true, + "name": "date_histogram", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + "kind": "instance_of", + "type": { + "name": "DateHistogramGrouping", + "namespace": "rollup._types" } } }, { - "name": "index_pattern", - "required": true, + "name": "histogram", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "HistogramGrouping", + "namespace": "rollup._types" } } }, { - "name": "job_id", + "name": "terms", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermsGrouping", + "namespace": "rollup._types" + } + } + } + ], + "specLocation": "rollup/_types/Groupings.ts#L24-L28" + }, + { + "kind": "interface", + "name": { + "name": "HistogramGrouping", + "namespace": "rollup._types" + }, + "properties": [ + { + "name": "fields", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Fields", + "namespace": "_types" } } }, { - "name": "rollup_index", + "name": "interval", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "long", + "namespace": "_types" } } } - ] + ], + "specLocation": "rollup/_types/Groupings.ts#L44-L47" + }, + { + "kind": "enum", + "members": [ + { + "name": "min" + }, + { + "name": "max" + }, + { + "name": "sum" + }, + { + "name": "avg" + }, + { + "name": "value_count" + } + ], + "name": { + "name": "Metric", + "namespace": "rollup._types" + }, + "specLocation": "rollup/_types/Metric.ts#L22-L28" }, { "kind": "interface", "name": { - "name": "IndexCapabilities", - "namespace": "rollup.get_rollup_index_capabilities" + "name": "TermsGrouping", + "namespace": "rollup._types" }, "properties": [ { - "name": "rollup_jobs", + "name": "fields", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RollupJobSummary", - "namespace": "rollup.get_rollup_index_capabilities" - } + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" } } } - ] + ], + "specLocation": "rollup/_types/Groupings.ts#L40-L42" }, { "attachedBehaviors": [ @@ -122389,6 +141982,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes an existing rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -122398,11 +141992,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "rollup.get_rollup_index_capabilities" + "namespace": "rollup.delete_job" }, "path": [ { - "name": "index", + "description": "The ID of the job to delete", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -122413,149 +142008,127 @@ } } ], - "query": [] + "query": [], + "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L32" }, { "body": { "kind": "properties", - "properties": [] - }, - "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, + "properties": [ { - "kind": "instance_of", + "name": "task_failures", + "required": false, "type": { - "name": "IndexCapabilities", - "namespace": "rollup.get_rollup_index_capabilities" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TaskFailure", + "namespace": "rollup.delete_job" + } + } } } - ], + ] + }, + "inherits": { "type": { - "name": "DictionaryResponseBase", + "name": "AcknowledgedResponseBase", "namespace": "_types" } }, "kind": "response", "name": { "name": "Response", - "namespace": "rollup.get_rollup_index_capabilities" - } + "namespace": "rollup.delete_job" + }, + "specLocation": "rollup/delete_job/DeleteRollupJobResponse.ts#L23-L27" }, { "kind": "interface", "name": { - "name": "RollupJobSummary", - "namespace": "rollup.get_rollup_index_capabilities" + "name": "TaskFailure", + "namespace": "rollup.delete_job" }, "properties": [ { - "name": "fields", + "name": "task_id", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RollupJobSummaryField", - "namespace": "rollup.get_rollup_index_capabilities" - } - } + "kind": "instance_of", + "type": { + "name": "TaskId", + "namespace": "_types" } } }, { - "name": "index_pattern", + "name": "node_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "Id", + "namespace": "_types" } } }, { - "name": "job_id", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "rollup_index", + "name": "reason", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "TaskFailureReason", + "namespace": "rollup.delete_job" } } } - ] + ], + "specLocation": "rollup/delete_job/types.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "RollupJobSummaryField", - "namespace": "rollup.get_rollup_index_capabilities" + "name": "TaskFailureReason", + "namespace": "rollup.delete_job" }, "properties": [ { - "name": "agg", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "time_zone", - "required": false, + "name": "reason", + "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "calendar_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "rollup/delete_job/types.ts#L29-L32" }, { "kind": "enum", @@ -122578,8 +142151,9 @@ ], "name": { "name": "IndexingJobState", - "namespace": "rollup.get_rollup_job" - } + "namespace": "rollup.get_jobs" + }, + "specLocation": "rollup/get_jobs/types.ts#L66-L72" }, { "attachedBehaviors": [ @@ -122588,6 +142162,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves the configuration, stats, and status of rollup jobs.", "inherits": { "type": { "name": "RequestBase", @@ -122597,10 +142172,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, "path": [ { + "description": "The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs", "name": "id", "required": false, "type": { @@ -122612,7 +142188,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L32" }, { "body": { @@ -122627,7 +142204,7 @@ "kind": "instance_of", "type": { "name": "RollupJob", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" } } } @@ -122637,14 +142214,15 @@ "kind": "response", "name": { "name": "Response", - "namespace": "rollup.get_rollup_job" - } + "namespace": "rollup.get_jobs" + }, + "specLocation": "rollup/get_jobs/GetRollupJobResponse.ts#L22-L24" }, { "kind": "interface", "name": { "name": "RollupJob", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, "properties": [ { @@ -122654,7 +142232,7 @@ "kind": "instance_of", "type": { "name": "RollupJobConfiguration", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" } } }, @@ -122665,7 +142243,7 @@ "kind": "instance_of", "type": { "name": "RollupJobStats", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" } } }, @@ -122676,17 +142254,18 @@ "kind": "instance_of", "type": { "name": "RollupJobStatus", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" } } } - ] + ], + "specLocation": "rollup/get_jobs/types.ts#L28-L32" }, { "kind": "interface", "name": { "name": "RollupJobConfiguration", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, "properties": [ { @@ -122696,7 +142275,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -122729,7 +142308,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -122780,13 +142359,14 @@ } } } - ] + ], + "specLocation": "rollup/get_jobs/types.ts#L34-L43" }, { "kind": "interface", "name": { "name": "RollupJobStats", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, "properties": [ { @@ -122921,13 +142501,14 @@ } } } - ] + ], + "specLocation": "rollup/get_jobs/types.ts#L45-L58" }, { "kind": "interface", "name": { "name": "RollupJobStatus", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" }, "properties": [ { @@ -122938,7 +142519,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -122955,7 +142536,7 @@ "kind": "instance_of", "type": { "name": "IndexingJobState", - "namespace": "rollup.get_rollup_job" + "namespace": "rollup.get_jobs" } } }, @@ -122966,32 +142547,211 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "rollup/get_jobs/types.ts#L60-L64" }, { "attachedBehaviors": [ "CommonQueryParameters" ], + "body": { + "kind": "no_body" + }, + "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "rollup.get_rollup_caps" + }, + "path": [ + { + "description": "The ID of the index to check rollup capabilities on, or left blank for all jobs", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L32" + }, + { "body": { "kind": "properties", - "properties": [ + "properties": [] + }, + "inherits": { + "generics": [ { - "name": "stub", - "required": true, + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", "type": { + "name": "RollupCapabilities", + "namespace": "rollup.get_rollup_caps" + } + } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "rollup.get_rollup_caps" + }, + "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts#L24-L27" + }, + { + "kind": "interface", + "name": { + "name": "RollupCapabilities", + "namespace": "rollup.get_rollup_caps" + }, + "properties": [ + { + "name": "rollup_jobs", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "integer", + "name": "RollupCapabilitySummary", + "namespace": "rollup.get_rollup_caps" + } + } + } + } + ], + "specLocation": "rollup/get_rollup_caps/types.ts#L24-L26" + }, + { + "kind": "interface", + "name": { + "name": "RollupCapabilitySummary", + "namespace": "rollup.get_rollup_caps" + }, + "properties": [ + { + "name": "fields", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", "namespace": "_types" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } } } - ] + }, + { + "name": "index_pattern", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "rollup_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "rollup/get_rollup_caps/types.ts#L28-L33" + }, + { + "kind": "interface", + "name": { + "name": "IndexCapabilities", + "namespace": "rollup.get_rollup_index_caps" + }, + "properties": [ + { + "name": "rollup_jobs", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RollupJobSummary", + "namespace": "rollup.get_rollup_index_caps" + } + } + } + } + ], + "specLocation": "rollup/get_rollup_index_caps/types.ts#L24-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" }, + "description": "Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).", "inherits": { "type": { "name": "RequestBase", @@ -123001,57 +142761,360 @@ "kind": "request", "name": { "name": "Request", - "namespace": "rollup.rollup" + "namespace": "rollup.get_rollup_index_caps" }, "path": [ { - "name": "stubb", + "description": "The rollup index or index pattern to obtain rollup capabilities from.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } } ], - "query": [ + "query": [], + "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L32" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IndexCapabilities", + "namespace": "rollup.get_rollup_index_caps" + } + } + ], + "type": { + "name": "DictionaryResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "rollup.get_rollup_index_caps" + }, + "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts#L24-L27" + }, + { + "kind": "interface", + "name": { + "name": "RollupJobSummary", + "namespace": "rollup.get_rollup_index_caps" + }, + "properties": [ + { + "name": "fields", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RollupJobSummaryField", + "namespace": "rollup.get_rollup_index_caps" + } + } + } + } + }, { - "name": "stuba", + "name": "index_pattern", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "rollup_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "specLocation": "rollup/get_rollup_index_caps/types.ts#L28-L33" + }, + { + "kind": "interface", + "name": { + "name": "RollupJobSummaryField", + "namespace": "rollup.get_rollup_index_caps" + }, + "properties": [ + { + "name": "agg", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "time_zone", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "calendar_interval", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", "namespace": "_types" } } } - ] + ], + "specLocation": "rollup/get_rollup_index_caps/types.ts#L35-L39" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "stub", - "required": true, + "name": "cron", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "groups", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Groupings", + "namespace": "rollup._types" + } + } + }, + { + "name": "index_pattern", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "metrics", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldMetric", + "namespace": "rollup._types" + } + } + } + }, + { + "name": "page_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "rollup_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", "namespace": "_types" } } } ] }, + "description": "Creates a rollup job.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "rollup.put_job" + }, + "path": [ + { + "description": "The ID of the job to create", + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L26-L43" + }, + { + "body": { + "kind": "properties", + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "rollup.put_job" + }, + "specLocation": "rollup/put_job/CreateRollupJobResponse.ts#L22-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "config", + "kind": "value", + "value": { + "kind": "user_defined_value" + } + }, + "description": "Rollup an index", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "rollup.rollup" + }, + "path": [ + { + "description": "The index to roll up", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "description": "The name of the rollup index to create", + "name": "rollup_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "rollup/rollup/RollupRequest.ts#L24-L36" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "user_defined_value" + } + }, "kind": "response", "name": { "name": "Response", "namespace": "rollup.rollup" - } + }, + "specLocation": "rollup/rollup/RollupResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -123061,14 +143124,17 @@ "kind": "properties", "properties": [ { - "name": "aggs", + "aliases": [ + "aggs" + ], + "name": "aggregations", "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -123094,6 +143160,7 @@ } }, { + "description": "Must be zero if set, as rollups work on pre-aggregated data", "name": "size", "required": false, "type": { @@ -123106,6 +143173,7 @@ } ] }, + "description": "Enables searching rolled-up data using the standard query DSL.", "inherits": { "type": { "name": "RequestBase", @@ -123119,6 +143187,7 @@ }, "path": [ { + "description": "The indices or index-pattern(s) (containing rollup or regular data) that should be searched", "name": "index", "required": true, "type": { @@ -123130,6 +143199,7 @@ } }, { + "description": "The doc type inside the index", "name": "type", "required": false, "type": { @@ -123143,28 +143213,31 @@ ], "query": [ { + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "name": "rest_total_hits_as_int", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "name": "typed_keys", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L48" }, { "body": { @@ -123188,7 +143261,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -123199,7 +143272,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -123268,7 +143341,8 @@ "name": { "name": "Response", "namespace": "rollup.rollup_search" - } + }, + "specLocation": "rollup/rollup_search/RollupSearchResponse.ts#L27-L36" }, { "attachedBehaviors": [ @@ -123277,6 +143351,7 @@ "body": { "kind": "no_body" }, + "description": "Starts an existing, stopped rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -123286,10 +143361,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "rollup.start_rollup_job" + "namespace": "rollup.start_job" }, "path": [ { + "description": "The ID of the job to start", "name": "id", "required": true, "type": { @@ -123301,7 +143377,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L32" }, { "body": { @@ -123314,7 +143391,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -123323,8 +143400,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "rollup.start_rollup_job" - } + "namespace": "rollup.start_job" + }, + "specLocation": "rollup/start_job/StartRollupJobResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -123333,6 +143411,7 @@ "body": { "kind": "no_body" }, + "description": "Stops an existing, started rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -123342,10 +143421,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "rollup.stop_rollup_job" + "namespace": "rollup.stop_job" }, "path": [ { + "description": "The ID of the job to stop", "name": "id", "required": true, "type": { @@ -123359,6 +143439,7 @@ ], "query": [ { + "description": "Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.", "name": "timeout", "required": false, "type": { @@ -123370,17 +143451,19 @@ } }, { + "description": "True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L37" }, { "body": { @@ -123393,7 +143476,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -123402,8 +143485,230 @@ "kind": "response", "name": { "name": "Response", - "namespace": "rollup.stop_rollup_job" - } + "namespace": "rollup.stop_job" + }, + "specLocation": "rollup/stop_job/StopRollupJobResponse.ts#L20-L22" + }, + { + "kind": "enum", + "members": [ + { + "name": "cluster" + }, + { + "name": "indices" + }, + { + "name": "shards" + } + ], + "name": { + "name": "StatsLevel", + "namespace": "searchable_snapshots._types" + }, + "specLocation": "searchable_snapshots/_types/stats.ts#L20-L24" + }, + { + "kind": "interface", + "name": { + "name": "Node", + "namespace": "searchable_snapshots.cache_stats" + }, + "properties": [ + { + "name": "shared_cache", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Shared", + "namespace": "searchable_snapshots.cache_stats" + } + } + } + ], + "specLocation": "searchable_snapshots/cache_stats/Response.ts#L30-L32" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieve node-level cache statistics about searchable snapshots.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "searchable_snapshots.cache_stats" + }, + "path": [ + { + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "name": "node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeIds", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "name": "master_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L36" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Node", + "namespace": "searchable_snapshots.cache_stats" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "searchable_snapshots.cache_stats" + }, + "specLocation": "searchable_snapshots/cache_stats/Response.ts#L24-L28" + }, + { + "kind": "interface", + "name": { + "name": "Shared", + "namespace": "searchable_snapshots.cache_stats" + }, + "properties": [ + { + "name": "reads", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "bytes_read_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "name": "writes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "bytes_written_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "name": "evictions", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "num_regions", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "size_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "name": "region_size_in_bytes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + } + ], + "specLocation": "searchable_snapshots/cache_stats/Response.ts#L34-L43" }, { "attachedBehaviors": [ @@ -123412,6 +143717,7 @@ "body": { "kind": "no_body" }, + "description": "Clear the cache of searchable snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -123425,6 +143731,7 @@ }, "path": [ { + "description": "A comma-separated list of index names", "name": "index", "required": false, "type": { @@ -123438,6 +143745,7 @@ ], "query": [ { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -123449,24 +143757,26 @@ } }, { + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -123477,7 +143787,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -123488,34 +143798,26 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L39" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] + "kind": "value", + "value": { + "kind": "user_defined_value" + } }, "kind": "response", "name": { "name": "Response", "namespace": "searchable_snapshots.clear_cache" - } + }, + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts#L22-L24" }, { "kind": "interface", @@ -123557,7 +143859,8 @@ } } } - ] + ], + "specLocation": "searchable_snapshots/mount/types.ts#L23-L27" }, { "attachedBehaviors": [ @@ -123596,7 +143899,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -123615,13 +143918,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } ] }, + "description": "Mount a snapshot as a searchable index.", "inherits": { "type": { "name": "RequestBase", @@ -123635,6 +143939,7 @@ }, "path": [ { + "description": "The name of the repository containing the snapshot of the index to mount", "name": "repository", "required": true, "type": { @@ -123646,6 +143951,7 @@ } }, { + "description": "The name of the snapshot of the index to mount", "name": "snapshot", "required": true, "type": { @@ -123659,6 +143965,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -123671,6 +143978,7 @@ } }, { + "description": "Should this request wait until the operation has completed before returning", "name": "wait_for_completion", "required": false, "serverDefault": false, @@ -123678,11 +143986,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", "name": "storage", "required": false, "serverDefault": "full_copy", @@ -123690,11 +143999,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L50" }, { "body": { @@ -123717,28 +144027,17 @@ "name": { "name": "Response", "namespace": "searchable_snapshots.mount" - } + }, + "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountResponse.ts#L22-L26" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "stub_c", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] + "kind": "no_body" }, + "description": "Retrieve shard-level statistics about searchable snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -123748,16 +144047,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "searchable_snapshots.repository_stats" + "namespace": "searchable_snapshots.stats" }, "path": [ { - "name": "stub_a", - "required": true, + "description": "A comma-separated list of index names", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Indices", "namespace": "_types" } } @@ -123765,112 +144065,36 @@ ], "query": [ { - "name": "stub_b", - "required": true, + "description": "Return stats aggregated at cluster, index or shard level", + "name": "level", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "StatsLevel", + "namespace": "searchable_snapshots._types" } } } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "searchable_snapshots.repository_stats" - } + ], + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L36" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "name": "stub_c", + "name": "stats", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "searchable_snapshots.stats" - }, - "path": [ - { - "name": "stub_a", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "stub_b", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "user_defined_value" } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "stub", + "name": "total", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "user_defined_value" } } ] @@ -123879,7 +144103,8 @@ "name": { "name": "Response", "namespace": "searchable_snapshots.stats" - } + }, + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsResponse.ts#L22-L27" }, { "kind": "interface", @@ -123899,7 +144124,8 @@ } } } - ] + ], + "specLocation": "security/_types/Privileges.ts#L192-L194" }, { "kind": "interface", @@ -123909,17 +144135,19 @@ }, "properties": [ { + "description": "The name of the application to which this entry applies.", "name": "application", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "A list of strings, where each element is the name of an application privilege or action.", "name": "privileges", "required": true, "type": { @@ -123928,12 +144156,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "A list resources to which the privileges are applied.", "name": "resources", "required": true, "type": { @@ -123942,12 +144171,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "security/_types/Privileges.ts#L26-L39" }, { "kind": "interface", @@ -123967,7 +144197,127 @@ } } } - ] + ], + "specLocation": "security/_types/ClusterNode.ts#L22-L24" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ + { + "name": "all" + }, + { + "name": "cancel_task" + }, + { + "name": "create_snapshot" + }, + { + "name": "grant_api_key" + }, + { + "name": "manage" + }, + { + "name": "manage_api_key" + }, + { + "name": "manage_ccr" + }, + { + "name": "manage_enrich" + }, + { + "name": "manage_ilm" + }, + { + "name": "manage_index_templates" + }, + { + "name": "manage_ingest_pipelines" + }, + { + "name": "manage_logstash_pipelines" + }, + { + "name": "manage_ml" + }, + { + "name": "manage_oidc" + }, + { + "name": "manage_own_api_key" + }, + { + "name": "manage_pipeline" + }, + { + "name": "manage_rollup" + }, + { + "name": "manage_saml" + }, + { + "name": "manage_security" + }, + { + "name": "manage_service_account" + }, + { + "name": "manage_slm" + }, + { + "name": "manage_token" + }, + { + "name": "manage_transform" + }, + { + "name": "manage_watcher" + }, + { + "name": "monitor" + }, + { + "name": "monitor_ml" + }, + { + "name": "monitor_rollup" + }, + { + "name": "monitor_snapshot" + }, + { + "name": "monitor_text_structure" + }, + { + "name": "monitor_transform" + }, + { + "name": "monitor_watcher" + }, + { + "name": "read_ccr" + }, + { + "name": "read_ilm" + }, + { + "name": "read_pipeline" + }, + { + "name": "read_slm" + }, + { + "name": "transport_client" + } + ], + "name": { + "name": "ClusterPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L41-L79" }, { "kind": "interface", @@ -123983,11 +144333,59 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + ], + "specLocation": "security/_types/CreatedStatus.ts#L20-L22" + }, + { + "kind": "interface", + "name": { + "name": "FieldRule", + "namespace": "security._types" + }, + "properties": [ + { + "name": "username", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "name": "dn", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + }, + { + "name": "groups", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" } } } - ] + ], + "specLocation": "security/_types/RoleMappingRule.ts#L36-L44", + "variants": { + "kind": "container", + "nonExhaustive": true + } }, { "kind": "interface", @@ -124009,7 +144407,7 @@ }, { "name": "grant", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -124018,12 +144416,13 @@ } } } - ] + ], + "specLocation": "security/_types/FieldSecurity.ts#L22-L25" }, { "kind": "interface", "name": { - "name": "GlobalPrivileges", + "name": "GlobalPrivilege", "namespace": "security._types" }, "properties": [ @@ -124038,7 +144437,76 @@ } } } - ] + ], + "specLocation": "security/_types/Privileges.ts#L188-L190" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ + { + "name": "none" + }, + { + "name": "all" + }, + { + "name": "auto_configure" + }, + { + "name": "create" + }, + { + "name": "create_doc" + }, + { + "name": "create_index" + }, + { + "name": "delete" + }, + { + "name": "delete_index" + }, + { + "name": "index" + }, + { + "name": "maintenance" + }, + { + "name": "manage" + }, + { + "name": "manage_follow_index" + }, + { + "name": "manage_ilm" + }, + { + "name": "manage_leader_index" + }, + { + "name": "monitor" + }, + { + "name": "read" + }, + { + "name": "read_cross_cluster" + }, + { + "name": "view_index_metadata" + }, + { + "name": "write" + } + ], + "name": { + "name": "IndexPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L165-L186" }, { "kind": "interface", @@ -124048,17 +144516,35 @@ }, "properties": [ { + "description": "The document fields that the owners of the role have read access to.", + "docId": "field-and-document-access-control", "name": "field_security", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "FieldSecurity", - "namespace": "security._types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "FieldSecurity", + "namespace": "security._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldSecurity", + "namespace": "security._types" + } + } + } + ], + "kind": "union_of" } }, { + "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", "name": "names", "required": true, "type": { @@ -124070,6 +144556,7 @@ } }, { + "description": "The index level privileges that owners of the role have on the specified indices.", "name": "privileges", "required": true, "type": { @@ -124077,47 +144564,79 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexPrivilege", + "namespace": "security._types" } } } }, { + "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.", "name": "query", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IndicesPrivilegesQuery", + "namespace": "security._types" + } } }, { + "description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.", "name": "allow_restricted_indices", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/_types/Privileges.ts#L81-L104" + }, + { + "codegenNames": [ + "json_text", + "query", + "template" + ], + "description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.", + "kind": "type_alias", + "name": { + "name": "IndicesPrivilegesQuery", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L130-L138", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RoleTemplateQuery", + "namespace": "security._types" + } + } + ], + "kind": "union_of" + } }, { "kind": "interface", @@ -124135,12 +144654,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "security/_types/Privileges.ts#L196-L198" }, { "kind": "interface", @@ -124167,11 +144687,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/_types/RealmInfo.ts#L22-L25" }, { "kind": "interface", @@ -124187,7 +144708,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -124211,7 +144732,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -124222,20 +144743,305 @@ "type": { "kind": "instance_of", "type": { - "name": "RoleMappingRuleBase", + "name": "RoleMappingRule", + "namespace": "security._types" + } + } + }, + { + "name": "role_templates", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RoleTemplate", + "namespace": "security._types" + } + } + } + } + ], + "specLocation": "security/_types/RoleMapping.ts#L25-L31" + }, + { + "kind": "interface", + "name": { + "name": "RoleMappingRule", + "namespace": "security._types" + }, + "properties": [ + { + "name": "any", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RoleMappingRule", + "namespace": "security._types" + } + } + } + }, + { + "name": "all", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RoleMappingRule", + "namespace": "security._types" + } + } + } + }, + { + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldRule", + "namespace": "security._types" + } + } + }, + { + "name": "except", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RoleMappingRule", + "namespace": "security._types" + } + } + } + ], + "specLocation": "security/_types/RoleMappingRule.ts#L23-L34", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "RoleTemplate", + "namespace": "security._types" + }, + "properties": [ + { + "name": "format", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TemplateFormat", + "namespace": "security._types" + } + } + }, + { + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + } + ], + "specLocation": "security/_types/RoleTemplate.ts#L28-L31" + }, + { + "codegenNames": [ + "query_string", + "query_object" + ], + "kind": "type_alias", + "name": { + "name": "RoleTemplateInlineQuery", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L159-L160", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + ], + "kind": "union_of" + } + }, + { + "inherits": { + "type": { + "name": "ScriptBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "RoleTemplateInlineScript", + "namespace": "security._types" + }, + "properties": [ + { + "name": "lang", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScriptLanguage", + "namespace": "_types" + } + } + }, + { + "name": "options", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RoleTemplateInlineQuery", + "namespace": "security._types" + } + } + } + ], + "shortcutProperty": "source", + "specLocation": "security/_types/Privileges.ts#L152-L157" + }, + { + "kind": "interface", + "name": { + "name": "RoleTemplateQuery", + "namespace": "security._types" + }, + "properties": [ + { + "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", + "docId": "templating-role-query", + "name": "template", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RoleTemplateScript", + "namespace": "security._types" + } + } + } + ], + "specLocation": "security/_types/Privileges.ts#L140-L150" + }, + { + "codegenNames": [ + "inline", + "stored" + ], + "kind": "type_alias", + "name": { + "name": "RoleTemplateScript", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L162-L163", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "RoleTemplateInlineScript", "namespace": "security._types" } + }, + { + "kind": "instance_of", + "type": { + "name": "StoredScriptId", + "namespace": "_types" + } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "string" + }, + { + "name": "json" } - ] + ], + "name": { + "name": "TemplateFormat", + "namespace": "security._types" + }, + "specLocation": "security/_types/RoleTemplate.ts#L22-L25" }, { "kind": "interface", "name": { - "name": "RoleMappingRuleBase", + "name": "TransientMetadataConfig", "namespace": "security._types" }, - "properties": [] + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "security/_types/TransientMetadataConfig.ts#L20-L22" }, { "kind": "interface", @@ -124251,7 +145057,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -124286,7 +145092,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -124309,11 +145115,124 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + ], + "specLocation": "security/_types/User.ts#L22-L29" + }, + { + "kind": "interface", + "name": { + "name": "UserIndicesPrivileges", + "namespace": "security._types" + }, + "properties": [ + { + "description": "The document fields that the owners of the role have read access to.", + "docId": "field-and-document-access-control", + "name": "field_security", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldSecurity", + "namespace": "security._types" + } + } + } + }, + { + "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", + "name": "names", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "The index level privileges that owners of the role have on the specified indices.", + "name": "privileges", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexPrivilege", + "namespace": "security._types" + } + } + } + }, + { + "description": "Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role.", + "name": "query", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndicesPrivilegesQuery", + "namespace": "security._types" + } + } + } + }, + { + "description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.", + "name": "allow_restricted_indices", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "security/_types/Privileges.ts#L106-L128" + }, + { + "kind": "interface", + "name": { + "name": "ApiKey", + "namespace": "security.authenticate" + }, + "properties": [ + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } } - ] + ], + "specLocation": "security/authenticate/types.ts#L28-L31" }, { "attachedBehaviors": [ @@ -124322,6 +145241,7 @@ "body": { "kind": "no_body" }, + "description": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.", "inherits": { "type": { "name": "RequestBase", @@ -124334,12 +145254,24 @@ "namespace": "security.authenticate" }, "path": [], - "query": [] + "query": [], + "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L28" }, { "body": { "kind": "properties", "properties": [ + { + "name": "api_key", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ApiKey", + "namespace": "security.authenticate" + } + } + }, { "name": "authentication_realm", "required": true, @@ -124355,22 +145287,46 @@ "name": "email", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "name": "full_name", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { @@ -124404,7 +145360,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -124427,7 +145383,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -124438,7 +145394,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -124460,7 +145416,8 @@ "name": { "name": "Response", "namespace": "security.authenticate" - } + }, + "specLocation": "security/authenticate/SecurityAuthenticateResponse.ts#L24-L39" }, { "kind": "interface", @@ -124479,8 +145436,21 @@ "namespace": "_types" } } + }, + { + "name": "type", + "required": false, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "security/authenticate/types.ts#L22-L26" }, { "attachedBehaviors": [ @@ -124490,6 +145460,7 @@ "kind": "properties", "properties": [ { + "description": "The new password value. Passwords must be at least 6 characters long.", "name": "password", "required": false, "type": { @@ -124499,9 +145470,22 @@ "namespace": "_types" } } + }, + { + "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", + "name": "password_hash", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ] }, + "description": "Changes the passwords of users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -124515,6 +145499,7 @@ }, "path": [ { + "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", "name": "username", "required": false, "type": { @@ -124528,6 +145513,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -124538,7 +145524,8 @@ } } } - ] + ], + "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L52" }, { "body": { @@ -124549,7 +145536,8 @@ "name": { "name": "Response", "namespace": "security.change_password" - } + }, + "specLocation": "security/change_password/SecurityChangePasswordResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -124558,6 +145546,7 @@ "body": { "kind": "no_body" }, + "description": "Clear a subset or all entries from the API key cache.", "inherits": { "type": { "name": "RequestBase", @@ -124571,8 +145560,9 @@ }, "path": [ { + "description": "A comma-separated list of IDs of API keys to clear from the cache", "name": "ids", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -124582,14 +145572,15 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L32" }, { "body": { "kind": "properties", "properties": [ { - "identifier": "node_stats", + "codegenName": "node_stats", "name": "_nodes", "required": true, "type": { @@ -124619,7 +145610,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -124639,7 +145630,8 @@ "name": { "name": "Response", "namespace": "security.clear_api_key_cache" - } + }, + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts#L25-L32" }, { "attachedBehaviors": [ @@ -124648,6 +145640,7 @@ "body": { "kind": "no_body" }, + "description": "Evicts application privileges from the native application privileges cache.", "inherits": { "type": { "name": "RequestBase", @@ -124661,6 +145654,7 @@ }, "path": [ { + "description": "A comma-separated list of application names", "name": "application", "required": true, "type": { @@ -124672,209 +145666,15 @@ } } ], - "query": [] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "identifier": "node_stats", - "name": "_nodes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeStatistics", - "namespace": "_types" - } - } - }, - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "nodes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterNode", - "namespace": "security._types" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "security.clear_cached_privileges" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "security.clear_cached_realms" - }, - "path": [ - { - "name": "realms", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "name": "usernames", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - } - ] - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "identifier": "node_stats", - "name": "_nodes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeStatistics", - "namespace": "_types" - } - } - }, - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "nodes", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterNode", - "namespace": "security._types" - } - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "security.clear_cached_realms" - } - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "security.clear_cached_roles" - }, - "path": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - } - ], - "query": [] + "query": [], + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L32" }, { "body": { "kind": "properties", "properties": [ { - "identifier": "node_stats", + "codegenName": "node_stats", "name": "_nodes", "required": true, "type": { @@ -124904,7 +145704,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -124923,8 +145723,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "security.clear_cached_roles" - } + "namespace": "security.clear_cached_privileges" + }, + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts#L25-L32" }, { "attachedBehaviors": [ @@ -124933,6 +145734,7 @@ "body": { "kind": "no_body" }, + "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", "inherits": { "type": { "name": "RequestBase", @@ -124942,32 +145744,121 @@ "kind": "request", "name": { "name": "Request", - "namespace": "security.clear_cached_service_tokens" + "namespace": "security.clear_cached_realms" }, "path": [ { - "name": "namespace", + "description": "Comma-separated list of realms to clear", + "name": "realms", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Namespace", + "name": "Names", "namespace": "_types" } } - }, + } + ], + "query": [ { - "name": "service", - "required": true, + "description": "Comma-separated list of usernames to clear from the cache", + "name": "usernames", + "required": false, "type": { - "kind": "instance_of", + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L35" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "codegenName": "node_stats", + "name": "_nodes", + "required": true, "type": { - "name": "Service", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "NodeStatistics", + "namespace": "_types" + } + } + }, + { + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterNode", + "namespace": "security._types" + } + } } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "security.clear_cached_realms" + }, + "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts#L25-L32" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Evicts roles from the native role cache.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "security.clear_cached_roles" + }, + "path": [ { + "description": "Role name", "name": "name", "required": true, "type": { @@ -124979,14 +145870,15 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L32" }, { "body": { "kind": "properties", "properties": [ { - "identifier": "node_stats", + "codegenName": "node_stats", "name": "_nodes", "required": true, "type": { @@ -125016,7 +145908,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -125035,42 +145927,127 @@ "kind": "response", "name": { "name": "Response", - "namespace": "security.clear_cached_service_tokens" - } + "namespace": "security.clear_cached_roles" + }, + "specLocation": "security/clear_cached_roles/ClearCachedRolesResponse.ts#L25-L32" }, { - "kind": "interface", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Evicts tokens from the service account token caches.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "IndexPrivileges", - "namespace": "security.create_api_key" + "name": "Request", + "namespace": "security.clear_cached_service_tokens" }, - "properties": [ + "path": [ { - "name": "names", + "description": "An identifier for the namespace", + "name": "namespace", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Namespace", "namespace": "_types" } } }, { - "name": "privileges", + "description": "An identifier for the service name", + "name": "service", "required": true, "type": { - "kind": "array_of", - "value": { + "kind": "instance_of", + "type": { + "name": "Service", + "namespace": "_types" + } + } + }, + { + "description": "A comma-separated list of service token names", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L34" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "codegenName": "node_stats", + "name": "_nodes", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "NodeStatistics", + "namespace": "_types" + } + } + }, + { + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "nodes", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterNode", + "namespace": "security._types" + } } } } - } - ] + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "security.clear_cached_service_tokens" + }, + "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts#L25-L32" }, { "attachedBehaviors": [ @@ -125104,7 +146081,7 @@ } }, { - "description": " An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.", + "description": "An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "role_descriptors", "required": false, @@ -125113,7 +146090,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -125142,6 +146119,7 @@ } ] }, + "description": "Creates an API key for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -125156,6 +146134,7 @@ "path": [], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125166,24 +146145,27 @@ } } } - ] + ], + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L51" }, { "body": { "kind": "properties", "properties": [ { + "description": "Generated API key.", "name": "api_key", "required": true, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Expiration in milliseconds for the API key.", "name": "expiration", "required": false, "type": { @@ -125195,6 +146177,7 @@ } }, { + "description": "Unique ID for this API key.", "name": "id", "required": true, "type": { @@ -125206,6 +146189,7 @@ } }, { + "description": "Specifies the name for this API key.", "name": "name", "required": true, "type": { @@ -125215,6 +146199,19 @@ "namespace": "_types" } } + }, + { + "description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).", + "name": "encoded", + "required": true, + "since": "7.16.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ] }, @@ -125222,7 +146219,8 @@ "name": { "name": "Response", "namespace": "security.create_api_key" - } + }, + "specLocation": "security/create_api_key/SecurityCreateApiKeyResponse.ts#L23-L49" }, { "kind": "interface", @@ -125240,25 +146238,54 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { - "name": "index", + "aliases": [ + "index" + ], + "name": "indices", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "IndexPrivileges", - "namespace": "security.create_api_key" + "name": "IndicesPrivileges", + "namespace": "security._types" } } } }, + { + "name": "global", + "required": false, + "type": { + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GlobalPrivilege", + "namespace": "security._types" + } + } + }, + { + "kind": "instance_of", + "type": { + "name": "GlobalPrivilege", + "namespace": "security._types" + } + } + ], + "kind": "union_of" + } + }, { "name": "applications", "required": false, @@ -125272,8 +146299,45 @@ } } } + }, + { + "name": "metadata", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + }, + { + "name": "run_as", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "transient_metadata", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TransientMetadataConfig", + "namespace": "security._types" + } + } } - ] + ], + "specLocation": "security/create_api_key/types.ts#L30-L39" }, { "attachedBehaviors": [ @@ -125282,6 +146346,7 @@ "body": { "kind": "no_body" }, + "description": "Creates a service account token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -125295,6 +146360,7 @@ }, "path": [ { + "description": "An identifier for the namespace", "name": "namespace", "required": true, "type": { @@ -125306,6 +146372,7 @@ } }, { + "description": "An identifier for the service name", "name": "service", "required": true, "type": { @@ -125317,6 +146384,7 @@ } }, { + "description": "An identifier for the token name", "name": "name", "required": true, "type": { @@ -125328,7 +146396,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L34" }, { "body": { @@ -125341,7 +146410,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -125362,7 +146431,8 @@ "name": { "name": "Response", "namespace": "security.create_service_token" - } + }, + "specLocation": "security/create_service_token/CreateServiceTokenResponse.ts#L22-L27" }, { "kind": "interface", @@ -125389,11 +146459,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/create_service_token/types.ts#L22-L25" }, { "kind": "interface", @@ -125409,11 +146480,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/delete_privileges/types.ts#L20-L22" }, { "attachedBehaviors": [ @@ -125422,6 +146494,7 @@ "body": { "kind": "no_body" }, + "description": "Removes application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -125435,6 +146508,7 @@ }, "path": [ { + "description": "Application name", "name": "application", "required": true, "type": { @@ -125446,6 +146520,7 @@ } }, { + "description": "Privilege name", "name": "name", "required": true, "type": { @@ -125459,6 +146534,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125469,7 +146545,8 @@ } } } - ] + ], + "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L36" }, { "body": { @@ -125482,7 +146559,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -125490,7 +146567,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -125513,7 +146590,8 @@ "name": { "name": "Response", "namespace": "security.delete_privileges" - } + }, + "specLocation": "security/delete_privileges/SecurityDeletePrivilegesResponse.ts#L24-L27" }, { "attachedBehaviors": [ @@ -125522,6 +146600,7 @@ "body": { "kind": "no_body" }, + "description": "Removes roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -125535,6 +146614,7 @@ }, "path": [ { + "description": "Role name", "name": "name", "required": true, "type": { @@ -125548,6 +146628,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125558,7 +146639,8 @@ } } } - ] + ], + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L35" }, { "body": { @@ -125571,7 +146653,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -125581,7 +146663,8 @@ "name": { "name": "Response", "namespace": "security.delete_role" - } + }, + "specLocation": "security/delete_role/SecurityDeleteRoleResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -125590,6 +146673,7 @@ "body": { "kind": "no_body" }, + "description": "Removes role mappings.", "inherits": { "type": { "name": "RequestBase", @@ -125603,6 +146687,7 @@ }, "path": [ { + "description": "Role-mapping name", "name": "name", "required": true, "type": { @@ -125616,6 +146701,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125626,7 +146712,8 @@ } } } - ] + ], + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L35" }, { "body": { @@ -125639,7 +146726,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -125649,7 +146736,8 @@ "name": { "name": "Response", "namespace": "security.delete_role_mapping" - } + }, + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -125658,6 +146746,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a service account token.", "inherits": { "type": { "name": "RequestBase", @@ -125671,6 +146760,7 @@ }, "path": [ { + "description": "An identifier for the namespace", "name": "namespace", "required": true, "type": { @@ -125682,6 +146772,7 @@ } }, { + "description": "An identifier for the service name", "name": "service", "required": true, "type": { @@ -125693,6 +146784,7 @@ } }, { + "description": "An identifier for the token name", "name": "name", "required": true, "type": { @@ -125706,6 +146798,7 @@ ], "query": [ { + "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125716,7 +146809,8 @@ } } } - ] + ], + "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L37" }, { "body": { @@ -125729,7 +146823,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -125739,7 +146833,8 @@ "name": { "name": "Response", "namespace": "security.delete_service_token" - } + }, + "specLocation": "security/delete_service_token/DeleteServiceTokenResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -125748,6 +146843,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes users from the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -125761,6 +146857,7 @@ }, "path": [ { + "description": "username", "name": "username", "required": true, "type": { @@ -125774,6 +146871,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125784,7 +146882,8 @@ } } } - ] + ], + "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L35" }, { "body": { @@ -125797,7 +146896,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -125807,7 +146906,8 @@ "name": { "name": "Response", "namespace": "security.delete_user" - } + }, + "specLocation": "security/delete_user/SecurityDeleteUserResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -125816,6 +146916,7 @@ "body": { "kind": "no_body" }, + "description": "Disables users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -125829,6 +146930,7 @@ }, "path": [ { + "description": "The username of the user to disable", "name": "username", "required": true, "type": { @@ -125842,6 +146944,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125852,7 +146955,8 @@ } } } - ] + ], + "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L35" }, { "body": { @@ -125863,7 +146967,8 @@ "name": { "name": "Response", "namespace": "security.disable_user" - } + }, + "specLocation": "security/disable_user/SecurityDisableUserResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -125872,6 +146977,7 @@ "body": { "kind": "no_body" }, + "description": "Enables users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -125885,6 +146991,7 @@ }, "path": [ { + "description": "The username of the user to enable", "name": "username", "required": true, "type": { @@ -125898,6 +147005,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -125908,7 +147016,8 @@ } } } - ] + ], + "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L35" }, { "body": { @@ -125919,7 +147028,8 @@ "name": { "name": "Response", "namespace": "security.enable_user" - } + }, + "specLocation": "security/enable_user/SecurityEnableUserResponse.ts#L20-L22" }, { "kind": "interface", @@ -125968,7 +147078,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -125990,7 +147100,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -126017,7 +147127,8 @@ } } } - ] + ], + "specLocation": "security/get_api_key/types.ts#L23-L33" }, { "attachedBehaviors": [ @@ -126026,6 +147137,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information for one or more API keys.", "inherits": { "type": { "name": "RequestBase", @@ -126040,6 +147152,7 @@ "path": [], "query": [ { + "description": "API key id of the API key to be retrieved", "name": "id", "required": false, "type": { @@ -126051,6 +147164,7 @@ } }, { + "description": "API key name of the API key to be retrieved", "name": "name", "required": false, "type": { @@ -126062,17 +147176,19 @@ } }, { + "description": "flag to query API keys owned by the currently authenticated user", "name": "owner", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "realm name of the user who created this API key to be retrieved", "name": "realm_name", "required": false, "type": { @@ -126084,6 +147200,7 @@ } }, { + "description": "user name of the user who created this API key to be retrieved", "name": "username", "required": false, "type": { @@ -126094,7 +147211,8 @@ } } } - ] + ], + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L36" }, { "body": { @@ -126120,7 +147238,8 @@ "name": { "name": "Response", "namespace": "security.get_api_key" - } + }, + "specLocation": "security/get_api_key/SecurityGetApiKeyResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -126129,6 +147248,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -126141,7 +147261,8 @@ "namespace": "security.get_builtin_privileges" }, "path": [], - "query": [] + "query": [], + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L27" }, { "body": { @@ -126156,7 +147277,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -126178,7 +147299,8 @@ "name": { "name": "Response", "namespace": "security.get_builtin_privileges" - } + }, + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -126187,6 +147309,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -126200,6 +147323,7 @@ }, "path": [ { + "description": "Application name", "name": "application", "required": false, "type": { @@ -126211,6 +147335,7 @@ } }, { + "description": "Privilege name", "name": "name", "required": false, "type": { @@ -126222,7 +147347,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L33" }, { "body": { @@ -126235,7 +147361,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -126243,7 +147369,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -126266,89 +147392,8 @@ "name": { "name": "Response", "namespace": "security.get_privileges" - } - }, - { - "kind": "interface", - "name": { - "name": "InlineRoleTemplate", - "namespace": "security.get_role" }, - "properties": [ - { - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "InlineRoleTemplateSource", - "namespace": "security.get_role" - } - } - }, - { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TemplateFormat", - "namespace": "security.get_role" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "InlineRoleTemplateSource", - "namespace": "security.get_role" - }, - "properties": [ - { - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "InvalidRoleTemplate", - "namespace": "security.get_role" - }, - "properties": [ - { - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TemplateFormat", - "namespace": "security.get_role" - } - } - } - ] + "specLocation": "security/get_privileges/SecurityGetPrivilegesResponse.ts#L24-L27" }, { "attachedBehaviors": [ @@ -126357,6 +147402,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -126370,6 +147416,7 @@ }, "path": [ { + "description": "A comma-separated list of role names", "name": "name", "required": false, "type": { @@ -126381,7 +147428,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L32" }, { "body": { @@ -126394,7 +147442,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -126414,7 +147462,8 @@ "name": { "name": "Response", "namespace": "security.get_role" - } + }, + "specLocation": "security/get_role/SecurityGetRoleResponse.ts#L23-L23" }, { "kind": "interface", @@ -126432,7 +147481,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -126471,7 +147520,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -126510,111 +147559,13 @@ "kind": "instance_of", "type": { "name": "RoleTemplate", - "namespace": "security.get_role" + "namespace": "security._types" } } } } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "RoleTemplate", - "namespace": "security.get_role" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "InlineRoleTemplate", - "namespace": "security.get_role" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StoredRoleTemplate", - "namespace": "security.get_role" - } - }, - { - "kind": "instance_of", - "type": { - "name": "InvalidRoleTemplate", - "namespace": "security.get_role" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "StoredRoleTemplate", - "namespace": "security.get_role" - }, - "properties": [ - { - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "StoredRoleTemplateId", - "namespace": "security.get_role" - } - } - }, - { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TemplateFormat", - "namespace": "security.get_role" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "StoredRoleTemplateId", - "namespace": "security.get_role" - }, - "properties": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "enum", - "members": [ - { - "name": "string" - }, - { - "name": "json" - } ], - "name": { - "name": "TemplateFormat", - "namespace": "security.get_role" - } + "specLocation": "security/get_role/types.ts#L27-L35" }, { "kind": "interface", @@ -126630,11 +147581,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/get_role/types.ts#L37-L39" }, { "attachedBehaviors": [ @@ -126643,6 +147595,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves role mappings.", "inherits": { "type": { "name": "RequestBase", @@ -126656,6 +147609,7 @@ }, "path": [ { + "description": "A comma-separated list of role-mapping names", "name": "name", "required": false, "type": { @@ -126667,7 +147621,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L32" }, { "body": { @@ -126680,7 +147635,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -126700,7 +147655,8 @@ "name": { "name": "Response", "namespace": "security.get_role_mapping" - } + }, + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingResponse.ts#L23-L23" }, { "attachedBehaviors": [ @@ -126709,6 +147665,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information about service accounts.", "inherits": { "type": { "name": "RequestBase", @@ -126722,6 +147679,7 @@ }, "path": [ { + "description": "An identifier for the namespace", "name": "namespace", "required": false, "type": { @@ -126733,6 +147691,7 @@ } }, { + "description": "An identifier for the service name", "name": "service", "required": false, "type": { @@ -126744,7 +147703,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L33" }, { "body": { @@ -126757,7 +147717,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -126777,7 +147737,8 @@ "name": { "name": "Response", "namespace": "security.get_service_accounts" - } + }, + "specLocation": "security/get_service_accounts/GetServiceAccountsResponse.ts#L23-L26" }, { "kind": "interface", @@ -126795,12 +147756,15 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "aliases": [ + "index" + ], "name": "indices", "required": true, "type": { @@ -126822,7 +147786,7 @@ "value": { "kind": "instance_of", "type": { - "name": "GlobalPrivileges", + "name": "GlobalPrivilege", "namespace": "security._types" } } @@ -126862,7 +147826,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -126875,7 +147839,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -126885,7 +147849,8 @@ } } } - ] + ], + "specLocation": "security/get_service_accounts/types.ts#L33-L42" }, { "kind": "interface", @@ -126905,7 +147870,8 @@ } } } - ] + ], + "specLocation": "security/get_service_accounts/types.ts#L29-L31" }, { "attachedBehaviors": [ @@ -126914,6 +147880,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information of all service credentials for a service account.", "inherits": { "type": { "name": "RequestBase", @@ -126927,6 +147894,7 @@ }, "path": [ { + "description": "An identifier for the namespace", "name": "namespace", "required": true, "type": { @@ -126938,6 +147906,7 @@ } }, { + "description": "An identifier for the service name", "name": "service", "required": true, "type": { @@ -126949,7 +147918,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L33" }, { "body": { @@ -126962,7 +147932,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -126996,7 +147966,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -127018,7 +147988,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -127038,7 +148008,8 @@ "name": { "name": "Response", "namespace": "security.get_service_credentials" - } + }, + "specLocation": "security/get_service_credentials/GetServiceCredentialsResponse.ts#L24-L32" }, { "kind": "enum", @@ -127059,7 +148030,8 @@ "name": { "name": "AccessTokenGrantType", "namespace": "security.get_token" - } + }, + "specLocation": "security/get_token/types.ts#L23-L28" }, { "inherits": { @@ -127114,11 +148086,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/get_token/types.ts#L40-L45" }, { "kind": "interface", @@ -127134,7 +148107,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127149,7 +148122,8 @@ } } } - ] + ], + "specLocation": "security/get_token/types.ts#L35-L38" }, { "attachedBehaviors": [ @@ -127176,7 +148150,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127198,7 +148172,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127209,7 +148183,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127226,6 +148200,7 @@ } ] }, + "description": "Creates a bearer token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -127238,7 +148213,8 @@ "namespace": "security.get_token" }, "path": [], - "query": [] + "query": [], + "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L39" }, { "body": { @@ -127251,7 +148227,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127273,7 +148249,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127284,18 +148260,18 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "refresh_token", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127306,7 +148282,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127327,7 +148303,8 @@ "name": { "name": "Response", "namespace": "security.get_token" - } + }, + "specLocation": "security/get_token/GetUserAccessTokenResponse.ts#L23-L33" }, { "kind": "interface", @@ -127354,11 +148331,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "security/get_token/types.ts#L30-L33" }, { "attachedBehaviors": [ @@ -127367,6 +148345,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information about users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -127407,7 +148386,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L33" }, { "body": { @@ -127420,7 +148400,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -127440,7 +148420,8 @@ "name": { "name": "Response", "namespace": "security.get_user" - } + }, + "specLocation": "security/get_user/SecurityGetUserResponse.ts#L23-L23" }, { "attachedBehaviors": [ @@ -127449,6 +148430,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves security privileges for the logged in user.", "inherits": { "type": { "name": "RequestBase", @@ -127486,7 +148468,8 @@ } } } - ] + ], + "specLocation": "security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L35" }, { "body": { @@ -127515,7 +148498,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -127528,7 +148511,7 @@ "value": { "kind": "instance_of", "type": { - "name": "GlobalPrivileges", + "name": "GlobalPrivilege", "namespace": "security._types" } } @@ -127542,7 +148525,7 @@ "value": { "kind": "instance_of", "type": { - "name": "IndicesPrivileges", + "name": "UserIndicesPrivileges", "namespace": "security._types" } } @@ -127557,7 +148540,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -127568,7 +148551,8 @@ "name": { "name": "Response", "namespace": "security.get_user_privileges" - } + }, + "specLocation": "security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts#L27-L35" }, { "kind": "interface", @@ -127609,7 +148593,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -127620,7 +148604,8 @@ } } } - ] + ], + "specLocation": "security/grant_api_key/types.ts#L25-L29" }, { "kind": "enum", @@ -127635,7 +148620,8 @@ "name": { "name": "ApiKeyGrantType", "namespace": "security.grant_api_key" - } + }, + "specLocation": "security/grant_api_key/types.ts#L31-L34" }, { "attachedBehaviors": [ @@ -127673,7 +148659,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127701,6 +148687,7 @@ } ] }, + "description": "Creates an API key on behalf of another user.", "inherits": { "type": { "name": "RequestBase", @@ -127713,7 +148700,8 @@ "namespace": "security.grant_api_key" }, "path": [], - "query": [] + "query": [], + "specLocation": "security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L37" }, { "body": { @@ -127726,7 +148714,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127769,7 +148757,8 @@ "name": { "name": "Response", "namespace": "security.grant_api_key" - } + }, + "specLocation": "security/grant_api_key/SecurityGrantApiKeyResponse.ts#L23-L25" }, { "kind": "interface", @@ -127785,7 +148774,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -127798,7 +148787,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -127812,12 +148801,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "security/has_privileges/types.ts#L24-L28" }, { "kind": "type_alias", @@ -127825,6 +148815,7 @@ "name": "ApplicationsPrivileges", "namespace": "security.has_privileges" }, + "specLocation": "security/has_privileges/types.ts#L35-L35", "type": { "key": { "kind": "instance_of", @@ -127855,13 +148846,10 @@ "name": "names", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" } } }, @@ -127873,13 +148861,14 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "IndexPrivilege", + "namespace": "security._types" } } } } - ] + ], + "specLocation": "security/has_privileges/types.ts#L30-L33" }, { "kind": "type_alias", @@ -127887,12 +148876,13 @@ "name": "Privileges", "namespace": "security.has_privileges" }, + "specLocation": "security/has_privileges/types.ts#L37-L37", "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -127901,7 +148891,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -127935,8 +148925,8 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ClusterPrivilege", + "namespace": "security._types" } } } @@ -127957,6 +148947,7 @@ } ] }, + "description": "Determines whether the specified user has a specified list of privileges.", "inherits": { "type": { "name": "RequestBase", @@ -127970,6 +148961,7 @@ }, "path": [ { + "description": "Username", "name": "user", "required": false, "type": { @@ -127981,7 +148973,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L39" }, { "kind": "type_alias", @@ -127989,6 +148982,7 @@ "name": "ResourcePrivileges", "namespace": "security.has_privileges" }, + "specLocation": "security/has_privileges/types.ts#L36-L36", "type": { "key": { "kind": "instance_of", @@ -128031,7 +149025,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -128040,7 +149034,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -128052,7 +149046,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128095,7 +149089,8 @@ "name": { "name": "Response", "namespace": "security.has_privileges" - } + }, + "specLocation": "security/has_privileges/SecurityHasPrivilegesResponse.ts#L24-L32" }, { "attachedBehaviors": [ @@ -128147,7 +149142,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128158,7 +149153,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128175,6 +149170,7 @@ } ] }, + "description": "Invalidates one or more API keys.", "inherits": { "type": { "name": "RequestBase", @@ -128187,7 +149183,8 @@ "namespace": "security.invalidate_api_key" }, "path": [], - "query": [] + "query": [], + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L37" }, { "body": { @@ -128227,7 +149224,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -128241,7 +149238,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -128252,7 +149249,8 @@ "name": { "name": "Response", "namespace": "security.invalidate_api_key" - } + }, + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyResponse.ts#L23-L30" }, { "attachedBehaviors": [ @@ -128268,7 +149266,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128279,7 +149277,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128307,6 +149305,7 @@ } ] }, + "description": "Invalidates one or more access tokens or refresh tokens.", "inherits": { "type": { "name": "RequestBase", @@ -128319,7 +149318,8 @@ "namespace": "security.invalidate_token" }, "path": [], - "query": [] + "query": [], + "specLocation": "security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L35" }, { "body": { @@ -128378,7 +149378,8 @@ "name": { "name": "Response", "namespace": "security.invalidate_token" - } + }, + "specLocation": "security/invalidate_token/SecurityInvalidateTokenResponse.ts#L23-L30" }, { "kind": "interface", @@ -128396,7 +149397,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -128408,7 +149409,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128434,20 +149435,22 @@ } } } - ] + ], + "specLocation": "security/put_privileges/types.ts#L22-L27" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { + "codegenName": "privileges", "kind": "value", "value": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -128457,7 +149460,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -128472,6 +149475,7 @@ } } }, + "description": "Adds or updates application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -128486,6 +149490,7 @@ "path": [], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -128496,7 +149501,8 @@ } } } - ] + ], + "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L37" }, { "body": { @@ -128509,7 +149515,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -128517,7 +149523,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -128540,7 +149546,8 @@ "name": { "name": "Response", "namespace": "security.put_privileges" - } + }, + "specLocation": "security/put_privileges/SecurityPutPrivilegesResponse.ts#L24-L27" }, { "attachedBehaviors": [ @@ -128550,6 +149557,7 @@ "kind": "properties", "properties": [ { + "description": "A list of application privilege entries.", "name": "applications", "required": false, "type": { @@ -128564,6 +149572,7 @@ } }, { + "description": "A list of cluster privileges. These privileges define the cluster-level actions for users with this role.", "name": "cluster", "required": false, "type": { @@ -128571,13 +149580,14 @@ "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "ClusterPrivilege", + "namespace": "security._types" } } } }, { + "description": "An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.", "name": "global", "required": false, "type": { @@ -128585,7 +149595,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -128596,6 +149606,7 @@ } }, { + "description": "A list of indices permissions entries.", "name": "indices", "required": false, "type": { @@ -128610,6 +149621,7 @@ } }, { + "description": "Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.", "name": "metadata", "required": false, "type": { @@ -128621,6 +149633,8 @@ } }, { + "description": "A list of users that the owners of this role can impersonate.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", "name": "run_as", "required": false, "type": { @@ -128629,12 +149643,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.", "name": "transient_metadata", "required": false, "type": { @@ -128647,6 +149662,7 @@ } ] }, + "description": "Adds and updates roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -128660,6 +149676,7 @@ }, "path": [ { + "description": "Role name", "name": "name", "required": true, "type": { @@ -128673,6 +149690,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -128683,7 +149701,8 @@ } } } - ] + ], + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L74" }, { "body": { @@ -128706,7 +149725,8 @@ "name": { "name": "Response", "namespace": "security.put_role" - } + }, + "specLocation": "security/put_role/SecurityPutRoleResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -128722,7 +149742,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128746,7 +149766,21 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + } + }, + { + "name": "role_templates", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RoleTemplate", + "namespace": "security._types" } } } @@ -128757,7 +149791,7 @@ "type": { "kind": "instance_of", "type": { - "name": "RoleMappingRuleBase", + "name": "RoleMappingRule", "namespace": "security._types" } } @@ -128771,13 +149805,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } ] }, + "description": "Creates and updates role mappings.", "inherits": { "type": { "name": "RequestBase", @@ -128791,6 +149826,7 @@ }, "path": [ { + "description": "Role-mapping name", "name": "name", "required": true, "type": { @@ -128804,6 +149840,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -128814,7 +149851,8 @@ } } } - ] + ], + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L45" }, { "body": { @@ -128827,7 +149865,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128848,7 +149886,8 @@ "name": { "name": "Response", "namespace": "security.put_role_mapping" - } + }, + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -128877,14 +149916,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "null", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -128900,14 +149939,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "null", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -128943,7 +149982,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -128956,7 +149995,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -128968,12 +150007,13 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Adds and updates users in the native realm. These users are commonly referred to as native users.", "inherits": { "type": { "name": "RequestBase", @@ -128987,6 +150027,7 @@ }, "path": [ { + "description": "The username of the User", "name": "username", "required": true, "type": { @@ -129000,6 +150041,7 @@ ], "query": [ { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, "type": { @@ -129010,7 +150052,8 @@ } } } - ] + ], + "specLocation": "security/put_user/SecurityPutUserRequest.ts#L23-L45" }, { "body": { @@ -129023,7 +150066,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -129033,28 +150076,17 @@ "name": { "name": "Response", "namespace": "security.put_user" - } + }, + "specLocation": "security/put_user/SecurityPutUserResponse.ts#L20-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "kind": "no_body" }, + "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -129066,52 +150098,189 @@ "name": "Request", "namespace": "shutdown.delete_node" }, - "path": [], - "query": [] + "path": [ + { + "description": "The node id of node to be removed from the shutdown state", + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L23-L32" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", "namespace": "shutdown.delete_node" - } + }, + "specLocation": "shutdown/delete_node/ShutdownDeleteNodeResponse.ts#L22-L22" }, { - "attachedBehaviors": [ - "CommonQueryParameters" + "kind": "interface", + "name": { + "name": "NodeShutdownStatus", + "namespace": "shutdown.get_node" + }, + "properties": [ + { + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShutdownType", + "namespace": "shutdown.get_node" + } + } + }, + { + "name": "reason", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "shutdown_startedmillis", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" + } + } + }, + { + "name": "shard_migration", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShardMigrationStatus", + "namespace": "shutdown.get_node" + } + } + }, + { + "name": "persistent_tasks", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "PersistentTaskStatus", + "namespace": "shutdown.get_node" + } + } + }, + { + "name": "plugins", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "PluginsStatus", + "namespace": "shutdown.get_node" + } + } + } ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L29-L38" + }, + { + "kind": "interface", + "name": { + "name": "PersistentTaskStatus", + "namespace": "shutdown.get_node" + }, + "properties": [ + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" } } - ] + } + ], + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L56-L58" + }, + { + "kind": "interface", + "name": { + "name": "PluginsStatus", + "namespace": "shutdown.get_node" }, + "properties": [ + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" + } + } + } + ], + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L60-L62" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -129123,21 +150292,38 @@ "name": "Request", "namespace": "shutdown.get_node" }, - "path": [], - "query": [] + "path": [ + { + "description": "Which node for which to retrieve the shutdown status", + "name": "node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeIds", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L23-L32" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "nodes", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "NodeShutdownStatus", + "namespace": "shutdown.get_node" + } } } } @@ -129147,28 +150333,76 @@ "name": { "name": "Response", "namespace": "shutdown.get_node" - } + }, + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L23-L27" + }, + { + "kind": "interface", + "name": { + "name": "ShardMigrationStatus", + "namespace": "shutdown.get_node" + }, + "properties": [ + { + "name": "status", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" + } + } + } + ], + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L52-L54" + }, + { + "kind": "enum", + "members": [ + { + "name": "not_started" + }, + { + "name": "in_progress" + }, + { + "name": "stalled" + }, + { + "name": "complete" + } + ], + "name": { + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" + }, + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L45-L50" + }, + { + "kind": "enum", + "members": [ + { + "name": "remove" + }, + { + "name": "restart" + } + ], + "name": { + "name": "ShutdownType", + "namespace": "shutdown.get_node" + }, + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L40-L43" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "kind": "no_body" }, + "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -129180,31 +150414,40 @@ "name": "Request", "namespace": "shutdown.put_node" }, - "path": [], - "query": [] + "path": [ + { + "description": "The node id of node to be shut down", + "name": "node_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeId", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "shutdown/put_node/ShutdownPutNodeRequest.ts#L23-L32" }, { "body": { "kind": "properties", - "properties": [ - { - "name": "stub", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] + "properties": [] + }, + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } }, "kind": "response", "name": { "name": "Response", "namespace": "shutdown.put_node" - } + }, + "specLocation": "shutdown/put_node/ShutdownPutNodeResponse.ts#L22-L22" }, { "kind": "interface", @@ -129214,39 +150457,85 @@ }, "properties": [ { + "description": "If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.\nBy default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters.", + "name": "indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" } } }, { + "description": "If true, the current global state is included in the snapshot.", "name": "include_global_state", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "name": "indices", - "required": true, + "description": "A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API.\nEach feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false.", + "name": "feature_states", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes.", + "name": "metadata", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Metadata", "namespace": "_types" } } + }, + { + "description": "If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.", + "name": "partial", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L93-L123" }, { "kind": "interface", @@ -129284,7 +150573,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -129299,7 +150588,8 @@ } } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L125-L130" }, { "kind": "interface", @@ -129330,7 +150620,8 @@ } } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L132-L135" }, { "kind": "interface", @@ -129341,7 +150632,7 @@ "properties": [ { "name": "config", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -129368,13 +150659,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { "name": "retention", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -129394,7 +150685,8 @@ } } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L70-L76" }, { "kind": "interface", @@ -129404,6 +150696,7 @@ }, "properties": [ { + "description": "Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule.", "name": "expire_after", "required": true, "type": { @@ -129415,6 +150708,7 @@ } }, { + "description": "Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots.", "name": "max_count", "required": true, "type": { @@ -129426,6 +150720,7 @@ } }, { + "description": "Minimum number of snapshots to retain, even if the snapshots have expired.", "name": "min_count", "required": true, "type": { @@ -129436,7 +150731,8 @@ } } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L78-L91" }, { "kind": "interface", @@ -129555,7 +150851,8 @@ } } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L32-L43" }, { "kind": "interface", @@ -129686,7 +150983,8 @@ } } } - ] + ], + "specLocation": "slm/_types/SnapshotLifecycle.ts#L45-L68" }, { "attachedBehaviors": [ @@ -129695,6 +150993,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes an existing snapshot lifecycle policy.", "inherits": { "type": { "name": "RequestBase", @@ -129708,6 +151007,7 @@ }, "path": [ { + "description": "The id of the snapshot lifecycle policy to remove", "name": "policy_id", "required": true, "type": { @@ -129719,7 +151019,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L23-L32" }, { "body": { @@ -129736,7 +151037,8 @@ "name": { "name": "Response", "namespace": "slm.delete_lifecycle" - } + }, + "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -129745,6 +151047,7 @@ "body": { "kind": "no_body" }, + "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", "inherits": { "type": { "name": "RequestBase", @@ -129758,6 +151061,7 @@ }, "path": [ { + "description": "The id of the snapshot lifecycle policy to be executed", "name": "policy_id", "required": true, "type": { @@ -129769,7 +151073,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L23-L32" }, { "body": { @@ -129792,7 +151097,8 @@ "name": { "name": "Response", "namespace": "slm.execute_lifecycle" - } + }, + "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -129801,6 +151107,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes any snapshots that are expired according to the policy's retention rules.", "inherits": { "type": { "name": "RequestBase", @@ -129813,7 +151120,8 @@ "namespace": "slm.execute_retention" }, "path": [], - "query": [] + "query": [], + "specLocation": "slm/execute_retention/ExecuteRetentionRequest.ts#L22-L27" }, { "body": { @@ -129830,7 +151138,8 @@ "name": { "name": "Response", "namespace": "slm.execute_retention" - } + }, + "specLocation": "slm/execute_retention/ExecuteRetentionResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -129839,6 +151148,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "inherits": { "type": { "name": "RequestBase", @@ -129852,6 +151162,7 @@ }, "path": [ { + "description": "Comma-separated list of snapshot lifecycle policies to retrieve", "name": "policy_id", "required": false, "type": { @@ -129863,7 +151174,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L23-L32" }, { "body": { @@ -129896,7 +151208,8 @@ "name": { "name": "Response", "namespace": "slm.get_lifecycle" - } + }, + "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleResponse.ts#L24-L24" }, { "attachedBehaviors": [ @@ -129905,6 +151218,7 @@ "body": { "kind": "no_body" }, + "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", "inherits": { "type": { "name": "RequestBase", @@ -129917,7 +151231,8 @@ "namespace": "slm.get_stats" }, "path": [], - "query": [] + "query": [], + "specLocation": "slm/get_stats/GetSnapshotLifecycleStatsRequest.ts#L22-L27" }, { "body": { @@ -129930,7 +151245,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -130031,7 +151346,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -130042,7 +151357,8 @@ "name": { "name": "Response", "namespace": "slm.get_stats" - } + }, + "specLocation": "slm/get_stats/GetSnapshotLifecycleStatsResponse.ts#L23-L36" }, { "attachedBehaviors": [ @@ -130051,6 +151367,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves the status of snapshot lifecycle management (SLM).", "inherits": { "type": { "name": "RequestBase", @@ -130063,7 +151380,8 @@ "namespace": "slm.get_status" }, "path": [], - "query": [] + "query": [], + "specLocation": "slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts#L22-L27" }, { "body": { @@ -130086,7 +151404,8 @@ "name": { "name": "Response", "namespace": "slm.get_status" - } + }, + "specLocation": "slm/get_status/GetSnapshotLifecycleManagementStatusResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -130096,6 +151415,7 @@ "kind": "properties", "properties": [ { + "description": "Configuration for each snapshot created by the policy.", "name": "config", "required": false, "type": { @@ -130107,6 +151427,7 @@ } }, { + "description": "Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.", "name": "name", "required": false, "type": { @@ -130118,17 +151439,19 @@ } }, { + "description": "Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.", "name": "repository", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Retention rules used to retain and delete snapshots created by the policy.", "name": "retention", "required": false, "type": { @@ -130140,6 +151463,7 @@ } }, { + "description": "Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.", "name": "schedule", "required": false, "type": { @@ -130152,6 +151476,7 @@ } ] }, + "description": "Creates or updates a snapshot lifecycle policy.", "inherits": { "type": { "name": "RequestBase", @@ -130165,6 +151490,7 @@ }, "path": [ { + "description": "ID for the snapshot lifecycle policy you want to create or update.", "name": "policy_id", "required": true, "type": { @@ -130176,7 +151502,35 @@ } } ], - "query": [] + "query": [ + { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "slm/put_lifecycle/PutSnapshotLifecycleRequest.ts#L26-L72" }, { "body": { @@ -130193,7 +151547,8 @@ "name": { "name": "Response", "namespace": "slm.put_lifecycle" - } + }, + "specLocation": "slm/put_lifecycle/PutSnapshotLifecycleResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -130202,6 +151557,7 @@ "body": { "kind": "no_body" }, + "description": "Turns on snapshot lifecycle management (SLM).", "inherits": { "type": { "name": "RequestBase", @@ -130214,7 +151570,8 @@ "namespace": "slm.start" }, "path": [], - "query": [] + "query": [], + "specLocation": "slm/start/StartSnapshotLifecycleManagementRequest.ts#L22-L27" }, { "body": { @@ -130231,7 +151588,8 @@ "name": { "name": "Response", "namespace": "slm.start" - } + }, + "specLocation": "slm/start/StartSnapshotLifecycleManagementResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -130240,6 +151598,7 @@ "body": { "kind": "no_body" }, + "description": "Turns off snapshot lifecycle management (SLM).", "inherits": { "type": { "name": "RequestBase", @@ -130252,7 +151611,8 @@ "namespace": "slm.stop" }, "path": [], - "query": [] + "query": [], + "specLocation": "slm/stop/StopSnapshotLifecycleManagementRequest.ts#L22-L27" }, { "body": { @@ -130269,7 +151629,8 @@ "name": { "name": "Response", "namespace": "slm.stop" - } + }, + "specLocation": "slm/stop/StopSnapshotLifecycleManagementResponse.ts#L22-L22" }, { "kind": "interface", @@ -130300,7 +151661,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/FileCountSnapshotStats.ts#L22-L25" }, { "kind": "interface", @@ -130353,7 +151715,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotIndexDetails.ts#L23-L28" }, { "kind": "interface", @@ -130369,7 +151732,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -130384,7 +151747,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotInfoFeatureState.ts#L22-L25" }, { "kind": "interface", @@ -130400,7 +151764,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -130426,7 +151790,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L23-L27" }, { "kind": "interface", @@ -130442,7 +151807,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -130455,14 +151820,14 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } ], @@ -130478,7 +151843,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -130499,7 +151864,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -130515,21 +151880,22 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } ], "kind": "union_of" } } - ] + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L29-L38" }, { "kind": "interface", @@ -130604,7 +151970,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotShardsStats.ts#L22-L29" }, { "kind": "enum", @@ -130633,7 +152000,8 @@ "name": { "name": "ShardsStatsStage", "namespace": "snapshot._types" - } + }, + "specLocation": "snapshot/_types/SnapshotShardsStatsStage.ts#L20-L34" }, { "kind": "interface", @@ -130686,7 +152054,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotShardsStatus.ts#L28-L33" }, { "kind": "interface", @@ -130717,7 +152086,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotShardsStatus.ts#L35-L38" }, { "kind": "interface", @@ -130734,7 +152104,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -130770,7 +152140,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotIndexStats.ts#L25-L29" }, { "kind": "interface", @@ -130788,7 +152159,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -130858,7 +152229,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -130917,7 +152288,19 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "repository", + "required": false, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, @@ -130972,7 +152355,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131023,7 +152406,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotInfo.ts#L35-L59" }, { "kind": "interface", @@ -131061,7 +152445,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131083,11 +152467,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotShardFailure.ts#L22-L28" }, { "kind": "interface", @@ -131118,7 +152503,42 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotShardsStatus.ts#L23-L26" + }, + { + "kind": "enum", + "members": [ + { + "name": "start_time" + }, + { + "name": "duration" + }, + { + "name": "name" + }, + { + "name": "index_count" + }, + { + "name": "repository", + "since": "7.16.0" + }, + { + "name": "shard_count", + "since": "7.16.0" + }, + { + "name": "failed_shard_count", + "since": "7.16.0" + } + ], + "name": { + "name": "SnapshotSort", + "namespace": "snapshot._types" + }, + "specLocation": "snapshot/_types/SnapshotInfo.ts#L61-L72" }, { "kind": "interface", @@ -131171,7 +152591,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotStats.ts#L23-L28" }, { "kind": "interface", @@ -131187,7 +152608,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131199,7 +152620,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -131220,7 +152641,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131242,7 +152663,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131253,7 +152674,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131279,7 +152700,8 @@ } } } - ] + ], + "specLocation": "snapshot/_types/SnapshotStatus.ts#L26-L35" }, { "kind": "interface", @@ -131289,6 +152711,7 @@ }, "properties": [ { + "description": "Number of binary large objects (blobs) removed during cleanup.", "name": "deleted_blobs", "required": true, "type": { @@ -131300,6 +152723,7 @@ } }, { + "description": "Number of bytes freed by cleanup operations.", "name": "deleted_bytes", "required": true, "type": { @@ -131310,7 +152734,8 @@ } } } - ] + ], + "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L29-L34" }, { "attachedBehaviors": [ @@ -131319,6 +152744,7 @@ "body": { "kind": "no_body" }, + "description": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -131332,6 +152758,8 @@ }, "path": [ { + "codegenName": "name", + "description": "Snapshot repository to clean up.", "name": "repository", "required": true, "type": { @@ -131345,8 +152773,10 @@ ], "query": [ { + "description": "Period to wait for a connection to the master node.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131356,8 +152786,10 @@ } }, { + "description": "Period to wait for a response.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131366,13 +152798,15 @@ } } } - ] + ], + "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts#L24-L49" }, { "body": { "kind": "properties", "properties": [ { + "description": "Statistics for cleanup operations.", "name": "results", "required": true, "type": { @@ -131389,7 +152823,8 @@ "name": { "name": "Response", "namespace": "snapshot.cleanup_repository" - } + }, + "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L22-L27" }, { "attachedBehaviors": [ @@ -131405,12 +152840,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Clones indices from one snapshot into another snapshot in the same repository.", "inherits": { "type": { "name": "RequestBase", @@ -131424,6 +152860,7 @@ }, "path": [ { + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -131435,6 +152872,7 @@ } }, { + "description": "The name of the snapshot to clone from", "name": "snapshot", "required": true, "type": { @@ -131446,6 +152884,7 @@ } }, { + "description": "The name of the cloned snapshot to create", "name": "target_snapshot", "required": true, "type": { @@ -131459,6 +152898,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -131480,7 +152920,8 @@ } } } - ] + ], + "specLocation": "snapshot/clone/SnapshotCloneRequest.ts#L24-L42" }, { "body": { @@ -131497,7 +152938,8 @@ "name": { "name": "Response", "namespace": "snapshot.clone" - } + }, + "specLocation": "snapshot/clone/SnapshotCloneResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -131507,28 +152949,33 @@ "kind": "properties", "properties": [ { + "description": "If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).", "name": "include_global_state", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default.", "name": "indices", "required": false, "type": { @@ -131540,6 +152987,22 @@ } }, { + "description": "Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default.", + "name": "feature_states", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch.", "name": "metadata", "required": false, "type": { @@ -131551,18 +153014,21 @@ } }, { + "description": "If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.", "name": "partial", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Creates a snapshot in a repository.", "inherits": { "type": { "name": "RequestBase", @@ -131576,6 +153042,7 @@ }, "path": [ { + "description": "Repository for the snapshot.", "name": "repository", "required": true, "type": { @@ -131587,6 +153054,7 @@ } }, { + "description": "Name of the snapshot. Must be unique in the repository.", "name": "snapshot", "required": true, "type": { @@ -131600,8 +153068,10 @@ ], "query": [ { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131611,34 +153081,40 @@ } }, { + "description": "If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes.", "name": "wait_for_completion", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "snapshot/create/SnapshotCreateRequest.ts#L24-L81" }, { "body": { "kind": "properties", "properties": [ { + "description": "Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`", "name": "accepted", "required": false, + "since": "7.15.0", "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Snapshot information. Present when the request had `wait_for_completion` set to `true`", "name": "snapshot", "required": false, "type": { @@ -131655,7 +153131,8 @@ "name": { "name": "Response", "namespace": "snapshot.create" - } + }, + "specLocation": "snapshot/create/SnapshotCreateResponse.ts#L22-L34" }, { "attachedBehaviors": [ @@ -131682,7 +153159,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -131699,6 +153176,7 @@ } ] }, + "description": "Creates a repository.", "inherits": { "type": { "name": "RequestBase", @@ -131712,6 +153190,8 @@ }, "path": [ { + "codegenName": "name", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -131725,6 +153205,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -131736,6 +153217,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -131747,17 +153229,19 @@ } }, { + "description": "Whether to verify the repository after creation", "name": "verify", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L28-L49" }, { "body": { @@ -131774,7 +153258,8 @@ "name": { "name": "Response", "namespace": "snapshot.create_repository" - } + }, + "specLocation": "snapshot/create_repository/SnapshotCreateRepositoryResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -131783,6 +153268,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -131796,6 +153282,7 @@ }, "path": [ { + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -131807,6 +153294,7 @@ } }, { + "description": "A snapshot name", "name": "snapshot", "required": true, "type": { @@ -131820,6 +153308,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -131830,7 +153319,8 @@ } } } - ] + ], + "specLocation": "snapshot/delete/SnapshotDeleteRequest.ts#L24-L37" }, { "body": { @@ -131847,7 +153337,8 @@ "name": { "name": "Response", "namespace": "snapshot.delete" - } + }, + "specLocation": "snapshot/delete/SnapshotDeleteResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -131856,6 +153347,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a repository.", "inherits": { "type": { "name": "RequestBase", @@ -131869,6 +153361,8 @@ }, "path": [ { + "codegenName": "name", + "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", "name": "repository", "required": true, "type": { @@ -131882,6 +153376,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -131893,6 +153388,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -131903,7 +153399,8 @@ } } } - ] + ], + "specLocation": "snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts#L24-L38" }, { "body": { @@ -131920,7 +153417,8 @@ "name": { "name": "Response", "namespace": "snapshot.delete_repository" - } + }, + "specLocation": "snapshot/delete_repository/SnapshotDeleteRepositoryResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -131929,6 +153427,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -131942,6 +153441,7 @@ }, "path": [ { + "description": "Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.", "name": "repository", "required": true, "type": { @@ -131953,6 +153453,7 @@ } }, { + "description": "Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).\n- To get information about all snapshots in a registered repository, use a wildcard (*) or _all.\n- To get information about any snapshots that are currently running, use _current.", "name": "snapshot", "required": true, "type": { @@ -131966,19 +153467,23 @@ ], "query": [ { + "description": "If false, the request returns an error for any snapshots that are unavailable.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131988,25 +153493,29 @@ } }, { + "description": "If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.", "name": "verbose", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted.", "name": "index_details", "required": false, + "serverDefault": false, "since": "7.13.0", "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132017,11 +153526,119 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Whether to include the repository name in the snapshot info. Defaults to true.", + "name": "include_repository", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp.", + "name": "sort", + "required": false, + "serverDefault": "start_time", + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "SnapshotSort", + "namespace": "snapshot._types" + } + } + }, + { + "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit.", + "name": "size", + "required": false, + "serverDefault": 0, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order.", + "name": "order", + "required": false, + "serverDefault": "asc", + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } + } + }, + { + "description": "Offset identifier to start pagination from as returned by the next field in the response body.", + "name": "after", + "required": false, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.", + "name": "offset", + "required": false, + "serverDefault": 0, + "since": "7.15.0", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count.", + "name": "from_sort_value", + "required": false, + "since": "7.16.0", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy.", + "name": "slm_policy_filter", + "required": false, + "since": "7.16.0", + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } } - ] + ], + "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L109" }, { "body": { @@ -132054,6 +153671,32 @@ } } } + }, + { + "description": "The total number of snapshots that match the request when ignoring size limit or after query parameter.", + "name": "total", + "required": true, + "since": "7.15.0", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.", + "name": "remaining", + "required": true, + "since": "7.15.0", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ] }, @@ -132061,7 +153704,8 @@ "name": { "name": "Response", "namespace": "snapshot.get" - } + }, + "specLocation": "snapshot/get/SnapshotGetResponse.ts#L25-L40" }, { "kind": "interface", @@ -132106,7 +153750,8 @@ } } } - ] + ], + "specLocation": "snapshot/get/SnapshotGetResponse.ts#L42-L46" }, { "attachedBehaviors": [ @@ -132115,6 +153760,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about a repository.", "inherits": { "type": { "name": "RequestBase", @@ -132128,6 +153774,8 @@ }, "path": [ { + "codegenName": "name", + "description": "A comma-separated list of repository names", "name": "repository", "required": false, "type": { @@ -132141,17 +153789,19 @@ ], "query": [ { + "description": "Return local information, do not retrieve the state from master node (default: false)", "name": "local", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -132162,7 +153812,8 @@ } } } - ] + ], + "specLocation": "snapshot/get_repository/SnapshotGetRepositoryRequest.ts#L24-L38" }, { "body": { @@ -132175,7 +153826,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -132195,7 +153846,8 @@ "name": { "name": "Response", "namespace": "snapshot.get_repository" - } + }, + "specLocation": "snapshot/get_repository/SnapshotGetRepositoryResponse.ts#L23-L23" }, { "attachedBehaviors": [ @@ -132204,6 +153856,20 @@ "body": { "kind": "properties", "properties": [ + { + "name": "feature_states", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, { "name": "ignore_index_settings", "required": false, @@ -132213,7 +153879,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -132225,7 +153891,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132236,7 +153902,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132247,7 +153913,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132280,7 +153946,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132291,7 +153957,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132302,12 +153968,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Restores a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -132321,6 +153988,7 @@ }, "path": [ { + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -132332,6 +154000,7 @@ } }, { + "description": "A snapshot name", "name": "snapshot", "required": true, "type": { @@ -132345,6 +154014,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -132356,17 +154026,19 @@ } }, { + "description": "Should this request wait until the operation has completed before returning", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "snapshot/restore/SnapshotRestoreRequest.ts#L25-L51" }, { "body": { @@ -132389,7 +154061,8 @@ "name": { "name": "Response", "namespace": "snapshot.restore" - } + }, + "specLocation": "snapshot/restore/SnapshotRestoreResponse.ts#L23-L25" }, { "kind": "interface", @@ -132419,7 +154092,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132434,7 +154107,8 @@ } } } - ] + ], + "specLocation": "snapshot/restore/SnapshotRestoreResponse.ts#L27-L31" }, { "attachedBehaviors": [ @@ -132443,6 +154117,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about the status of a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -132456,6 +154131,7 @@ }, "path": [ { + "description": "A repository name", "name": "repository", "required": false, "type": { @@ -132467,6 +154143,7 @@ } }, { + "description": "A comma-separated list of snapshot names", "name": "snapshot", "required": false, "type": { @@ -132480,17 +154157,19 @@ ], "query": [ { + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown", "name": "ignore_unavailable", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -132501,7 +154180,8 @@ } } } - ] + ], + "specLocation": "snapshot/status/SnapshotStatusRequest.ts#L24-L38" }, { "body": { @@ -132527,7 +154207,8 @@ "name": { "name": "Response", "namespace": "snapshot.status" - } + }, + "specLocation": "snapshot/status/SnapshotStatusResponse.ts#L22-L24" }, { "kind": "interface", @@ -132547,7 +154228,8 @@ } } } - ] + ], + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L27-L29" }, { "attachedBehaviors": [ @@ -132556,6 +154238,7 @@ "body": { "kind": "no_body" }, + "description": "Verifies a repository.", "inherits": { "type": { "name": "RequestBase", @@ -132569,6 +154252,8 @@ }, "path": [ { + "codegenName": "name", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -132582,6 +154267,7 @@ ], "query": [ { + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "type": { @@ -132593,6 +154279,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -132603,7 +154290,8 @@ } } } - ] + ], + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts#L24-L38" }, { "body": { @@ -132617,7 +154305,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -132637,7 +154325,8 @@ "name": { "name": "Response", "namespace": "snapshot.verify_repository" - } + }, + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L23-L25" }, { "attachedBehaviors": [ @@ -132653,12 +154342,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Clears the SQL cursor", "inherits": { "type": { "name": "RequestBase", @@ -132671,7 +154361,8 @@ "namespace": "sql.clear_cursor" }, "path": [], - "query": [] + "query": [], + "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L31" }, { "body": { @@ -132684,7 +154375,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -132694,7 +154385,8 @@ "name": { "name": "Response", "namespace": "sql.clear_cursor" - } + }, + "specLocation": "sql/clear_cursor/ClearSqlCursorResponse.ts#L20-L22" }, { "kind": "interface", @@ -132721,11 +154413,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "sql/query/types.ts#L23-L26" }, { "attachedBehaviors": [ @@ -132734,6 +154427,18 @@ "body": { "kind": "properties", "properties": [ + { + "description": "Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.", + "name": "catalog", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "name": "columnar", "required": false, @@ -132741,7 +154446,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132752,7 +154457,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132760,7 +154465,7 @@ "description": "The maximum number of rows (or entries) to return in one response", "name": "fetch_size", "required": false, - "serverDefault": "1000", + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { @@ -132791,7 +154496,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132830,7 +154535,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132843,12 +154548,95 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "description": "Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async.", + "name": "wait_for_completion_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "Values for parameters in the query.", + "name": "params", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "Retention period for an async or saved synchronous search.", + "name": "keep_alive", + "required": false, + "serverDefault": "5d", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.", + "name": "keep_on_completion", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, the search can run on frozen indices. Defaults to false.", + "name": "index_using_frozen", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ] }, + "description": "Executes a SQL request", "inherits": { "type": { "name": "RequestBase", @@ -132863,6 +154651,7 @@ "path": [], "query": [ { + "description": "a short version of the Accept header, e.g. json, yaml", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html#sql-rest-format", "name": "format", "required": false, @@ -132870,11 +154659,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "sql/query/QuerySqlRequest.ts#L28-L111" }, { "body": { @@ -132901,7 +154691,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132925,7 +154715,8 @@ "name": { "name": "Response", "namespace": "sql.query" - } + }, + "specLocation": "sql/query/QuerySqlResponse.ts#L22-L28" }, { "kind": "type_alias", @@ -132933,6 +154724,7 @@ "name": "Row", "namespace": "sql.query" }, + "specLocation": "sql/query/types.ts#L28-L28", "type": { "kind": "array_of", "value": { @@ -132976,7 +154768,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -132987,12 +154779,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } ] }, + "description": "Translates SQL into Elasticsearch queries", "inherits": { "type": { "name": "RequestBase", @@ -133005,15 +154798,38 @@ "namespace": "sql.translate" }, "path": [], - "query": [] + "query": [], + "specLocation": "sql/translate/TranslateSqlRequest.ts#L24-L36" }, { "body": { "kind": "properties", "properties": [ + { + "name": "aggregations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } + } + }, { "name": "size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -133024,67 +154840,48 @@ }, { "name": "_source", - "required": true, + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } } }, { "name": "fields", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" } } } }, + { + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, { "name": "sort", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "Sort", - "namespace": "_global.search._types" + "namespace": "_types" } } } @@ -133094,24 +154891,37 @@ "name": { "name": "Response", "namespace": "sql.translate" - } + }, + "specLocation": "sql/translate/TranslateSqlResponse.ts#L28-L38" }, { "kind": "interface", "name": { "name": "CertificateInformation", - "namespace": "ssl.get_certificates" + "namespace": "ssl.certificates" }, "properties": [ { "name": "alias", - "required": false, + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { @@ -133132,7 +154942,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -133143,7 +154953,18 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "issuer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, @@ -133154,7 +154975,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -133165,7 +154986,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -133176,11 +154997,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "ssl/certificates/types.ts#L22-L31" }, { "attachedBehaviors": [ @@ -133189,6 +155011,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information about the X.509 certificates used to encrypt communications in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -133198,10 +155021,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ssl.get_certificates" + "namespace": "ssl.certificates" }, "path": [], - "query": [] + "query": [], + "specLocation": "ssl/certificates/GetCertificatesRequest.ts#L22-L27" }, { "body": { @@ -133212,7 +155036,7 @@ "kind": "instance_of", "type": { "name": "CertificateInformation", - "namespace": "ssl.get_certificates" + "namespace": "ssl.certificates" } } } @@ -133220,14 +155044,34 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ssl.get_certificates" - } + "namespace": "ssl.certificates" + }, + "specLocation": "ssl/certificates/GetCertificatesResponse.ts#L22-L24" + }, + { + "kind": "enum", + "members": [ + { + "name": "nodes" + }, + { + "name": "parents" + }, + { + "name": "none" + } + ], + "name": { + "name": "GroupBy", + "namespace": "tasks._types" + }, + "specLocation": "tasks/_types/GroupBy.ts#L20-L24" }, { "kind": "interface", "name": { "name": "Info", - "namespace": "task._types" + "namespace": "tasks._types" }, "properties": [ { @@ -133237,7 +155081,18 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "cancelled", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, @@ -133248,7 +155103,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -133261,7 +155116,7 @@ "kind": "instance_of", "type": { "name": "Info", - "namespace": "task._types" + "namespace": "tasks._types" } } } @@ -133273,7 +155128,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -133306,148 +155161,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "running_time_in_nanos", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "start_time_in_millis", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "status", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Status", - "namespace": "task._types" - } - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "parent_task_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "State", - "namespace": "task._types" - }, - "properties": [ - { - "name": "action", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "cancellable", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "headers", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "HttpHeaders", - "namespace": "_types" - } - } - }, - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "parent_task_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskId", - "namespace": "_types" + "namespace": "_builtins" } } }, @@ -133477,11 +155191,7 @@ "name": "status", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Status", - "namespace": "task._types" - } + "kind": "user_defined_value" } }, { @@ -133491,123 +155201,77 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "Status", - "namespace": "task._types" - }, - "properties": [ - { - "name": "batches", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "namespace": "_builtins" } } }, { - "name": "canceled", + "name": "parent_task_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "created", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "specLocation": "tasks/_types/TaskInfo.ts#L25-L39" + }, + { + "kind": "interface", + "name": { + "name": "State", + "namespace": "tasks._types" + }, + "properties": [ { - "name": "deleted", + "name": "action", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "noops", + "name": "cancellable", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "failures", + "name": "description", "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - }, - { - "name": "requests_per_second", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "retries", + "name": "headers", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Retries", - "namespace": "_types" - } - } - }, - { - "name": "throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", + "name": "HttpHeaders", "namespace": "_types" } } }, { - "name": "throttled_millis", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -133618,41 +155282,30 @@ } }, { - "name": "throttled_until", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Time", - "namespace": "_types" - } - } - }, - { - "name": "throttled_until_millis", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "timed_out", + "name": "parent_task_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "internal" + "name": "TaskId", + "namespace": "_types" } } }, { - "name": "took", - "required": false, + "name": "running_time_in_nanos", + "required": true, "type": { "kind": "instance_of", "type": { @@ -133662,7 +155315,7 @@ } }, { - "name": "total", + "name": "start_time_in_millis", "required": true, "type": { "kind": "instance_of", @@ -133673,28 +155326,25 @@ } }, { - "name": "updated", - "required": true, + "name": "status", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "user_defined_value" } }, { - "name": "version_conflicts", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "tasks/_types/TaskState.ts#L24-L36" }, { "inherits": { @@ -133706,7 +155356,7 @@ "kind": "interface", "name": { "name": "TaskExecutingNode", - "namespace": "task._types" + "namespace": "tasks._types" }, "properties": [ { @@ -133726,12 +155376,13 @@ "kind": "instance_of", "type": { "name": "State", - "namespace": "task._types" + "namespace": "tasks._types" } } } } - ] + ], + "specLocation": "tasks/_types/TaskExecutingNode.ts#L25-L27" }, { "attachedBehaviors": [ @@ -133740,6 +155391,7 @@ "body": { "kind": "no_body" }, + "description": "Cancels a task, if it can be cancelled through an API.", "inherits": { "type": { "name": "RequestBase", @@ -133749,10 +155401,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "task.cancel" + "namespace": "tasks.cancel" }, "path": [ { + "description": "Cancel the task with specified task id (node_id:task_number)", "name": "task_id", "required": false, "type": { @@ -133766,6 +155419,7 @@ ], "query": [ { + "description": "A comma-separated list of actions that should be cancelled. Leave empty to cancel all.", "name": "actions", "required": false, "type": { @@ -133774,7 +155428,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -133783,7 +155437,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -133792,6 +155446,7 @@ } }, { + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", "name": "nodes", "required": false, "type": { @@ -133800,34 +155455,37 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", "name": "parent_task_id", "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "tasks/cancel/CancelTasksRequest.ts#L23-L38" }, { "body": { @@ -133855,7 +155513,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -133864,7 +155522,7 @@ "kind": "instance_of", "type": { "name": "TaskExecutingNode", - "namespace": "task._types" + "namespace": "tasks._types" } } } @@ -133874,8 +155532,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "task.cancel" - } + "namespace": "tasks.cancel" + }, + "specLocation": "tasks/cancel/CancelTasksResponse.ts#L24-L29" }, { "attachedBehaviors": [ @@ -133884,6 +155543,7 @@ "body": { "kind": "no_body" }, + "description": "Returns information about a task.", "inherits": { "type": { "name": "RequestBase", @@ -133893,10 +155553,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "task.get" + "namespace": "tasks.get" }, "path": [ { + "description": "Return the task with specified id (node_id:task_number)", "name": "task_id", "required": true, "type": { @@ -133910,6 +155571,7 @@ ], "query": [ { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -133921,17 +155583,19 @@ } }, { + "description": "Wait for the matching tasks to complete (default: false)", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "tasks/get/GetTaskRequest.ts#L24-L37" }, { "body": { @@ -133944,7 +155608,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -133955,7 +155619,7 @@ "kind": "instance_of", "type": { "name": "Info", - "namespace": "task._types" + "namespace": "tasks._types" } } }, @@ -133963,11 +155627,7 @@ "name": "response", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Status", - "namespace": "task._types" - } + "kind": "user_defined_value" } }, { @@ -133986,8 +155646,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "task.get" - } + "namespace": "tasks.get" + }, + "specLocation": "tasks/get/GetTaskResponse.ts#L24-L31" }, { "attachedBehaviors": [ @@ -133996,6 +155657,7 @@ "body": { "kind": "no_body" }, + "description": "Returns a list of tasks.", "inherits": { "type": { "name": "RequestBase", @@ -134005,11 +155667,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "task.list" + "namespace": "tasks.list" }, "path": [], "query": [ { + "description": "A comma-separated list of actions that should be returned. Leave empty to return all.", "name": "actions", "required": false, "type": { @@ -134018,7 +155681,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -134027,7 +155690,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -134036,28 +155699,31 @@ } }, { + "description": "Return detailed task information (default: false)", "name": "detailed", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Group tasks by nodes or parent/child relationships", "name": "group_by", "required": false, "type": { "kind": "instance_of", "type": { "name": "GroupBy", - "namespace": "_types" + "namespace": "tasks._types" } } }, { + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", "name": "nodes", "required": false, "type": { @@ -134066,12 +155732,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.", "name": "parent_task_id", "required": false, "type": { @@ -134083,6 +155750,7 @@ } }, { + "description": "Explicit operation timeout", "name": "timeout", "required": false, "type": { @@ -134094,17 +155762,19 @@ } }, { + "description": "Wait for the matching tasks to complete (default: false)", "name": "wait_for_completion", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "tasks/list/ListTasksRequest.ts#L25-L40" }, { "body": { @@ -134132,7 +155802,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -134141,7 +155811,7 @@ "kind": "instance_of", "type": { "name": "TaskExecutingNode", - "namespace": "task._types" + "namespace": "tasks._types" } } } @@ -134150,37 +155820,22 @@ "name": "tasks", "required": false, "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Info", - "namespace": "task._types" - } - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Info", - "namespace": "task._types" - } - } + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Info", + "namespace": "tasks._types" + } + } } } ] @@ -134188,8 +155843,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "task.list" - } + "namespace": "tasks.list" + }, + "specLocation": "tasks/list/ListTasksResponse.ts#L25-L31" }, { "kind": "interface", @@ -134285,7 +155941,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134296,14 +155952,16 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "text_structure/find_structure/types.ts#L23-L33" }, { "body": { + "codegenName": "text_files", "kind": "value", "value": { "kind": "array_of", @@ -134316,6 +155974,7 @@ } } }, + "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", "generics": [ { "name": "TJsonDocument", @@ -134337,7 +155996,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134349,7 +156008,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134361,7 +156020,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134374,7 +156033,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134386,7 +156045,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134398,7 +156057,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134410,7 +156069,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134418,7 +156077,7 @@ "description": "The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.", "name": "line_merge_size_limit", "required": false, - "serverDefault": "10000", + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { @@ -134431,7 +156090,7 @@ "description": "The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2; If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.", "name": "lines_to_sample", "required": false, - "serverDefault": "1000", + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { @@ -134448,7 +156107,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134460,7 +156119,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134478,6 +156137,7 @@ } }, { + "description": "Optional parameter to specify the timestamp field in the file", "name": "timestamp_field", "required": false, "type": { @@ -134496,11 +156156,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "text_structure/find_structure/FindStructureRequest.ts#L24-L73" }, { "body": { @@ -134513,7 +156174,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134524,7 +156185,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134535,7 +156196,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134546,7 +156207,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134579,7 +156240,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134612,7 +156273,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134623,7 +156284,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134634,7 +156295,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134658,7 +156319,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -134672,7 +156333,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -134684,7 +156345,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134695,7 +156356,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134706,7 +156367,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134719,7 +156380,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -134733,7 +156394,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -134756,7 +156417,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -134777,7 +156438,8 @@ "name": { "name": "Response", "namespace": "text_structure.find_structure" - } + }, + "specLocation": "text_structure/find_structure/FindStructureResponse.ts#L27-L52" }, { "kind": "interface", @@ -134804,7 +156466,8 @@ "kind": "user_defined_value" } } - ] + ], + "specLocation": "text_structure/find_structure/types.ts#L35-L38" }, { "kind": "interface", @@ -134840,7 +156503,8 @@ } } } - ] + ], + "specLocation": "transform/_types/Transform.ts#L47-L52" }, { "kind": "interface", @@ -134853,6 +156517,7 @@ "aliases": [ "aggs" ], + "description": "Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket\nscript, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,\nmin, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted\naverage.", "name": "aggregations", "required": false, "type": { @@ -134860,7 +156525,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -134875,14 +156540,15 @@ } }, { + "description": "Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are\ncurrently supported: date histogram, geotile grid, histogram, terms.", "name": "group_by", - "required": true, + "required": false, "type": { "key": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -134895,19 +156561,9 @@ } } } - }, - { - "name": "max_page_search_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } } - ] + ], + "specLocation": "transform/_types/Transform.ts#L54-L68" }, { "kind": "interface", @@ -134961,6 +156617,7 @@ } } ], + "specLocation": "transform/_types/Transform.ts#L70-L78", "variants": { "kind": "container" } @@ -134985,7 +156642,7 @@ } }, { - "description": "Specifies the maximum age of a document in the destination index. Documents that are older than the configured value are removed from the destination index.", + "description": "Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index.", "name": "max_age", "required": true, "type": { @@ -134996,7 +156653,8 @@ } } } - ] + ], + "specLocation": "transform/_types/Transform.ts#L88-L96" }, { "kind": "interface", @@ -135008,7 +156666,7 @@ { "description": "Specifies that the transform uses a time field to set the retention policy.", "name": "time", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -135018,6 +156676,7 @@ } } ], + "specLocation": "transform/_types/Transform.ts#L80-L86", "variants": { "kind": "container" } @@ -135031,7 +156690,20 @@ }, "properties": [ { - "description": "Defines if dates in the ouput should be written as ISO formatted string (default) or as millis since epoch. epoch_millis has been the default for transforms created before version 7.11. For compatible output set this to true.", + "description": "Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align\ncheckpoint ranges with the date histogram interval when date histogram is specified as a group source in the\ntransform config. As a result, less document updates in the destination index will be performed thus improving\noverall performance.", + "name": "align_checkpoints", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was\nthe default for transforms created before version 7.11. For compatible output set this value to `true`.", "name": "dates_as_epoch_millis", "required": false, "serverDefault": false, @@ -135039,12 +156711,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.", + "description": "Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a\nwait time between search requests. The default value is null, which disables throttling.", "name": "docs_per_second", "required": false, "type": { @@ -135056,10 +156728,10 @@ } }, { - "description": "Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 10,000.", + "description": "Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker\nexceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`.", "name": "max_page_search_size", "required": false, - "serverDefault": "500", + "serverDefault": 500, "type": { "kind": "instance_of", "type": { @@ -135068,7 +156740,55 @@ } } } - ] + ], + "specLocation": "transform/_types/Transform.ts#L98-L128" + }, + { + "kind": "interface", + "name": { + "name": "Source", + "namespace": "transform._types" + }, + "properties": [ + { + "description": "The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + }, + { + "description": "A query clause that retrieves a subset of data from the source index.", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.", + "name": "runtime_mappings", + "required": false, + "since": "7.12.0", + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + } + ], + "specLocation": "transform/_types/Transform.ts#L130-L148" }, { "kind": "interface", @@ -135080,7 +156800,7 @@ { "description": "Specifies that the transform uses a time field to synchronize the source and destination indices.", "name": "time", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -135090,6 +156810,7 @@ } } ], + "specLocation": "transform/_types/Transform.ts#L152-L158", "variants": { "kind": "container" } @@ -135105,6 +156826,7 @@ "description": "The time delay between the current time and the latest input data time.", "name": "delay", "required": false, + "serverDefault": "60s", "type": { "kind": "instance_of", "type": { @@ -135114,7 +156836,7 @@ } }, { - "description": "The date field that is used to identify new documents in the source.", + "description": "The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays.", "name": "field", "required": true, "type": { @@ -135125,7 +156847,8 @@ } } } - ] + ], + "specLocation": "transform/_types/Transform.ts#L160-L172" }, { "attachedBehaviors": [ @@ -135134,6 +156857,7 @@ "body": { "kind": "no_body" }, + "description": "Deletes a transform.", "inherits": { "type": { "name": "RequestBase", @@ -135147,12 +156871,13 @@ }, "path": [ { + "description": "Identifier for the transform.", "name": "transform_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } @@ -135160,17 +156885,33 @@ ], "query": [ { + "description": "If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.", "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "transform/delete_transform/DeleteTransformRequest.ts#L24-L51" }, { "body": { @@ -135187,7 +156928,8 @@ "name": { "name": "Response", "namespace": "transform.delete_transform" - } + }, + "specLocation": "transform/delete_transform/DeleteTransformResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -135196,6 +156938,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves configuration information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -135209,12 +156952,13 @@ }, "path": [ { + "description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.", "name": "transform_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Names", "namespace": "_types" } } @@ -135222,19 +156966,23 @@ ], "query": [ { + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.", "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Skips the specified number of transforms.", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -135244,8 +156992,10 @@ } }, { + "description": "Specifies the maximum number of transforms to obtain.", "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -135255,17 +157005,20 @@ } }, { + "description": "Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "name": "exclude_generated", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L72" }, { "body": { @@ -135290,8 +157043,8 @@ "value": { "kind": "instance_of", "type": { - "name": "Transform", - "namespace": "_types" + "name": "TransformSummary", + "namespace": "transform.get_transform" } } } @@ -135302,7 +157055,156 @@ "name": { "name": "Response", "namespace": "transform.get_transform" - } + }, + "specLocation": "transform/get_transform/GetTransformResponse.ts#L23-L25" + }, + { + "kind": "interface", + "name": { + "name": "TransformSummary", + "namespace": "transform.get_transform" + }, + "properties": [ + { + "description": "The destination for the transform.", + "name": "dest", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Destination", + "namespace": "_global.reindex" + } + } + }, + { + "description": "Free text description of the transform.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "The pivot method transforms the data by aggregating and grouping it.", + "name": "pivot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Pivot", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines optional transform settings.", + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Settings", + "namespace": "transform._types" + } + } + }, + { + "description": "The source of the data for the transform.", + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Source", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines the properties transforms require to run continuously.", + "name": "sync", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncContainer", + "namespace": "transform._types" + } + } + }, + { + "name": "create_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EpochMillis", + "namespace": "_types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } + }, + { + "name": "latest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Latest", + "namespace": "transform._types" + } + } + }, + { + "name": "_meta", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" + } + } + } + ], + "specLocation": "transform/get_transform/types.ts#L31-L50" }, { "kind": "interface", @@ -135377,7 +157279,8 @@ } } } - ] + ], + "specLocation": "transform/get_transform_stats/types.ts#L60-L67" }, { "kind": "interface", @@ -135441,7 +157344,8 @@ } } } - ] + ], + "specLocation": "transform/get_transform_stats/types.ts#L69-L75" }, { "attachedBehaviors": [ @@ -135450,6 +157354,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves usage information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -135463,12 +157368,13 @@ }, "path": [ { + "description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.", "name": "transform_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Names", "namespace": "_types" } } @@ -135476,19 +157382,23 @@ ], "query": [ { + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.", "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Skips the specified number of transforms.", "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -135498,8 +157408,10 @@ } }, { + "description": "Specifies the maximum number of transforms to obtain.", "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -135508,7 +157420,8 @@ } } } - ] + ], + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L24-L66" }, { "body": { @@ -135545,7 +157458,8 @@ "name": { "name": "Response", "namespace": "transform.get_transform_stats" - } + }, + "specLocation": "transform/get_transform_stats/GetTransformStatsResponse.ts#L23-L25" }, { "kind": "interface", @@ -135719,7 +157633,8 @@ } } } - ] + ], + "specLocation": "transform/get_transform_stats/types.ts#L42-L58" }, { "kind": "interface", @@ -135783,7 +157698,8 @@ } } } - ] + ], + "specLocation": "transform/get_transform_stats/types.ts#L34-L40" }, { "kind": "interface", @@ -135832,7 +157748,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -135843,7 +157759,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -135858,7 +157774,8 @@ } } } - ] + ], + "specLocation": "transform/get_transform_stats/types.ts#L25-L32" }, { "attachedBehaviors": [ @@ -135887,12 +157804,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { - "description": "The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.", + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.", "name": "frequency", "required": false, "serverDefault": "1m", @@ -135905,7 +157822,7 @@ } }, { - "description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.", + "description": "The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.", "name": "pivot", "required": false, "type": { @@ -135941,7 +157858,7 @@ } }, { - "description": " Defines the properties transforms require to run continuously.", + "description": "Defines the properties transforms require to run continuously.", "name": "sync", "required": false, "type": { @@ -135953,7 +157870,7 @@ } }, { - "description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.", + "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.", "name": "retention_policy", "required": false, "type": { @@ -135965,7 +157882,7 @@ } }, { - "description": " The latest method transforms the data by finding the latest document for each unique key.", + "description": "The latest method transforms the data by finding the latest document for\neach unique key.", "name": "latest", "required": false, "type": { @@ -135978,6 +157895,7 @@ } ] }, + "description": "Previews a transform.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "inherits": { "type": { "name": "RequestBase", @@ -135989,8 +157907,36 @@ "name": "Request", "namespace": "transform.preview_transform" }, - "path": [], - "query": [] + "path": [ + { + "description": "Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.", + "name": "transform_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L32-L106" }, { "body": { @@ -136033,7 +157979,8 @@ "name": { "name": "Response", "namespace": "transform.preview_transform" - } + }, + "specLocation": "transform/preview_transform/PreviewTransformResponse.ts#L22-L27" }, { "attachedBehaviors": [ @@ -136041,12 +157988,146 @@ ], "body": { "kind": "properties", - "properties": [] + "properties": [ + { + "description": "The destination for the transform.", + "name": "dest", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Destination", + "namespace": "_global.reindex" + } + } + }, + { + "description": "Free text description of the transform.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.", + "name": "frequency", + "required": false, + "serverDefault": "1m", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "The latest method transforms the data by finding the latest document for each unique key.", + "name": "latest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Latest", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines optional transform metadata.", + "name": "_meta", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.", + "name": "pivot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Pivot", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.", + "name": "retention_policy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RetentionPolicyContainer", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines optional transform settings.", + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Settings", + "namespace": "transform._types" + } + } + }, + { + "description": "The source of the data for the transform.", + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Source", + "namespace": "_global.reindex" + } + } + }, + { + "description": "Defines the properties transforms require to run continuously.", + "name": "sync", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncContainer", + "namespace": "transform._types" + } + } + } + ] }, + "description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "inherits": { "type": { - "name": "Request", - "namespace": "transform.preview_transform" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", @@ -136056,7 +158137,7 @@ }, "path": [ { - "description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.", "name": "transform_id", "required": true, "type": { @@ -136070,18 +158151,33 @@ ], "query": [ { - "description": "When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.", + "description": "When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.", "name": "defer_validation", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" } } } - ] + ], + "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L122" }, { "body": { @@ -136098,7 +158194,8 @@ "name": { "name": "Response", "namespace": "transform.put_transform" - } + }, + "specLocation": "transform/put_transform/PutTransformResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -136107,6 +158204,7 @@ "body": { "kind": "no_body" }, + "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "inherits": { "type": { "name": "RequestBase", @@ -136120,12 +158218,13 @@ }, "path": [ { + "description": "Identifier for the transform.", "name": "transform_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Id", "namespace": "_types" } } @@ -136133,8 +158232,10 @@ ], "query": [ { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -136143,7 +158244,8 @@ } } } - ] + ], + "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L61" }, { "body": { @@ -136160,7 +158262,8 @@ "name": { "name": "Response", "namespace": "transform.start_transform" - } + }, + "specLocation": "transform/start_transform/StartTransformResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -136169,6 +158272,7 @@ "body": { "kind": "no_body" }, + "description": "Stops one or more transforms.", "inherits": { "type": { "name": "RequestBase", @@ -136182,6 +158286,7 @@ }, "path": [ { + "description": "Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.", "name": "transform_id", "required": true, "type": { @@ -136195,30 +158300,36 @@ ], "query": [ { + "description": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.", "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If it is true, the API forcefully stops the transforms.", "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -136228,28 +158339,33 @@ } }, { + "description": "If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.", "name": "wait_for_checkpoint", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.", "name": "wait_for_completion", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L76" }, { "body": { @@ -136266,7 +158382,8 @@ "name": { "name": "Response", "namespace": "transform.stop_transform" - } + }, + "specLocation": "transform/stop_transform/StopTransformResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -136274,12 +158391,99 @@ ], "body": { "kind": "properties", - "properties": [] + "properties": [ + { + "description": "The destination for the transform.", + "name": "dest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Destination", + "namespace": "_global.reindex" + } + } + }, + { + "description": "Free text description of the transform.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.", + "name": "frequency", + "required": false, + "serverDefault": "1m", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + }, + { + "description": "The source of the data for the transform.", + "name": "source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Source", + "namespace": "_global.reindex" + } + } + }, + { + "description": "Defines optional transform settings.", + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Settings", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines the properties transforms require to run continuously.", + "name": "sync", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncContainer", + "namespace": "transform._types" + } + } + }, + { + "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.", + "name": "retention_policy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RetentionPolicyContainer", + "namespace": "transform._types" + } + } + } + ] }, + "description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "inherits": { "type": { - "name": "Request", - "namespace": "transform.put_transform" + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", @@ -136287,8 +158491,48 @@ "name": "Request", "namespace": "transform.update_transform" }, - "path": [], - "query": [] + "path": [ + { + "description": "Identifier for the transform.", + "name": "transform_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.", + "name": "defer_validation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L30-L100" }, { "body": { @@ -136312,7 +158556,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -136349,9 +158593,20 @@ } } }, + { + "name": "latest", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Latest", + "namespace": "transform._types" + } + } + }, { "name": "pivot", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -136360,6 +158615,17 @@ } } }, + { + "name": "retention_policy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RetentionPolicyContainer", + "namespace": "transform._types" + } + } + }, { "name": "settings", "required": true, @@ -136410,7 +158676,107 @@ "name": { "name": "Response", "namespace": "transform.update_transform" - } + }, + "specLocation": "transform/update_transform/UpdateTransformResponse.ts#L32-L48" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "transform.upgrade_transforms" + }, + "path": [], + "query": [ + { + "description": "When true, the request checks for updates but does not run them.", + "name": "dry_run", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and\nreturns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Time", + "namespace": "_types" + } + } + } + ], + "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L49" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "The number of transforms that need to be upgraded.", + "name": "needs_update", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of transforms that don’t require upgrading.", + "name": "no_action", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of transforms that have been upgraded.", + "name": "updated", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "transform.upgrade_transforms" + }, + "specLocation": "transform/upgrade_transforms/UpgradeTransformsResponse.ts#L25-L34" }, { "kind": "interface", @@ -136441,7 +158807,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Action.ts#L87-L90" }, { "kind": "enum", @@ -136459,7 +158826,8 @@ "name": { "name": "AcknowledgementOptions", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Action.ts#L81-L85" }, { "kind": "interface", @@ -136497,7 +158865,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -136577,8 +158945,21 @@ "namespace": "watcher._types" } } + }, + { + "name": "webhook", + "required": false, + "since": "7.14.0", + "type": { + "kind": "instance_of", + "type": { + "name": "ActionWebhook", + "namespace": "watcher._types" + } + } } - ] + ], + "specLocation": "watcher/_types/Action.ts#L29-L42" }, { "kind": "enum", @@ -136602,7 +158983,8 @@ "name": { "name": "ActionExecutionMode", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Action.ts#L60-L66" }, { "kind": "interface", @@ -136655,7 +159037,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Action.ts#L102-L107" }, { "kind": "enum", @@ -136676,7 +159059,8 @@ "name": { "name": "ActionStatusOptions", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Action.ts#L74-L79" }, { "kind": "enum", @@ -136703,7 +159087,40 @@ "name": { "name": "ActionType", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Action.ts#L51-L58" + }, + { + "kind": "interface", + "name": { + "name": "ActionWebhook", + "namespace": "watcher._types" + }, + "properties": [ + { + "name": "host", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Host", + "namespace": "_types" + } + } + }, + { + "name": "port", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "watcher/_types/Action.ts#L44-L47" }, { "kind": "type_alias", @@ -136711,6 +159128,7 @@ "name": "Actions", "namespace": "watcher._types" }, + "specLocation": "watcher/_types/Action.ts#L49-L49", "type": { "key": { "kind": "instance_of", @@ -136744,7 +159162,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -136759,7 +159177,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Activation.ts#L24-L27" }, { "kind": "interface", @@ -136801,7 +159220,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Activation.ts#L29-L33" }, { "kind": "interface", @@ -136809,37 +159229,43 @@ "name": "AlwaysCondition", "namespace": "watcher._types" }, - "properties": [] + "properties": [], + "specLocation": "watcher/_types/Conditions.ts#L25-L25" }, { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "ConditionOp", + "namespace": "watcher._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ArrayCompareOpParams", + "namespace": "watcher._types" + } + } + ], + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], "kind": "interface", "name": { "name": "ArrayCompareCondition", "namespace": "watcher._types" }, "properties": [ - { - "name": "array_path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "comparison", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, { "name": "path", "required": true, @@ -136847,156 +159273,79 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } - }, - { - "name": "quantifier", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Quantifier", - "namespace": "watcher._types" - } - } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "user_defined_value" - } } - ] + ], + "specLocation": "watcher/_types/Conditions.ts#L32-L36" }, { "kind": "interface", "name": { - "name": "ChainInput", + "name": "ArrayCompareOpParams", "namespace": "watcher._types" }, "properties": [ { - "name": "inputs", + "name": "quantifier", "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "InputContainer", - "namespace": "watcher._types" - } - } - } - } - ] - }, - { - "kind": "interface", - "name": { - "name": "CompareCondition", - "namespace": "watcher._types" - }, - "properties": [ - { - "name": "comparison", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "path", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "value", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "ctx.payload.match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CompareContextPayloadCondition", + "name": "Quantifier", "namespace": "watcher._types" } } }, { - "name": "ctx.payload.value", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CompareContextPayloadCondition", - "namespace": "watcher._types" + "name": "FieldValue", + "namespace": "_types" } } } - ] + ], + "specLocation": "watcher/_types/Conditions.ts#L27-L30" }, { "kind": "interface", "name": { - "name": "CompareContextPayloadCondition", + "name": "ChainInput", "namespace": "watcher._types" }, "properties": [ { - "name": "eq", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "lt", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "gt", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "lte", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "gte", - "required": false, + "name": "inputs", + "required": true, "type": { - "kind": "user_defined_value" + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "InputContainer", + "namespace": "watcher._types" + } + } + } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L35-L37" }, { "kind": "interface", @@ -137020,10 +159369,21 @@ "name": "array_compare", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "ArrayCompareCondition", - "namespace": "watcher._types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "ArrayCompareCondition", + "namespace": "watcher._types" + } } } }, @@ -137031,10 +159391,32 @@ "name": "compare", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "CompareCondition", - "namespace": "watcher._types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "ConditionOp", + "namespace": "watcher._types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } } } }, @@ -137061,10 +159443,39 @@ } } ], + "specLocation": "watcher/_types/Conditions.ts#L47-L59", "variants": { "kind": "container" } }, + { + "kind": "enum", + "members": [ + { + "name": "not_eq" + }, + { + "name": "eq" + }, + { + "name": "lt" + }, + { + "name": "gt" + }, + { + "name": "lte" + }, + { + "name": "gte" + } + ], + "name": { + "name": "ConditionOp", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Conditions.ts#L38-L45" + }, { "kind": "enum", "members": [ @@ -137087,7 +159498,8 @@ "name": { "name": "ConditionType", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Conditions.ts#L61-L67" }, { "kind": "enum", @@ -137102,21 +159514,24 @@ "name": { "name": "ConnectionScheme", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Input.ts#L39-L42" }, { - "inherits": { - "type": { - "name": "ScheduleBase", - "namespace": "watcher._types" - } - }, - "kind": "interface", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cron-expressions.html", + "kind": "type_alias", "name": { "name": "CronExpression", "namespace": "watcher._types" }, - "properties": [] + "specLocation": "watcher/_types/Schedule.ts#L27-L30", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "kind": "interface", @@ -137129,29 +159544,18 @@ "name": "at", "required": true, "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TimeOfDay", - "namespace": "watcher._types" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TimeOfDay", + "namespace": "watcher._types" } - ], - "kind": "union_of" + } } } - ] + ], + "specLocation": "watcher/_types/Schedule.ts#L33-L35" }, { "kind": "enum", @@ -137181,7 +159585,8 @@ "name": { "name": "Day", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Schedule.ts#L37-L45" }, { "kind": "interface", @@ -137197,7 +159602,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -137219,11 +159624,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L144-L148" }, { "kind": "enum", @@ -137256,7 +159662,8 @@ "name": { "name": "ExecutionPhase", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Execution.ts#L48-L57" }, { "kind": "interface", @@ -137323,7 +159730,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Execution.ts#L59-L65" }, { "kind": "interface", @@ -137394,7 +159802,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -137442,7 +159850,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Execution.ts#L73-L84" }, { "kind": "interface", @@ -137458,7 +159867,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -137484,7 +159893,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Execution.ts#L67-L71" }, { "kind": "interface", @@ -137501,7 +159911,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -137533,7 +159943,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Execution.ts#L86-L90" }, { "kind": "interface", @@ -137549,7 +159960,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -137564,7 +159975,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Action.ts#L92-L95" }, { "kind": "enum", @@ -137597,7 +160009,8 @@ "name": { "name": "ExecutionStatus", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Execution.ts#L37-L46" }, { "kind": "interface", @@ -137628,15 +160041,30 @@ } } } - ] + ], + "specLocation": "watcher/_types/Execution.ts#L92-L95" }, { "kind": "interface", "name": { - "name": "HourlySchedule", + "name": "HourAndMinute", "namespace": "watcher._types" }, "properties": [ + { + "name": "hour", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + }, { "name": "minute", "required": true, @@ -137651,26 +160079,40 @@ } } } - ] + ], + "specLocation": "watcher/_types/Schedule.ts#L106-L109" }, { "kind": "interface", "name": { - "name": "HttpInput", + "name": "HourlySchedule", "namespace": "watcher._types" }, "properties": [ { - "name": "http", - "required": false, + "name": "minute", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "HttpInput", - "namespace": "watcher._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - }, + } + ], + "specLocation": "watcher/_types/Schedule.ts#L47-L49" + }, + { + "kind": "interface", + "name": { + "name": "HttpInput", + "namespace": "watcher._types" + }, + "properties": [ { "name": "extract", "required": false, @@ -137680,7 +160122,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -137707,7 +160149,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L44-L48" }, { "kind": "interface", @@ -137727,7 +160170,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L50-L52" }, { "kind": "interface", @@ -137758,7 +160202,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L54-L57" }, { "kind": "enum", @@ -137782,7 +160227,8 @@ "name": { "name": "HttpInputMethod", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Input.ts#L59-L65" }, { "kind": "interface", @@ -137813,7 +160259,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L67-L70" }, { "kind": "interface", @@ -137840,7 +160287,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -137863,7 +160310,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -137872,7 +160319,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -137907,7 +160354,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -137916,7 +160363,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -137928,7 +160375,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -137983,11 +160430,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L72-L86" }, { "inherits": { @@ -138001,7 +160449,8 @@ "name": "HttpInputRequestResult", "namespace": "watcher._types" }, - "properties": [] + "properties": [], + "specLocation": "watcher/_types/Actions.ts#L203-L203" }, { "kind": "interface", @@ -138017,7 +160466,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138043,7 +160492,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L205-L209" }, { "kind": "interface", @@ -138073,8 +160523,20 @@ "namespace": "_types" } } + }, + { + "name": "refresh", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Refresh", + "namespace": "_types" + } + } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L165-L169" }, { "kind": "interface", @@ -138094,7 +160556,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L171-L173" }, { "kind": "interface", @@ -138110,7 +160573,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138169,60 +160632,8 @@ } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "IndicesOptions", - "namespace": "watcher._types" - }, - "properties": [ - { - "name": "allow_no_indices", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "expand_wildcards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "name": "ignore_unavailable", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "ignore_throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "internal" - } - } - } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L175-L182" }, { "kind": "interface", @@ -138272,7 +160683,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -138283,6 +160694,7 @@ } } ], + "specLocation": "watcher/_types/Input.ts#L90-L98", "variants": { "kind": "container" } @@ -138303,7 +160715,8 @@ "name": { "name": "InputType", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Input.ts#L100-L104" }, { "kind": "interface", @@ -138314,12 +160727,12 @@ "properties": [ { "name": "level", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138330,11 +160743,23 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" + } + } + }, + { + "name": "category", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L186-L190" }, { "kind": "interface", @@ -138350,11 +160775,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L192-L194" }, { "kind": "enum", @@ -138399,7 +160825,8 @@ "name": { "name": "Month", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Schedule.ts#L70-L83" }, { "kind": "interface", @@ -138407,7 +160834,8 @@ "name": "NeverCondition", "namespace": "watcher._types" }, - "properties": [] + "properties": [], + "specLocation": "watcher/_types/Conditions.ts#L69-L69" }, { "kind": "interface", @@ -138434,7 +160862,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138460,7 +160888,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L62-L67" }, { "kind": "interface", @@ -138476,7 +160905,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138487,7 +160916,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138502,7 +160931,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L45-L49" }, { "kind": "enum", @@ -138517,7 +160947,8 @@ "name": { "name": "PagerDutyContextType", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Actions.ts#L51-L54" }, { "kind": "interface", @@ -138533,7 +160964,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138544,7 +160975,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138555,7 +160986,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138566,7 +160997,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138591,7 +161022,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138613,11 +161044,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L34-L43" }, { "kind": "enum", @@ -138635,7 +161067,8 @@ "name": { "name": "PagerDutyEventType", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Actions.ts#L56-L60" }, { "kind": "interface", @@ -138655,7 +161088,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L69-L71" }, { "kind": "enum", @@ -138670,7 +161104,73 @@ "name": { "name": "Quantifier", "namespace": "watcher._types" - } + }, + "specLocation": "watcher/_types/Conditions.ts#L71-L74" + }, + { + "kind": "interface", + "name": { + "name": "QueryWatch", + "namespace": "watcher._types" + }, + "properties": [ + { + "name": "_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WatchStatus", + "namespace": "watcher._types" + } + } + }, + { + "name": "watch", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Watch", + "namespace": "watcher._types" + } + } + }, + { + "name": "_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } + } + ], + "specLocation": "watcher/_types/Watch.ts#L58-L64" }, { "kind": "enum", @@ -138688,15 +161188,8 @@ "name": { "name": "ResponseContentType", "namespace": "watcher._types" - } - }, - { - "kind": "interface", - "name": { - "name": "ScheduleBase", - "namespace": "watcher._types" }, - "properties": [] + "specLocation": "watcher/_types/Input.ts#L106-L110" }, { "kind": "interface", @@ -138792,6 +161285,7 @@ } } ], + "specLocation": "watcher/_types/Schedule.ts#L85-L96", "variants": { "kind": "container" } @@ -138807,49 +161301,26 @@ "name": "scheduled_time", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } } }, { "name": "triggered_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "DateString", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "DateString", + "namespace": "_types" + } } } - ] + ], + "specLocation": "watcher/_types/Schedule.ts#L98-L101" }, { "kind": "interface", @@ -138865,7 +161336,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -138877,7 +161348,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -138894,11 +161365,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Conditions.ts#L76-L80" }, { "kind": "interface", @@ -138916,7 +161388,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -138943,7 +161415,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L112-L116" }, { "kind": "interface", @@ -138963,7 +161436,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L127-L129" }, { "kind": "interface", @@ -139004,7 +161478,7 @@ "kind": "instance_of", "type": { "name": "IndicesOptions", - "namespace": "watcher._types" + "namespace": "_types" } } }, @@ -139037,11 +161511,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Input.ts#L118-L125" }, { "kind": "interface", @@ -139059,7 +161534,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -139082,11 +161557,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Action.ts#L68-L72" }, { "kind": "interface", @@ -139102,7 +161578,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139113,7 +161589,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139124,7 +161600,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139135,7 +161611,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139146,7 +161622,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139171,7 +161647,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139182,7 +161658,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139193,7 +161669,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139204,7 +161680,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139215,7 +161691,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139226,7 +161702,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139237,7 +161713,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139248,7 +161724,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139263,7 +161739,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L80-L96" }, { "kind": "interface", @@ -139279,7 +161756,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139290,7 +161767,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139301,11 +161778,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L98-L102" }, { "kind": "interface", @@ -139332,11 +161810,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L104-L107" }, { "kind": "interface", @@ -139377,7 +161856,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139388,7 +161867,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139399,7 +161878,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139412,12 +161891,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L109-L116" }, { "kind": "interface", @@ -139433,7 +161913,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139448,7 +161928,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L75-L78" }, { "kind": "interface", @@ -139464,7 +161945,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139479,44 +161960,39 @@ } } } - ] + ], + "specLocation": "watcher/_types/Action.ts#L97-L100" }, { - "kind": "interface", + "codegenNames": [ + "text", + "hour_minute" + ], + "kind": "type_alias", "name": { "name": "TimeOfDay", "namespace": "watcher._types" }, - "properties": [ - { - "name": "hour", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "specLocation": "watcher/_types/Schedule.ts#L103-L104", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "minute", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + }, + { + "kind": "instance_of", + "type": { + "name": "HourAndMinute", + "namespace": "watcher._types" } } - } - ] + ], + "kind": "union_of" + } }, { "kind": "interface", @@ -139534,7 +162010,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -139553,7 +162029,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Schedule.ts#L111-L114" }, { "kind": "interface", @@ -139571,7 +162048,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -139590,7 +162067,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Schedule.ts#L116-L119" }, { "kind": "interface", @@ -139608,7 +162086,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -139641,7 +162119,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Schedule.ts#L121-L125" }, { "kind": "interface", @@ -139652,7 +162131,7 @@ "properties": [ { "name": "schedule", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -139662,6 +162141,7 @@ } } ], + "specLocation": "watcher/_types/Trigger.ts#L23-L28", "variants": { "kind": "container" } @@ -139675,7 +162155,7 @@ "properties": [ { "name": "schedule", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -139685,6 +162165,7 @@ } } ], + "specLocation": "watcher/_types/Trigger.ts#L32-L37", "variants": { "kind": "container" } @@ -139725,11 +162206,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Trigger.ts#L39-L43" }, { "kind": "interface", @@ -139811,7 +162293,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -139848,7 +162330,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Watch.ts#L37-L47" }, { "kind": "interface", @@ -139919,11 +162402,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/_types/Watch.ts#L49-L56" }, { "kind": "interface", @@ -139954,7 +162438,8 @@ } } } - ] + ], + "specLocation": "watcher/_types/Actions.ts#L198-L201" }, { "attachedBehaviors": [ @@ -139963,6 +162448,7 @@ "body": { "kind": "no_body" }, + "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", "inherits": { "type": { "name": "RequestBase", @@ -139976,6 +162462,7 @@ }, "path": [ { + "description": "Watch ID", "name": "watch_id", "required": true, "type": { @@ -139987,6 +162474,7 @@ } }, { + "description": "A comma-separated list of the action ids to be acked", "name": "action_id", "required": false, "type": { @@ -139998,7 +162486,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "watcher/ack_watch/WatcherAckWatchRequest.ts#L23-L33" }, { "body": { @@ -140021,7 +162510,8 @@ "name": { "name": "Response", "namespace": "watcher.ack_watch" - } + }, + "specLocation": "watcher/ack_watch/WatcherAckWatchResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -140030,6 +162520,7 @@ "body": { "kind": "no_body" }, + "description": "Activates a currently inactive watch.", "inherits": { "type": { "name": "RequestBase", @@ -140043,6 +162534,7 @@ }, "path": [ { + "description": "Watch ID", "name": "watch_id", "required": true, "type": { @@ -140054,7 +162546,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "watcher/activate_watch/WatcherActivateWatchRequest.ts#L23-L32" }, { "body": { @@ -140077,7 +162570,8 @@ "name": { "name": "Response", "namespace": "watcher.activate_watch" - } + }, + "specLocation": "watcher/activate_watch/WatcherActivateWatchResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -140086,6 +162580,7 @@ "body": { "kind": "no_body" }, + "description": "Deactivates a currently active watch.", "inherits": { "type": { "name": "RequestBase", @@ -140099,6 +162594,7 @@ }, "path": [ { + "description": "Watch ID", "name": "watch_id", "required": true, "type": { @@ -140110,7 +162606,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "watcher/deactivate_watch/DeactivateWatchRequest.ts#L23-L32" }, { "body": { @@ -140133,7 +162630,8 @@ "name": { "name": "Response", "namespace": "watcher.deactivate_watch" - } + }, + "specLocation": "watcher/deactivate_watch/DeactivateWatchResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -140142,6 +162640,7 @@ "body": { "kind": "no_body" }, + "description": "Removes a watch from Watcher.", "inherits": { "type": { "name": "RequestBase", @@ -140155,6 +162654,7 @@ }, "path": [ { + "description": "Watch ID", "name": "id", "required": true, "type": { @@ -140166,7 +162666,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "watcher/delete_watch/DeleteWatchRequest.ts#L23-L32" }, { "body": { @@ -140179,7 +162680,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140211,7 +162712,8 @@ "name": { "name": "Response", "namespace": "watcher.delete_watch" - } + }, + "specLocation": "watcher/delete_watch/DeleteWatchResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -140228,7 +162730,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -140250,7 +162752,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -140267,7 +162769,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140278,7 +162780,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140317,6 +162819,7 @@ } ] }, + "description": "Forces the execution of a stored watch.", "inherits": { "type": { "name": "RequestBase", @@ -140330,6 +162833,7 @@ }, "path": [ { + "description": "Watch ID", "name": "id", "required": false, "type": { @@ -140343,17 +162847,19 @@ ], "query": [ { + "description": "indicates whether the watch should execute in debug mode", "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "watcher/execute_watch/WatcherExecuteWatchRequest.ts#L28-L49" }, { "body": { @@ -140387,7 +162893,8 @@ "name": { "name": "Response", "namespace": "watcher.execute_watch" - } + }, + "specLocation": "watcher/execute_watch/WatcherExecuteWatchResponse.ts#L23-L25" }, { "kind": "interface", @@ -140427,7 +162934,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -140450,7 +162957,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140509,7 +163016,8 @@ } } } - ] + ], + "specLocation": "watcher/execute_watch/types.ts#L26-L37" }, { "attachedBehaviors": [ @@ -140518,6 +163026,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves a watch by its ID.", "inherits": { "type": { "name": "RequestBase", @@ -140531,6 +163040,7 @@ }, "path": [ { + "description": "Watch ID", "name": "id", "required": true, "type": { @@ -140542,7 +163052,8 @@ } } ], - "query": [] + "query": [], + "specLocation": "watcher/get_watch/GetWatchRequest.ts#L23-L32" }, { "body": { @@ -140555,7 +163066,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140631,7 +163142,8 @@ "name": { "name": "Response", "namespace": "watcher.get_watch" - } + }, + "specLocation": "watcher/get_watch/GetWatchResponse.ts#L24-L34" }, { "attachedBehaviors": [ @@ -140648,7 +163160,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -140702,7 +163214,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140730,6 +163242,7 @@ } ] }, + "description": "Creates a new watch, or updates an existing one.", "inherits": { "type": { "name": "RequestBase", @@ -140743,6 +163256,7 @@ }, "path": [ { + "description": "Watch ID", "name": "id", "required": true, "type": { @@ -140756,17 +163270,19 @@ ], "query": [ { + "description": "Specify whether the watch is in/active by default", "name": "active", "required": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "only update the watch if the last operation that has changed the watch has the specified primary term", "name": "if_primary_term", "required": false, "type": { @@ -140778,17 +163294,19 @@ } }, { - "name": "if_sequence_number", + "description": "only update the watch if the last operation that has changed the watch has the specified sequence number", + "name": "if_seq_no", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "SequenceNumber", "namespace": "_types" } } }, { + "description": "Explicit version number for concurrency control", "name": "version", "required": false, "type": { @@ -140799,7 +163317,8 @@ } } } - ] + ], + "specLocation": "watcher/put_watch/WatcherPutWatchRequest.ts#L30-L54" }, { "body": { @@ -140812,7 +163331,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -140866,7 +163385,8 @@ "name": { "name": "Response", "namespace": "watcher.put_watch" - } + }, + "specLocation": "watcher/put_watch/WatcherPutWatchResponse.ts#L23-L31" }, { "attachedBehaviors": [ @@ -140876,18 +163396,70 @@ "kind": "properties", "properties": [ { - "name": "stub_c", - "required": true, + "description": "The offset from the first result to fetch. Needs to be non-negative.", + "name": "from", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The number of hits to return. Needs to be non-negative.", + "name": "size", + "required": false, + "serverDefault": 10, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Optional, query filter watches to be returned.", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Optional sort definition.", + "name": "sort", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Sort", + "namespace": "_types" + } + } + }, + { + "description": "Optional search After to do pagination using last hit’s sort values.", + "name": "search_after", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortResults", + "namespace": "_types" } } } ] }, + "description": "Retrieves stored watches.", "inherits": { "type": { "name": "RequestBase", @@ -140899,39 +163471,16 @@ "name": "Request", "namespace": "watcher.query_watches" }, - "path": [ - { - "name": "stub_a", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ], - "query": [ - { - "name": "stub_b", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + "path": [], + "query": [], + "specLocation": "watcher/query_watches/WatcherQueryWatchesRequest.ts#L25-L49" }, { "body": { "kind": "properties", "properties": [ { - "name": "stub", + "name": "count", "required": true, "type": { "kind": "instance_of", @@ -140940,6 +163489,20 @@ "namespace": "_types" } } + }, + { + "name": "watches", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryWatch", + "namespace": "watcher._types" + } + } + } } ] }, @@ -140947,7 +163510,8 @@ "name": { "name": "Response", "namespace": "watcher.query_watches" - } + }, + "specLocation": "watcher/query_watches/WatcherQueryWatchesResponse.ts#L23-L28" }, { "attachedBehaviors": [ @@ -140956,6 +163520,7 @@ "body": { "kind": "no_body" }, + "description": "Starts Watcher if it is not already running.", "inherits": { "type": { "name": "RequestBase", @@ -140968,7 +163533,8 @@ "namespace": "watcher.start" }, "path": [], - "query": [] + "query": [], + "specLocation": "watcher/start/WatcherStartRequest.ts#L22-L27" }, { "body": { @@ -140985,7 +163551,8 @@ "name": { "name": "Response", "namespace": "watcher.start" - } + }, + "specLocation": "watcher/start/WatcherStartResponse.ts#L22-L22" }, { "attachedBehaviors": [ @@ -140994,6 +163561,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves the current Watcher metrics.", "inherits": { "type": { "name": "RequestBase", @@ -141007,6 +163575,7 @@ }, "path": [ { + "description": "Defines which additional metrics are included in the response.", "name": "metric", "required": false, "type": { @@ -141035,17 +163604,20 @@ ], "query": [ { + "description": "Defines whether stack traces are generated for each watch that is running.", "name": "emit_stacktraces", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Defines which additional metrics are included in the response.", "name": "metric", "required": false, "type": { @@ -141071,14 +163643,15 @@ "kind": "union_of" } } - ] + ], + "specLocation": "watcher/stats/WatcherStatsRequest.ts#L23-L46" }, { "body": { "kind": "properties", "properties": [ { - "identifier": "node_stats", + "codegenName": "node_stats", "name": "_nodes", "required": true, "type": { @@ -141107,7 +163680,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -141131,7 +163704,8 @@ "name": { "name": "Response", "namespace": "watcher.stats" - } + }, + "specLocation": "watcher/stats/WatcherStatsResponse.ts#L24-L32" }, { "kind": "interface", @@ -141151,7 +163725,8 @@ } } } - ] + ], + "specLocation": "watcher/stats/types.ts#L50-L52" }, { "inherits": { @@ -141197,7 +163772,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -141224,12 +163799,16 @@ } } } - ] + ], + "specLocation": "watcher/stats/types.ts#L54-L60" }, { "kind": "enum", "members": [ { + "aliases": [ + "all" + ], "name": "_all" }, { @@ -141245,7 +163824,8 @@ "name": { "name": "WatcherMetric", "namespace": "watcher.stats" - } + }, + "specLocation": "watcher/stats/types.ts#L42-L48" }, { "kind": "interface", @@ -141326,7 +163906,8 @@ } } } - ] + ], + "specLocation": "watcher/stats/types.ts#L33-L40" }, { "kind": "enum", @@ -141347,7 +163928,8 @@ "name": { "name": "WatcherState", "namespace": "watcher.stats" - } + }, + "specLocation": "watcher/stats/types.ts#L26-L31" }, { "attachedBehaviors": [ @@ -141356,6 +163938,7 @@ "body": { "kind": "no_body" }, + "description": "Stops Watcher if it is running.", "inherits": { "type": { "name": "RequestBase", @@ -141368,7 +163951,8 @@ "namespace": "watcher.stop" }, "path": [], - "query": [] + "query": [], + "specLocation": "watcher/stop/WatcherStopRequest.ts#L22-L27" }, { "body": { @@ -141385,7 +163969,8 @@ "name": { "name": "Response", "namespace": "watcher.stop" - } + }, + "specLocation": "watcher/stop/WatcherStopResponse.ts#L22-L22" }, { "kind": "interface", @@ -141412,11 +163997,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "xpack/info/types.ts#L24-L27" }, { "kind": "interface", @@ -141432,7 +164018,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -141443,7 +164029,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -141454,7 +164040,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -141469,7 +164055,8 @@ } } } - ] + ], + "specLocation": "xpack/info/types.ts#L72-L77" }, { "kind": "interface", @@ -141744,7 +164331,7 @@ }, { "name": "vectors", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -141775,7 +164362,8 @@ } } } - ] + ], + "specLocation": "xpack/info/types.ts#L42-L70" }, { "kind": "interface", @@ -141835,11 +164423,12 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "xpack/info/types.ts#L34-L40" }, { "kind": "interface", @@ -141855,7 +164444,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -141870,7 +164459,8 @@ } } } - ] + ], + "specLocation": "xpack/info/types.ts#L29-L32" }, { "attachedBehaviors": [ @@ -141879,6 +164469,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves information about the installed X-Pack features.", "inherits": { "type": { "name": "RequestBase", @@ -141893,6 +164484,7 @@ "path": [], "query": [ { + "description": "Comma-separated list of info categories. Can be any of: build, license, features", "name": "categories", "required": false, "type": { @@ -141901,12 +164493,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L31" }, { "body": { @@ -141952,7 +164545,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -141962,7 +164555,8 @@ "name": { "name": "Response", "namespace": "xpack.info" - } + }, + "specLocation": "xpack/info/XPackInfoResponse.ts#L22-L29" }, { "inherits": { @@ -141988,7 +164582,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L285-L287" }, { "kind": "interface", @@ -142096,7 +164691,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L50-L60" }, { "inherits": { @@ -142120,12 +164716,13 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L62-L64" }, { "kind": "interface", @@ -142141,7 +164738,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -142152,42 +164749,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] - }, - { - "kind": "interface", - "name": { - "name": "BaseUrlConfig", - "namespace": "xpack.usage" - }, - "properties": [ - { - "name": "url_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - }, - { - "name": "url_value", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" - } - } - } - ] + ], + "specLocation": "xpack/usage/types.ts#L27-L30" }, { "inherits": { @@ -142224,7 +164791,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L289-L292" }, { "kind": "interface", @@ -142255,7 +164823,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L32-L35" }, { "inherits": { @@ -142292,7 +164861,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L70-L73" }, { "kind": "interface", @@ -142411,7 +164981,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L75-L86" }, { "inherits": { @@ -142482,7 +165053,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L294-L301" }, { "kind": "interface", @@ -142502,7 +165074,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L66-L68" }, { "inherits": { @@ -142536,7 +165109,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -142550,7 +165123,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L303-L306" }, { "kind": "interface", @@ -142636,7 +165210,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L88-L96" }, { "kind": "interface", @@ -142700,7 +165275,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L98-L104" }, { "kind": "interface", @@ -142764,7 +165340,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L106-L112" }, { "kind": "interface", @@ -142795,7 +165372,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L114-L117" }, { "kind": "interface", @@ -142870,7 +165448,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L119-L126" }, { "kind": "interface", @@ -142886,11 +165465,12 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L37-L39" }, { "inherits": { @@ -142916,7 +165496,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L308-L310" }, { "inherits": { @@ -142942,7 +165523,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L312-L314" }, { "kind": "interface", @@ -142976,7 +165558,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L147-L150" }, { "kind": "interface", @@ -143007,7 +165590,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L142-L145" }, { "kind": "interface", @@ -143023,7 +165607,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -143034,37 +165618,88 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L152-L155" }, { - "inherits": { - "type": { - "name": "BaseUrlConfig", - "namespace": "xpack.usage" - } - }, "kind": "interface", "name": { - "name": "KibanaUrlConfig", + "name": "JobUsage", "namespace": "xpack.usage" }, "properties": [ { - "name": "time_range", - "required": false, + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "created_by", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + }, + { + "name": "detectors", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "JobStatistics", + "namespace": "ml._types" + } + } + }, + { + "name": "forecasts", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "MlJobForecasts", + "namespace": "xpack.usage" + } + } + }, + { + "name": "model_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "JobStatistics", + "namespace": "ml._types" } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L316-L322" }, { "inherits": { @@ -143087,7 +165722,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -143102,6 +165737,7 @@ } }, { + "description": "Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs.", "name": "jobs", "required": true, "type": { @@ -143109,7 +165745,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -143117,8 +165753,8 @@ "value": { "kind": "instance_of", "type": { - "name": "Job", - "namespace": "ml._types" + "name": "JobUsage", + "namespace": "xpack.usage" } } } @@ -143156,7 +165792,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L324-L331" }, { "kind": "interface", @@ -143176,7 +165813,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L210-L212" }, { "kind": "interface", @@ -143218,7 +165856,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L162-L166" }, { "kind": "interface", @@ -143238,7 +165877,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L172-L174" }, { "kind": "interface", @@ -143258,7 +165898,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L168-L170" }, { "kind": "interface", @@ -143275,7 +165916,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -143300,7 +165941,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L176-L179" }, { "kind": "interface", @@ -143353,7 +165995,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L181-L186" }, { "kind": "interface", @@ -143395,7 +166038,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L195-L199" }, { "kind": "interface", @@ -143448,7 +166092,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L188-L193" }, { "kind": "interface", @@ -143490,6 +166135,17 @@ } } }, + { + "name": "pass_through", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, { "name": "regression", "required": true, @@ -143512,7 +166168,40 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L201-L208" + }, + { + "kind": "interface", + "name": { + "name": "MlJobForecasts", + "namespace": "xpack.usage" + }, + "properties": [ + { + "name": "total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "forecasted_jobs", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "xpack/usage/types.ts#L157-L160" }, { "inherits": { @@ -143534,7 +166223,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -143546,7 +166235,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -143560,7 +166249,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L333-L336" }, { "kind": "interface", @@ -143613,7 +166303,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L214-L219" }, { "inherits": { @@ -143637,7 +166328,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -143693,7 +166384,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -143707,7 +166398,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -143721,7 +166412,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -143735,12 +166426,13 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L369-L378" }, { "kind": "interface", @@ -143760,7 +166452,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L221-L223" }, { "attachedBehaviors": [ @@ -143769,6 +166462,7 @@ "body": { "kind": "no_body" }, + "description": "Retrieves usage information about the installed X-Pack features.", "inherits": { "type": { "name": "RequestBase", @@ -143783,6 +166477,7 @@ "path": [], "query": [ { + "description": "Specify timeout for watch write operation", "name": "master_timeout", "required": false, "type": { @@ -143793,7 +166488,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/XPackUsageRequest.ts#L23-L32" }, { "body": { @@ -144076,7 +166772,7 @@ }, { "name": "vectors", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -144102,7 +166798,8 @@ "name": { "name": "Response", "namespace": "xpack.usage" - } + }, + "specLocation": "xpack/usage/XPackUsageResponse.ts#L41-L71" }, { "kind": "interface", @@ -144133,7 +166830,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L225-L228" }, { "inherits": { @@ -144162,7 +166860,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L230-L232" }, { "kind": "interface", @@ -144246,7 +166945,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -144328,7 +167027,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L234-L249" }, { "inherits": { @@ -144376,7 +167076,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L380-L384" }, { "inherits": { @@ -144454,7 +167155,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -144476,7 +167177,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -144545,7 +167246,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L386-L399" }, { "kind": "interface", @@ -144587,7 +167289,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L251-L255" }, { "kind": "interface", @@ -144607,7 +167310,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L263-L265" }, { "kind": "interface", @@ -144649,7 +167353,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L267-L271" }, { "kind": "interface", @@ -144665,7 +167370,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -144676,7 +167381,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -144691,7 +167396,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L273-L277" }, { "kind": "interface", @@ -144707,7 +167413,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -144718,7 +167424,7 @@ "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, @@ -144733,7 +167439,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L257-L261" }, { "inherits": { @@ -144770,7 +167477,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L401-L404" }, { "inherits": { @@ -144793,7 +167501,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -144815,7 +167523,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -144829,7 +167537,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L338-L341" }, { "kind": "interface", @@ -144860,33 +167569,8 @@ } } } - ] - }, - { - "kind": "type_alias", - "name": { - "name": "UrlConfig", - "namespace": "xpack.usage" - }, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "BaseUrlConfig", - "namespace": "xpack.usage" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KibanaUrlConfig", - "namespace": "xpack.usage" - } - } - ], - "kind": "union_of" - } + ], + "specLocation": "xpack/usage/types.ts#L343-L346" }, { "inherits": { @@ -144934,7 +167618,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L406-L410" }, { "inherits": { @@ -144982,7 +167667,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L412-L416" }, { "kind": "interface", @@ -145013,7 +167699,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L364-L367" }, { "kind": "interface", @@ -145044,7 +167731,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L348-L350" }, { "kind": "interface", @@ -145130,7 +167818,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L352-L357" }, { "kind": "interface", @@ -145161,7 +167850,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L359-L362" }, { "inherits": { @@ -145198,7 +167888,8 @@ } } } - ] + ], + "specLocation": "xpack/usage/types.ts#L418-L421" }, { "description": "In some places in the specification an object consists of the union of a set of known properties\nand a set of runtime injected properties. Meaning that object should theoretically extend Dictionary but expose\na set of known keys and possibly. The object might already be part of an object graph and have a parent class.\nThis puts it into a bind that needs a client specific solution.\nWe therefore document the requirement to behave like a dictionary for unknown properties with this interface.", @@ -145217,7 +167908,28 @@ "name": "AdditionalProperties", "namespace": "_spec_utils" }, - "properties": [] + "properties": [], + "specLocation": "_spec_utils/behaviors.ts#L29-L37" + }, + { + "description": "In some places in the specification an object consists of a static set of properties and a single additional property\nwith an arbitrary name but a statically defined type. This is typically used for configurations associated\nto a single field. Meaning that object should theoretically extend SingleKeyDictionary but expose\na set of known keys. And possibly the object might already be part of an object graph and have a parent class.\nThis puts it into a bind that needs a client specific solution.\nWe therefore document the requirement to accept a single unknown property with this interface.", + "generics": [ + { + "name": "TKey", + "namespace": "_spec_utils" + }, + { + "name": "TValue", + "namespace": "_spec_utils" + } + ], + "kind": "interface", + "name": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + }, + "properties": [], + "specLocation": "_spec_utils/behaviors.ts#L39-L48" }, { "description": "Implements a set of common query parameters all API's support.\nSince these can break the request structure these are listed explicitly as a behavior.\nIts up to individual clients to define support although `error_trace` and `pretty` are\nrecommended as a minimum.", @@ -145228,17 +167940,20 @@ }, "properties": [ { + "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "name": "error_trace", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "name": "filter_path", "required": false, "type": { @@ -145247,7 +167962,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } }, { @@ -145256,7 +167971,7 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } @@ -145265,58 +167980,33 @@ } }, { + "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"eixsts_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "name": "human", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "name": "pretty", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" - } - } - }, - { - "name": "source_query_string", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } - ] - }, - { - "description": "In some places in the specification an object consists of a static set of properties and a single additional property\nwith an arbitrary name but a statically defined type. This is typically used for configurations associated\nto a single field. Meaning that object should theoretically extend SingleKeyDictionary but expose\na set of known keys. And possibly the object might already be part of an object graph and have a parent class.\nThis puts it into a bind that needs a client specific solution.\nWe therefore document the requirement to accept a single unknown property with this interface.", - "generics": [ - { - "name": "TKey", - "namespace": "_spec_utils" - }, - { - "name": "TValue", - "namespace": "_spec_utils" - } ], - "kind": "interface", - "name": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" - }, - "properties": [] + "specLocation": "_spec_utils/behaviors.ts#L50-L84" }, { "description": "Implements a set of common query parameters all Cat API's support.\nSince these can break the request structure these are listed explicitly as a behavior.", @@ -145327,17 +168017,20 @@ }, "properties": [ { + "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", "name": "format", "required": false, + "serverDefault": "text", "type": { "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "List of columns to appear in the response. Supports simple wildcards.", "name": "h", "required": false, "type": { @@ -145349,30 +168042,36 @@ } }, { + "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "name": "help", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "name": "local", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } }, { + "description": "Period to wait for a connection to the master node.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -145382,6 +168081,7 @@ } }, { + "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "name": "s", "required": false, "type": { @@ -145390,23 +168090,42 @@ "kind": "instance_of", "type": { "name": "string", - "namespace": "internal" + "namespace": "_builtins" } } } }, { + "description": "When set to `true` will enable verbose output.", "name": "v", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { "name": "boolean", - "namespace": "internal" + "namespace": "_builtins" } } } - ] + ], + "specLocation": "_spec_utils/behaviors.ts#L86-L132" + }, + { + "description": "A class that implements `OverloadOf` should have the exact same properties with the same types.\nIt can change if a property is required or not. There is no need to port the descriptions\nand js doc tags, the compiler will do that for you.", + "generics": [ + { + "name": "TDefinition", + "namespace": "_spec_utils" + } + ], + "kind": "interface", + "name": { + "name": "OverloadOf", + "namespace": "_spec_utils" + }, + "properties": [], + "specLocation": "_spec_utils/behaviors.ts#L134-L140" } ] } \ No newline at end of file diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index a504dc3d11..02dc149040 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -2,355 +2,541 @@ "endpointErrors": { "async_search.delete": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "async_search.get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "type_alias definition _types.aggregations:Aggregate / instance_of - Non-leaf type cannot be used here: '_types.aggregations:StatsAggregate'", + "type_alias definition _types.aggregations:Aggregate / instance_of - Non-leaf type cannot be used here: '_types.aggregations:ExtendedStatsAggregate'", + "type_alias definition _types.aggregations:Buckets / union_of / dictionary_of / instance_of - No type definition for '_types.aggregations:TBucket'", + "type_alias definition _types.aggregations:Buckets / union_of / array_of / instance_of - No type definition for '_types.aggregations:TBucket'", + "type_alias definition _spec_utils:Void / instance_of - No type definition for '_builtins:void'", + "type_alias definition _types.aggregations:Aggregate / instance_of - Non-leaf type cannot be used here: '_types.aggregations:RangeAggregate'", + "type_alias definition _global.search._types:Suggest - A tagged union should not have generic parameters", + "type_alias definition _global.search._types:Suggest / instance_of / Generics / instance_of - No type definition for '_global.search._types:TDocument'", + "type_alias definition _global.search._types:Suggest - Expected 1 generic parameters but got 0" + ] }, "async_search.status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "async_search.submit": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'ccs_minimize_roundtrips' does not exist in the json spec", + "Request: query parameter 'min_compatible_shard_node' does not exist in the json spec", + "Request: query parameter 'pre_filter_shard_size' does not exist in the json spec", + "Request: query parameter 'scroll' does not exist in the json spec", + "Request: query parameter 'rest_total_hits_as_int' does not exist in the json spec" ], "response": [] }, "autoscaling.delete_autoscaling_policy": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "autoscaling.get_autoscaling_capacity": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "autoscaling.get_autoscaling_policy": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "autoscaling.put_autoscaling_policy": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cat.aliases": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.aliases:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.allocation": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.allocation:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.count": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.count:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.fielddata": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: missing json spec query parameter 'fields'", + "Request: should not have a body", + "request definition cat.fielddata:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.health": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.health:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.help": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: should not have a body", + "request definition cat.help:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.indices": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.indices:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.master": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.master:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.ml_data_frame_analytics": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.ml_data_frame_analytics:Request / query - Property 'h' is already defined in an ancestor class", + "request definition cat.ml_data_frame_analytics:Request / query - Property 's' is already defined in an ancestor class", + "request definition cat.ml_data_frame_analytics:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.ml_datafeeds": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body", + "request definition cat.ml_datafeeds:Request / query - Property 'format' is already defined in an ancestor class", + "request definition cat.ml_datafeeds:Request / query - Property 'h' is already defined in an ancestor class", + "request definition cat.ml_datafeeds:Request / query - Property 'help' is already defined in an ancestor class", + "request definition cat.ml_datafeeds:Request / query - Property 's' is already defined in an ancestor class", + "request definition cat.ml_datafeeds:Request / query - Property 'v' is already defined in an ancestor class", + "request definition cat.ml_datafeeds:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.ml_jobs": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body", + "request definition cat.ml_jobs:Request / query - Property 'format' is already defined in an ancestor class", + "request definition cat.ml_jobs:Request / query - Property 'h' is already defined in an ancestor class", + "request definition cat.ml_jobs:Request / query - Property 'help' is already defined in an ancestor class", + "request definition cat.ml_jobs:Request / query - Property 's' is already defined in an ancestor class", + "request definition cat.ml_jobs:Request / query - Property 'v' is already defined in an ancestor class", + "request definition cat.ml_jobs:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.ml_trained_models": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.ml_trained_models:Request / query - Property 'h' is already defined in an ancestor class", + "request definition cat.ml_trained_models:Request / query - Property 's' is already defined in an ancestor class", + "request definition cat.ml_trained_models:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.nodeattrs": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.nodeattrs:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.nodes": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: missing json spec query parameter 'include_unloaded_segments'", + "Request: should not have a body", + "request definition cat.nodes:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.pending_tasks": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.pending_tasks:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.plugins": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 'include_bootstrap'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.plugins:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.recovery": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 'index'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.recovery:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.repositories": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.repositories:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.segments": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.segments:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.shards": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.shards:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.snapshots": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.snapshots:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.tasks": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'node_id' does not exist in the json spec", + "Request: query parameter 'parent_task' does not exist in the json spec", + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'nodes'", + "Request: missing json spec query parameter 'parent_task_id'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'time'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.tasks:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.templates": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.templates:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.thread_pool": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'local'", + "Request: missing json spec query parameter 'master_timeout'", + "Request: missing json spec query parameter 'h'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 's'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.thread_pool:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "cat.transforms": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'format'", + "Request: missing json spec query parameter 'help'", + "Request: missing json spec query parameter 'v'", + "Request: should not have a body", + "request definition cat.transforms:Request / query - Property 'h' is already defined in an ancestor class", + "request definition cat.transforms:Request / query - Property 's' is already defined in an ancestor class", + "request definition cat.transforms:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] }, "ccr.delete_auto_follow_pattern": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.follow_info": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.follow_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.get_auto_follow_pattern": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.pause_auto_follow_pattern": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.pause_follow": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.resume_auto_follow_pattern": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ccr.unfollow": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.delete_component_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.delete_voting_config_exclusions": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.exists_component_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.get_component_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'flat_settings' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "cluster.get_settings": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.health": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.pending_tasks": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.post_voting_config_exclusions": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.put_component_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'timeout'", + "request definition cluster.put_component_template:Request / body / Property 'template' / instance_of - Non-leaf type cannot be used here: 'indices._types:IndexState'" ], "response": [] }, "cluster.remote_info": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "cluster.reroute": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.state": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "cluster.stats": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "count": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "dangling_indices.delete_dangling_index": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "dangling_indices.import_dangling_index": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "dangling_indices.list_dangling_indices": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -404,101 +590,110 @@ }, "delete": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "delete_by_query_rethrottle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "delete_script": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "enrich.delete_policy": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "enrich.execute_policy": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "enrich.get_policy": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "enrich.stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "eql.delete": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "eql.get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "eql.get_status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "eql.search": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'allow_no_indices' does not exist in the json spec", + "Request: query parameter 'expand_wildcards' does not exist in the json spec", + "Request: query parameter 'ignore_unavailable' does not exist in the json spec" ], "response": [] }, "exists": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "exists_source": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "explain": { + "features.get_features": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'master_timeout'", + "Request: should not have a body" ], "response": [] }, - "features.get_features": { + "features.reset_features": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "features.reset_features": { + "fleet.global_checkpoints": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "fleet.global_checkpoints": { + "fleet.msearch": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "fleet.search": { "request": [ "Missing request & response" ], @@ -506,193 +701,205 @@ }, "get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "get_script": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "get_script_context": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "get_script_languages": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "get_source": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'stored_fields' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "ilm.delete_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "ilm.explain_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "ilm.get_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "ilm.get_status": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "ilm.migrate_to_data_tiers": { - "request": [ - "Missing request & response" + "Request: should not have a body" ], "response": [] }, "ilm.put_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec" ], "response": [] }, "ilm.remove_policy": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ilm.retry": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ilm.start": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "ilm.stop": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "indices.add_block": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.analyze": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'index'" ], "response": [] }, "indices.clear_cache": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'index'", + "Request: should not have a body" ], "response": [] }, "indices.close": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.create_data_stream": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.data_streams_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.delete": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.delete_alias": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.delete_data_stream": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.delete_index_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.delete_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.disk_usage": { "request": [ - "Missing request & response" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec", + "Request: query parameter 'wait_for_active_shards' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "indices.exists": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.exists_alias": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.exists_index_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'flat_settings'", + "Request: missing json spec query parameter 'local'", + "Request: should not have a body" ], "response": [] }, "indices.exists_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.exists_type": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -704,217 +911,222 @@ }, "indices.flush": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.flush_synced": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.forcemerge": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.freeze": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "response definition indices.get:Response / Inherits / Generics / instance_of - Non-leaf type cannot be used here: 'indices._types:IndexState'" + ] }, "indices.get_alias": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.get_data_stream": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.get_field_mapping": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.get_index_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'include_type_name' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "indices.get_mapping": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.get_settings": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "response definition indices.get_settings:Response / Inherits / Generics / instance_of - Non-leaf type cannot be used here: 'indices._types:IndexState'" + ] }, "indices.get_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.get_upgrade": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'ignore_unavailable'", + "Request: missing json spec query parameter 'allow_no_indices'", + "Request: missing json spec query parameter 'expand_wildcards'", + "Request: should not have a body" ], "response": [] }, "indices.migrate_to_data_stream": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "indices.open": { + "indices.modify_data_stream": { "request": [ - "Endpoint has \"@stability: TODO" + "Missing request & response" ], "response": [] }, - "indices.promote_data_stream": { + "indices.open": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "indices.put_index_template": { + "indices.promote_data_stream": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "indices.put_settings": { + "indices.put_index_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'create'", + "Request: missing json spec query parameter 'cause'", + "Request: missing json spec query parameter 'master_timeout'" ], "response": [] }, "indices.put_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'flat_settings' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec" ], "response": [] }, "indices.recovery": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.refresh": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.reload_search_analyzers": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.resolve_index": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.segments": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.shard_stores": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.shrink": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'copy_settings'" ], "response": [] }, "indices.simulate_index_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'cause'" ], "response": [] }, "indices.simulate_template": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'cause'" ], "response": [] }, "indices.split": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'copy_settings'" ], "response": [] }, "indices.stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.unfreeze": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "indices.upgrade": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "indices.validate_query": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "info": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ingest.delete_pipeline": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ingest.geo_ip_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -926,212 +1138,227 @@ }, "ingest.processor_grok": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" + ], + "response": [] + }, + "ingest.put_pipeline": { + "request": [ + "Request: missing json spec query parameter 'if_version'" ], "response": [] }, + "ingest.simulate": { + "request": [], + "response": [ + "type_alias definition _spec_utils:Stringified / union_of / instance_of - No type definition for '_spec_utils:T'" + ] + }, "license.delete": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "license.get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "license.get_basic_status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "license.get_trial_status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "license.post_start_basic": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "license.post_start_trial": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'type_query_string' does not exist in the json spec", + "Request: missing json spec query parameter 'type'", + "Request: should not have a body" ], "response": [] }, "logstash.delete_pipeline": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "logstash.get_pipeline": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "logstash.put_pipeline": { + "mget": { + "request": [], + "response": [ + "type_alias definition _global.mget:ResponseItem / union_of / instance_of / Generics / instance_of - No type definition for '_global.mget:TDocument'" + ] + }, + "migration.deprecations": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "migration.deprecations": { + "migration.get_feature_upgrade_status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "ml.close_job": { + "migration.post_feature_upgrade": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_calendar": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_calendar_event": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_calendar_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_data_frame_analytics": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_datafeed": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "ml.delete_expired_data": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_filter": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_forecast": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_model_snapshot": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_trained_model": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.delete_trained_model_alias": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.evaluate_data_frame": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] + "request": [], + "response": [ + "interface definition ml.evaluate_data_frame:DataframeRegressionSummary / Property 'huber' / instance_of - Non-leaf type cannot be used here: 'ml.evaluate_data_frame:DataframeEvaluationValue'", + "interface definition ml.evaluate_data_frame:DataframeRegressionSummary / Property 'mse' / instance_of - Non-leaf type cannot be used here: 'ml.evaluate_data_frame:DataframeEvaluationValue'", + "interface definition ml.evaluate_data_frame:DataframeRegressionSummary / Property 'msle' / instance_of - Non-leaf type cannot be used here: 'ml.evaluate_data_frame:DataframeEvaluationValue'", + "interface definition ml.evaluate_data_frame:DataframeRegressionSummary / Property 'r_squared' / instance_of - Non-leaf type cannot be used here: 'ml.evaluate_data_frame:DataframeEvaluationValue'" + ] }, "ml.find_file_structure": { "request": [ - "Endpoint has \"@stability: TODO" + "Missing request & response" ], "response": [] }, "ml.flush_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'calc_interim'", + "Request: missing json spec query parameter 'start'", + "Request: missing json spec query parameter 'end'", + "Request: missing json spec query parameter 'advance_time'" ], "response": [] }, "ml.forecast": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "ml.get_buckets": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'duration'", + "Request: missing json spec query parameter 'expires_in'", + "Request: missing json spec query parameter 'max_model_memory'" ], "response": [] }, "ml.get_calendar_events": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.get_data_frame_analytics": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.get_data_frame_analytics_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.get_datafeed_stats": { "request": [ - "Request: missing json spec query parameter 'allow_no_match'", "Request: should not have a body" ], "response": [] }, "ml.get_datafeeds": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.get_filters": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -1146,41 +1373,34 @@ "request": [ "Request: should not have a body" ], - "response": [ - "type_alias definition xpack.usage:UrlConfig / union_of / instance_of - Non-leaf type cannot be used here: 'xpack.usage:BaseUrlConfig'" - ] + "response": [] }, - "ml.get_overall_buckets": { + "ml.get_model_snapshot_upgrade_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "ml.get_records": { + "ml.get_overall_buckets": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'allow_no_jobs'" ], "response": [] }, "ml.get_trained_models": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'include_model_definition'", + "Request: should not have a body" ], "response": [] }, "ml.get_trained_models_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.info": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "ml.open_job": { "request": [ "Request: should not have a body" ], @@ -1188,25 +1408,28 @@ }, "ml.put_calendar_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "ml.put_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'ignore_unavailable'", + "Request: missing json spec query parameter 'allow_no_indices'", + "Request: missing json spec query parameter 'ignore_throttled'", + "Request: missing json spec query parameter 'expand_wildcards'" ], "response": [] }, "ml.put_trained_model": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'defer_definition_decompression'" ], "response": [] }, "ml.put_trained_model_alias": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -1216,39 +1439,34 @@ ], "response": [] }, - "ml.set_upgrade_mode": { + "ml.revert_model_snapshot": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'delete_intervening_results'" ], "response": [] }, - "ml.start_datafeed": { + "ml.set_upgrade_mode": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "ml.stop_datafeed": { + "ml.start_datafeed": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'end'", + "Request: missing json spec query parameter 'timeout'" ], "response": [] }, - "ml.update_datafeed": { + "ml.stop_datafeed": { "request": [ - "Missing request & response" + "Request: missing json spec query parameter 'timeout'" ], "response": [] }, "ml.upgrade_job_snapshot": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "monitoring.bulk": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -1257,336 +1475,337 @@ "Request: query parameter 'allow_no_indices' does not exist in the json spec", "Request: query parameter 'expand_wildcards' does not exist in the json spec", "Request: query parameter 'ignore_throttled' does not exist in the json spec", - "Request: query parameter 'ignore_unavailable' does not exist in the json spec" + "Request: query parameter 'ignore_unavailable' does not exist in the json spec", + "Request: query parameter 'routing' does not exist in the json spec" ], "response": [ - "type_alias definition _types.aggregations:Aggregate / union_of / instance_of - Non-leaf type cannot be used here: '_types.aggregations:MultiBucketAggregate'", - "type_alias definition _types.aggregations:MetricAggregate / union_of / instance_of - Non-leaf type cannot be used here: '_types.aggregations:ValueAggregate'", - "type_alias definition _types.aggregations:MetricAggregate / union_of / instance_of - Non-leaf type cannot be used here: '_types.aggregations:StatsAggregate'", - "type_alias definition _global.search._types:SuggestOption / union_of / instance_of / Generics / instance_of - No type definition for '_global.search._types:TDocument'" + "type_alias definition _global.msearch:ResponseItem / union_of / instance_of / Generics / instance_of - No type definition for '_global.msearch:TDocument'" ] }, - "msearch_template": { + "nodes.clear_repositories_metering_archive": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "mtermvectors": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "nodes.clear_metering_archive": { - "request": [ - "Missing request & response" + "Request: should not have a body" ], "response": [] }, - "nodes.get_metering_info": { + "nodes.get_repositories_metering_info": { "request": [ - "Missing request & response" + "Request: should not have a body" ], "response": [] }, "nodes.hot_threads": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: missing json spec query parameter 'sort'", + "Request: should not have a body" ], "response": [] }, "nodes.info": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "nodes.reload_secure_settings": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] + "request": [], + "response": [ + "interface definition nodes._types:OperatingSystem / Property 'swap' / instance_of - Non-leaf type cannot be used here: 'nodes._types:MemoryStats'", + "interface definition nodes._types:Process / Property 'mem' / instance_of - Non-leaf type cannot be used here: 'nodes._types:MemoryStats'" + ] }, "nodes.stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "nodes.usage": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "open_point_in_time": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'preference'", + "Request: missing json spec query parameter 'routing'", + "Request: missing json spec query parameter 'expand_wildcards'", + "Request: should not have a body" ], "response": [] }, "ping": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "put_script": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'context'" ], "response": [] }, "reindex": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'require_alias' does not exist in the json spec", + "Request: missing json spec query parameter 'max_docs'" ], "response": [] }, "reindex_rethrottle": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "render_search_template": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "rollup.delete_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "rollup.get_jobs": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "rollup.get_rollup_caps": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "rollup.get_rollup_index_caps": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "rollup.rollup": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "rollup.start_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "rollup.stop_job": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "scroll": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] + "request": [], + "response": [ + "response definition _global.scroll:Response / body / instance_of - Non-leaf type cannot be used here: '_global.search:ResponseBody'" + ] }, "search": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] + "request": [], + "response": [ + "response definition _global.search:Response / body / instance_of - Non-leaf type cannot be used here: '_global.search:ResponseBody'" + ] }, - "search_shards": { + "search_mvt": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'track_total_hits'" ], - "response": [] + "response": [ + "type_alias definition _types:MapboxVectorTiles / instance_of - No type definition for '_builtins:binary'" + ] }, - "search_template": { + "search_shards": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "searchable_snapshots.cache_stats": { "request": [ - "Missing request & response" + "Request: should not have a body" ], "response": [] }, "searchable_snapshots.clear_cache": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'pretty' does not exist in the json spec", + "Request: query parameter 'human' does not exist in the json spec", + "Request: missing json spec query parameter 'index'", + "Request: should not have a body", + "request definition searchable_snapshots.clear_cache:Request / query - Property 'pretty' is already defined in an ancestor class", + "request definition searchable_snapshots.clear_cache:Request / query - Property 'human' is already defined in an ancestor class" ], "response": [] }, "searchable_snapshots.repository_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Missing request & response" ], "response": [] }, "searchable_snapshots.stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.authenticate": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.clear_api_key_cache": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.clear_cached_privileges": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.clear_cached_realms": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.clear_cached_roles": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.clear_cached_service_tokens": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.create_service_token": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'refresh'", + "Request: should not have a body" ], "response": [] }, "security.delete_privileges": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.delete_role": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.delete_role_mapping": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.delete_service_token": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.delete_user": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.disable_user": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.enable_user": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_api_key": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_builtin_privileges": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_privileges": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_role": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_role_mapping": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_service_accounts": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_service_credentials": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "security.get_user": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "response definition security.get_user:Response / Inherits / Generics / instance_of - Non-leaf type cannot be used here: 'security._types:User'" + ] }, "security.get_user_privileges": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'application' does not exist in the json spec", + "Request: query parameter 'priviledge' does not exist in the json spec", + "Request: should not have a body" ], "response": [] }, "security.grant_api_key": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'refresh'" + ], + "response": [] + }, + "security.query_api_keys": { + "request": [ + "Missing request & response" ], "response": [] }, @@ -1628,103 +1847,106 @@ }, "shutdown.delete_node": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "shutdown.get_node": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "shutdown.put_node": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.delete_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.execute_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.execute_retention": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.get_lifecycle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.get_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.get_status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" + ], + "response": [] + }, + "slm.put_lifecycle": { + "request": [ + "Request: query parameter 'master_timeout' does not exist in the json spec", + "Request: query parameter 'timeout' does not exist in the json spec" ], "response": [] }, "slm.start": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "slm.stop": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "snapshot.cleanup_repository": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "snapshot.clone": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'timeout' does not exist in the json spec" ], "response": [] }, "snapshot.delete": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "snapshot.delete_repository": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "snapshot.get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: query parameter 'human' does not exist in the json spec", + "Request: should not have a body", + "request definition snapshot.get:Request / query - Property 'human' is already defined in an ancestor class" ], "response": [] }, "snapshot.get_repository": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -1736,19 +1958,19 @@ }, "snapshot.restore": { "request": [ - "Endpoint has \"@stability: TODO" + "request definition snapshot.restore:Request / body / Property 'index_settings' / instance_of - 'indices.put_settings:Request' is a request and must only be used in endpoints" ], "response": [] }, "snapshot.status": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "snapshot.verify_repository": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, @@ -1772,171 +1994,185 @@ }, "ssl.certificates": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "tasks.cancel": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "tasks.get": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "tasks.list": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "transform.delete_transform": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "transform.get_transform": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "interface definition transform._types:SyncContainer - Property time is a single-variant and must be required" + ] }, "transform.get_transform_stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "transform.preview_transform": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "transform.put_transform": { - "request": [ - "Endpoint has \"@stability: TODO" + "interface definition transform._types:RetentionPolicyContainer - Property time is a single-variant and must be required" ], - "response": [] + "response": [ + "response definition transform.preview_transform:Response / body / Property 'generated_dest_index' / instance_of - Non-leaf type cannot be used here: 'indices._types:IndexState'" + ] }, "transform.start_transform": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "transform.stop_transform": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "transform.update_transform": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, - "update": { + "transform.upgrade_transforms": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "update_by_query": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'q'", + "Request: missing json spec query parameter 'max_docs'" ], "response": [] }, "update_by_query_rethrottle": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.ack_watch": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.activate_watch": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.deactivate_watch": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.delete_watch": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.execute_watch": { "request": [ - "Endpoint has \"@stability: TODO" + "interface definition watcher._types:SearchInputRequestDefinition / Property 'template' / instance_of - '_global.search_template:Request' is a request and must only be used in endpoints", + "interface definition watcher._types:HttpInput / Property 'request' / instance_of - Non-leaf type cannot be used here: 'watcher._types:HttpInputRequestDefinition'", + "interface definition watcher._types:TriggerContainer - Property schedule is a single-variant and must be required" ], - "response": [] + "response": [ + "interface definition watcher._types:TriggerEventContainer - Property schedule is a single-variant and must be required" + ] }, "watcher.get_watch": { "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "watcher.put_watch": { - "request": [ - "Endpoint has \"@stability: TODO" - ], - "response": [] - }, - "watcher.query_watches": { - "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.start": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "watcher.stats": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "interface definition watcher.stats:WatcherNodeStats / Property 'queued_watches' / array_of / instance_of - Non-leaf type cannot be used here: 'watcher.stats:WatchRecordQueuedStats'" + ] }, "watcher.stop": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], "response": [] }, "xpack.info": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: missing json spec query parameter 'accept_enterprise'", + "Request: should not have a body" ], "response": [] }, "xpack.usage": { "request": [ - "Endpoint has \"@stability: TODO" + "Request: should not have a body" ], - "response": [] + "response": [ + "response definition xpack.usage:Response / body / Property 'aggregate_metric' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "interface definition xpack.usage:WatcherWatch / Property 'input' / dictionary_of / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "interface definition xpack.usage:WatcherWatch / Property 'condition' / dictionary_of / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "interface definition xpack.usage:WatcherWatch / Property 'action' / dictionary_of / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "interface definition xpack.usage:WatcherWatchTriggerSchedule / Property 'cron' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "interface definition xpack.usage:WatcherWatchTriggerSchedule / Property '_all' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "interface definition xpack.usage:WatcherWatchTrigger / Property '_all' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "interface definition xpack.usage:Watcher / Property 'count' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Counter'", + "response definition xpack.usage:Response / body / Property 'data_frame' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'data_science' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'enrich' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'graph' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'logstash' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'rollup' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'spatial' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "interface definition xpack.usage:Security / Property 'api_key_service' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Security / Property 'anonymous' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Security / Property 'fips_140' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Ssl / Property 'http' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Ssl / Property 'transport' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Security / Property 'system_key' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Security / Property 'token_service' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:FeatureToggle'", + "interface definition xpack.usage:Security / Property 'operator_privileges' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'transform' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'", + "response definition xpack.usage:Response / body / Property 'voting_only' / instance_of - Non-leaf type cannot be used here: 'xpack.usage:Base'" + ] } }, "generalErrors": [] diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 62a38083e2..b9d7c522f4 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -17,31 +17,23 @@ * under the License. */ -export interface BulkCreateOperation extends BulkOperation { +export interface BulkCreateOperation extends BulkWriteOperation { } -export interface BulkCreateResponseItem extends BulkResponseItemBase { +export interface BulkDeleteOperation extends BulkOperationBase { } -export interface BulkDeleteOperation extends BulkOperation { +export interface BulkIndexOperation extends BulkWriteOperation { } -export interface BulkDeleteResponseItem extends BulkResponseItemBase { -} - -export interface BulkIndexOperation extends BulkOperation { -} - -export interface BulkIndexResponseItem extends BulkResponseItemBase { -} - -export interface BulkOperation { - _id: Id - _index: IndexName - retry_on_conflict: integer - routing: Routing - version: VersionNumber - version_type: VersionType +export interface BulkOperationBase { + _id?: Id + _index?: IndexName + routing?: Routing + if_primary_term?: long + if_seq_no?: SequenceNumber + version?: VersionNumber + version_type?: VersionType } export interface BulkOperationContainer { @@ -51,29 +43,31 @@ export interface BulkOperationContainer { delete?: BulkDeleteOperation } -export interface BulkRequest extends RequestBase { +export type BulkOperationType = 'index' | 'create' | 'update' | 'delete' + +export interface BulkRequest extends RequestBase { index?: IndexName type?: Type pipeline?: string refresh?: Refresh routing?: Routing - _source?: boolean | Fields + _source?: SearchSourceConfigParam _source_excludes?: Fields _source_includes?: Fields timeout?: Time wait_for_active_shards?: WaitForActiveShards require_alias?: boolean - body?: (BulkOperationContainer | TSource)[] + body?: (BulkOperationContainer | BulkUpdateAction | TDocument)[] } export interface BulkResponse { errors: boolean - items: BulkResponseItemContainer[] + items: Partial>[] took: long ingest_took?: long } -export interface BulkResponseItemBase { +export interface BulkResponseItem { _id?: string | null _index: string status: integer @@ -88,17 +82,25 @@ export interface BulkResponseItemBase { get?: InlineGet> } -export interface BulkResponseItemContainer { - index?: BulkIndexResponseItem - create?: BulkCreateResponseItem - update?: BulkUpdateResponseItem - delete?: BulkDeleteResponseItem +export interface BulkUpdateAction { + detect_noop?: boolean + doc?: TPartialDocument + doc_as_upsert?: boolean + script?: Script + scripted_upsert?: boolean + _source?: SearchSourceConfig + upsert?: TDocument } -export interface BulkUpdateOperation extends BulkOperation { +export interface BulkUpdateOperation extends BulkOperationBase { + require_alias?: boolean + retry_on_conflict?: integer } -export interface BulkUpdateResponseItem extends BulkResponseItemBase { +export interface BulkWriteOperation extends BulkOperationBase { + dynamic_templates?: Record + pipeline?: string + require_alias?: boolean } export interface ClearScrollRequest extends RequestBase { @@ -130,7 +132,7 @@ export interface CountRequest extends RequestBase { allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean - default_operator?: DefaultOperator + default_operator?: QueryDslOperator df?: string expand_wildcards?: ExpandWildcards ignore_throttled?: boolean @@ -138,7 +140,6 @@ export interface CountRequest extends RequestBase { lenient?: boolean min_score?: double preference?: string - query_on_query_string?: string routing?: Routing terminate_after?: long q?: string @@ -193,7 +194,7 @@ export interface DeleteByQueryRequest extends RequestBase { analyzer?: string analyze_wildcard?: boolean conflicts?: Conflicts - default_operator?: DefaultOperator + default_operator?: QueryDslOperator df?: string expand_wildcards?: ExpandWildcards from?: long @@ -211,11 +212,8 @@ export interface DeleteByQueryRequest extends RequestBase { search_timeout?: Time search_type?: SearchType size?: long - slices?: long + slices?: Slices sort?: string[] - _source?: boolean | Fields - _source_excludes?: Fields - _source_includes?: Fields stats?: string[] terminate_after?: long timeout?: Time @@ -251,7 +249,7 @@ export interface DeleteByQueryRethrottleRequest extends RequestBase { requests_per_second?: long } -export interface DeleteByQueryRethrottleResponse extends TaskListResponse { +export interface DeleteByQueryRethrottleResponse extends TasksListResponse { } export interface DeleteScriptRequest extends RequestBase { @@ -271,9 +269,9 @@ export interface ExistsRequest extends RequestBase { realtime?: boolean refresh?: boolean routing?: Routing - source_enabled?: boolean - source_excludes?: Fields - source_includes?: Fields + _source?: SearchSourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields stored_fields?: Fields version?: VersionNumber version_type?: VersionType @@ -289,9 +287,9 @@ export interface ExistsSourceRequest extends RequestBase { realtime?: boolean refresh?: boolean routing?: Routing - source_enabled?: boolean - source_excludes?: Fields - source_includes?: Fields + _source?: SearchSourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields version?: VersionNumber version_type?: VersionType } @@ -316,13 +314,12 @@ export interface ExplainRequest extends RequestBase { type?: Type analyzer?: string analyze_wildcard?: boolean - default_operator?: DefaultOperator + default_operator?: QueryDslOperator df?: string lenient?: boolean preference?: string - query_on_query_string?: string routing?: Routing - _source?: boolean | Fields + _source?: SearchSourceConfigParam _source_excludes?: Fields _source_includes?: Fields stored_fields?: Fields @@ -341,31 +338,6 @@ export interface ExplainResponse { get?: InlineGet } -export interface FieldCapsFieldCapabilitiesBodyIndexFilter { - range?: FieldCapsFieldCapabilitiesBodyIndexFilterRange - match_none?: EmptyObject - term?: FieldCapsFieldCapabilitiesBodyIndexFilterTerm -} - -export interface FieldCapsFieldCapabilitiesBodyIndexFilterRange { - timestamp: FieldCapsFieldCapabilitiesBodyIndexFilterRangeTimestamp -} - -export interface FieldCapsFieldCapabilitiesBodyIndexFilterRangeTimestamp { - gte?: integer - gt?: integer - lte?: integer - lt?: integer -} - -export interface FieldCapsFieldCapabilitiesBodyIndexFilterTerm { - versionControl: FieldCapsFieldCapabilitiesBodyIndexFilterTermVersionControl -} - -export interface FieldCapsFieldCapabilitiesBodyIndexFilterTermVersionControl { - value: string -} - export interface FieldCapsFieldCapability { aggregatable: boolean indices?: Indices @@ -374,6 +346,7 @@ export interface FieldCapsFieldCapability { non_searchable_indices?: Indices searchable: boolean type: string + metadata_field?: boolean } export interface FieldCapsRequest extends RequestBase { @@ -384,7 +357,8 @@ export interface FieldCapsRequest extends RequestBase { ignore_unavailable?: boolean include_unmapped?: boolean body?: { - index_filter?: FieldCapsFieldCapabilitiesBodyIndexFilter + index_filter?: QueryDslQueryContainer + runtime_mappings?: MappingRuntimeFields } } @@ -393,6 +367,19 @@ export interface FieldCapsResponse { fields: Record> } +export interface GetGetResult { + _index: IndexName + fields?: Record + found: boolean + _id: Id + _primary_term?: long + _routing?: string + _seq_no?: SequenceNumber + _source?: TDocument + _type?: Type + _version?: VersionNumber +} + export interface GetRequest extends RequestBase { id: Id index: IndexName @@ -401,27 +388,15 @@ export interface GetRequest extends RequestBase { realtime?: boolean refresh?: boolean routing?: Routing - source_enabled?: boolean + _source?: SearchSourceConfigParam _source_excludes?: Fields _source_includes?: Fields stored_fields?: Fields version?: VersionNumber version_type?: VersionType - _source?: boolean | Fields } -export interface GetResponse { - _index: IndexName - fields?: Record - found: boolean - _id: Id - _primary_term?: long - _routing?: string - _seq_no?: SequenceNumber - _source?: TDocument - _type?: Type - _version?: VersionNumber -} +export type GetResponse = GetGetResult export interface GetScriptRequest extends RequestBase { id: Id @@ -470,7 +445,20 @@ export interface GetScriptLanguagesResponse { types_allowed: string[] } -export interface GetSourceRequest extends GetRequest { +export interface GetSourceRequest extends RequestBase { + id: Id + index: IndexName + type?: string + preference?: string + realtime?: boolean + refresh?: boolean + routing?: Routing + _source?: SearchSourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields + stored_fields?: Fields + version?: VersionNumber + version_type?: VersionType } export type GetSourceResponse = TDocument @@ -507,27 +495,18 @@ export interface InfoResponse { version: ElasticsearchVersionInfo } -export interface MgetHit { - error?: MainError - fields?: Record - found?: boolean +export interface MgetMultiGetError { + error: ErrorCause _id: Id _index: IndexName - _primary_term?: long - _routing?: Routing - _seq_no?: SequenceNumber - _source?: TDocument _type?: Type - _version?: VersionNumber } -export type MgetMultiGetId = string | integer - export interface MgetOperation { - _id: MgetMultiGetId + _id: Id _index?: IndexName routing?: Routing - _source?: boolean | Fields | SearchSourceFilter + _source?: SearchSourceConfig stored_fields?: Fields _type?: Type version?: VersionNumber @@ -541,40 +520,77 @@ export interface MgetRequest extends RequestBase { realtime?: boolean refresh?: boolean routing?: Routing - _source?: boolean | Fields + _source?: SearchSourceConfigParam _source_excludes?: Fields _source_includes?: Fields stored_fields?: Fields body?: { docs?: MgetOperation[] - ids?: MgetMultiGetId[] + ids?: Ids } } export interface MgetResponse { - docs: MgetHit[] + docs: MgetResponseItem[] } -export interface MsearchBody { +export type MgetResponseItem = GetGetResult | MgetMultiGetError + +export interface MsearchMultiSearchItem extends SearchResponseBody { + status?: integer +} + +export interface MsearchMultiSearchResult { + took: long + responses: MsearchResponseItem[] +} + +export interface MsearchMultisearchBody { aggregations?: Record aggs?: Record + collapse?: SearchFieldCollapse query?: QueryDslQueryContainer + explain?: boolean + ext?: Record + stored_fields?: Fields + docvalue_fields?: (QueryDslFieldAndFormat | Field)[] from?: integer + highlight?: SearchHighlight + indices_boost?: Record[] + min_score?: double + post_filter?: QueryDslQueryContainer + profile?: boolean + rescore?: SearchRescore | SearchRescore[] + script_fields?: Record + search_after?: SortResults size?: integer + sort?: Sort + _source?: SearchSourceConfig + fields?: (QueryDslFieldAndFormat | Field)[] + terminate_after?: long + stats?: string[] + timeout?: string + track_scores?: boolean + track_total_hits?: SearchTrackHits + version?: boolean + runtime_mappings?: MappingRuntimeFields + seq_no_primary_term?: boolean pit?: SearchPointInTimeReference - track_total_hits?: boolean | integer - suggest?: SearchSuggestContainer | Record + suggest?: SearchSuggester } -export interface MsearchHeader { +export interface MsearchMultisearchHeader { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean index?: Indices preference?: string request_cache?: boolean - routing?: string + routing?: Routing search_type?: SearchType + ccs_minimize_roundtrips?: boolean + allow_partial_search_results?: boolean + ignore_throttled?: boolean } export interface MsearchRequest extends RequestBase { @@ -588,20 +604,18 @@ export interface MsearchRequest extends RequestBase { max_concurrent_searches?: long max_concurrent_shard_requests?: long pre_filter_shard_size?: long - search_type?: SearchType rest_total_hits_as_int?: boolean + routing?: Routing + search_type?: SearchType typed_keys?: boolean - body?: (MsearchHeader | MsearchBody)[] + body?: MsearchRequestItem[] } -export interface MsearchResponse { - took: long - responses: (MsearchSearchResult | ErrorResponseBase)[] -} +export type MsearchRequestItem = MsearchMultisearchHeader | MsearchMultisearchBody -export interface MsearchSearchResult extends SearchResponse { - status: integer -} +export type MsearchResponse = MsearchMultiSearchResult + +export type MsearchResponseItem = MsearchMultiSearchItem | ErrorResponseBase export interface MsearchTemplateRequest extends RequestBase { index?: Indices @@ -611,23 +625,23 @@ export interface MsearchTemplateRequest extends RequestBase { search_type?: SearchType rest_total_hits_as_int?: boolean typed_keys?: boolean - body?: MsearchTemplateTemplateItem[] + body?: MsearchTemplateRequestItem[] } -export interface MsearchTemplateResponse { - responses: SearchResponse[] - took: long -} +export type MsearchTemplateRequestItem = MsearchMultisearchHeader | MsearchTemplateTemplateConfig -export interface MsearchTemplateTemplateItem { +export type MsearchTemplateResponse = MsearchMultiSearchResult + +export interface MsearchTemplateTemplateConfig { + explain?: boolean id?: Id - index?: Indices params?: Record + profile?: boolean source?: string } export interface MtermvectorsOperation { - doc: object + doc: any fields: Fields field_statistics: boolean filter: TermvectorsFilter @@ -645,6 +659,7 @@ export interface MtermvectorsOperation { export interface MtermvectorsRequest extends RequestBase { index?: IndexName type?: Type + ids?: Id[] fields?: Fields field_statistics?: boolean offsets?: boolean @@ -677,7 +692,8 @@ export interface MtermvectorsTermVectorsResult { export interface OpenPointInTimeRequest extends RequestBase { index: Indices - keep_alive?: Time + keep_alive: Time + ignore_unavailable?: boolean } export interface OpenPointInTimeResponse { @@ -695,7 +711,7 @@ export interface PutScriptRequest extends RequestBase { master_timeout?: Time timeout?: Time body?: { - script?: StoredScript + script: StoredScript } } @@ -717,7 +733,7 @@ export interface RankEvalRankEvalHit { export interface RankEvalRankEvalHitItem { hit: RankEvalRankEvalHit - rating?: double + rating?: double | null } export interface RankEvalRankEvalMetric { @@ -798,7 +814,7 @@ export interface RankEvalUnratedDocument { } export interface ReindexDestination { - index: IndexName + index?: IndexName op_type?: OpType pipeline?: string routing?: Routing @@ -806,29 +822,30 @@ export interface ReindexDestination { } export interface ReindexRemoteSource { - connect_timeout: Time + connect_timeout?: Time + headers?: Record host: Host - username: Username - password: Password - socket_timeout: Time + username?: Username + password?: Password + socket_timeout?: Time } export interface ReindexRequest extends RequestBase { refresh?: boolean requests_per_second?: long scroll?: Time - slices?: long + slices?: Slices timeout?: Time wait_for_active_shards?: WaitForActiveShards wait_for_completion?: boolean require_alias?: boolean body?: { conflicts?: Conflicts - dest?: ReindexDestination + dest: ReindexDestination max_docs?: long script?: Script size?: long - source?: ReindexSource + source: ReindexSource } } @@ -857,8 +874,9 @@ export interface ReindexSource { remote?: ReindexRemoteSource size?: integer slice?: SlicedScroll - sort?: SearchSort + sort?: Sort _source?: Fields + runtime_mappings?: MappingRuntimeFields } export interface ReindexRethrottleReindexNode extends SpecUtilsBaseNode { @@ -902,6 +920,7 @@ export interface ReindexRethrottleResponse { } export interface RenderSearchTemplateRequest extends RequestBase { + id?: Id body?: { file?: string params?: Record @@ -919,17 +938,11 @@ export interface ScriptsPainlessExecutePainlessContextSetup { query: QueryDslQueryContainer } -export interface ScriptsPainlessExecutePainlessExecutionPosition { - offset: integer - start: integer - end: integer -} - export interface ScriptsPainlessExecuteRequest extends RequestBase { body?: { context?: string context_setup?: ScriptsPainlessExecutePainlessContextSetup - script?: InlineScript + script?: InlineScript | string } } @@ -938,19 +951,16 @@ export interface ScriptsPainlessExecuteResponse { } export interface ScrollRequest extends RequestBase { - scroll_id?: Id + scroll_id?: ScrollId scroll?: Time rest_total_hits_as_int?: boolean - total_hits_as_integer?: boolean body?: { scroll?: Time scroll_id: ScrollId - rest_total_hits_as_int?: boolean } } -export interface ScrollResponse extends SearchResponse { -} +export type ScrollResponse = SearchResponseBody export interface SearchRequest extends RequestBase { index?: Indices @@ -961,7 +971,7 @@ export interface SearchRequest extends RequestBase { analyze_wildcard?: boolean batched_reduce_size?: long ccs_minimize_roundtrips?: boolean - default_operator?: DefaultOperator + default_operator?: QueryDslOperator df?: string docvalue_fields?: Fields expand_wildcards?: ExpandWildcards @@ -985,12 +995,12 @@ export interface SearchRequest extends RequestBase { suggest_text?: string terminate_after?: long timeout?: Time - track_total_hits?: boolean | integer + track_total_hits?: SearchTrackHits track_scores?: boolean typed_keys?: boolean rest_total_hits_as_int?: boolean version?: boolean - _source?: boolean | Fields + _source?: SearchSourceConfigParam _source_excludes?: Fields _source_includes?: Fields seq_no_primary_term?: boolean @@ -999,28 +1009,29 @@ export interface SearchRequest extends RequestBase { from?: integer sort?: string | string[] body?: { - aggs?: Record aggregations?: Record + aggs?: Record collapse?: SearchFieldCollapse explain?: boolean + ext?: Record from?: integer highlight?: SearchHighlight - track_total_hits?: boolean | integer + track_total_hits?: SearchTrackHits indices_boost?: Record[] - docvalue_fields?: SearchDocValueField | (Field | SearchDocValueField)[] + docvalue_fields?: (QueryDslFieldAndFormat | Field)[] min_score?: double post_filter?: QueryDslQueryContainer profile?: boolean query?: QueryDslQueryContainer rescore?: SearchRescore | SearchRescore[] script_fields?: Record - search_after?: (integer | string)[] + search_after?: SortResults size?: integer slice?: SlicedScroll - sort?: SearchSort - _source?: boolean | Fields | SearchSourceFilter - fields?: (Field | DateField)[] - suggest?: SearchSuggestContainer | Record + sort?: Sort + _source?: SearchSourceConfig + fields?: (QueryDslFieldAndFormat | Field)[] + suggest?: SearchSuggester terminate_after?: long timeout?: string track_scores?: boolean @@ -1033,14 +1044,15 @@ export interface SearchRequest extends RequestBase { } } -export interface SearchResponse { +export type SearchResponse = SearchResponseBody + +export interface SearchResponseBody { took: long timed_out: boolean _shards: ShardStatistics hits: SearchHitsMetadata aggregations?: Record _clusters?: ClusterStatistics - documents?: TDocument[] fields?: Record max_score?: double num_reduce_phases?: long @@ -1072,14 +1084,54 @@ export interface SearchAggregationProfile { time_in_nanos: long type: string debug?: SearchAggregationProfileDebug - children?: SearchAggregationProfileDebug[] + children?: SearchAggregationProfile[] } export interface SearchAggregationProfileDebug { + segments_with_multi_valued_ords?: integer + collection_strategy?: string + segments_with_single_valued_ords?: integer + total_buckets?: integer + built_buckets?: integer + result_strategy?: string + has_filter?: boolean + delegate?: string + delegate_debug?: SearchAggregationProfileDelegateDebug + chars_fetched?: integer + extract_count?: integer + extract_ns?: integer + values_fetched?: integer + collect_analyzed_ns?: integer + collect_analyzed_count?: integer + surviving_buckets?: integer + ordinals_collectors_used?: integer + ordinals_collectors_overhead_too_high?: integer + string_hashing_collectors_used?: integer + numeric_collectors_used?: integer + empty_collectors_used?: integer + deferred_aggregators?: string[] +} + +export interface SearchAggregationProfileDelegateDebug { + segments_with_doc_count_field?: integer + segments_with_deleted_docs?: integer + filters?: SearchAggregationProfileDelegateDebugFilter[] + segments_counted?: integer + segments_collected?: integer + map_reducer?: string +} + +export interface SearchAggregationProfileDelegateDebugFilter { + results_from_metadata?: integer + query?: string + specialized_for?: string + segments_counted_in_constant_time?: integer } export type SearchBoundaryScanner = 'chars' | 'sentence' | 'word' +export type SearchBuiltinHighlighterType = 'plain' | 'fvh' | 'unified' + export interface SearchCollector { name: string reason: string @@ -1087,28 +1139,41 @@ export interface SearchCollector { children?: SearchCollector[] } +export interface SearchCompletionContext { + boost?: double + context: SearchContext + neighbours?: GeoHashPrecision[] + precision?: GeoHashPrecision + prefix?: boolean +} + +export interface SearchCompletionSuggest extends SearchSuggestBase { + options: SearchCompletionSuggestOption | SearchCompletionSuggestOption[] +} + export interface SearchCompletionSuggestOption { collate_match?: boolean contexts?: Record fields?: Record - _id: string - _index: IndexName + _id?: string + _index?: IndexName _type?: Type _routing?: Routing - _score: double - _source: TDocument + _score?: double + _source?: TDocument text: string + score?: double } export interface SearchCompletionSuggester extends SearchSuggesterBase { - contexts?: Record + contexts?: Record fuzzy?: SearchSuggestFuzziness prefix?: string regex?: string skip_duplicates?: boolean } -export type SearchContext = string | QueryDslGeoLocation +export type SearchContext = string | GeoLocation export interface SearchDirectGenerator { field: Field @@ -1124,15 +1189,29 @@ export interface SearchDirectGenerator { suggest_mode?: SuggestMode } -export interface SearchDocValueField { - field: Field - format?: string +export interface SearchFetchProfile { + type: string + description: string + time_in_nanos: long + breakdown: SearchFetchProfileBreakdown + debug?: SearchFetchProfileDebug + children?: SearchFetchProfile[] } -export interface SearchFieldAndFormat { - field: Field - format?: string - include_unmapped?: boolean +export interface SearchFetchProfileBreakdown { + load_source?: integer + load_source_count?: integer + load_stored_fields?: integer + load_stored_fields_count?: integer + next_reader?: integer + next_reader_count?: integer + process_count?: integer + process?: integer +} + +export interface SearchFetchProfileDebug { + stored_fields?: string[] + fast_path?: integer } export interface SearchFieldCollapse { @@ -1141,68 +1220,48 @@ export interface SearchFieldCollapse { max_concurrent_group_searches?: integer } -export interface SearchFieldSort { - missing?: AggregationsMissing - mode?: SearchSortMode - nested?: SearchNestedSortValue - order?: SearchSortOrder - unmapped_type?: MappingFieldType +export interface SearchFieldSuggester { + completion?: SearchCompletionSuggester + phrase?: SearchPhraseSuggester + term?: SearchTermSuggester + prefix?: string + regex?: string + text?: string } -export interface SearchGeoDistanceSortKeys { - mode?: SearchSortMode - distance_type?: GeoDistanceType - order?: SearchSortOrder - unit?: DistanceUnit +export interface SearchHighlight extends SearchHighlightBase { + encoder?: SearchHighlighterEncoder + fields: Record } -export type SearchGeoDistanceSort = SearchGeoDistanceSortKeys | - { [property: string]: QueryDslGeoLocation | QueryDslGeoLocation[] } -export interface SearchHighlight { - fields: Record +export interface SearchHighlightBase { type?: SearchHighlighterType boundary_chars?: string boundary_max_scan?: integer boundary_scanner?: SearchBoundaryScanner boundary_scanner_locale?: string - encoder?: SearchHighlighterEncoder + force_source?: boolean fragmenter?: SearchHighlighterFragmenter - fragment_offset?: integer fragment_size?: integer + highlight_filter?: boolean + highlight_query?: QueryDslQueryContainer max_fragment_length?: integer + max_analyzed_offset?: integer no_match_size?: integer number_of_fragments?: integer + options?: Record order?: SearchHighlighterOrder + phrase_limit?: integer post_tags?: string[] pre_tags?: string[] require_field_match?: boolean tags_schema?: SearchHighlighterTagsSchema - highlight_query?: QueryDslQueryContainer - max_analyzed_offset?: string | integer } -export interface SearchHighlightField { - boundary_chars?: string - boundary_max_scan?: integer - boundary_scanner?: SearchBoundaryScanner - boundary_scanner_locale?: string - field?: Field - force_source?: boolean - fragmenter?: SearchHighlighterFragmenter +export interface SearchHighlightField extends SearchHighlightBase { fragment_offset?: integer - fragment_size?: integer - highlight_query?: QueryDslQueryContainer matched_fields?: Fields - max_fragment_length?: integer - no_match_size?: integer - number_of_fragments?: integer - order?: SearchHighlighterOrder - phrase_limit?: integer - post_tags?: string[] - pre_tags?: string[] - require_field_match?: boolean - tags_schema?: SearchHighlighterTagsSchema - type?: SearchHighlighterType | string + analyzer?: AnalysisAnalyzer } export type SearchHighlighterEncoder = 'default' | 'html' @@ -1213,7 +1272,7 @@ export type SearchHighlighterOrder = 'score' export type SearchHighlighterTagsSchema = 'styled' -export type SearchHighlighterType = 'plain' | 'fvh' | 'unified' +export type SearchHighlighterType = SearchBuiltinHighlighterType | string export interface SearchHit { _index: IndexName @@ -1234,11 +1293,11 @@ export interface SearchHit { _seq_no?: SequenceNumber _primary_term?: long _version?: VersionNumber - sort?: SearchSortResults + sort?: SortResults } export interface SearchHitsMetadata { - total: SearchTotalHits | long + total?: SearchTotalHits | long hits: SearchHit[] max_score?: double } @@ -1248,28 +1307,22 @@ export interface SearchInnerHits { size?: integer from?: integer collapse?: SearchFieldCollapse - docvalue_fields?: (SearchFieldAndFormat | Field)[] + docvalue_fields?: (QueryDslFieldAndFormat | Field)[] explain?: boolean highlight?: SearchHighlight ignore_unmapped?: boolean script_fields?: Record seq_no_primary_term?: boolean fields?: Fields - sort?: SearchSort - _source?: boolean | SearchSourceFilter + sort?: Sort + _source?: SearchSourceConfig stored_field?: Fields track_scores?: boolean version?: boolean } -export interface SearchInnerHitsMetadata { - total: SearchTotalHits | long - hits: SearchHit>[] - max_score?: double -} - export interface SearchInnerHitsResult { - hits: SearchInnerHitsMetadata + hits: SearchHitsMetadata } export interface SearchLaplaceSmoothingModel { @@ -1288,10 +1341,8 @@ export interface SearchNestedIdentity { _nested?: SearchNestedIdentity } -export interface SearchNestedSortValue { - filter?: QueryDslQueryContainer - max_children?: integer - path: Field +export interface SearchPhraseSuggest extends SearchSuggestBase { + options: SearchPhraseSuggestOption | SearchPhraseSuggestOption[] } export interface SearchPhraseSuggestCollate { @@ -1312,8 +1363,9 @@ export interface SearchPhraseSuggestHighlight { export interface SearchPhraseSuggestOption { text: string - highlighted: string score: double + highlighted?: string + collate_match?: boolean } export interface SearchPhraseSuggester extends SearchSuggesterBase { @@ -1384,17 +1436,6 @@ export interface SearchRescoreQuery { export type SearchScoreMode = 'avg' | 'max' | 'min' | 'multiply' | 'total' -export interface SearchScoreSort { - mode?: SearchSortMode - order?: SearchSortOrder -} - -export interface SearchScriptSort { - order?: SearchSortOrder - script: Script - type?: string -} - export interface SearchSearchProfile { collector: SearchCollector[] query: SearchQueryProfile[] @@ -1405,6 +1446,7 @@ export interface SearchShardProfile { aggregations: SearchAggregationProfile[] id: string searches: SearchSearchProfile[] + fetch?: SearchFetchProfile } export interface SearchSmoothingModelContainer { @@ -1413,29 +1455,14 @@ export interface SearchSmoothingModelContainer { stupid_backoff?: SearchStupidBackoffSmoothingModel } -export type SearchSort = SearchSortCombinations | SearchSortCombinations[] +export type SearchSourceConfig = boolean | SearchSourceFilter | Fields -export type SearchSortCombinations = Field | SearchSortContainer | SearchSortOrder - -export interface SearchSortContainerKeys { - _score?: SearchScoreSort - _doc?: SearchScoreSort - _geo_distance?: SearchGeoDistanceSort - _script?: SearchScriptSort -} -export type SearchSortContainer = SearchSortContainerKeys | - { [property: string]: SearchFieldSort | SearchSortOrder } - -export type SearchSortMode = 'min' | 'max' | 'sum' | 'avg' | 'median' - -export type SearchSortOrder = 'asc' | 'desc' | '_doc' - -export type SearchSortResults = (long | double | string | null)[] +export type SearchSourceConfigParam = boolean | Fields export interface SearchSourceFilter { excludes?: Fields - includes?: Fields exclude?: Fields + includes?: Fields include?: Fields } @@ -1445,52 +1472,46 @@ export interface SearchStupidBackoffSmoothingModel { discount: double } -export interface SearchSuggest { +export type SearchSuggest = SearchCompletionSuggest | SearchPhraseSuggest | SearchTermSuggest + +export interface SearchSuggestBase { length: integer offset: integer - options: SearchSuggestOption[] text: string } -export interface SearchSuggestContainer { - completion?: SearchCompletionSuggester - phrase?: SearchPhraseSuggester - prefix?: string - regex?: string - term?: SearchTermSuggester - text?: string -} - -export interface SearchSuggestContextQuery { - boost?: double - context: SearchContext - neighbours?: Distance[] | integer[] - precision?: Distance | integer - prefix?: boolean -} - export interface SearchSuggestFuzziness { - fuzziness: Fuzziness - min_length: integer - prefix_length: integer - transpositions: boolean - unicode_aware: boolean + fuzziness?: Fuzziness + min_length?: integer + prefix_length?: integer + transpositions?: boolean + unicode_aware?: boolean } -export type SearchSuggestOption = SearchCompletionSuggestOption | SearchPhraseSuggestOption | SearchTermSuggestOption - export type SearchSuggestSort = 'score' | 'frequency' +export interface SearchSuggesterKeys { + text?: string +} +export type SearchSuggester = SearchSuggesterKeys + & { [property: string]: SearchFieldSuggester | string } + export interface SearchSuggesterBase { field: Field analyzer?: string size?: integer } +export interface SearchTermSuggest extends SearchSuggestBase { + options: SearchTermSuggestOption | SearchTermSuggestOption[] +} + export interface SearchTermSuggestOption { text: string - freq?: long score: double + freq: long + highlighted?: string + collate_match?: boolean } export interface SearchTermSuggester extends SearchSuggesterBase { @@ -1515,7 +1536,42 @@ export interface SearchTotalHits { export type SearchTotalHitsRelation = 'eq' | 'gte' -export interface SearchShardsRequest extends RequestBase { +export type SearchTrackHits = boolean | integer + +export interface SearchMvtRequest extends RequestBase { + index: Indices + field: Field + zoom: SearchMvtZoomLevel + x: SearchMvtCoordinate + y: SearchMvtCoordinate + exact_bounds?: boolean + extent?: integer + grid_precision?: integer + grid_type?: SearchMvtGridType + size?: integer + body?: { + aggs?: Record + exact_bounds?: boolean + extent?: integer + fields?: Fields + grid_precision?: integer + grid_type?: SearchMvtGridType + query?: QueryDslQueryContainer + runtime_mappings?: MappingRuntimeFields + size?: integer + sort?: Sort + } +} + +export type SearchMvtResponse = MapboxVectorTiles + +export type SearchMvtCoordinate = integer + +export type SearchMvtGridType = 'grid' | 'point' | 'centroid' + +export type SearchMvtZoomLevel = integer + +export interface SearchShardsRequest extends RequestBase { index?: Indices allow_no_indices?: boolean expand_wildcards?: ExpandWildcards @@ -1550,20 +1606,32 @@ export interface SearchTemplateRequest extends RequestBase { routing?: Routing scroll?: Time search_type?: SearchType - total_hits_as_integer?: boolean + rest_total_hits_as_int?: boolean typed_keys?: boolean body?: { + explain?: boolean id?: Id params?: Record + profile?: boolean source?: string } } export interface SearchTemplateResponse { - _shards: ShardStatistics + took: long timed_out: boolean - took: integer + _shards: ShardStatistics hits: SearchHitsMetadata + aggregations?: Record + _clusters?: ClusterStatistics + fields?: Record + max_score?: double + num_reduce_phases?: long + profile?: SearchProfile + pit_id?: Id + _scroll_id?: ScrollId + suggest?: Record[]> + terminated_early?: boolean } export interface TermsEnumRequest extends RequestBase { @@ -1637,7 +1705,7 @@ export interface TermvectorsTerm { doc_freq?: integer score?: double term_freq: integer - tokens: TermvectorsToken[] + tokens?: TermvectorsToken[] ttf?: integer } @@ -1662,12 +1730,11 @@ export interface UpdateRequest lang?: string refresh?: Refresh require_alias?: boolean - retry_on_conflict?: long + retry_on_conflict?: integer routing?: Routing - source_enabled?: boolean timeout?: Time wait_for_active_shards?: WaitForActiveShards - _source?: boolean | Fields + _source?: SearchSourceConfigParam _source_excludes?: Fields _source_includes?: Fields body?: { @@ -1676,7 +1743,7 @@ export interface UpdateRequest doc_as_upsert?: boolean script?: Script scripted_upsert?: boolean - _source?: boolean | SearchSourceFilter + _source?: SearchSourceConfig upsert?: TDocument } } @@ -1692,7 +1759,7 @@ export interface UpdateByQueryRequest extends RequestBase { analyzer?: string analyze_wildcard?: boolean conflicts?: Conflicts - default_operator?: DefaultOperator + default_operator?: QueryDslOperator df?: string expand_wildcards?: ExpandWildcards from?: long @@ -1700,7 +1767,6 @@ export interface UpdateByQueryRequest extends RequestBase { lenient?: boolean pipeline?: string preference?: string - query_on_query_string?: string refresh?: boolean request_cache?: boolean requests_per_second?: long @@ -1710,11 +1776,8 @@ export interface UpdateByQueryRequest extends RequestBase { search_timeout?: Time search_type?: SearchType size?: long - slices?: long + slices?: Slices sort?: string[] - source_enabled?: boolean - source_excludes?: Fields - source_includes?: Fields stats?: string[] terminate_after?: long timeout?: Time @@ -1758,7 +1821,7 @@ export interface UpdateByQueryRethrottleResponse { } export interface UpdateByQueryRethrottleUpdateByQueryRethrottleNode extends SpecUtilsBaseNode { - tasks: Record + tasks: Record } export interface SpecUtilsBaseNode { @@ -1770,14 +1833,20 @@ export interface SpecUtilsBaseNode { transport_address: TransportAddress } +export type SpecUtilsStringified = T | string + +export type SpecUtilsVoid = void + export interface AcknowledgedResponseBase { acknowledged: boolean } export type AggregateName = string +export type BuiltinScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java' + export interface BulkIndexByScrollFailure { - cause: MainError + cause: ErrorCause id: Id index: IndexName status: integer @@ -1798,14 +1867,10 @@ export interface BulkStats { export type ByteSize = long | string -export type Bytes = 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb' +export type Bytes = 'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb' export type CategoryId = string -export interface ChainTransform { - transforms: TransformContainer[] -} - export interface ClusterStatistics { skipped: integer successful: integer @@ -1820,13 +1885,16 @@ export interface CompletionStats { export type Conflicts = 'abort' | 'proceed' +export interface CoordsGeoBounds { + top: double + bottom: double + left: double + right: double +} + export type DataStreamName = string -export interface DateField { - field: Field - format?: string - include_unmapped?: boolean -} +export type DataStreamNames = DataStreamName | DataStreamName[] export type DateFormat = string @@ -1836,8 +1904,6 @@ export type DateMathTime = string export type DateString = string -export type DefaultOperator = 'AND' | 'OR' - export interface DictionaryResponseBase { [key: string]: TValue } @@ -1848,7 +1914,7 @@ export type DistanceUnit = 'in' | 'ft' | 'yd' | 'mi' | 'nmi' | 'km' | 'm' | 'cm' export interface DocStats { count: long - deleted: long + deleted?: long } export interface ElasticsearchVersionInfo { @@ -1864,51 +1930,30 @@ export interface ElasticsearchVersionInfo { } export interface EmptyObject { + [key: string]: never } export type EpochMillis = string | long -export interface ErrorCause { +export interface ErrorCauseKeys { type: string - reason: string - caused_by?: ErrorCause - shard?: integer | string + reason?: string stack_trace?: string + caused_by?: ErrorCause root_cause?: ErrorCause[] - bytes_limit?: long - bytes_wanted?: long - column?: integer - col?: integer - failed_shards?: ShardFailure[] - grouped?: boolean - index?: IndexName - index_uuid?: Uuid - language?: string - licensed_expired_feature?: string - line?: integer - max_buckets?: integer - phase?: string - property_name?: string - processor_type?: string - resource_id?: Ids - 'resource.id'?: Ids - resource_type?: string - 'resource.type'?: string - script?: string - script_stack?: string[] - header?: HttpHeaders - lang?: string - position?: ScriptsPainlessExecutePainlessExecutionPosition + suppressed?: ErrorCause[] } +export type ErrorCause = ErrorCauseKeys + & { [property: string]: any } export interface ErrorResponseBase { - error: MainError | string + error: ErrorCause status: integer } -export type ExpandWildcardOptions = 'all' | 'open' | 'closed' | 'hidden' | 'none' +export type ExpandWildcard = 'all' | 'open' | 'closed' | 'hidden' | 'none' -export type ExpandWildcards = ExpandWildcardOptions | ExpandWildcardOptions[] | string +export type ExpandWildcards = ExpandWildcard | ExpandWildcard[] export type Field = string @@ -1922,6 +1967,20 @@ export interface FieldSizeUsage { size_in_bytes: long } +export interface FieldSort { + missing?: AggregationsMissing + mode?: SortMode + nested?: NestedSortValue + order?: SortOrder + unmapped_type?: MappingFieldType + numeric_type?: FieldSortNumericType + format?: string +} + +export type FieldSortNumericType = 'long' | 'double' | 'date' | 'date_nanos' + +export type FieldValue = long | double | string | boolean | null | any + export interface FielddataStats { evictions?: long memory_size?: ByteSize @@ -1940,14 +1999,41 @@ export interface FlushStats { export type Fuzziness = string | integer +export type GeoBounds = CoordsGeoBounds | TopLeftBottomRightGeoBounds | TopRightBottomLeftGeoBounds | WktGeoBounds + +export interface GeoDistanceSortKeys { + mode?: SortMode + distance_type?: GeoDistanceType + ignore_unmapped?: boolean + order?: SortOrder + unit?: DistanceUnit +} +export type GeoDistanceSort = GeoDistanceSortKeys + & { [property: string]: GeoLocation | GeoLocation[] | SortMode | GeoDistanceType | boolean | SortOrder | DistanceUnit } + export type GeoDistanceType = 'arc' | 'plane' -export type GeoHashPrecision = number +export type GeoHash = string + +export interface GeoHashLocation { + geohash: GeoHash +} + +export type GeoHashPrecision = number | string + +export interface GeoLine { + type: string + coordinates: double[][] +} + +export type GeoLocation = LatLonGeoLocation | GeoHashLocation | double[] | string export type GeoShape = any export type GeoShapeRelation = 'intersects' | 'disjoint' | 'within' | 'contains' +export type GeoTile = string + export type GeoTilePrecision = number export interface GetStats { @@ -1963,15 +2049,13 @@ export interface GetStats { total: long } -export type GroupBy = 'nodes' | 'parents' | 'none' - -export type Health = 'green' | 'yellow' | 'red' +export type HealthStatus = 'green' | 'GREEN' | 'yellow' | 'YELLOW' | 'red' | 'RED' export type Host = string export type HttpHeaders = Record -export type Id = string +export type Id = string | number export type Ids = Id | Id[] @@ -1983,10 +2067,6 @@ export type IndexPattern = string export type IndexPatterns = IndexPattern[] -export interface IndexedScript extends ScriptBase { - id: Id -} - export interface IndexingStats { index_current: long delete_current: long @@ -2004,28 +2084,39 @@ export interface IndexingStats { types?: Record } -export type Indices = string | string[] +export type Indices = IndexName | IndexName[] + +export interface IndicesOptions { + allow_no_indices?: boolean + expand_wildcards?: ExpandWildcards + ignore_unavailable?: boolean + ignore_throttled?: boolean +} export interface IndicesResponseBase extends AcknowledgedResponseBase { _shards?: ShardStatistics } -export interface InlineGet { +export interface InlineGetKeys { fields?: Record found: boolean - _seq_no: SequenceNumber - _primary_term: long + _seq_no?: SequenceNumber + _primary_term?: long _routing?: Routing _source: TDocument } +export type InlineGet = InlineGetKeys + & { [property: string]: any } export interface InlineScript extends ScriptBase { + lang?: ScriptLanguage + options?: Record source: string } export type Ip = string -export interface LatLon { +export interface LatLonGeoLocation { lat: double lon: double } @@ -2034,9 +2125,7 @@ export type Level = 'cluster' | 'indices' | 'shards' export type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED' -export interface MainError extends ErrorCause { - headers?: Record -} +export type MapboxVectorTiles = ArrayBuffer export interface MergesStats { current: long @@ -2067,22 +2156,30 @@ export type MultiTermQueryRewrite = string export type Name = string -export type Names = string | string[] +export type Names = Name | Name[] export type Namespace = string +export interface NestedSortValue { + filter?: QueryDslQueryContainer + max_children?: integer + nested?: NestedSortValue + path: Field +} + export interface NodeAttributes { attributes: Record ephemeral_id: Id - id?: Id + id?: NodeId name: NodeName transport_address: TransportAddress roles?: NodeRoles + external_id: string } export type NodeId = string -export type NodeIds = string +export type NodeIds = NodeId | NodeId[] export type NodeName = string @@ -2099,6 +2196,7 @@ export interface NodeShard { allocation_id?: Record recovery_source?: Record unassigned_info?: ClusterAllocationExplainUnassignedInformation + relocating_node?: NodeId | null } export interface NodeStatistics { @@ -2149,9 +2247,7 @@ export interface RecoveryStats { throttle_time_in_millis: long } -export type Refresh = boolean | RefreshOptions - -export type RefreshOptions = 'wait_for' +export type Refresh = boolean | 'true' | 'false' | 'wait_for' export interface RefreshStats { external_total: long @@ -2175,7 +2271,7 @@ export interface RequestCacheStats { miss_count: long } -export type Result = 'Error' | 'created' | 'updated' | 'deleted' | 'not_found' | 'noop' +export type Result = 'created' | 'updated' | 'deleted' | 'not_found' | 'noop' export interface Retries { bulk: long @@ -2184,10 +2280,13 @@ export interface Retries { export type Routing = string -export type Script = InlineScript | IndexedScript | string +export interface ScoreSort { + order?: SortOrder +} + +export type Script = InlineScript | string | StoredScriptId export interface ScriptBase { - lang?: ScriptLanguage params?: Record } @@ -2196,7 +2295,17 @@ export interface ScriptField { ignore_failure?: boolean } -export type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java' +export type ScriptLanguage = BuiltinScriptLanguage | string + +export interface ScriptSort { + order?: SortOrder + script: Script + type?: ScriptSortType + mode?: SortMode + nested?: NestedSortValue +} + +export type ScriptSortType = 'string' | 'number' | 'version' export interface ScriptTransform { lang: string @@ -2239,7 +2348,7 @@ export interface SegmentsStats { index_writer_memory?: ByteSize index_writer_max_memory_in_bytes?: integer index_writer_memory_in_bytes: integer - max_unsafe_auto_id_timestamp: integer + max_unsafe_auto_id_timestamp: long memory?: ByteSize memory_in_bytes: integer norms_memory?: ByteSize @@ -2256,12 +2365,10 @@ export interface SegmentsStats { version_map_memory_in_bytes: integer } -export type SequenceNumber = integer +export type SequenceNumber = long export type Service = string -export type ShapeRelation = 'intersects' | 'disjoint' | 'within' - export interface ShardFailure { index?: IndexName node?: string @@ -2282,14 +2389,35 @@ export interface ShardsOperationResponseBase { _shards: ShardStatistics } -export type Size = 'Raw' | 'k' | 'm' | 'g' | 't' | 'p' - export interface SlicedScroll { field?: Field - id: integer + id: Id max: integer } +export type Slices = integer | SlicesCalculation + +export type SlicesCalculation = 'auto' + +export type Sort = SortCombinations | SortCombinations[] + +export type SortCombinations = Field | SortOptions + +export type SortMode = 'min' | 'max' | 'sum' | 'avg' | 'median' + +export interface SortOptionsKeys { + _score?: ScoreSort + _doc?: ScoreSort + _geo_distance?: GeoDistanceSort + _script?: ScriptSort +} +export type SortOptions = SortOptionsKeys + & { [property: string]: FieldSort | SortOrder | ScoreSort | GeoDistanceSort | ScriptSort } + +export type SortOrder = 'asc' | 'desc' + +export type SortResults = FieldValue[] + export interface StoreStats { size?: ByteSize size_in_bytes: integer @@ -2300,10 +2428,15 @@ export interface StoreStats { } export interface StoredScript { - lang?: ScriptLanguage + lang: ScriptLanguage + options?: Record source: string } +export interface StoredScriptId extends ScriptBase { + id: Id +} + export type SuggestMode = 'missing' | 'popular' | 'always' export type SuggestionName = string @@ -2316,15 +2449,24 @@ export type Time = string | integer export type TimeSpan = string +export type TimeUnit = 'nanos' | 'micros' | 'ms' | 's' | 'm' | 'h' | 'd' + export type TimeZone = string export type Timestamp = string -export interface Transform { +export interface TopLeftBottomRightGeoBounds { + top_left: GeoLocation + bottom_right: GeoLocation +} + +export interface TopRightBottomLeftGeoBounds { + top_right: GeoLocation + bottom_left: GeoLocation } export interface TransformContainer { - chain?: ChainTransform + chain?: TransformContainer[] script?: ScriptTransform search?: SearchTransform } @@ -2355,14 +2497,12 @@ export type VersionString = string export type VersionType = 'internal' | 'external' | 'external_gte' | 'force' -export type WaitForActiveShardOptions = 'all' +export type WaitForActiveShardOptions = 'all' | 'index-setting' export type WaitForActiveShards = integer | WaitForActiveShardOptions export type WaitForEvents = 'immediate' | 'urgent' | 'high' | 'normal' | 'low' | 'languid' -export type WaitForStatus = 'green' | 'yellow' | 'red' - export interface WarmerStats { current: long total: long @@ -2370,6 +2510,10 @@ export interface WarmerStats { total_time_in_millis: long } +export interface WktGeoBounds { + wkt: string +} + export interface WriteResponseBase { _id: Id _index: IndexName @@ -2382,6 +2526,8 @@ export interface WriteResponseBase { forced_refresh?: boolean } +export type byte = number + export type double = number export type float = number @@ -2390,30 +2536,43 @@ export type integer = number export type long = number +export type short = number + export type uint = number export type ulong = number +export interface AggregationsAdjacencyMatrixAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsAdjacencyMatrixAggregation extends AggregationsBucketAggregationBase { filters?: Record } -export type AggregationsAggregate = AggregationsSingleBucketAggregate | AggregationsAutoDateHistogramAggregate | AggregationsFiltersAggregate | AggregationsSignificantTermsAggregate | AggregationsTermsAggregate | AggregationsBucketAggregate | AggregationsCompositeBucketAggregate | AggregationsMultiBucketAggregate | AggregationsMatrixStatsAggregate | AggregationsKeyedValueAggregate | AggregationsMetricAggregate +export interface AggregationsAdjacencyMatrixBucketKeys extends AggregationsMultiBucketBase { + key: string +} +export type AggregationsAdjacencyMatrixBucket = AggregationsAdjacencyMatrixBucketKeys + & { [property: string]: AggregationsAggregate | string | long } + +export type AggregationsAggregate = AggregationsCardinalityAggregate | AggregationsHdrPercentilesAggregate | AggregationsHdrPercentileRanksAggregate | AggregationsTDigestPercentilesAggregate | AggregationsTDigestPercentileRanksAggregate | AggregationsPercentilesBucketAggregate | AggregationsMedianAbsoluteDeviationAggregate | AggregationsMinAggregate | AggregationsMaxAggregate | AggregationsSumAggregate | AggregationsAvgAggregate | AggregationsWeightedAvgAggregate | AggregationsValueCountAggregate | AggregationsSimpleValueAggregate | AggregationsDerivativeAggregate | AggregationsBucketMetricValueAggregate | AggregationsStatsAggregate | AggregationsStatsBucketAggregate | AggregationsExtendedStatsAggregate | AggregationsExtendedStatsBucketAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsHistogramAggregate | AggregationsDateHistogramAggregate | AggregationsAutoDateHistogramAggregate | AggregationsVariableWidthHistogramAggregate | AggregationsStringTermsAggregate | AggregationsLongTermsAggregate | AggregationsDoubleTermsAggregate | AggregationsUnmappedTermsAggregate | AggregationsLongRareTermsAggregate | AggregationsStringRareTermsAggregate | AggregationsUnmappedRareTermsAggregate | AggregationsMultiTermsAggregate | AggregationsMissingAggregate | AggregationsNestedAggregate | AggregationsReverseNestedAggregate | AggregationsGlobalAggregate | AggregationsFilterAggregate | AggregationsChildrenAggregate | AggregationsParentAggregate | AggregationsSamplerAggregate | AggregationsUnmappedSamplerAggregate | AggregationsGeoHashGridAggregate | AggregationsGeoTileGridAggregate | AggregationsRangeAggregate | AggregationsDateRangeAggregate | AggregationsGeoDistanceAggregate | AggregationsIpRangeAggregate | AggregationsFiltersAggregate | AggregationsAdjacencyMatrixAggregate | AggregationsSignificantLongTermsAggregate | AggregationsSignificantStringTermsAggregate | AggregationsUnmappedSignificantTermsAggregate | AggregationsCompositeAggregate | AggregationsScriptedMetricAggregate | AggregationsTopHitsAggregate | AggregationsInferenceAggregate | AggregationsStringStatsAggregate | AggregationsBoxPlotAggregate | AggregationsTopMetricsAggregate | AggregationsTTestAggregate | AggregationsRateAggregate | AggregationsCumulativeCardinalityAggregate | AggregationsMatrixStatsAggregate | AggregationsGeoLineAggregate export interface AggregationsAggregateBase { meta?: Record } +export type AggregationsAggregateOrder = Partial> | Partial>[] + export interface AggregationsAggregation { meta?: Record name?: string } export interface AggregationsAggregationContainer { + aggregations?: Record aggs?: Record meta?: Record adjacency_matrix?: AggregationsAdjacencyMatrixAggregation - aggregations?: Record auto_date_histogram?: AggregationsAutoDateHistogramAggregation avg?: AggregationsAverageAggregation avg_bucket?: AggregationsAverageBucketAggregation @@ -2491,7 +2650,13 @@ export interface AggregationsAggregationRange { to?: double | string } -export interface AggregationsAutoDateHistogramAggregate extends AggregationsMultiBucketAggregate> { +export interface AggregationsArrayPercentilesItem { + key: string + value: double | null + value_as_string?: string +} + +export interface AggregationsAutoDateHistogramAggregate extends AggregationsMultiBucketAggregateBase { interval: DateMathTime } @@ -2513,32 +2678,35 @@ export interface AggregationsAverageAggregation extends AggregationsFormatMetric export interface AggregationsAverageBucketAggregation extends AggregationsPipelineAggregationBase { } +export interface AggregationsAvgAggregate extends AggregationsSingleMetricAggregateBase { +} + export interface AggregationsBoxPlotAggregate extends AggregationsAggregateBase { min: double max: double q1: double q2: double q3: double + lower: double + upper: double + min_as_string?: string + max_as_string?: string + q1_as_string?: string + q2_as_string?: string + q3_as_string?: string + lower_as_string?: string + upper_as_string?: string } export interface AggregationsBoxplotAggregation extends AggregationsMetricAggregationBase { compression?: double } -export type AggregationsBucket = AggregationsCompositeBucket | AggregationsDateHistogramBucket | AggregationsFiltersBucketItem | AggregationsIpRangeBucket | AggregationsRangeBucket | AggregationsRareTermsBucket | AggregationsSignificantTermsBucket | AggregationsKeyedBucket - -export interface AggregationsBucketAggregate extends AggregationsAggregateBase { - after_key: Record - bg_count: long - doc_count: long - doc_count_error_upper_bound: long - sum_other_doc_count: long - interval: DateMathTime - items: AggregationsBucket +export interface AggregationsBucketAggregationBase extends AggregationsAggregation { } -export interface AggregationsBucketAggregationBase extends AggregationsAggregation { - aggregations?: Record +export interface AggregationsBucketMetricValueAggregate extends AggregationsSingleMetricAggregateBase { + keys: string[] } export interface AggregationsBucketScriptAggregation extends AggregationsPipelineAggregationBase { @@ -2553,10 +2721,17 @@ export interface AggregationsBucketSortAggregation extends AggregationsAggregati from?: integer gap_policy?: AggregationsGapPolicy size?: integer - sort?: SearchSort + sort?: Sort } -export interface AggregationsBucketsPath { +export type AggregationsBuckets = Record | TBucket[] + +export type AggregationsBucketsPath = string | string[] | Record + +export type AggregationsCalendarInterval = 'second' | '1s' | 'minute' | '1m' | 'hour' | '1h' | 'day' | '1d' | 'week' | '1w' | 'month' | '1M' | 'quarter' | '1q' | 'year' | '1Y' + +export interface AggregationsCardinalityAggregate extends AggregationsAggregateBase { + value: long } export interface AggregationsCardinalityAggregation extends AggregationsMetricAggregationBase { @@ -2569,6 +2744,11 @@ export interface AggregationsChiSquareHeuristic { include_negatives: boolean } +export interface AggregationsChildrenAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsChildrenAggregate = AggregationsChildrenAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } + export interface AggregationsChildrenAggregation extends AggregationsBucketAggregationBase { type?: RelationName } @@ -2581,8 +2761,14 @@ export interface AggregationsClassificationInferenceOptions { top_classes_results_field?: string } +export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase { + after_key?: AggregationsCompositeAggregateKey +} + +export type AggregationsCompositeAggregateKey = Record + export interface AggregationsCompositeAggregation extends AggregationsBucketAggregationBase { - after?: Record + after?: AggregationsCompositeAggregateKey size?: integer sources?: Record[] } @@ -2594,13 +2780,15 @@ export interface AggregationsCompositeAggregationSource { geotile_grid?: AggregationsGeoTileGridAggregation } -export interface AggregationsCompositeBucketKeys { +export interface AggregationsCompositeBucketKeys extends AggregationsMultiBucketBase { + key: AggregationsCompositeAggregateKey } -export type AggregationsCompositeBucket = AggregationsCompositeBucketKeys | - { [property: string]: AggregationsAggregate } +export type AggregationsCompositeBucket = AggregationsCompositeBucketKeys + & { [property: string]: AggregationsAggregate | AggregationsCompositeAggregateKey | long } -export interface AggregationsCompositeBucketAggregate extends AggregationsMultiBucketAggregate> { - after_key: Record +export interface AggregationsCumulativeCardinalityAggregate extends AggregationsAggregateBase { + value: long + value_as_string?: string } export interface AggregationsCumulativeCardinalityAggregation extends AggregationsPipelineAggregationBase { @@ -2609,29 +2797,36 @@ export interface AggregationsCumulativeCardinalityAggregation extends Aggregatio export interface AggregationsCumulativeSumAggregation extends AggregationsPipelineAggregationBase { } +export interface AggregationsDateHistogramAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsDateHistogramAggregation extends AggregationsBucketAggregationBase { - calendar_interval?: AggregationsDateInterval | Time - extended_bounds?: AggregationsExtendedBounds - hard_bounds?: AggregationsExtendedBounds + calendar_interval?: AggregationsCalendarInterval + extended_bounds?: AggregationsExtendedBounds + hard_bounds?: AggregationsExtendedBounds field?: Field - fixed_interval?: AggregationsDateInterval | Time + fixed_interval?: Time format?: string - interval?: AggregationsDateInterval | Time + interval?: Time min_doc_count?: integer missing?: DateString offset?: Time - order?: AggregationsHistogramOrder + order?: AggregationsAggregateOrder params?: Record script?: Script time_zone?: string + keyed?: boolean } -export interface AggregationsDateHistogramBucketKeys { +export interface AggregationsDateHistogramBucketKeys extends AggregationsMultiBucketBase { + key_as_string?: string + key: EpochMillis } -export type AggregationsDateHistogramBucket = AggregationsDateHistogramBucketKeys | - { [property: string]: AggregationsAggregate } +export type AggregationsDateHistogramBucket = AggregationsDateHistogramBucketKeys + & { [property: string]: AggregationsAggregate | string | EpochMillis | long } -export type AggregationsDateInterval = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' +export interface AggregationsDateRangeAggregate extends AggregationsRangeAggregate { +} export interface AggregationsDateRangeAggregation extends AggregationsBucketAggregationBase { field?: Field @@ -2639,15 +2834,18 @@ export interface AggregationsDateRangeAggregation extends AggregationsBucketAggr missing?: AggregationsMissing ranges?: AggregationsDateRangeExpression[] time_zone?: string + keyed?: boolean } export interface AggregationsDateRangeExpression { - from?: DateMath | float - from_as_string?: string - to_as_string?: string + from?: AggregationsFieldDateMath key?: string - to?: DateMath | float - doc_count?: long + to?: AggregationsFieldDateMath +} + +export interface AggregationsDerivativeAggregate extends AggregationsSingleMetricAggregateBase { + normalized_value?: double + normalized_value_as_string?: string } export interface AggregationsDerivativeAggregation extends AggregationsPipelineAggregationBase { @@ -2661,49 +2859,79 @@ export interface AggregationsDiversifiedSamplerAggregation extends AggregationsB field?: Field } +export interface AggregationsDoubleTermsAggregate extends AggregationsTermsAggregateBase { +} + +export interface AggregationsDoubleTermsBucketKeys extends AggregationsTermsBucketBase { + key: double + key_as_string?: string +} +export type AggregationsDoubleTermsBucket = AggregationsDoubleTermsBucketKeys + & { [property: string]: AggregationsAggregate | double | string | long } + export interface AggregationsEwmaModelSettings { alpha?: float } +export interface AggregationsEwmaMovingAverageAggregation extends AggregationsMovingAverageAggregationBase { + model: 'ewma' + settings: AggregationsEwmaModelSettings +} + export interface AggregationsExtendedBounds { max: T min: T } export interface AggregationsExtendedStatsAggregate extends AggregationsStatsAggregate { - std_deviation_bounds: AggregationsStandardDeviationBounds - sum_of_squares?: double - variance?: double - variance_population?: double - variance_sampling?: double - std_deviation?: double - std_deviation_population?: double - std_deviation_sampling?: double + sum_of_squares: double | null + variance: double | null + variance_population: double | null + variance_sampling: double | null + std_deviation: double | null + std_deviation_population: double | null + std_deviation_sampling: double | null + std_deviation_bounds?: AggregationsStandardDeviationBounds + sum_of_squares_as_string?: string + variance_as_string?: string + variance_population_as_string?: string + variance_sampling_as_string?: string + std_deviation_as_string?: string + std_deviation_bounds_as_string?: AggregationsStandardDeviationBoundsAsString } export interface AggregationsExtendedStatsAggregation extends AggregationsFormatMetricAggregationBase { sigma?: double } +export interface AggregationsExtendedStatsBucketAggregate extends AggregationsExtendedStatsAggregate { +} + export interface AggregationsExtendedStatsBucketAggregation extends AggregationsPipelineAggregationBase { sigma?: double } -export interface AggregationsFiltersAggregate extends AggregationsAggregateBase { - buckets: AggregationsFiltersBucketItem[] | Record +export type AggregationsFieldDateMath = DateMath | double + +export interface AggregationsFilterAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsFilterAggregate = AggregationsFilterAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } + +export interface AggregationsFiltersAggregate extends AggregationsMultiBucketAggregateBase { } export interface AggregationsFiltersAggregation extends AggregationsBucketAggregationBase { - filters?: Record | QueryDslQueryContainer[] + filters?: AggregationsBuckets other_bucket?: boolean other_bucket_key?: string + keyed?: boolean } -export interface AggregationsFiltersBucketItemKeys { - doc_count: long +export interface AggregationsFiltersBucketKeys extends AggregationsMultiBucketBase { } -export type AggregationsFiltersBucketItem = AggregationsFiltersBucketItemKeys | - { [property: string]: AggregationsAggregate } +export type AggregationsFiltersBucket = AggregationsFiltersBucketKeys + & { [property: string]: AggregationsAggregate | long } export interface AggregationsFormatMetricAggregationBase extends AggregationsMetricAggregationBase { format?: string @@ -2713,15 +2941,10 @@ export interface AggregationsFormattableMetricAggregation extends AggregationsMe format?: string } -export type AggregationsGapPolicy = 'skip' | 'insert_zeros' - -export interface AggregationsGeoBounds { - bottom_right: LatLon - top_left: LatLon -} +export type AggregationsGapPolicy = 'skip' | 'insert_zeros' | 'keep_values' export interface AggregationsGeoBoundsAggregate extends AggregationsAggregateBase { - bounds: AggregationsGeoBounds + bounds?: GeoBounds } export interface AggregationsGeoBoundsAggregation extends AggregationsMetricAggregationBase { @@ -2730,41 +2953,53 @@ export interface AggregationsGeoBoundsAggregation extends AggregationsMetricAggr export interface AggregationsGeoCentroidAggregate extends AggregationsAggregateBase { count: long - location: QueryDslGeoLocation + location?: GeoLocation } export interface AggregationsGeoCentroidAggregation extends AggregationsMetricAggregationBase { count?: long - location?: QueryDslGeoLocation + location?: GeoLocation +} + +export interface AggregationsGeoDistanceAggregate extends AggregationsRangeAggregate { } export interface AggregationsGeoDistanceAggregation extends AggregationsBucketAggregationBase { distance_type?: GeoDistanceType field?: Field - origin?: QueryDslGeoLocation | string + origin?: GeoLocation ranges?: AggregationsAggregationRange[] unit?: DistanceUnit } +export interface AggregationsGeoHashGridAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsGeoHashGridAggregation extends AggregationsBucketAggregationBase { - bounds?: QueryDslBoundingBox + bounds?: GeoBounds field?: Field precision?: GeoHashPrecision shard_size?: integer size?: integer } +export interface AggregationsGeoHashGridBucketKeys extends AggregationsMultiBucketBase { + key: GeoHash +} +export type AggregationsGeoHashGridBucket = AggregationsGeoHashGridBucketKeys + & { [property: string]: AggregationsAggregate | GeoHash | long } + export interface AggregationsGeoLineAggregate extends AggregationsAggregateBase { type: string - geometry: AggregationsLineStringGeoShape - properties: AggregationsGeoLineProperties + geometry: GeoLine + properties: any } export interface AggregationsGeoLineAggregation { point: AggregationsGeoLinePoint sort: AggregationsGeoLineSort include_sort?: boolean - sort_order?: SearchSortOrder + sort_order?: SortOrder size?: integer } @@ -2772,41 +3007,50 @@ export interface AggregationsGeoLinePoint { field: Field } -export interface AggregationsGeoLineProperties { - complete: boolean - sort_values: double[] -} - export interface AggregationsGeoLineSort { field: Field } +export interface AggregationsGeoTileGridAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsGeoTileGridAggregation extends AggregationsBucketAggregationBase { field?: Field precision?: GeoTilePrecision shard_size?: integer size?: integer - bounds?: AggregationsGeoBounds + bounds?: GeoBounds +} + +export interface AggregationsGeoTileGridBucketKeys extends AggregationsMultiBucketBase { + key: GeoTile +} +export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys + & { [property: string]: AggregationsAggregate | GeoTile | long } + +export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase { } +export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } export interface AggregationsGlobalAggregation extends AggregationsBucketAggregationBase { } export interface AggregationsGoogleNormalizedDistanceHeuristic { - background_is_superset: boolean + background_is_superset?: boolean } export interface AggregationsHdrMethod { number_of_significant_value_digits?: integer } -export interface AggregationsHdrPercentileItem { - key: double - value: double +export interface AggregationsHdrPercentileRanksAggregate extends AggregationsPercentilesAggregateBase { +} + +export interface AggregationsHdrPercentilesAggregate extends AggregationsPercentilesAggregateBase { } -export interface AggregationsHdrPercentilesAggregate extends AggregationsAggregateBase { - values: AggregationsHdrPercentileItem[] +export interface AggregationsHistogramAggregate extends AggregationsMultiBucketAggregateBase { } export interface AggregationsHistogramAggregation extends AggregationsBucketAggregationBase { @@ -2817,21 +3061,29 @@ export interface AggregationsHistogramAggregation extends AggregationsBucketAggr min_doc_count?: integer missing?: double offset?: double - order?: AggregationsHistogramOrder + order?: AggregationsAggregateOrder script?: Script format?: string + keyed?: boolean } -export interface AggregationsHistogramOrder { - _count?: SearchSortOrder - _key?: SearchSortOrder +export interface AggregationsHistogramBucketKeys extends AggregationsMultiBucketBase { + key_as_string?: string + key: double } +export type AggregationsHistogramBucket = AggregationsHistogramBucketKeys + & { [property: string]: AggregationsAggregate | string | double | long } export interface AggregationsHoltLinearModelSettings { alpha?: float beta?: float } +export interface AggregationsHoltMovingAverageAggregation extends AggregationsMovingAverageAggregationBase { + model: 'holt' + settings: AggregationsHoltLinearModelSettings +} + export interface AggregationsHoltWintersModelSettings { alpha?: float beta?: float @@ -2841,18 +3093,52 @@ export interface AggregationsHoltWintersModelSettings { type?: AggregationsHoltWintersType } +export interface AggregationsHoltWintersMovingAverageAggregation extends AggregationsMovingAverageAggregationBase { + model: 'holt_winters' + settings: AggregationsHoltWintersModelSettings +} + export type AggregationsHoltWintersType = 'add' | 'mult' +export interface AggregationsInferenceAggregateKeys extends AggregationsAggregateBase { + value?: FieldValue + feature_importance?: AggregationsInferenceFeatureImportance[] + top_classes?: AggregationsInferenceTopClassEntry[] + warning?: string +} +export type AggregationsInferenceAggregate = AggregationsInferenceAggregateKeys + & { [property: string]: any } + export interface AggregationsInferenceAggregation extends AggregationsPipelineAggregationBase { model_id: Name inference_config?: AggregationsInferenceConfigContainer } +export interface AggregationsInferenceClassImportance { + class_name: string + importance: double +} + export interface AggregationsInferenceConfigContainer { regression?: AggregationsRegressionInferenceOptions classification?: AggregationsClassificationInferenceOptions } +export interface AggregationsInferenceFeatureImportance { + feature_name: string + importance?: double + classes?: AggregationsInferenceClassImportance[] +} + +export interface AggregationsInferenceTopClassEntry { + class_name: FieldValue + class_probability: double + class_score: double +} + +export interface AggregationsIpRangeAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsIpRangeAggregation extends AggregationsBucketAggregationBase { field?: Field ranges?: AggregationsIpRangeAggregationRange[] @@ -2864,26 +3150,40 @@ export interface AggregationsIpRangeAggregationRange { to?: string } -export interface AggregationsIpRangeBucketKeys { +export interface AggregationsIpRangeBucketKeys extends AggregationsMultiBucketBase { + key?: string + from?: string + to?: string +} +export type AggregationsIpRangeBucket = AggregationsIpRangeBucketKeys + & { [property: string]: AggregationsAggregate | string | long } + +export type AggregationsKeyedPercentiles = Record + +export interface AggregationsLinearMovingAverageAggregation extends AggregationsMovingAverageAggregationBase { + model: 'linear' + settings: EmptyObject +} + +export interface AggregationsLongRareTermsAggregate extends AggregationsMultiBucketAggregateBase { } -export type AggregationsIpRangeBucket = AggregationsIpRangeBucketKeys | - { [property: string]: AggregationsAggregate } -export interface AggregationsKeyedBucketKeys { - doc_count: long - key: TKey - key_as_string: string +export interface AggregationsLongRareTermsBucketKeys extends AggregationsMultiBucketBase { + key: long + key_as_string?: string } -export type AggregationsKeyedBucket = AggregationsKeyedBucketKeys | - { [property: string]: AggregationsAggregate } +export type AggregationsLongRareTermsBucket = AggregationsLongRareTermsBucketKeys + & { [property: string]: AggregationsAggregate | long | string } -export interface AggregationsKeyedValueAggregate extends AggregationsValueAggregate { - keys: string[] +export interface AggregationsLongTermsAggregate extends AggregationsTermsAggregateBase { } -export interface AggregationsLineStringGeoShape { - coordinates: QueryDslGeoCoordinate[] +export interface AggregationsLongTermsBucketKeys extends AggregationsTermsBucketBase { + key: string + key_as_string?: string } +export type AggregationsLongTermsBucket = AggregationsLongTermsBucketKeys + & { [property: string]: AggregationsAggregate | string | long } export interface AggregationsMatrixAggregation extends AggregationsAggregation { fields?: Fields @@ -2891,21 +3191,27 @@ export interface AggregationsMatrixAggregation extends AggregationsAggregation { } export interface AggregationsMatrixStatsAggregate extends AggregationsAggregateBase { - correlation: Record - covariance: Record - count: integer - kurtosis: double - mean: double - skewness: double - variance: double - name: string + doc_count: long + fields: AggregationsMatrixStatsFields[] } export interface AggregationsMatrixStatsAggregation extends AggregationsMatrixAggregation { - mode?: AggregationsMatrixStatsMode + mode?: SortMode +} + +export interface AggregationsMatrixStatsFields { + name: Field + count: long + mean: double + variance: double + skewness: double + kurtosis: double + covariance: Record + correlation: Record } -export type AggregationsMatrixStatsMode = 'avg' | 'min' | 'max' | 'sum' | 'median' +export interface AggregationsMaxAggregate extends AggregationsSingleMetricAggregateBase { +} export interface AggregationsMaxAggregation extends AggregationsFormatMetricAggregationBase { } @@ -2913,18 +3219,22 @@ export interface AggregationsMaxAggregation extends AggregationsFormatMetricAggr export interface AggregationsMaxBucketAggregation extends AggregationsPipelineAggregationBase { } +export interface AggregationsMedianAbsoluteDeviationAggregate extends AggregationsSingleMetricAggregateBase { +} + export interface AggregationsMedianAbsoluteDeviationAggregation extends AggregationsFormatMetricAggregationBase { compression?: double } -export type AggregationsMetricAggregate = AggregationsValueAggregate | AggregationsBoxPlotAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsGeoLineAggregate | AggregationsPercentilesAggregate | AggregationsScriptedMetricAggregate | AggregationsStatsAggregate | AggregationsStringStatsAggregate | AggregationsTopHitsAggregate | AggregationsTopMetricsAggregate | AggregationsExtendedStatsAggregate | AggregationsTDigestPercentilesAggregate | AggregationsHdrPercentilesAggregate - export interface AggregationsMetricAggregationBase { field?: Field missing?: AggregationsMissing script?: Script } +export interface AggregationsMinAggregate extends AggregationsSingleMetricAggregateBase { +} + export interface AggregationsMinAggregation extends AggregationsFormatMetricAggregationBase { } @@ -2935,23 +3245,26 @@ export type AggregationsMinimumInterval = 'second' | 'minute' | 'hour' | 'day' | export type AggregationsMissing = string | integer | double | boolean +export interface AggregationsMissingAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsMissingAggregate = AggregationsMissingAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } + export interface AggregationsMissingAggregation extends AggregationsBucketAggregationBase { field?: Field missing?: AggregationsMissing } -export interface AggregationsMovingAverageAggregation extends AggregationsPipelineAggregationBase { +export type AggregationsMissingOrder = 'first' | 'last' | 'default' + +export type AggregationsMovingAverageAggregation = AggregationsLinearMovingAverageAggregation | AggregationsSimpleMovingAverageAggregation | AggregationsEwmaMovingAverageAggregation | AggregationsHoltMovingAverageAggregation | AggregationsHoltWintersMovingAverageAggregation + +export interface AggregationsMovingAverageAggregationBase extends AggregationsPipelineAggregationBase { minimize?: boolean - model?: AggregationsMovingAverageModel - settings: AggregationsMovingAverageSettings predict?: integer window?: integer } -export type AggregationsMovingAverageModel = 'linear' | 'simple' | 'ewma' | 'holt' | 'holt_winters' - -export type AggregationsMovingAverageSettings = AggregationsEwmaModelSettings | AggregationsHoltLinearModelSettings | AggregationsHoltWintersModelSettings - export interface AggregationsMovingFunctionAggregation extends AggregationsPipelineAggregationBase { script?: string shift?: integer @@ -2961,24 +3274,53 @@ export interface AggregationsMovingFunctionAggregation extends AggregationsPipel export interface AggregationsMovingPercentilesAggregation extends AggregationsPipelineAggregationBase { window?: integer shift?: integer + keyed?: boolean } -export interface AggregationsMultiBucketAggregate extends AggregationsAggregateBase { - buckets: TBucket[] +export interface AggregationsMultiBucketAggregateBase extends AggregationsAggregateBase { + buckets: AggregationsBuckets +} + +export interface AggregationsMultiBucketBase { + doc_count: long } export interface AggregationsMultiTermLookup { field: Field + missing?: AggregationsMissing +} + +export interface AggregationsMultiTermsAggregate extends AggregationsTermsAggregateBase { } export interface AggregationsMultiTermsAggregation extends AggregationsBucketAggregationBase { + collect_mode?: AggregationsTermsAggregationCollectMode + order?: AggregationsAggregateOrder + min_doc_count?: long + shard_min_doc_count?: long + shard_size?: integer + show_term_doc_count_error?: boolean + size?: integer terms: AggregationsMultiTermLookup[] } +export interface AggregationsMultiTermsBucketKeys extends AggregationsMultiBucketBase { + key: FieldValue[] + key_as_string?: string + doc_count_error_upper_bound?: long +} +export type AggregationsMultiTermsBucket = AggregationsMultiTermsBucketKeys + & { [property: string]: AggregationsAggregate | FieldValue[] | string | long } + export interface AggregationsMutualInformationHeuristic { - background_is_superset: boolean - include_negatives: boolean + background_is_superset?: boolean + include_negatives?: boolean +} + +export interface AggregationsNestedAggregateKeys extends AggregationsSingleBucketAggregateBase { } +export type AggregationsNestedAggregate = AggregationsNestedAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } export interface AggregationsNestedAggregation extends AggregationsBucketAggregationBase { path?: Field @@ -2988,29 +3330,32 @@ export interface AggregationsNormalizeAggregation extends AggregationsPipelineAg method?: AggregationsNormalizeMethod } -export type AggregationsNormalizeMethod = 'rescale_0_1' | 'rescale_0_100' | 'percent_of_sum' | 'mean' | 'zscore' | 'softmax' +export type AggregationsNormalizeMethod = 'rescale_0_1' | 'rescale_0_100' | 'percent_of_sum' | 'mean' | 'z-score' | 'softmax' + +export interface AggregationsParentAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsParentAggregate = AggregationsParentAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } export interface AggregationsParentAggregation extends AggregationsBucketAggregationBase { type?: RelationName } export interface AggregationsPercentageScoreHeuristic { -} - -export interface AggregationsPercentileItem { - percentile: double - value: double + [key: string]: never } export interface AggregationsPercentileRanksAggregation extends AggregationsFormatMetricAggregationBase { keyed?: boolean - values?: double[] + values?: double[] | null hdr?: AggregationsHdrMethod tdigest?: AggregationsTDigest } -export interface AggregationsPercentilesAggregate extends AggregationsAggregateBase { - items: AggregationsPercentileItem[] +export type AggregationsPercentiles = AggregationsKeyedPercentiles | AggregationsArrayPercentilesItem[] + +export interface AggregationsPercentilesAggregateBase extends AggregationsAggregateBase { + values: AggregationsPercentiles } export interface AggregationsPercentilesAggregation extends AggregationsFormatMetricAggregationBase { @@ -3020,6 +3365,9 @@ export interface AggregationsPercentilesAggregation extends AggregationsFormatMe tdigest?: AggregationsTDigest } +export interface AggregationsPercentilesBucketAggregate extends AggregationsPercentilesAggregateBase { +} + export interface AggregationsPercentilesBucketAggregation extends AggregationsPipelineAggregationBase { percents?: double[] } @@ -3030,48 +3378,68 @@ export interface AggregationsPipelineAggregationBase extends AggregationsAggrega gap_policy?: AggregationsGapPolicy } +export interface AggregationsRangeAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsRangeAggregation extends AggregationsBucketAggregationBase { field?: Field + missing?: integer ranges?: AggregationsAggregationRange[] script?: Script + keyed?: boolean } -export interface AggregationsRangeBucketKeys { +export interface AggregationsRangeBucketKeys extends AggregationsMultiBucketBase { + from?: double + to?: double + from_as_string?: string + to_as_string?: string + key?: string } -export type AggregationsRangeBucket = AggregationsRangeBucketKeys | - { [property: string]: AggregationsAggregate } +export type AggregationsRangeBucket = AggregationsRangeBucketKeys + & { [property: string]: AggregationsAggregate | double | string | long } export interface AggregationsRareTermsAggregation extends AggregationsBucketAggregationBase { - exclude?: string | string[] + exclude?: AggregationsTermsExclude field?: Field - include?: string | string[] | AggregationsTermsInclude + include?: AggregationsTermsInclude max_doc_count?: long missing?: AggregationsMissing precision?: double value_type?: string } -export interface AggregationsRareTermsBucketKeys { +export interface AggregationsRateAggregate extends AggregationsAggregateBase { + value: double + value_as_string?: string } -export type AggregationsRareTermsBucket = AggregationsRareTermsBucketKeys | - { [property: string]: AggregationsAggregate } export interface AggregationsRateAggregation extends AggregationsFormatMetricAggregationBase { - unit?: AggregationsDateInterval + unit?: AggregationsCalendarInterval mode?: AggregationsRateMode } export type AggregationsRateMode = 'sum' | 'value_count' export interface AggregationsRegressionInferenceOptions { - results_field: Field + results_field?: Field num_top_feature_importance_values?: integer } +export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } + export interface AggregationsReverseNestedAggregation extends AggregationsBucketAggregationBase { path?: Field } +export interface AggregationsSamplerAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsSamplerAggregate = AggregationsSamplerAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } + export interface AggregationsSamplerAggregation extends AggregationsBucketAggregationBase { shard_size?: integer } @@ -3098,19 +3466,38 @@ export interface AggregationsSerialDifferencingAggregation extends AggregationsP lag?: integer } -export interface AggregationsSignificantTermsAggregate extends AggregationsMultiBucketAggregate { - bg_count: long - doc_count: long +export interface AggregationsSignificantLongTermsAggregate extends AggregationsSignificantTermsAggregateBase { +} + +export interface AggregationsSignificantLongTermsBucketKeys extends AggregationsSignificantTermsBucketBase { + key: long + key_as_string?: string +} +export type AggregationsSignificantLongTermsBucket = AggregationsSignificantLongTermsBucketKeys + & { [property: string]: AggregationsAggregate | long | string | double } + +export interface AggregationsSignificantStringTermsAggregate extends AggregationsSignificantTermsAggregateBase { +} + +export interface AggregationsSignificantStringTermsBucketKeys extends AggregationsSignificantTermsBucketBase { + key: string +} +export type AggregationsSignificantStringTermsBucket = AggregationsSignificantStringTermsBucketKeys + & { [property: string]: AggregationsAggregate | string | double | long } + +export interface AggregationsSignificantTermsAggregateBase extends AggregationsMultiBucketAggregateBase { + bg_count?: long + doc_count?: long } export interface AggregationsSignificantTermsAggregation extends AggregationsBucketAggregationBase { background_filter?: QueryDslQueryContainer chi_square?: AggregationsChiSquareHeuristic - exclude?: string | string[] + exclude?: AggregationsTermsExclude execution_hint?: AggregationsTermsAggregationExecutionHint field?: Field gnd?: AggregationsGoogleNormalizedDistanceHeuristic - include?: string | string[] + include?: AggregationsTermsInclude min_doc_count?: long mutual_information?: AggregationsMutualInformationHeuristic percentage?: AggregationsPercentageScoreHeuristic @@ -3120,20 +3507,20 @@ export interface AggregationsSignificantTermsAggregation extends AggregationsBuc size?: integer } -export interface AggregationsSignificantTermsBucketKeys { +export interface AggregationsSignificantTermsBucketBase extends AggregationsMultiBucketBase { + score: double + bg_count: long } -export type AggregationsSignificantTermsBucket = AggregationsSignificantTermsBucketKeys | - { [property: string]: AggregationsAggregate } export interface AggregationsSignificantTextAggregation extends AggregationsBucketAggregationBase { background_filter?: QueryDslQueryContainer chi_square?: AggregationsChiSquareHeuristic - exclude?: string | string[] + exclude?: AggregationsTermsExclude execution_hint?: AggregationsTermsAggregationExecutionHint field?: Field filter_duplicate_text?: boolean gnd?: AggregationsGoogleNormalizedDistanceHeuristic - include?: string | string[] + include?: AggregationsTermsInclude min_doc_count?: long mutual_information?: AggregationsMutualInformationHeuristic percentage?: AggregationsPercentageScoreHeuristic @@ -3144,48 +3531,99 @@ export interface AggregationsSignificantTextAggregation extends AggregationsBuck source_fields?: Fields } -export interface AggregationsSingleBucketAggregateKeys extends AggregationsAggregateBase { - doc_count: double +export interface AggregationsSimpleMovingAverageAggregation extends AggregationsMovingAverageAggregationBase { + model: 'simple' + settings: EmptyObject +} + +export interface AggregationsSimpleValueAggregate extends AggregationsSingleMetricAggregateBase { +} + +export interface AggregationsSingleBucketAggregateBase extends AggregationsAggregateBase { + doc_count: long +} + +export interface AggregationsSingleMetricAggregateBase extends AggregationsAggregateBase { + value: double | null + value_as_string?: string } -export type AggregationsSingleBucketAggregate = AggregationsSingleBucketAggregateKeys | - { [property: string]: AggregationsAggregate } export interface AggregationsStandardDeviationBounds { - lower?: double - upper?: double - lower_population?: double - upper_population?: double - lower_sampling?: double - upper_sampling?: double + upper: double | null + lower: double | null + upper_population: double | null + lower_population: double | null + upper_sampling: double | null + lower_sampling: double | null +} + +export interface AggregationsStandardDeviationBoundsAsString { + upper: string + lower: string + upper_population: string + lower_population: string + upper_sampling: string + lower_sampling: string } export interface AggregationsStatsAggregate extends AggregationsAggregateBase { - count: double + count: long + min: double | null + max: double | null + avg: double | null sum: double - avg?: double - max?: double - min?: double + min_as_string?: string + max_as_string?: string + avg_as_string?: string + sum_as_string?: string } export interface AggregationsStatsAggregation extends AggregationsFormatMetricAggregationBase { } +export interface AggregationsStatsBucketAggregate extends AggregationsStatsAggregate { +} + export interface AggregationsStatsBucketAggregation extends AggregationsPipelineAggregationBase { } +export interface AggregationsStringRareTermsAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsStringRareTermsBucketKeys extends AggregationsMultiBucketBase { + key: string +} +export type AggregationsStringRareTermsBucket = AggregationsStringRareTermsBucketKeys + & { [property: string]: AggregationsAggregate | string | long } + export interface AggregationsStringStatsAggregate extends AggregationsAggregateBase { count: long - min_length: integer - max_length: integer - avg_length: double - entropy: double - distribution?: Record + min_length: integer | null + max_length: integer | null + avg_length: double | null + entropy: double | null + distribution?: Record | null + min_length_as_string?: string + max_length_as_string?: string + avg_length_as_string?: string } export interface AggregationsStringStatsAggregation extends AggregationsMetricAggregationBase { show_distribution?: boolean } +export interface AggregationsStringTermsAggregate extends AggregationsTermsAggregateBase { +} + +export interface AggregationsStringTermsBucketKeys extends AggregationsTermsBucketBase { + key: FieldValue +} +export type AggregationsStringTermsBucket = AggregationsStringTermsBucketKeys + & { [property: string]: AggregationsAggregate | FieldValue | long } + +export interface AggregationsSumAggregate extends AggregationsSingleMetricAggregateBase { +} + export interface AggregationsSumAggregation extends AggregationsFormatMetricAggregationBase { } @@ -3196,8 +3634,15 @@ export interface AggregationsTDigest { compression?: integer } -export interface AggregationsTDigestPercentilesAggregate extends AggregationsAggregateBase { - values: Record +export interface AggregationsTDigestPercentileRanksAggregate extends AggregationsPercentilesAggregateBase { +} + +export interface AggregationsTDigestPercentilesAggregate extends AggregationsPercentilesAggregateBase { +} + +export interface AggregationsTTestAggregate extends AggregationsAggregateBase { + value: double | null + value_as_string?: string } export interface AggregationsTTestAggregation extends AggregationsAggregation { @@ -3208,22 +3653,23 @@ export interface AggregationsTTestAggregation extends AggregationsAggregation { export type AggregationsTTestType = 'paired' | 'homoscedastic' | 'heteroscedastic' -export interface AggregationsTermsAggregate extends AggregationsMultiBucketAggregate { - doc_count_error_upper_bound: long - sum_other_doc_count: long +export interface AggregationsTermsAggregateBase extends AggregationsMultiBucketAggregateBase { + doc_count_error_upper_bound?: long + sum_other_doc_count?: long } export interface AggregationsTermsAggregation extends AggregationsBucketAggregationBase { collect_mode?: AggregationsTermsAggregationCollectMode - exclude?: string | string[] + exclude?: AggregationsTermsExclude execution_hint?: AggregationsTermsAggregationExecutionHint field?: Field - include?: string | string[] | AggregationsTermsInclude + include?: AggregationsTermsInclude min_doc_count?: integer missing?: AggregationsMissing + missing_order?: AggregationsMissingOrder missing_bucket?: boolean value_type?: string - order?: AggregationsTermsAggregationOrder + order?: AggregationsAggregateOrder script?: Script shard_size?: integer show_term_doc_count_error?: boolean @@ -3234,9 +3680,15 @@ export type AggregationsTermsAggregationCollectMode = 'depth_first' | 'breadth_f export type AggregationsTermsAggregationExecutionHint = 'map' | 'global_ordinals' | 'global_ordinals_hash' | 'global_ordinals_low_cardinality' -export type AggregationsTermsAggregationOrder = SearchSortOrder | Record | Record[] +export interface AggregationsTermsBucketBase extends AggregationsMultiBucketBase { + doc_count_error?: long +} + +export type AggregationsTermsExclude = string | string[] -export interface AggregationsTermsInclude { +export type AggregationsTermsInclude = string | string[] | AggregationsTermsPartition + +export interface AggregationsTermsPartition { num_partitions: long partition: long } @@ -3248,7 +3700,7 @@ export interface AggregationsTestPopulation { } export interface AggregationsTopHitsAggregate extends AggregationsAggregateBase { - hits: SearchHitsMetadata> + hits: SearchHitsMetadata } export interface AggregationsTopHitsAggregation extends AggregationsMetricAggregationBase { @@ -3258,8 +3710,8 @@ export interface AggregationsTopHitsAggregation extends AggregationsMetricAggreg highlight?: SearchHighlight script_fields?: Record size?: integer - sort?: SearchSort - _source?: boolean | SearchSourceFilter | Fields + sort?: Sort + _source?: SearchSourceConfig stored_fields?: Fields track_scores?: boolean version?: boolean @@ -3267,8 +3719,8 @@ export interface AggregationsTopHitsAggregation extends AggregationsMetricAggreg } export interface AggregationsTopMetrics { - sort: (long | double | string)[] - metrics: Record + sort: (FieldValue | null)[] + metrics: Record } export interface AggregationsTopMetricsAggregate extends AggregationsAggregateBase { @@ -3278,16 +3730,28 @@ export interface AggregationsTopMetricsAggregate extends AggregationsAggregateBa export interface AggregationsTopMetricsAggregation extends AggregationsMetricAggregationBase { metrics?: AggregationsTopMetricsValue | AggregationsTopMetricsValue[] size?: integer - sort?: SearchSort + sort?: Sort } export interface AggregationsTopMetricsValue { field: Field } -export interface AggregationsValueAggregate extends AggregationsAggregateBase { - value: double - value_as_string?: string +export interface AggregationsUnmappedRareTermsAggregate extends AggregationsMultiBucketAggregateBase { +} + +export interface AggregationsUnmappedSamplerAggregateKeys extends AggregationsSingleBucketAggregateBase { +} +export type AggregationsUnmappedSamplerAggregate = AggregationsUnmappedSamplerAggregateKeys + & { [property: string]: AggregationsAggregate | long | Record } + +export interface AggregationsUnmappedSignificantTermsAggregate extends AggregationsSignificantTermsAggregateBase { +} + +export interface AggregationsUnmappedTermsAggregate extends AggregationsTermsAggregateBase { +} + +export interface AggregationsValueCountAggregate extends AggregationsSingleMetricAggregateBase { } export interface AggregationsValueCountAggregation extends AggregationsFormattableMetricAggregation { @@ -3295,6 +3759,9 @@ export interface AggregationsValueCountAggregation extends AggregationsFormattab export type AggregationsValueType = 'string' | 'long' | 'double' | 'number' | 'date' | 'date_nanos' | 'ip' | 'numeric' | 'geo_point' | 'boolean' +export interface AggregationsVariableWidthHistogramAggregate extends AggregationsMultiBucketAggregateBase { +} + export interface AggregationsVariableWidthHistogramAggregation { field?: Field buckets?: integer @@ -3302,6 +3769,17 @@ export interface AggregationsVariableWidthHistogramAggregation { initial_buffer?: integer } +export interface AggregationsVariableWidthHistogramBucketKeys extends AggregationsMultiBucketBase { + min: double + key: double + max: double + min_as_string?: string + key_as_string?: string + max_as_string?: string +} +export type AggregationsVariableWidthHistogramBucket = AggregationsVariableWidthHistogramBucketKeys + & { [property: string]: AggregationsAggregate | double | string | long } + export interface AggregationsWeightedAverageAggregation extends AggregationsAggregation { format?: string value?: AggregationsWeightedAverageValue @@ -3315,171 +3793,377 @@ export interface AggregationsWeightedAverageValue { script?: Script } +export interface AggregationsWeightedAvgAggregate extends AggregationsSingleMetricAggregateBase { +} + +export type AnalysisAnalyzer = AnalysisCustomAnalyzer | AnalysisFingerprintAnalyzer | AnalysisKeywordAnalyzer | AnalysisLanguageAnalyzer | AnalysisNoriAnalyzer | AnalysisPatternAnalyzer | AnalysisSimpleAnalyzer | AnalysisStandardAnalyzer | AnalysisStopAnalyzer | AnalysisWhitespaceAnalyzer | AnalysisIcuAnalyzer | AnalysisKuromojiAnalyzer | AnalysisSnowballAnalyzer | AnalysisDutchAnalyzer + export interface AnalysisAsciiFoldingTokenFilter extends AnalysisTokenFilterBase { - preserve_original: boolean + type: 'asciifolding' + preserve_original?: boolean } -export type AnalysisCharFilter = AnalysisHtmlStripCharFilter | AnalysisMappingCharFilter | AnalysisPatternReplaceTokenFilter +export type AnalysisCharFilter = string | AnalysisCharFilterDefinition export interface AnalysisCharFilterBase { - type: string version?: VersionString } +export type AnalysisCharFilterDefinition = AnalysisHtmlStripCharFilter | AnalysisMappingCharFilter | AnalysisPatternReplaceCharFilter | AnalysisIcuNormalizationCharFilter | AnalysisKuromojiIterationMarkCharFilter + export interface AnalysisCharGroupTokenizer extends AnalysisTokenizerBase { + type: 'char_group' tokenize_on_chars: string[] + max_token_length?: integer } export interface AnalysisCommonGramsTokenFilter extends AnalysisTokenFilterBase { - common_words: string[] - common_words_path: string - ignore_case: boolean - query_mode: boolean + type: 'common_grams' + common_words?: string[] + common_words_path?: string + ignore_case?: boolean + query_mode?: boolean } export interface AnalysisCompoundWordTokenFilterBase extends AnalysisTokenFilterBase { - hyphenation_patterns_path: string - max_subword_size: integer - min_subword_size: integer - min_word_size: integer - only_longest_match: boolean - word_list: string[] - word_list_path: string + hyphenation_patterns_path?: string + max_subword_size?: integer + min_subword_size?: integer + min_word_size?: integer + only_longest_match?: boolean + word_list?: string[] + word_list_path?: string } export interface AnalysisConditionTokenFilter extends AnalysisTokenFilterBase { + type: 'condition' filter: string[] script: Script } +export interface AnalysisCustomAnalyzer { + type: 'custom' + char_filter?: string[] + filter?: string[] + position_increment_gap?: integer + position_offset_gap?: integer + tokenizer: string +} + +export interface AnalysisCustomNormalizer { + type: 'custom' + char_filter?: string[] + filter?: string[] +} + export type AnalysisDelimitedPayloadEncoding = 'int' | 'float' | 'identity' export interface AnalysisDelimitedPayloadTokenFilter extends AnalysisTokenFilterBase { - delimiter: string - encoding: AnalysisDelimitedPayloadEncoding + type: 'delimited_payload' + delimiter?: string + encoding?: AnalysisDelimitedPayloadEncoding +} + +export interface AnalysisDictionaryDecompounderTokenFilter extends AnalysisCompoundWordTokenFilterBase { + type: 'dictionary_decompounder' +} + +export interface AnalysisDutchAnalyzer { + type: 'dutch' + stopwords?: AnalysisStopWords } export type AnalysisEdgeNGramSide = 'front' | 'back' export interface AnalysisEdgeNGramTokenFilter extends AnalysisTokenFilterBase { - max_gram: integer - min_gram: integer - side: AnalysisEdgeNGramSide + type: 'edge_ngram' + max_gram?: integer + min_gram?: integer + side?: AnalysisEdgeNGramSide + preserve_original?: boolean } export interface AnalysisEdgeNGramTokenizer extends AnalysisTokenizerBase { - custom_token_chars: string + type: 'edge_ngram' + custom_token_chars?: string max_gram: integer min_gram: integer token_chars: AnalysisTokenChar[] } export interface AnalysisElisionTokenFilter extends AnalysisTokenFilterBase { - articles: string[] - articles_case: boolean + type: 'elision' + articles?: string[] + articles_path?: string + articles_case?: boolean } -export interface AnalysisFingerprintTokenFilter extends AnalysisTokenFilterBase { +export interface AnalysisFingerprintAnalyzer { + type: 'fingerprint' + version?: VersionString max_output_size: integer + preserve_original: boolean separator: string + stopwords?: AnalysisStopWords + stopwords_path?: string +} + +export interface AnalysisFingerprintTokenFilter extends AnalysisTokenFilterBase { + type: 'fingerprint' + max_output_size?: integer + separator?: string } export interface AnalysisHtmlStripCharFilter extends AnalysisCharFilterBase { + type: 'html_strip' } export interface AnalysisHunspellTokenFilter extends AnalysisTokenFilterBase { - dedup: boolean - dictionary: string + type: 'hunspell' + dedup?: boolean + dictionary?: string locale: string - longest_only: boolean + longest_only?: boolean } export interface AnalysisHyphenationDecompounderTokenFilter extends AnalysisCompoundWordTokenFilterBase { + type: 'hyphenation_decompounder' +} + +export interface AnalysisIcuAnalyzer { + type: 'icu_analyzer' + method: AnalysisIcuNormalizationType + mode: AnalysisIcuNormalizationMode +} + +export type AnalysisIcuCollationAlternate = 'shifted' | 'non-ignorable' + +export type AnalysisIcuCollationCaseFirst = 'lower' | 'upper' + +export type AnalysisIcuCollationDecomposition = 'no' | 'identical' + +export type AnalysisIcuCollationStrength = 'primary' | 'secondary' | 'tertiary' | 'quaternary' | 'identical' + +export interface AnalysisIcuCollationTokenFilter extends AnalysisTokenFilterBase { + type: 'icu_collation' + alternate?: AnalysisIcuCollationAlternate + caseFirst?: AnalysisIcuCollationCaseFirst + caseLevel?: boolean + country?: string + decomposition?: AnalysisIcuCollationDecomposition + hiraganaQuaternaryMode?: boolean + language?: string + numeric?: boolean + rules?: string + strength?: AnalysisIcuCollationStrength + variableTop?: string + variant?: string +} + +export interface AnalysisIcuFoldingTokenFilter extends AnalysisTokenFilterBase { + type: 'icu_folding' + unicode_set_filter: string +} + +export interface AnalysisIcuNormalizationCharFilter extends AnalysisCharFilterBase { + type: 'icu_normalizer' + mode?: AnalysisIcuNormalizationMode + name?: AnalysisIcuNormalizationType +} + +export type AnalysisIcuNormalizationMode = 'decompose' | 'compose' + +export interface AnalysisIcuNormalizationTokenFilter extends AnalysisTokenFilterBase { + type: 'icu_normalizer' + name: AnalysisIcuNormalizationType +} + +export type AnalysisIcuNormalizationType = 'nfc' | 'nfkc' | 'nfkc_cf' + +export interface AnalysisIcuTokenizer extends AnalysisTokenizerBase { + type: 'icu_tokenizer' + rule_files: string +} + +export type AnalysisIcuTransformDirection = 'forward' | 'reverse' + +export interface AnalysisIcuTransformTokenFilter extends AnalysisTokenFilterBase { + type: 'icu_transform' + dir?: AnalysisIcuTransformDirection + id: string } export interface AnalysisKStemTokenFilter extends AnalysisTokenFilterBase { + type: 'kstem' } export type AnalysisKeepTypesMode = 'include' | 'exclude' export interface AnalysisKeepTypesTokenFilter extends AnalysisTokenFilterBase { - mode: AnalysisKeepTypesMode - types: string[] + type: 'keep_types' + mode?: AnalysisKeepTypesMode + types?: string[] } export interface AnalysisKeepWordsTokenFilter extends AnalysisTokenFilterBase { - keep_words: string[] - keep_words_case: boolean - keep_words_path: string + type: 'keep' + keep_words?: string[] + keep_words_case?: boolean + keep_words_path?: string +} + +export interface AnalysisKeywordAnalyzer { + type: 'keyword' + version?: VersionString } export interface AnalysisKeywordMarkerTokenFilter extends AnalysisTokenFilterBase { - ignore_case: boolean - keywords: string[] - keywords_path: string - keywords_pattern: string + type: 'keyword_marker' + ignore_case?: boolean + keywords?: string[] + keywords_path?: string + keywords_pattern?: string } export interface AnalysisKeywordTokenizer extends AnalysisTokenizerBase { + type: 'keyword' buffer_size: integer } +export interface AnalysisKuromojiAnalyzer { + type: 'kuromoji' + mode: AnalysisKuromojiTokenizationMode + user_dictionary?: string +} + +export interface AnalysisKuromojiIterationMarkCharFilter extends AnalysisCharFilterBase { + type: 'kuromoji_iteration_mark' + normalize_kana: boolean + normalize_kanji: boolean +} + +export interface AnalysisKuromojiPartOfSpeechTokenFilter extends AnalysisTokenFilterBase { + type: 'kuromoji_part_of_speech' + stoptags: string[] +} + +export interface AnalysisKuromojiReadingFormTokenFilter extends AnalysisTokenFilterBase { + type: 'kuromoji_readingform' + use_romaji: boolean +} + +export interface AnalysisKuromojiStemmerTokenFilter extends AnalysisTokenFilterBase { + type: 'kuromoji_stemmer' + minimum_length: integer +} + +export type AnalysisKuromojiTokenizationMode = 'normal' | 'search' | 'extended' + +export interface AnalysisKuromojiTokenizer extends AnalysisTokenizerBase { + type: 'kuromoji_tokenizer' + discard_punctuation?: boolean + mode: AnalysisKuromojiTokenizationMode + nbest_cost?: integer + nbest_examples?: string + user_dictionary?: string + user_dictionary_rules?: string[] + discard_compound_token?: boolean +} + +export type AnalysisLanguage = 'Arabic' | 'Armenian' | 'Basque' | 'Brazilian' | 'Bulgarian' | 'Catalan' | 'Chinese' | 'Cjk' | 'Czech' | 'Danish' | 'Dutch' | 'English' | 'Estonian' | 'Finnish' | 'French' | 'Galician' | 'German' | 'Greek' | 'Hindi' | 'Hungarian' | 'Indonesian' | 'Irish' | 'Italian' | 'Latvian' | 'Norwegian' | 'Persian' | 'Portuguese' | 'Romanian' | 'Russian' | 'Sorani' | 'Spanish' | 'Swedish' | 'Turkish' | 'Thai' + +export interface AnalysisLanguageAnalyzer { + type: 'language' + version?: VersionString + language: AnalysisLanguage + stem_exclusion: string[] + stopwords?: AnalysisStopWords + stopwords_path?: string +} + export interface AnalysisLengthTokenFilter extends AnalysisTokenFilterBase { - max: integer - min: integer + type: 'length' + max?: integer + min?: integer } export interface AnalysisLetterTokenizer extends AnalysisTokenizerBase { + type: 'letter' } export interface AnalysisLimitTokenCountTokenFilter extends AnalysisTokenFilterBase { - consume_all_tokens: boolean - max_token_count: integer + type: 'limit' + consume_all_tokens?: boolean + max_token_count?: integer +} + +export interface AnalysisLowercaseNormalizer { + type: 'lowercase' } export interface AnalysisLowercaseTokenFilter extends AnalysisTokenFilterBase { - language: string + type: 'lowercase' + language?: string } export interface AnalysisLowercaseTokenizer extends AnalysisTokenizerBase { + type: 'lowercase' } export interface AnalysisMappingCharFilter extends AnalysisCharFilterBase { - mappings: string[] - mappings_path: string + type: 'mapping' + mappings?: string[] + mappings_path?: string } export interface AnalysisMultiplexerTokenFilter extends AnalysisTokenFilterBase { + type: 'multiplexer' filters: string[] - preserve_original: boolean + preserve_original?: boolean } export interface AnalysisNGramTokenFilter extends AnalysisTokenFilterBase { - max_gram: integer - min_gram: integer + type: 'ngram' + max_gram?: integer + min_gram?: integer + preserve_original?: boolean } export interface AnalysisNGramTokenizer extends AnalysisTokenizerBase { - custom_token_chars: string + type: 'ngram' + custom_token_chars?: string max_gram: integer min_gram: integer token_chars: AnalysisTokenChar[] } +export interface AnalysisNoriAnalyzer { + type: 'nori' + version?: VersionString + decompound_mode?: AnalysisNoriDecompoundMode + stoptags?: string[] + user_dictionary?: string +} + export type AnalysisNoriDecompoundMode = 'discard' | 'none' | 'mixed' export interface AnalysisNoriPartOfSpeechTokenFilter extends AnalysisTokenFilterBase { - stoptags: string[] + type: 'nori_part_of_speech' + stoptags?: string[] } export interface AnalysisNoriTokenizer extends AnalysisTokenizerBase { - decompound_mode: AnalysisNoriDecompoundMode - discard_punctuation: boolean - user_dictionary: string - user_dictionary_rules: string[] + type: 'nori_tokenizer' + decompound_mode?: AnalysisNoriDecompoundMode + discard_punctuation?: boolean + user_dictionary?: string + user_dictionary_rules?: string[] } +export type AnalysisNormalizer = AnalysisLowercaseNormalizer | AnalysisCustomNormalizer + export interface AnalysisPathHierarchyTokenizer extends AnalysisTokenizerBase { + type: 'path_hierarchy' buffer_size: integer delimiter: string replacement: string @@ -3487,158 +4171,262 @@ export interface AnalysisPathHierarchyTokenizer extends AnalysisTokenizerBase { skip: integer } +export interface AnalysisPatternAnalyzer { + type: 'pattern' + version?: VersionString + flags?: string + lowercase?: boolean + pattern: string + stopwords?: AnalysisStopWords +} + export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase { + type: 'pattern_capture' patterns: string[] - preserve_original: boolean + preserve_original?: boolean +} + +export interface AnalysisPatternReplaceCharFilter extends AnalysisCharFilterBase { + type: 'pattern_replace' + flags?: string + pattern: string + replacement?: string } export interface AnalysisPatternReplaceTokenFilter extends AnalysisTokenFilterBase { + type: 'pattern_replace' + all?: boolean + flags?: string + pattern: string + replacement?: string +} + +export interface AnalysisPatternTokenizer extends AnalysisTokenizerBase { + type: 'pattern' flags: string + group: integer pattern: string - replacement: string +} + +export type AnalysisPhoneticEncoder = 'metaphone' | 'double_metaphone' | 'soundex' | 'refined_soundex' | 'caverphone1' | 'caverphone2' | 'cologne' | 'nysiis' | 'koelnerphonetik' | 'haasephonetik' | 'beider_morse' | 'daitch_mokotoff' + +export type AnalysisPhoneticLanguage = 'any' | 'common' | 'cyrillic' | 'english' | 'french' | 'german' | 'hebrew' | 'hungarian' | 'polish' | 'romanian' | 'russian' | 'spanish' + +export type AnalysisPhoneticNameType = 'generic' | 'ashkenazi' | 'sephardic' + +export type AnalysisPhoneticRuleType = 'approx' | 'exact' + +export interface AnalysisPhoneticTokenFilter extends AnalysisTokenFilterBase { + type: 'phonetic' + encoder: AnalysisPhoneticEncoder + languageset: AnalysisPhoneticLanguage[] + max_code_len?: integer + name_type: AnalysisPhoneticNameType + replace?: boolean + rule_type: AnalysisPhoneticRuleType } export interface AnalysisPorterStemTokenFilter extends AnalysisTokenFilterBase { + type: 'porter_stem' } export interface AnalysisPredicateTokenFilter extends AnalysisTokenFilterBase { + type: 'predicate_token_filter' script: Script } export interface AnalysisRemoveDuplicatesTokenFilter extends AnalysisTokenFilterBase { + type: 'remove_duplicates' } export interface AnalysisReverseTokenFilter extends AnalysisTokenFilterBase { + type: 'reverse' } export interface AnalysisShingleTokenFilter extends AnalysisTokenFilterBase { - filler_token: string - max_shingle_size: integer - min_shingle_size: integer - output_unigrams: boolean - output_unigrams_if_no_shingles: boolean - token_separator: string + type: 'shingle' + filler_token?: string + max_shingle_size?: integer | string + min_shingle_size?: integer | string + output_unigrams?: boolean + output_unigrams_if_no_shingles?: boolean + token_separator?: string +} + +export interface AnalysisSimpleAnalyzer { + type: 'simple' + version?: VersionString +} + +export interface AnalysisSnowballAnalyzer { + type: 'snowball' + version?: VersionString + language: AnalysisSnowballLanguage + stopwords?: AnalysisStopWords } export type AnalysisSnowballLanguage = 'Armenian' | 'Basque' | 'Catalan' | 'Danish' | 'Dutch' | 'English' | 'Finnish' | 'French' | 'German' | 'German2' | 'Hungarian' | 'Italian' | 'Kp' | 'Lovins' | 'Norwegian' | 'Porter' | 'Portuguese' | 'Romanian' | 'Russian' | 'Spanish' | 'Swedish' | 'Turkish' export interface AnalysisSnowballTokenFilter extends AnalysisTokenFilterBase { + type: 'snowball' language: AnalysisSnowballLanguage } +export interface AnalysisStandardAnalyzer { + type: 'standard' + max_token_length?: integer + stopwords?: AnalysisStopWords +} + export interface AnalysisStandardTokenizer extends AnalysisTokenizerBase { - max_token_length: integer + type: 'standard' + max_token_length?: integer } export interface AnalysisStemmerOverrideTokenFilter extends AnalysisTokenFilterBase { - rules: string[] - rules_path: string + type: 'stemmer_override' + rules?: string[] + rules_path?: string } export interface AnalysisStemmerTokenFilter extends AnalysisTokenFilterBase { - language: string + type: 'stemmer' + language?: string + name?: string +} + +export interface AnalysisStopAnalyzer { + type: 'stop' + version?: VersionString + stopwords?: AnalysisStopWords + stopwords_path?: string } export interface AnalysisStopTokenFilter extends AnalysisTokenFilterBase { + type: 'stop' ignore_case?: boolean remove_trailing?: boolean - stopwords: AnalysisStopWords + stopwords?: AnalysisStopWords stopwords_path?: string } -export type AnalysisStopWords = string[] +export type AnalysisStopWords = string | string[] export type AnalysisSynonymFormat = 'solr' | 'wordnet' export interface AnalysisSynonymGraphTokenFilter extends AnalysisTokenFilterBase { - expand: boolean - format: AnalysisSynonymFormat - lenient: boolean - synonyms: string[] - synonyms_path: string - tokenizer: string - updateable: boolean + type: 'synonym_graph' + expand?: boolean + format?: AnalysisSynonymFormat + lenient?: boolean + synonyms?: string[] + synonyms_path?: string + tokenizer?: string + updateable?: boolean } export interface AnalysisSynonymTokenFilter extends AnalysisTokenFilterBase { - expand: boolean - format: AnalysisSynonymFormat - lenient: boolean - synonyms: string[] - synonyms_path: string - tokenizer: string - updateable: boolean + type: 'synonym' + expand?: boolean + format?: AnalysisSynonymFormat + lenient?: boolean + synonyms?: string[] + synonyms_path?: string + tokenizer?: string + updateable?: boolean } export type AnalysisTokenChar = 'letter' | 'digit' | 'whitespace' | 'punctuation' | 'symbol' | 'custom' -export type AnalysisTokenFilter = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter +export type AnalysisTokenFilter = string | AnalysisTokenFilterDefinition export interface AnalysisTokenFilterBase { - type: string version?: VersionString } -export type AnalysisTokenizer = AnalysisCharGroupTokenizer | AnalysisEdgeNGramTokenizer | AnalysisKeywordTokenizer | AnalysisLetterTokenizer | AnalysisLowercaseTokenizer | AnalysisNGramTokenizer | AnalysisNoriTokenizer | AnalysisPathHierarchyTokenizer | AnalysisStandardTokenizer | AnalysisUaxEmailUrlTokenizer | AnalysisWhitespaceTokenizer +export type AnalysisTokenFilterDefinition = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuTokenizer | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter + +export type AnalysisTokenizer = string | AnalysisTokenizerDefinition export interface AnalysisTokenizerBase { - type: string version?: VersionString } +export type AnalysisTokenizerDefinition = AnalysisCharGroupTokenizer | AnalysisEdgeNGramTokenizer | AnalysisKeywordTokenizer | AnalysisLetterTokenizer | AnalysisLowercaseTokenizer | AnalysisNGramTokenizer | AnalysisNoriTokenizer | AnalysisPathHierarchyTokenizer | AnalysisStandardTokenizer | AnalysisUaxEmailUrlTokenizer | AnalysisWhitespaceTokenizer | AnalysisKuromojiTokenizer | AnalysisPatternTokenizer | AnalysisIcuTokenizer + export interface AnalysisTrimTokenFilter extends AnalysisTokenFilterBase { + type: 'trim' } export interface AnalysisTruncateTokenFilter extends AnalysisTokenFilterBase { - length: integer + type: 'truncate' + length?: integer } export interface AnalysisUaxEmailUrlTokenizer extends AnalysisTokenizerBase { - max_token_length: integer + type: 'uax_url_email' + max_token_length?: integer } export interface AnalysisUniqueTokenFilter extends AnalysisTokenFilterBase { - only_on_same_position: boolean + type: 'unique' + only_on_same_position?: boolean } export interface AnalysisUppercaseTokenFilter extends AnalysisTokenFilterBase { + type: 'uppercase' +} + +export interface AnalysisWhitespaceAnalyzer { + type: 'whitespace' + version?: VersionString } export interface AnalysisWhitespaceTokenizer extends AnalysisTokenizerBase { - max_token_length: integer + type: 'whitespace' + max_token_length?: integer } export interface AnalysisWordDelimiterGraphTokenFilter extends AnalysisTokenFilterBase { - adjust_offsets: boolean - catenate_all: boolean - catenate_numbers: boolean - catenate_words: boolean - generate_number_parts: boolean - generate_word_parts: boolean - preserve_original: boolean - protected_words: string[] - protected_words_path: string - split_on_case_change: boolean - split_on_numerics: boolean - stem_english_possessive: boolean - type_table: string[] - type_table_path: string + type: 'word_delimiter_graph' + adjust_offsets?: boolean + catenate_all?: boolean + catenate_numbers?: boolean + catenate_words?: boolean + generate_number_parts?: boolean + generate_word_parts?: boolean + ignore_keywords?: boolean + preserve_original?: boolean + protected_words?: string[] + protected_words_path?: string + split_on_case_change?: boolean + split_on_numerics?: boolean + stem_english_possessive?: boolean + type_table?: string[] + type_table_path?: string } export interface AnalysisWordDelimiterTokenFilter extends AnalysisTokenFilterBase { - catenate_all: boolean - catenate_numbers: boolean - catenate_words: boolean - generate_number_parts: boolean - generate_word_parts: boolean - preserve_original: boolean - protected_words: string[] - protected_words_path: string - split_on_case_change: boolean - split_on_numerics: boolean - stem_english_possessive: boolean - type_table: string[] - type_table_path: string + type: 'word_delimiter' + catenate_all?: boolean + catenate_numbers?: boolean + catenate_words?: boolean + generate_number_parts?: boolean + generate_word_parts?: boolean + preserve_original?: boolean + protected_words?: string[] + protected_words_path?: string + split_on_case_change?: boolean + split_on_numerics?: boolean + stem_english_possessive?: boolean + type_table?: string[] + type_table_path?: string +} + +export interface MappingAggregateMetricDoubleProperty extends MappingPropertyBase { + type: 'aggregate_metric_double' + default_metric: string + metrics: string[] } export interface MappingAllField { @@ -3666,6 +4454,11 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase { type: 'boolean' } +export interface MappingByteNumberProperty extends MappingStandardNumberProperty { + type: 'byte' + null_value?: byte +} + export interface MappingCompletionProperty extends MappingDocValuesPropertyBase { analyzer?: string contexts?: MappingSuggestContext[] @@ -3681,7 +4474,7 @@ export interface MappingConstantKeywordProperty extends MappingPropertyBase { type: 'constant_keyword' } -export type MappingCoreProperty = MappingObjectProperty | MappingNestedProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingDocValuesProperty +export type MappingCoreProperty = MappingObjectProperty | MappingNestedProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingDocValuesProperty | MappingMatchOnlyTextProperty export interface MappingCorePropertyBase extends MappingPropertyBase { copy_to?: Fields @@ -3707,6 +4500,7 @@ export interface MappingDateProperty extends MappingDocValuesPropertyBase { index?: boolean null_value?: DateString precision_step?: integer + locale?: string type: 'date' } @@ -3715,20 +4509,64 @@ export interface MappingDateRangeProperty extends MappingRangePropertyBase { type: 'date_range' } -export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingGenericProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty +export interface MappingDenseVectorIndexOptions { + type: string + m: integer + ef_construction: integer +} + +export interface MappingDenseVectorProperty extends MappingPropertyBase { + type: 'dense_vector' + dims: integer + similarity?: string + index?: boolean + index_options?: MappingDenseVectorIndexOptions +} + +export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase { doc_values?: boolean } +export interface MappingDoubleNumberProperty extends MappingStandardNumberProperty { + type: 'double' + null_value?: double +} + export interface MappingDoubleRangeProperty extends MappingRangePropertyBase { type: 'double_range' } -export type MappingDynamicMapping = 'strict' | 'runtime' | 'true' | 'false' +export type MappingDynamicMapping = boolean | 'strict' | 'runtime' | 'true' | 'false' + +export interface MappingDynamicProperty extends MappingDocValuesPropertyBase { + type: '{dynamic_property}' + enabled?: boolean + null_value?: FieldValue + boost?: double + coerce?: boolean + script?: Script + on_script_error?: MappingOnScriptError + ignore_malformed?: boolean + analyzer?: string + eager_global_ordinals?: boolean + index?: boolean + index_options?: MappingIndexOptions + index_phrases?: boolean + index_prefixes?: MappingTextIndexPrefixes + norms?: boolean + position_increment_gap?: integer + search_analyzer?: string + search_quote_analyzer?: string + term_vector?: MappingTermVectorOption + format?: string + precision_step?: integer + locale?: string +} export interface MappingDynamicTemplate { - mapping?: MappingPropertyBase + mapping?: MappingProperty match?: string match_mapping_type?: string match_pattern?: MappingMatchType @@ -3743,13 +4581,15 @@ export interface MappingFieldAliasProperty extends MappingPropertyBase { } export interface MappingFieldMapping { + full_name: string + mapping: Partial> } export interface MappingFieldNamesField { enabled: boolean } -export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword' +export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'match_only_text' export interface MappingFlattenedProperty extends MappingPropertyBase { boost?: double @@ -3764,31 +4604,21 @@ export interface MappingFlattenedProperty extends MappingPropertyBase { type: 'flattened' } -export interface MappingFloatRangeProperty extends MappingRangePropertyBase { - type: 'float_range' +export interface MappingFloatNumberProperty extends MappingStandardNumberProperty { + type: 'float' + null_value?: float } -export interface MappingGenericProperty extends MappingDocValuesPropertyBase { - analyzer: string - boost: double - fielddata: IndicesStringFielddata - ignore_malformed: boolean - index: boolean - index_options: MappingIndexOptions - norms: boolean - null_value: string - position_increment_gap: integer - search_analyzer: string - term_vector: MappingTermVectorOption - type: string +export interface MappingFloatRangeProperty extends MappingRangePropertyBase { + type: 'float_range' } -export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'COUNTERCLOCKWISE' | 'ccw' | 'CCW' | 'left' | 'LEFT' | 'clockwise' | 'CLOCKWISE' | 'cw' | 'CW' +export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw' export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase { ignore_malformed?: boolean ignore_z_value?: boolean - null_value?: QueryDslGeoLocation + null_value?: GeoLocation type: 'geo_point' } @@ -3803,6 +4633,11 @@ export interface MappingGeoShapeProperty extends MappingDocValuesPropertyBase { export type MappingGeoStrategy = 'recursive' | 'term' +export interface MappingHalfFloatNumberProperty extends MappingStandardNumberProperty { + type: 'half_float' + null_value?: float +} + export interface MappingHistogramProperty extends MappingPropertyBase { ignore_malformed?: boolean type: 'histogram' @@ -3814,6 +4649,11 @@ export interface MappingIndexField { export type MappingIndexOptions = 'docs' | 'freqs' | 'positions' | 'offsets' +export interface MappingIntegerNumberProperty extends MappingStandardNumberProperty { + type: 'integer' + null_value?: integer +} + export interface MappingIntegerRangeProperty extends MappingRangePropertyBase { type: 'integer_range' } @@ -3822,6 +4662,7 @@ export interface MappingIpProperty extends MappingDocValuesPropertyBase { boost?: double index?: boolean null_value?: string + ignore_malformed?: boolean type: 'ip' } @@ -3846,10 +4687,22 @@ export interface MappingKeywordProperty extends MappingDocValuesPropertyBase { type: 'keyword' } +export interface MappingLongNumberProperty extends MappingStandardNumberProperty { + type: 'long' + null_value?: long +} + export interface MappingLongRangeProperty extends MappingRangePropertyBase { type: 'long_range' } +export interface MappingMatchOnlyTextProperty { + type: 'match_only_text' + fields?: Record + meta?: Record + copy_to?: Fields +} + export type MappingMatchType = 'simple' | 'regex' export interface MappingMurmur3HashProperty extends MappingDocValuesPropertyBase { @@ -3863,24 +4716,20 @@ export interface MappingNestedProperty extends MappingCorePropertyBase { type: 'nested' } -export interface MappingNumberProperty extends MappingDocValuesPropertyBase { - boost?: double - coerce?: boolean - fielddata?: IndicesNumericFielddata - ignore_malformed?: boolean +export type MappingNumberProperty = MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingDoubleNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingShortNumberProperty | MappingByteNumberProperty | MappingUnsignedLongNumberProperty | MappingScaledFloatNumberProperty + +export interface MappingNumberPropertyBase extends MappingDocValuesPropertyBase { index?: boolean - null_value?: double - scaling_factor?: double - type: MappingNumberType + ignore_malformed?: boolean } -export type MappingNumberType = 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer' | 'long' | 'short' | 'byte' | 'unsigned_long' - export interface MappingObjectProperty extends MappingCorePropertyBase { enabled?: boolean type?: 'object' } +export type MappingOnScriptError = 'fail' | 'continue' + export interface MappingPercolatorProperty extends MappingPropertyBase { type: 'percolator' } @@ -3892,15 +4741,13 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase { type: 'point' } -export type MappingProperty = MappingFlattenedProperty | MappingJoinProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingCoreProperty +export type MappingProperty = MappingFlattenedProperty | MappingJoinProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingDenseVectorProperty | MappingAggregateMetricDoubleProperty | MappingCoreProperty | MappingDynamicProperty export interface MappingPropertyBase { - local_metadata?: Metadata meta?: Record - name?: PropertyName properties?: Record ignore_above?: integer - dynamic?: boolean | MappingDynamicMapping + dynamic?: MappingDynamicMapping fields?: Record } @@ -3935,6 +4782,13 @@ export type MappingRuntimeFieldType = 'boolean' | 'date' | 'double' | 'geo_point export type MappingRuntimeFields = Record +export interface MappingScaledFloatNumberProperty extends MappingNumberPropertyBase { + type: 'scaled_float' + coerce?: boolean + null_value?: double + scaling_factor?: double +} + export interface MappingSearchAsYouTypeProperty extends MappingCorePropertyBase { analyzer?: string index?: boolean @@ -3947,16 +4801,19 @@ export interface MappingSearchAsYouTypeProperty extends MappingCorePropertyBase type: 'search_as_you_type' } -export type MappingShapeOrientation = 'right' | 'counterclockwise' | 'ccw' | 'left' | 'clockwise' | 'cw' - export interface MappingShapeProperty extends MappingDocValuesPropertyBase { coerce?: boolean ignore_malformed?: boolean ignore_z_value?: boolean - orientation?: MappingShapeOrientation + orientation?: MappingGeoOrientation type: 'shape' } +export interface MappingShortNumberProperty extends MappingStandardNumberProperty { + type: 'short' + null_value?: short +} + export interface MappingSizeField { enabled: boolean } @@ -3964,19 +4821,25 @@ export interface MappingSizeField { export interface MappingSourceField { compress?: boolean compress_threshold?: string - enabled: boolean + enabled?: boolean excludes?: string[] includes?: string[] } +export interface MappingStandardNumberProperty extends MappingNumberPropertyBase { + coerce?: boolean + script?: Script + on_script_error?: MappingOnScriptError +} + export interface MappingSuggestContext { name: Name path?: Field type: string - precision?: integer + precision?: integer | string } -export type MappingTermVectorOption = 'no' | 'yes' | 'with_offsets' | 'with_positions' | 'with_positions_offsets' | 'with_positions_offsets_payloads' +export type MappingTermVectorOption = 'no' | 'yes' | 'with_offsets' | 'with_positions' | 'with_positions_offsets' | 'with_positions_offsets_payloads' | 'with_positions_payloads' export interface MappingTextIndexPrefixes { max_chars: integer @@ -4013,9 +4876,9 @@ export interface MappingTokenCountProperty extends MappingDocValuesPropertyBase export interface MappingTypeMapping { all_field?: MappingAllField date_detection?: boolean - dynamic?: boolean | MappingDynamicMapping + dynamic?: MappingDynamicMapping dynamic_date_formats?: string[] - dynamic_templates?: Record | Record[] + dynamic_templates?: Record[] _field_names?: MappingFieldNamesField index_field?: MappingIndexField _meta?: Metadata @@ -4025,6 +4888,12 @@ export interface MappingTypeMapping { _size?: MappingSizeField _source?: MappingSourceField runtime?: Record + enabled?: boolean +} + +export interface MappingUnsignedLongNumberProperty extends MappingNumberPropertyBase { + type: 'unsigned_long' + null_value?: ulong } export interface MappingVersionProperty extends MappingDocValuesPropertyBase { @@ -4033,6 +4902,7 @@ export interface MappingVersionProperty extends MappingDocValuesPropertyBase { export interface MappingWildcardProperty extends MappingDocValuesPropertyBase { type: 'wildcard' + null_value?: string } export interface QueryDslBoolQuery extends QueryDslQueryBase { @@ -4049,18 +4919,6 @@ export interface QueryDslBoostingQuery extends QueryDslQueryBase { positive: QueryDslQueryContainer } -export interface QueryDslBoundingBox { - bottom_right?: QueryDslGeoLocation - top_left?: QueryDslGeoLocation - top_right?: QueryDslGeoLocation - bottom_left?: QueryDslGeoLocation - top?: double - left?: double - right?: double - bottom?: double - wkt?: string -} - export type QueryDslChildScoreMode = 'none' | 'avg' | 'sum' | 'max' | 'min' export type QueryDslCombinedFieldsOperator = 'or' | 'and' @@ -4070,7 +4928,7 @@ export interface QueryDslCombinedFieldsQuery extends QueryDslQueryBase { query: string auto_generate_synonyms_phrase_query?: boolean operator?: QueryDslCombinedFieldsOperator - mimimum_should_match?: MinimumShouldMatch + minimum_should_match?: MinimumShouldMatch zero_terms_query?: QueryDslCombinedFieldsZeroTerms } @@ -4091,8 +4949,8 @@ export interface QueryDslConstantScoreQuery extends QueryDslQueryBase { export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase { } -export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys | - { [property: string]: QueryDslDecayPlacement } +export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys + & { [property: string]: QueryDslDecayPlacement | QueryDslMultiValueMode } export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase { } @@ -4102,13 +4960,15 @@ export interface QueryDslDateRangeQuery extends QueryDslRangeQueryBase { gte?: DateMath lt?: DateMath lte?: DateMath + from?: DateMath | null + to?: DateMath | null format?: DateFormat time_zone?: TimeZone } export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction -export interface QueryDslDecayFunctionBase extends QueryDslScoreFunctionBase { +export interface QueryDslDecayFunctionBase { multi_value_mode?: QueryDslMultiValueMode } @@ -4136,6 +4996,12 @@ export interface QueryDslExistsQuery extends QueryDslQueryBase { field: Field } +export interface QueryDslFieldAndFormat { + field: Field + format?: string + include_unmapped?: boolean +} + export interface QueryDslFieldLookup { id: Id index?: IndexName @@ -4145,7 +5011,7 @@ export interface QueryDslFieldLookup { export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal' -export interface QueryDslFieldValueFactorScoreFunction extends QueryDslScoreFunctionBase { +export interface QueryDslFieldValueFactorScoreFunction { field: Field factor?: double missing?: double @@ -4182,47 +5048,46 @@ export interface QueryDslFuzzyQuery extends QueryDslQueryBase { rewrite?: MultiTermQueryRewrite transpositions?: boolean fuzziness?: Fuzziness - value: string + value: string | double | boolean } export interface QueryDslGeoBoundingBoxQueryKeys extends QueryDslQueryBase { type?: QueryDslGeoExecution validation_method?: QueryDslGeoValidationMethod + ignore_unmapped?: boolean } -export type QueryDslGeoBoundingBoxQuery = QueryDslGeoBoundingBoxQueryKeys | - { [property: string]: QueryDslBoundingBox } - -export type QueryDslGeoCoordinate = string | double[] | QueryDslThreeDimensionalPoint +export type QueryDslGeoBoundingBoxQuery = QueryDslGeoBoundingBoxQueryKeys + & { [property: string]: GeoBounds | QueryDslGeoExecution | QueryDslGeoValidationMethod | boolean | float | string } export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase { } -export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys | - { [property: string]: QueryDslDecayPlacement } +export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys + & { [property: string]: QueryDslDecayPlacement | QueryDslMultiValueMode } -export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase { +export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase { } export interface QueryDslGeoDistanceQueryKeys extends QueryDslQueryBase { distance?: Distance distance_type?: GeoDistanceType validation_method?: QueryDslGeoValidationMethod + ignore_unmapped?: boolean } -export type QueryDslGeoDistanceQuery = QueryDslGeoDistanceQueryKeys | - { [property: string]: QueryDslGeoLocation } +export type QueryDslGeoDistanceQuery = QueryDslGeoDistanceQueryKeys + & { [property: string]: GeoLocation | Distance | GeoDistanceType | QueryDslGeoValidationMethod | boolean | float | string } export type QueryDslGeoExecution = 'memory' | 'indexed' -export type QueryDslGeoLocation = string | double[] | QueryDslTwoDimensionalPoint - export interface QueryDslGeoPolygonPoints { - points: QueryDslGeoLocation[] + points: GeoLocation[] } export interface QueryDslGeoPolygonQueryKeys extends QueryDslQueryBase { validation_method?: QueryDslGeoValidationMethod + ignore_unmapped?: boolean } -export type QueryDslGeoPolygonQuery = QueryDslGeoPolygonQueryKeys | - { [property: string]: QueryDslGeoPolygonPoints } +export type QueryDslGeoPolygonQuery = QueryDslGeoPolygonQueryKeys + & { [property: string]: QueryDslGeoPolygonPoints | QueryDslGeoValidationMethod | boolean | float | string } export interface QueryDslGeoShapeFieldQuery { shape?: GeoShape @@ -4233,8 +5098,8 @@ export interface QueryDslGeoShapeFieldQuery { export interface QueryDslGeoShapeQueryKeys extends QueryDslQueryBase { ignore_unmapped?: boolean } -export type QueryDslGeoShapeQuery = QueryDslGeoShapeQueryKeys | - { [property: string]: QueryDslGeoShapeFieldQuery } +export type QueryDslGeoShapeQuery = QueryDslGeoShapeQueryKeys + & { [property: string]: QueryDslGeoShapeFieldQuery | boolean | float | string } export type QueryDslGeoValidationMethod = 'coerce' | 'ignore_malformed' | 'strict' @@ -4444,24 +5309,24 @@ export interface QueryDslNestedQuery extends QueryDslQueryBase { inner_hits?: SearchInnerHits path: Field query: QueryDslQueryContainer - score_mode?: QueryDslNestedScoreMode + score_mode?: QueryDslChildScoreMode } -export type QueryDslNestedScoreMode = 'avg' | 'sum' | 'min' | 'max' | 'none' - export interface QueryDslNumberRangeQuery extends QueryDslRangeQueryBase { gt?: double gte?: double lt?: double lte?: double + from?: double | null + to?: double | null } export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase { } -export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys | - { [property: string]: QueryDslDecayPlacement } +export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys + & { [property: string]: QueryDslDecayPlacement | QueryDslMultiValueMode } -export type QueryDslOperator = 'and' | 'or' +export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR' export interface QueryDslParentIdQuery extends QueryDslQueryBase { id?: Id @@ -4481,9 +5346,15 @@ export interface QueryDslPercolateQuery extends QueryDslQueryBase { version?: VersionNumber } +export interface QueryDslPinnedDoc { + _id: Id + _index: IndexName +} + export interface QueryDslPinnedQuery extends QueryDslQueryBase { - ids: Id[] organic: QueryDslQueryContainer + ids?: Id[] + docs?: QueryDslPinnedDoc[] } export interface QueryDslPrefixQuery extends QueryDslQueryBase { @@ -4500,14 +5371,14 @@ export interface QueryDslQueryBase { export interface QueryDslQueryContainer { bool?: QueryDslBoolQuery boosting?: QueryDslBoostingQuery - common?: Record + common?: Partial> combined_fields?: QueryDslCombinedFieldsQuery constant_score?: QueryDslConstantScoreQuery dis_max?: QueryDslDisMaxQuery distance_feature?: QueryDslDistanceFeatureQuery exists?: QueryDslExistsQuery function_score?: QueryDslFunctionScoreQuery - fuzzy?: Record + fuzzy?: Partial> geo_bounding_box?: QueryDslGeoBoundingBoxQuery geo_distance?: QueryDslGeoDistanceQuery geo_polygon?: QueryDslGeoPolygonQuery @@ -4515,24 +5386,24 @@ export interface QueryDslQueryContainer { has_child?: QueryDslHasChildQuery has_parent?: QueryDslHasParentQuery ids?: QueryDslIdsQuery - intervals?: Record - match?: Record + intervals?: Partial> + match?: Partial> match_all?: QueryDslMatchAllQuery - match_bool_prefix?: Record + match_bool_prefix?: Partial> match_none?: QueryDslMatchNoneQuery - match_phrase?: Record - match_phrase_prefix?: Record + match_phrase?: Partial> + match_phrase_prefix?: Partial> more_like_this?: QueryDslMoreLikeThisQuery multi_match?: QueryDslMultiMatchQuery nested?: QueryDslNestedQuery parent_id?: QueryDslParentIdQuery percolate?: QueryDslPercolateQuery pinned?: QueryDslPinnedQuery - prefix?: Record + prefix?: Partial> query_string?: QueryDslQueryStringQuery - range?: Record + range?: Partial> rank_feature?: QueryDslRankFeatureQuery - regexp?: Record + regexp?: Partial> script?: QueryDslScriptQuery script_score?: QueryDslScriptScoreQuery shape?: QueryDslShapeQuery @@ -4544,12 +5415,13 @@ export interface QueryDslQueryContainer { span_near?: QueryDslSpanNearQuery span_not?: QueryDslSpanNotQuery span_or?: QueryDslSpanOrQuery - span_term?: Record + span_term?: Partial> span_within?: QueryDslSpanWithinQuery - term?: Record + term?: Partial> terms?: QueryDslTermsQuery - terms_set?: Record - wildcard?: Record + terms_set?: Partial> + wildcard?: Partial> + wrapper?: QueryDslWrapperQuery type?: QueryDslTypeQuery } @@ -4581,7 +5453,7 @@ export interface QueryDslQueryStringQuery extends QueryDslQueryBase { type?: QueryDslTextQueryType } -export interface QueryDslRandomScoreFunction extends QueryDslScoreFunctionBase { +export interface QueryDslRandomScoreFunction { field?: Field seed?: long | string } @@ -4595,20 +5467,22 @@ export interface QueryDslRangeQueryBase extends QueryDslQueryBase { export type QueryDslRangeRelation = 'within' | 'contains' | 'intersects' export interface QueryDslRankFeatureFunction { + [key: string]: never } -export interface QueryDslRankFeatureFunctionLinear extends QueryDslRankFeatureFunction { +export interface QueryDslRankFeatureFunctionLinear { + [key: string]: never } -export interface QueryDslRankFeatureFunctionLogarithm extends QueryDslRankFeatureFunction { +export interface QueryDslRankFeatureFunctionLogarithm { scaling_factor: float } -export interface QueryDslRankFeatureFunctionSaturation extends QueryDslRankFeatureFunction { +export interface QueryDslRankFeatureFunctionSaturation { pivot?: float } -export interface QueryDslRankFeatureFunctionSigmoid extends QueryDslRankFeatureFunction { +export interface QueryDslRankFeatureFunctionSigmoid { pivot: float exponent: float } @@ -4629,16 +5503,11 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase { value: string } -export interface QueryDslScoreFunctionBase { - filter?: QueryDslQueryContainer - weight?: double -} - export interface QueryDslScriptQuery extends QueryDslQueryBase { script: Script } -export interface QueryDslScriptScoreFunction extends QueryDslScoreFunctionBase { +export interface QueryDslScriptScoreFunction { script: Script } @@ -4649,18 +5518,20 @@ export interface QueryDslScriptScoreQuery extends QueryDslQueryBase { } export interface QueryDslShapeFieldQuery { - ignore_unmapped?: boolean indexed_shape?: QueryDslFieldLookup - relation?: ShapeRelation + relation?: GeoShapeRelation shape?: GeoShape } export interface QueryDslShapeQueryKeys extends QueryDslQueryBase { + ignore_unmapped?: boolean } -export type QueryDslShapeQuery = QueryDslShapeQueryKeys | - { [property: string]: QueryDslShapeFieldQuery } +export type QueryDslShapeQuery = QueryDslShapeQueryKeys + & { [property: string]: QueryDslShapeFieldQuery | boolean | float | string } -export type QueryDslSimpleQueryStringFlags = 'NONE' | 'AND' | 'OR' | 'NOT' | 'PREFIX' | 'PHRASE' | 'PRECEDENCE' | 'ESCAPE' | 'WHITESPACE' | 'FUZZY' | 'NEAR' | 'SLOP' | 'ALL' +export type QueryDslSimpleQueryStringFlag = 'NONE' | 'AND' | 'OR' | 'NOT' | 'PREFIX' | 'PHRASE' | 'PRECEDENCE' | 'ESCAPE' | 'WHITESPACE' | 'FUZZY' | 'NEAR' | 'SLOP' | 'ALL' + +export type QueryDslSimpleQueryStringFlags = QueryDslSimpleQueryStringFlag | string export interface QueryDslSimpleQueryStringQuery extends QueryDslQueryBase { analyzer?: string @@ -4668,7 +5539,7 @@ export interface QueryDslSimpleQueryStringQuery extends QueryDslQueryBase { auto_generate_synonyms_phrase_query?: boolean default_operator?: QueryDslOperator fields?: Field[] - flags?: QueryDslSimpleQueryStringFlags | string + flags?: QueryDslSimpleQueryStringFlags fuzzy_max_expansions?: integer fuzzy_prefix_length?: integer fuzzy_transpositions?: boolean @@ -4693,6 +5564,8 @@ export interface QueryDslSpanFirstQuery extends QueryDslQueryBase { match: QueryDslSpanQuery } +export type QueryDslSpanGapQuery = Partial> + export interface QueryDslSpanMultiTermQuery extends QueryDslQueryBase { match: QueryDslQueryContainer } @@ -4719,12 +5592,12 @@ export interface QueryDslSpanQuery { span_containing?: QueryDslSpanContainingQuery field_masking_span?: QueryDslSpanFieldMaskingQuery span_first?: QueryDslSpanFirstQuery - span_gap?: Record + span_gap?: QueryDslSpanGapQuery span_multi?: QueryDslSpanMultiTermQuery span_near?: QueryDslSpanNearQuery span_not?: QueryDslSpanNotQuery span_or?: QueryDslSpanOrQuery - span_term?: Record + span_term?: Partial> span_within?: QueryDslSpanWithinQuery } @@ -4738,7 +5611,7 @@ export interface QueryDslSpanWithinQuery extends QueryDslQueryBase { } export interface QueryDslTermQuery extends QueryDslQueryBase { - value: string | float | boolean + value: FieldValue case_insensitive?: boolean } @@ -4751,33 +5624,19 @@ export interface QueryDslTermsLookup { export interface QueryDslTermsQueryKeys extends QueryDslQueryBase { } -export type QueryDslTermsQuery = QueryDslTermsQueryKeys | - { [property: string]: string[] | long[] | QueryDslTermsLookup } +export type QueryDslTermsQuery = QueryDslTermsQueryKeys + & { [property: string]: QueryDslTermsQueryField | float | string } -export interface QueryDslTermsSetFieldQuery { +export type QueryDslTermsQueryField = FieldValue[] | QueryDslTermsLookup + +export interface QueryDslTermsSetQuery extends QueryDslQueryBase { minimum_should_match_field?: Field minimum_should_match_script?: Script terms: string[] } -export interface QueryDslTermsSetQueryKeys extends QueryDslQueryBase { -} -export type QueryDslTermsSetQuery = QueryDslTermsSetQueryKeys | - { [property: string]: QueryDslTermsSetFieldQuery } - export type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix' -export interface QueryDslThreeDimensionalPoint { - lat: double - lon: double - z?: double -} - -export interface QueryDslTwoDimensionalPoint { - lat: double - lon: double -} - export interface QueryDslTypeQuery extends QueryDslQueryBase { value: string } @@ -4785,13 +5644,18 @@ export interface QueryDslTypeQuery extends QueryDslQueryBase { export interface QueryDslWildcardQuery extends QueryDslQueryBase { case_insensitive?: boolean rewrite?: MultiTermQueryRewrite - value: string + value?: string + wildcard?: string +} + +export interface QueryDslWrapperQuery extends QueryDslQueryBase { + query: string } export type QueryDslZeroTermsQuery = 'all' | 'none' export interface AsyncSearchAsyncSearch { - aggregations?: Record + aggregations?: Record _clusters?: ClusterStatistics fields?: Record hits: SearchHitsMetadata @@ -4847,121 +5711,174 @@ export interface AsyncSearchStatusResponse extends AsyncSea export interface AsyncSearchSubmitRequest extends RequestBase { index?: Indices - batched_reduce_size?: long wait_for_completion_timeout?: Time keep_on_completion?: boolean + keep_alive?: Time + allow_no_indices?: boolean + allow_partial_search_results?: boolean + analyzer?: string + analyze_wildcard?: boolean + batched_reduce_size?: long + ccs_minimize_roundtrips?: boolean + default_operator?: QueryDslOperator + df?: string + docvalue_fields?: Fields + expand_wildcards?: ExpandWildcards + explain?: boolean + ignore_throttled?: boolean + ignore_unavailable?: boolean + lenient?: boolean + max_concurrent_shard_requests?: long + min_compatible_shard_node?: VersionString + preference?: string + pre_filter_shard_size?: long + request_cache?: boolean + routing?: Routing + scroll?: Time + search_type?: SearchType + stats?: string[] + stored_fields?: Fields + suggest_field?: Field + suggest_mode?: SuggestMode + suggest_size?: long + suggest_text?: string + terminate_after?: long + timeout?: Time + track_total_hits?: SearchTrackHits + track_scores?: boolean typed_keys?: boolean + rest_total_hits_as_int?: boolean + version?: boolean + _source?: SearchSourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields + seq_no_primary_term?: boolean + q?: string + size?: integer + from?: integer + sort?: string | string[] body?: { + aggregations?: Record aggs?: Record - allow_no_indices?: boolean - allow_partial_search_results?: boolean - analyzer?: string - analyze_wildcard?: boolean - batched_reduce_size?: long collapse?: SearchFieldCollapse - default_operator?: DefaultOperator - df?: string - docvalue_fields?: Fields - expand_wildcards?: ExpandWildcards explain?: boolean + ext?: Record from?: integer highlight?: SearchHighlight - ignore_throttled?: boolean - ignore_unavailable?: boolean + track_total_hits?: SearchTrackHits indices_boost?: Record[] - keep_alive?: Time - keep_on_completion?: boolean - lenient?: boolean - max_concurrent_shard_requests?: long + docvalue_fields?: (QueryDslFieldAndFormat | Field)[] min_score?: double post_filter?: QueryDslQueryContainer - preference?: string profile?: boolean - pit?: SearchPointInTimeReference query?: QueryDslQueryContainer - query_on_query_string?: string - request_cache?: boolean - rescore?: SearchRescore[] - routing?: Routing + rescore?: SearchRescore | SearchRescore[] script_fields?: Record - search_after?: any[] - search_type?: SearchType - sequence_number_primary_term?: boolean + search_after?: SortResults size?: integer - sort?: SearchSort - _source?: boolean | SearchSourceFilter - stats?: string[] - stored_fields?: Fields - suggest?: Record - suggest_field?: Field - suggest_mode?: SuggestMode - suggest_size?: long - suggest_text?: string + slice?: SlicedScroll + sort?: Sort + _source?: SearchSourceConfig + fields?: (QueryDslFieldAndFormat | Field)[] + suggest?: SearchSuggester terminate_after?: long timeout?: string track_scores?: boolean - track_total_hits?: boolean - typed_keys?: boolean version?: boolean - wait_for_completion_timeout?: Time - fields?: (Field | DateField)[] + seq_no_primary_term?: boolean + stored_fields?: Fields + pit?: SearchPointInTimeReference + runtime_mappings?: MappingRuntimeFields + stats?: string[] } } export interface AsyncSearchSubmitResponse extends AsyncSearchAsyncSearchDocumentResponseBase { } -export interface AutoscalingCapacityGetRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface AutoscalingAutoscalingPolicy { + roles: string[] + deciders: Record } -export interface AutoscalingCapacityGetResponse { - stub: integer +export interface AutoscalingDeleteAutoscalingPolicyRequest extends RequestBase { + name: Name } -export interface AutoscalingPolicyDeleteRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface AutoscalingDeleteAutoscalingPolicyResponse extends AcknowledgedResponseBase { } -export interface AutoscalingPolicyDeleteResponse { - stub: integer +export interface AutoscalingGetAutoscalingCapacityAutoscalingCapacity { + node: AutoscalingGetAutoscalingCapacityAutoscalingResources + total: AutoscalingGetAutoscalingCapacityAutoscalingResources } -export interface AutoscalingPolicyGetRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface AutoscalingGetAutoscalingCapacityAutoscalingDecider { + required_capacity: AutoscalingGetAutoscalingCapacityAutoscalingCapacity + reason_summary?: string + reason_details?: any } -export interface AutoscalingPolicyGetResponse { - stub: integer +export interface AutoscalingGetAutoscalingCapacityAutoscalingDeciders { + required_capacity: AutoscalingGetAutoscalingCapacityAutoscalingCapacity + current_capacity: AutoscalingGetAutoscalingCapacityAutoscalingCapacity + current_nodes: AutoscalingGetAutoscalingCapacityAutoscalingNode[] + deciders: Record } -export interface AutoscalingPolicyPutRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface AutoscalingGetAutoscalingCapacityAutoscalingNode { + name: NodeName +} + +export interface AutoscalingGetAutoscalingCapacityAutoscalingResources { + storage: integer + memory: integer } -export interface AutoscalingPolicyPutResponse { - stub: integer -} +export interface AutoscalingGetAutoscalingCapacityRequest extends RequestBase { +} + +export interface AutoscalingGetAutoscalingCapacityResponse { + policies: Record +} + +export interface AutoscalingGetAutoscalingPolicyRequest extends RequestBase { + name: Name +} + +export type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy + +export interface AutoscalingPutAutoscalingPolicyRequest extends RequestBase { + name: Name + body?: AutoscalingAutoscalingPolicy +} + +export interface AutoscalingPutAutoscalingPolicyResponse extends AcknowledgedResponseBase { +} + +export type CatCatAnomalyDetectorColumn = 'assignment_explanation' | 'ae' | 'buckets.count' | 'bc' | 'bucketsCount' | 'buckets.time.exp_avg' | 'btea' | 'bucketsTimeExpAvg' | 'buckets.time.exp_avg_hour' | 'bteah' | 'bucketsTimeExpAvgHour' | 'buckets.time.max' | 'btmax' | 'bucketsTimeMax' | 'buckets.time.min' | 'btmin' | 'bucketsTimeMin' | 'buckets.time.total' | 'btt' | 'bucketsTimeTotal' | 'data.buckets' | 'db' | 'dataBuckets' | 'data.earliest_record' | 'der' | 'dataEarliestRecord' | 'data.empty_buckets' | 'deb' | 'dataEmptyBuckets' | 'data.input_bytes' | 'dib' | 'dataInputBytes' | 'data.input_fields' | 'dif' | 'dataInputFields' | 'data.input_records' | 'dir' | 'dataInputRecords' | 'data.invalid_dates' | 'did' | 'dataInvalidDates' | 'data.last' | 'dl' | 'dataLast' | 'data.last_empty_bucket' | 'dleb' | 'dataLastEmptyBucket' | 'data.last_sparse_bucket' | 'dlsb' | 'dataLastSparseBucket' | 'data.latest_record' | 'dlr' | 'dataLatestRecord' | 'data.missing_fields' | 'dmf' | 'dataMissingFields' | 'data.out_of_order_timestamps' | 'doot' | 'dataOutOfOrderTimestamps' | 'data.processed_fields' | 'dpf' | 'dataProcessedFields' | 'data.processed_records' | 'dpr' | 'dataProcessedRecords' | 'data.sparse_buckets' | 'dsb' | 'dataSparseBuckets' | 'forecasts.memory.avg' | 'fmavg' | 'forecastsMemoryAvg' | 'forecasts.memory.max' | 'fmmax' | 'forecastsMemoryMax' | 'forecasts.memory.min' | 'fmmin' | 'forecastsMemoryMin' | 'forecasts.memory.total' | 'fmt' | 'forecastsMemoryTotal' | 'forecasts.records.avg' | 'fravg' | 'forecastsRecordsAvg' | 'forecasts.records.max' | 'frmax' | 'forecastsRecordsMax' | 'forecasts.records.min' | 'frmin' | 'forecastsRecordsMin' | 'forecasts.records.total' | 'frt' | 'forecastsRecordsTotal' | 'forecasts.time.avg' | 'ftavg' | 'forecastsTimeAvg' | 'forecasts.time.max' | 'ftmax' | 'forecastsTimeMax' | 'forecasts.time.min' | 'ftmin' | 'forecastsTimeMin' | 'forecasts.time.total' | 'ftt' | 'forecastsTimeTotal' | 'forecasts.total' | 'ft' | 'forecastsTotal' | 'id' | 'model.bucket_allocation_failures' | 'mbaf' | 'modelBucketAllocationFailures' | 'model.by_fields' | 'mbf' | 'modelByFields' | 'model.bytes' | 'mb' | 'modelBytes' | 'model.bytes_exceeded' | 'mbe' | 'modelBytesExceeded' | 'model.categorization_status' | 'mcs' | 'modelCategorizationStatus' | 'model.categorized_doc_count' | 'mcdc' | 'modelCategorizedDocCount' | 'model.dead_category_count' | 'mdcc' | 'modelDeadCategoryCount' | 'model.failed_category_count' | 'mdcc' | 'modelFailedCategoryCount' | 'model.frequent_category_count' | 'mfcc' | 'modelFrequentCategoryCount' | 'model.log_time' | 'mlt' | 'modelLogTime' | 'model.memory_limit' | 'mml' | 'modelMemoryLimit' | 'model.memory_status' | 'mms' | 'modelMemoryStatus' | 'model.over_fields' | 'mof' | 'modelOverFields' | 'model.partition_fields' | 'mpf' | 'modelPartitionFields' | 'model.rare_category_count' | 'mrcc' | 'modelRareCategoryCount' | 'model.timestamp' | 'mt' | 'modelTimestamp' | 'model.total_category_count' | 'mtcc' | 'modelTotalCategoryCount' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'opened_time' | 'ot' | 'state' | 's' + +export type CatCatAnonalyDetectorColumns = CatCatAnomalyDetectorColumn | CatCatAnomalyDetectorColumn[] + +export type CatCatDatafeedColumn = 'ae' | 'assignment_explanation' | 'bc' | 'buckets.count' | 'bucketsCount' | 'id' | 'na' | 'node.address' | 'nodeAddress' | 'ne' | 'node.ephemeral_id' | 'nodeEphemeralId' | 'ni' | 'node.id' | 'nodeId' | 'nn' | 'node.name' | 'nodeName' | 'sba' | 'search.bucket_avg' | 'searchBucketAvg' | 'sc' | 'search.count' | 'searchCount' | 'seah' | 'search.exp_avg_hour' | 'searchExpAvgHour' | 'st' | 'search.time' | 'searchTime' | 's' | 'state' + +export type CatCatDatafeedColumns = CatCatDatafeedColumn | CatCatDatafeedColumn[] + +export type CatCatDfaColumn = 'assignment_explanation' | 'ae' | 'create_time' | 'ct' | 'createTime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'failure_reason' | 'fr' | 'failureReason' | 'id' | 'model_memory_limit' | 'mml' | 'modelMemoryLimit' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'progress' | 'p' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'type' | 't' | 'version' | 'v' + +export type CatCatDfaColumns = CatCatDfaColumn | CatCatDfaColumn[] export interface CatCatRequestBase extends RequestBase, SpecUtilsCommonCatQueryParameters { } +export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v' + +export type CatCatTrainedModelsColumns = CatCatTrainedModelsColumn | CatCatTrainedModelsColumn[] + +export type CatCatTransformColumn = 'changes_last_detection_time' | 'cldt' | 'checkpoint' | 'cp' | 'checkpoint_duration_time_exp_avg' | 'cdtea' | 'checkpointTimeExpAvg' | 'checkpoint_progress' | 'c' | 'checkpointProgress' | 'create_time' | 'ct' | 'createTime' | 'delete_time' | 'dtime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'documents_deleted' | 'docd' | 'documents_indexed' | 'doci' | 'docs_per_second' | 'dps' | 'documents_processed' | 'docp' | 'frequency' | 'f' | 'id' | 'index_failure' | 'if' | 'index_time' | 'itime' | 'index_total' | 'it' | 'indexed_documents_exp_avg' | 'idea' | 'last_search_time' | 'lst' | 'lastSearchTime' | 'max_page_search_size' | 'mpsz' | 'pages_processed' | 'pp' | 'pipeline' | 'p' | 'processed_documents_exp_avg' | 'pdea' | 'processing_time' | 'pt' | 'reason' | 'r' | 'search_failure' | 'sf' | 'search_time' | 'stime' | 'search_total' | 'st' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'transform_type' | 'tt' | 'trigger_count' | 'tc' | 'version' | 'v' + +export type CatCatTransformColumns = CatCatTransformColumn | CatCatTransformColumn[] + export interface CatAliasesAliasesRecord { alias?: string a?: string @@ -4992,24 +5909,24 @@ export type CatAliasesResponse = CatAliasesAliasesRecord[] export interface CatAllocationAllocationRecord { shards?: string s?: string - 'disk.indices'?: ByteSize - di?: ByteSize - diskIndices?: ByteSize - 'disk.used'?: ByteSize - du?: ByteSize - diskUsed?: ByteSize - 'disk.avail'?: ByteSize - da?: ByteSize - diskAvail?: ByteSize - 'disk.total'?: ByteSize - dt?: ByteSize - diskTotal?: ByteSize - 'disk.percent'?: Percentage - dp?: Percentage - diskPercent?: Percentage - host?: Host - h?: Host - ip?: Ip + 'disk.indices'?: ByteSize | null + di?: ByteSize | null + diskIndices?: ByteSize | null + 'disk.used'?: ByteSize | null + du?: ByteSize | null + diskUsed?: ByteSize | null + 'disk.avail'?: ByteSize | null + da?: ByteSize | null + diskAvail?: ByteSize | null + 'disk.total'?: ByteSize | null + dt?: ByteSize | null + diskTotal?: ByteSize | null + 'disk.percent'?: Percentage | null + dp?: Percentage | null + diskPercent?: Percentage | null + host?: Host | null + h?: Host | null + ip?: Ip | null node?: string n?: string } @@ -5041,100 +5958,6 @@ export interface CatCountRequest extends CatCatRequestBase { export type CatCountResponse = CatCountCountRecord[] -export interface CatDataFrameAnalyticsDataFrameAnalyticsRecord { - id?: Id - type?: Type - t?: Type - create_time?: string - ct?: string - createTime?: string - version?: VersionString - v?: VersionString - source_index?: IndexName - si?: IndexName - sourceIndex?: IndexName - dest_index?: IndexName - di?: IndexName - destIndex?: IndexName - description?: string - d?: string - model_memory_limit?: string - mml?: string - modelMemoryLimit?: string - state?: string - s?: string - failure_reason?: string - fr?: string - failureReason?: string - progress?: string - p?: string - assignment_explanation?: string - ae?: string - assignmentExplanation?: string - 'node.id'?: Id - ni?: Id - nodeId?: Id - 'node.name'?: Name - nn?: Name - nodeName?: Name - 'node.ephemeral_id'?: Id - ne?: Id - nodeEphemeralId?: Id - 'node.address'?: string - na?: string - nodeAddress?: string -} - -export interface CatDataFrameAnalyticsRequest extends CatCatRequestBase { - id?: Id - allow_no_match?: boolean - bytes?: Bytes -} - -export type CatDataFrameAnalyticsResponse = CatDataFrameAnalyticsDataFrameAnalyticsRecord[] - -export interface CatDatafeedsDatafeedsRecord { - id?: string - state?: MlDatafeedState - s?: MlDatafeedState - assignment_explanation?: string - ae?: string - 'buckets.count'?: string - bc?: string - bucketsCount?: string - 'search.count'?: string - sc?: string - searchCount?: string - 'search.time'?: string - st?: string - searchTime?: string - 'search.bucket_avg'?: string - sba?: string - searchBucketAvg?: string - 'search.exp_avg_hour'?: string - seah?: string - searchExpAvgHour?: string - 'node.id'?: string - ni?: string - nodeId?: string - 'node.name'?: string - nn?: string - nodeName?: string - 'node.ephemeral_id'?: string - ne?: string - nodeEphemeralId?: string - 'node.address'?: string - na?: string - nodeAddress?: string -} - -export interface CatDatafeedsRequest extends CatCatRequestBase { - datafeed_id?: Id - allow_no_datafeeds?: boolean -} - -export type CatDatafeedsResponse = CatDatafeedsDatafeedsRecord[] - export interface CatFielddataFielddataRecord { id?: string host?: string @@ -5204,7 +6027,6 @@ export interface CatHealthHealthRecord { } export interface CatHealthRequest extends CatCatRequestBase { - include_timestamp?: boolean ts?: boolean } @@ -5237,20 +6059,20 @@ export interface CatIndicesIndicesRecord { r?: string 'shards.replica'?: string shardsReplica?: string - 'docs.count'?: string - dc?: string - docsCount?: string - 'docs.deleted'?: string - dd?: string - docsDeleted?: string + 'docs.count'?: string | null + dc?: string | null + docsCount?: string | null + 'docs.deleted'?: string | null + dd?: string | null + docsDeleted?: string | null 'creation.date'?: string cd?: string 'creation.date.string'?: string cds?: string - 'store.size'?: string - ss?: string - storeSize?: string - 'pri.store.size'?: string + 'store.size'?: string | null + ss?: string | null + storeSize?: string | null + 'pri.store.size'?: string | null 'completion.size'?: string cs?: string completionSize?: string @@ -5513,14 +6335,132 @@ export interface CatIndicesRequest extends CatCatRequestBase { index?: Indices bytes?: Bytes expand_wildcards?: ExpandWildcards - health?: Health + health?: HealthStatus include_unloaded_segments?: boolean pri?: boolean } export type CatIndicesResponse = CatIndicesIndicesRecord[] -export interface CatJobsJobsRecord { +export interface CatMasterMasterRecord { + id?: string + host?: string + h?: string + ip?: string + node?: string + n?: string +} + +export interface CatMasterRequest extends CatCatRequestBase { +} + +export type CatMasterResponse = CatMasterMasterRecord[] + +export interface CatMlDataFrameAnalyticsDataFrameAnalyticsRecord { + id?: Id + type?: Type + t?: Type + create_time?: string + ct?: string + createTime?: string + version?: VersionString + v?: VersionString + source_index?: IndexName + si?: IndexName + sourceIndex?: IndexName + dest_index?: IndexName + di?: IndexName + destIndex?: IndexName + description?: string + d?: string + model_memory_limit?: string + mml?: string + modelMemoryLimit?: string + state?: string + s?: string + failure_reason?: string + fr?: string + failureReason?: string + progress?: string + p?: string + assignment_explanation?: string + ae?: string + assignmentExplanation?: string + 'node.id'?: Id + ni?: Id + nodeId?: Id + 'node.name'?: Name + nn?: Name + nodeName?: Name + 'node.ephemeral_id'?: Id + ne?: Id + nodeEphemeralId?: Id + 'node.address'?: string + na?: string + nodeAddress?: string +} + +export interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase { + id?: Id + allow_no_match?: boolean + bytes?: Bytes + h?: CatCatDfaColumns + s?: CatCatDfaColumns + time?: Time +} + +export type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[] + +export interface CatMlDatafeedsDatafeedsRecord { + id?: string + state?: MlDatafeedState + s?: MlDatafeedState + assignment_explanation?: string + ae?: string + 'buckets.count'?: string + bc?: string + bucketsCount?: string + 'search.count'?: string + sc?: string + searchCount?: string + 'search.time'?: string + st?: string + searchTime?: string + 'search.bucket_avg'?: string + sba?: string + searchBucketAvg?: string + 'search.exp_avg_hour'?: string + seah?: string + searchExpAvgHour?: string + 'node.id'?: string + ni?: string + nodeId?: string + 'node.name'?: string + nn?: string + nodeName?: string + 'node.ephemeral_id'?: string + ne?: string + nodeEphemeralId?: string + 'node.address'?: string + na?: string + nodeAddress?: string +} + +export interface CatMlDatafeedsRequest extends CatCatRequestBase { + datafeed_id?: Id + allow_no_datafeeds?: boolean + allow_no_match?: boolean + format?: string + h?: CatCatDatafeedColumns + help?: boolean + s?: CatCatDatafeedColumns + time?: TimeUnit + v?: boolean +} + +export type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[] + +export interface CatMlJobsJobsRecord { id?: Id state?: MlJobState s?: MlJobState @@ -5697,29 +6637,82 @@ export interface CatJobsJobsRecord { bucketsTimeExpAvgHour?: string } -export interface CatJobsRequest extends CatCatRequestBase { +export interface CatMlJobsRequest extends CatCatRequestBase { job_id?: Id allow_no_jobs?: boolean + allow_no_match?: boolean bytes?: Bytes + format?: string + h?: CatCatAnonalyDetectorColumns + help?: boolean + s?: CatCatAnonalyDetectorColumns + time?: TimeUnit + v?: boolean } -export type CatJobsResponse = CatJobsJobsRecord[] +export type CatMlJobsResponse = CatMlJobsJobsRecord[] -export interface CatMasterMasterRecord { - id?: string - host?: string - h?: string - ip?: string - node?: string - n?: string +export interface CatMlTrainedModelsRequest extends CatCatRequestBase { + model_id?: Id + allow_no_match?: boolean + bytes?: Bytes + h?: CatCatTrainedModelsColumns + s?: CatCatTrainedModelsColumns + from?: integer + size?: integer } -export interface CatMasterRequest extends CatCatRequestBase { +export type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[] + +export interface CatMlTrainedModelsTrainedModelsRecord { + id?: Id + created_by?: string + c?: string + createdBy?: string + heap_size?: ByteSize + hs?: ByteSize + modelHeapSize?: ByteSize + operations?: string + o?: string + modelOperations?: string + license?: string + l?: string + create_time?: DateString + ct?: DateString + version?: VersionString + v?: VersionString + description?: string + d?: string + 'ingest.pipelines'?: string + ip?: string + ingestPipelines?: string + 'ingest.count'?: string + ic?: string + ingestCount?: string + 'ingest.time'?: string + it?: string + ingestTime?: string + 'ingest.current'?: string + icurr?: string + ingestCurrent?: string + 'ingest.failed'?: string + if?: string + ingestFailed?: string + 'data_frame.id'?: string + dfid?: string + dataFrameAnalytics?: string + 'data_frame.create_time'?: string + dft?: string + dataFrameAnalyticsTime?: string + 'data_frame.source_index'?: string + dfsi?: string + dataFrameAnalyticsSrcIndex?: string + 'data_frame.analysis'?: string + dfa?: string + dataFrameAnalyticsAnalysis?: string } -export type CatMasterResponse = CatMasterMasterRecord[] - -export interface CatNodeAttributesNodeAttributesRecord { +export interface CatNodeattrsNodeAttributesRecord { node?: string id?: string pid?: string @@ -5732,10 +6725,10 @@ export interface CatNodeAttributesNodeAttributesRecord { value?: string } -export interface CatNodeAttributesRequest extends CatCatRequestBase { +export interface CatNodeattrsRequest extends CatCatRequestBase { } -export type CatNodeAttributesResponse = CatNodeAttributesNodeAttributesRecord[] +export type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[] export interface CatNodesNodesRecord { id?: Id @@ -6197,15 +7190,15 @@ export interface CatShardsShardsRecord { primaryOrReplica?: string state?: string st?: string - docs?: string - d?: string - dc?: string - store?: string - sto?: string - ip?: string + docs?: string | null + d?: string | null + dc?: string | null + store?: string | null + sto?: string | null + ip?: string | null id?: string - node?: string - n?: string + node?: string | null + n?: string | null sync_id?: string 'unassigned.reason'?: string ur?: string @@ -6497,15 +7490,15 @@ export interface CatTemplatesTemplatesRecord { order?: string o?: string p?: string - version?: VersionString - v?: VersionString + version?: VersionString | null + v?: VersionString | null composed_of?: string c?: string } export interface CatThreadPoolRequest extends CatCatRequestBase { thread_pool_patterns?: Names - size?: Size | boolean + size?: CatThreadPoolThreadPoolSize } export type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[] @@ -6543,78 +7536,25 @@ export interface CatThreadPoolThreadPoolRecord { l?: string completed?: string c?: string - core?: string - cr?: string - max?: string - mx?: string - size?: string - sz?: string - keep_alive?: string - ka?: string -} - -export interface CatTrainedModelsRequest extends CatCatRequestBase { - model_id?: Id - allow_no_match?: boolean - bytes?: Bytes - from?: integer - size?: integer + core?: string | null + cr?: string | null + max?: string | null + mx?: string | null + size?: string | null + sz?: string | null + keep_alive?: string | null + ka?: string | null } -export type CatTrainedModelsResponse = CatTrainedModelsTrainedModelsRecord[] - -export interface CatTrainedModelsTrainedModelsRecord { - id?: Id - created_by?: string - c?: string - createdBy?: string - heap_size?: ByteSize - hs?: ByteSize - modelHeapSize?: ByteSize - operations?: string - o?: string - modelOperations?: string - license?: string - l?: string - create_time?: DateString - ct?: DateString - version?: VersionString - v?: VersionString - description?: string - d?: string - 'ingest.pipelines'?: string - ip?: string - ingestPipelines?: string - 'ingest.count'?: string - ic?: string - ingestCount?: string - 'ingest.time'?: string - it?: string - ingestTime?: string - 'ingest.current'?: string - icurr?: string - ingestCurrent?: string - 'ingest.failed'?: string - if?: string - ingestFailed?: string - 'data_frame.id'?: string - dfid?: string - dataFrameAnalytics?: string - 'data_frame.create_time'?: string - dft?: string - dataFrameAnalyticsTime?: string - 'data_frame.source_index'?: string - dfsi?: string - dataFrameAnalyticsSrcIndex?: string - 'data_frame.analysis'?: string - dfa?: string - dataFrameAnalyticsAnalysis?: string -} +export type CatThreadPoolThreadPoolSize = 'k' | 'm' | 'g' | 't' | 'p' export interface CatTransformsRequest extends CatCatRequestBase { transform_id?: Id allow_no_match?: boolean from?: integer + h?: CatCatTransformColumns + s?: CatCatTransformColumns + time?: Time size?: integer } @@ -6629,14 +7569,14 @@ export interface CatTransformsTransformsRecord { documents_processed?: string docp?: string documentsProcessed?: string - checkpoint_progress?: string - cp?: string - checkpointProgress?: string - last_search_time?: string - lst?: string - lastSearchTime?: string - changes_last_detection_time?: string - cldt?: string + checkpoint_progress?: string | null + cp?: string | null + checkpointProgress?: string | null + last_search_time?: string | null + lst?: string | null + lastSearchTime?: string | null + changes_last_detection_time?: string | null + cldt?: string | null create_time?: string ct?: string createTime?: string @@ -6738,7 +7678,14 @@ export interface CcrShardStats { write_buffer_size_in_bytes: ByteSize } -export interface CcrCreateFollowIndexRequest extends RequestBase { +export interface CcrDeleteAutoFollowPatternRequest extends RequestBase { + name: Name +} + +export interface CcrDeleteAutoFollowPatternResponse extends AcknowledgedResponseBase { +} + +export interface CcrFollowRequest extends RequestBase { index: IndexName wait_for_active_shards?: WaitForActiveShards body?: { @@ -6757,27 +7704,12 @@ export interface CcrCreateFollowIndexRequest extends RequestBase { } } -export interface CcrCreateFollowIndexResponse { +export interface CcrFollowResponse { follow_index_created: boolean follow_index_shards_acked: boolean index_following_started: boolean } -export interface CcrDeleteAutoFollowPatternRequest extends RequestBase { - name: Name -} - -export interface CcrDeleteAutoFollowPatternResponse extends AcknowledgedResponseBase { -} - -export interface CcrFollowIndexStatsRequest extends RequestBase { - index: Indices -} - -export interface CcrFollowIndexStatsResponse { - indices: CcrFollowIndexStats[] -} - export interface CcrFollowInfoFollowerIndex { follower_index: IndexName leader_index: IndexName @@ -6809,7 +7741,15 @@ export interface CcrFollowInfoResponse { follower_indices: CcrFollowInfoFollowerIndex[] } -export interface CcrForgetFollowerIndexRequest extends RequestBase { +export interface CcrFollowStatsRequest extends RequestBase { + index: Indices +} + +export interface CcrFollowStatsResponse { + indices: CcrFollowIndexStats[] +} + +export interface CcrForgetFollowerRequest extends RequestBase { index: IndexName body?: { follower_cluster?: string @@ -6819,7 +7759,7 @@ export interface CcrForgetFollowerIndexRequest extends RequestBase { } } -export interface CcrForgetFollowerIndexResponse { +export interface CcrForgetFollowerResponse { _shards: ShardStatistics } @@ -6833,6 +7773,7 @@ export interface CcrGetAutoFollowPatternAutoFollowPatternSummary { remote_cluster: string follow_index_pattern?: IndexPattern leader_index_patterns: IndexPatterns + leader_index_exclusion_patterns: IndexPatterns max_outstanding_read_requests: integer } @@ -6851,11 +7792,11 @@ export interface CcrPauseAutoFollowPatternRequest extends RequestBase { export interface CcrPauseAutoFollowPatternResponse extends AcknowledgedResponseBase { } -export interface CcrPauseFollowIndexRequest extends RequestBase { +export interface CcrPauseFollowRequest extends RequestBase { index: IndexName } -export interface CcrPauseFollowIndexResponse extends AcknowledgedResponseBase { +export interface CcrPauseFollowResponse extends AcknowledgedResponseBase { } export interface CcrPutAutoFollowPatternRequest extends RequestBase { @@ -6864,6 +7805,7 @@ export interface CcrPutAutoFollowPatternRequest extends RequestBase { remote_cluster: string follow_index_pattern?: IndexPattern leader_index_patterns?: IndexPatterns + leader_index_exclusion_patterns?: IndexPatterns max_outstanding_read_requests?: integer settings?: Record max_outstanding_write_requests?: integer @@ -6888,7 +7830,7 @@ export interface CcrResumeAutoFollowPatternRequest extends RequestBase { export interface CcrResumeAutoFollowPatternResponse extends AcknowledgedResponseBase { } -export interface CcrResumeFollowIndexRequest extends RequestBase { +export interface CcrResumeFollowRequest extends RequestBase { index: IndexName body?: { max_outstanding_read_requests?: long @@ -6904,7 +7846,7 @@ export interface CcrResumeFollowIndexRequest extends RequestBase { } } -export interface CcrResumeFollowIndexResponse extends AcknowledgedResponseBase { +export interface CcrResumeFollowResponse extends AcknowledgedResponseBase { } export interface CcrStatsAutoFollowStats { @@ -6933,108 +7875,13 @@ export interface CcrStatsResponse { follow_stats: CcrStatsFollowStats } -export interface CcrUnfollowIndexRequest extends RequestBase { +export interface CcrUnfollowRequest extends RequestBase { index: IndexName } -export interface CcrUnfollowIndexResponse extends AcknowledgedResponseBase { -} - -export interface ClusterClusterStateBlockIndex { - description?: string - retryable?: boolean - levels?: string[] - aliases?: IndexAlias[] - aliases_version?: VersionNumber - version?: VersionNumber - mapping_version?: VersionNumber - settings_version?: VersionNumber - routing_num_shards?: VersionNumber - state?: string - settings?: Record - in_sync_allocations?: Record - primary_terms?: Record - mappings?: Record - rollover_info?: Record - timestamp_range?: Record - system?: boolean -} - -export interface ClusterClusterStateDeletedSnapshots { - snapshot_deletions: string[] -} - -export interface ClusterClusterStateIndexLifecycle { - policies: Record - operation_mode: LifecycleOperationMode -} - -export interface ClusterClusterStateIndexLifecyclePolicy { - phases: IlmPhases -} - -export interface ClusterClusterStateIndexLifecycleSummary { - policy: ClusterClusterStateIndexLifecyclePolicy - headers: HttpHeaders - version: VersionNumber - modified_date: long - modified_date_string: DateString -} - -export interface ClusterClusterStateIngest { - pipeline: ClusterClusterStateIngestPipeline[] -} - -export interface ClusterClusterStateIngestPipeline { - id: Id - config: ClusterClusterStateIngestPipelineConfig -} - -export interface ClusterClusterStateIngestPipelineConfig { - description?: string - version?: VersionNumber - processors: IngestProcessorContainer[] -} - -export interface ClusterClusterStateMetadata { - cluster_uuid: Uuid - cluster_uuid_committed: boolean - templates: ClusterClusterStateMetadataTemplate - indices?: Record - 'index-graveyard': ClusterClusterStateMetadataIndexGraveyard - cluster_coordination: ClusterClusterStateMetadataClusterCoordination - ingest?: ClusterClusterStateIngest - repositories?: Record - component_template?: Record - index_template?: Record - index_lifecycle?: ClusterClusterStateIndexLifecycle -} - -export interface ClusterClusterStateMetadataClusterCoordination { - term: integer - last_committed_config: string[] - last_accepted_config: string[] - voting_config_exclusions: ClusterVotingConfigExclusionsItem[] -} - -export interface ClusterClusterStateMetadataIndexGraveyard { - tombstones: ClusterTombstone[] +export interface CcrUnfollowResponse extends AcknowledgedResponseBase { } -export interface ClusterClusterStateMetadataTemplate { -} - -export interface ClusterClusterStateRoutingNodes { - unassigned: NodeShard[] - nodes: Record -} - -export interface ClusterClusterStateSnapshots { - snapshots: SnapshotStatus[] -} - -export type ClusterClusterStatus = 'green' | 'yellow' | 'red' - export interface ClusterComponentTemplate { name: Name component_template: ClusterComponentTemplateNode @@ -7049,27 +7896,11 @@ export interface ClusterComponentTemplateNode { export interface ClusterComponentTemplateSummary { _meta?: Metadata version?: VersionNumber - settings: Record + settings?: Record mappings?: MappingTypeMapping aliases?: Record } -export interface ClusterTombstone { - index: ClusterTombstoneIndex - delete_date?: DateString - delete_date_in_millis: long -} - -export interface ClusterTombstoneIndex { - index_name: Name - index_uuid: Uuid -} - -export interface ClusterVotingConfigExclusionsItem { - node_id: Id - node_name: Name -} - export interface ClusterAllocationExplainAllocationDecision { decider: string decision: ClusterAllocationExplainAllocationExplainDecision @@ -7174,6 +8005,7 @@ export interface ClusterAllocationExplainResponse { remaining_delay_in_millis?: long shard: integer unassigned_info?: ClusterAllocationExplainUnassignedInformation + note?: string } export interface ClusterAllocationExplainUnassignedInformation { @@ -7198,26 +8030,18 @@ export interface ClusterDeleteComponentTemplateResponse extends AcknowledgedResp } export interface ClusterDeleteVotingConfigExclusionsRequest extends RequestBase { - body?: { - stub: string - } + wait_for_removal?: boolean } -export interface ClusterDeleteVotingConfigExclusionsResponse { - stub: integer -} +export type ClusterDeleteVotingConfigExclusionsResponse = boolean export interface ClusterExistsComponentTemplateRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } + name: Names + master_timeout?: Time + local?: boolean } -export interface ClusterExistsComponentTemplateResponse { - stub: integer -} +export type ClusterExistsComponentTemplateResponse = boolean export interface ClusterGetComponentTemplateRequest extends RequestBase { name?: Name @@ -7251,7 +8075,7 @@ export interface ClusterHealthIndexHealthStats { number_of_shards: integer relocating_shards: integer shards?: Record - status: Health + status: HealthStatus unassigned_shards: integer } @@ -7267,7 +8091,7 @@ export interface ClusterHealthRequest extends RequestBase { wait_for_nodes?: string wait_for_no_initializing_shards?: boolean wait_for_no_relocating_shards?: boolean - wait_for_status?: WaitForStatus + wait_for_status?: HealthStatus } export interface ClusterHealthResponse { @@ -7283,7 +8107,7 @@ export interface ClusterHealthResponse { number_of_nodes: integer number_of_pending_tasks: integer relocating_shards: integer - status: Health + status: HealthStatus task_max_waiting_in_queue_millis: EpochMillis timed_out: boolean unassigned_shards: integer @@ -7294,11 +8118,12 @@ export interface ClusterHealthShardHealthStats { initializing_shards: integer primary_active: boolean relocating_shards: integer - status: Health + status: HealthStatus unassigned_shards: integer } export interface ClusterPendingTasksPendingTask { + executing: boolean insert_order: integer priority: string source: string @@ -7315,6 +8140,14 @@ export interface ClusterPendingTasksResponse { tasks: ClusterPendingTasksPendingTask[] } +export interface ClusterPostVotingConfigExclusionsRequest extends RequestBase { + node_names?: Names + node_ids?: Ids + timeout?: Time +} + +export type ClusterPostVotingConfigExclusionsResponse = boolean + export interface ClusterPutComponentTemplateRequest extends RequestBase { name: Name create?: boolean @@ -7348,30 +8181,30 @@ export interface ClusterPutSettingsResponse { transient: Record } -export interface ClusterPutVotingConfigExclusionsRequest extends RequestBase { - node_names?: Names - node_ids?: Ids - timeout?: Time - wait_for_removal?: boolean -} +export type ClusterRemoteInfoClusterRemoteInfo = ClusterRemoteInfoClusterRemoteSniffInfo | ClusterRemoteInfoClusterRemoteProxyInfo -export interface ClusterPutVotingConfigExclusionsResponse { - stub: integer +export interface ClusterRemoteInfoClusterRemoteProxyInfo { + mode: 'proxy' + connected: boolean + initial_connect_timeout: Time + skip_unavailable: boolean + proxy_address: string + server_name: string + num_proxy_sockets_connected: integer + max_proxy_socket_connections: integer } -export interface ClusterRemoteInfoClusterRemoteInfo { +export interface ClusterRemoteInfoClusterRemoteSniffInfo { + mode: 'sniff' connected: boolean - initial_connect_timeout: Time max_connections_per_cluster: integer num_nodes_connected: long - seeds: string[] + initial_connect_timeout: Time skip_unavailable: boolean + seeds: string[] } export interface ClusterRemoteInfoRequest extends RequestBase { - body?: { - stub: string - } } export interface ClusterRemoteInfoResponse extends DictionaryResponseBase { @@ -7445,28 +8278,9 @@ export interface ClusterRerouteRerouteParameters { to_node?: NodeName } -export interface ClusterRerouteRerouteState { - cluster_uuid: Uuid - state_uuid?: Uuid - master_node?: string - version?: VersionNumber - blocks?: EmptyObject - nodes?: Record - routing_table?: Record - routing_nodes?: ClusterClusterStateRoutingNodes - security_tokens?: Record - snapshots?: ClusterClusterStateSnapshots - snapshot_deletions?: ClusterClusterStateDeletedSnapshots - metadata?: ClusterClusterStateMetadata -} - -export interface ClusterRerouteResponse extends AcknowledgedResponseBase { +export interface ClusterRerouteResponse { explanations?: ClusterRerouteRerouteExplanation[] - state: ClusterRerouteRerouteState -} - -export interface ClusterStateClusterStateBlocks { - indices?: Record> + state: any } export interface ClusterStateRequest extends RequestBase { @@ -7482,21 +8296,7 @@ export interface ClusterStateRequest extends RequestBase { wait_for_timeout?: Time } -export interface ClusterStateResponse { - cluster_name: Name - cluster_uuid: Uuid - master_node?: string - state?: string[] - state_uuid?: Uuid - version?: VersionNumber - blocks?: ClusterStateClusterStateBlocks - metadata?: ClusterClusterStateMetadata - nodes?: Record - routing_table?: Record - routing_nodes?: ClusterClusterStateRoutingNodes - snapshots?: ClusterClusterStateSnapshots - snapshot_deletions?: ClusterClusterStateDeletedSnapshots -} +export type ClusterStateResponse = any export interface ClusterStatsCharFilterTypes { char_filter_types: ClusterStatsFieldTypes[] @@ -7610,7 +8410,7 @@ export interface ClusterStatsClusterOperatingSystem { available_processors: integer mem: ClusterStatsOperatingSystemMemoryInfo names: ClusterStatsClusterOperatingSystemName[] - pretty_names: ClusterStatsClusterOperatingSystemName[] + pretty_names: ClusterStatsClusterOperatingSystemPrettyName[] architectures?: ClusterStatsClusterOperatingSystemArchitecture[] } @@ -7624,6 +8424,11 @@ export interface ClusterStatsClusterOperatingSystemName { name: Name } +export interface ClusterStatsClusterOperatingSystemPrettyName { + count: integer + pretty_name: Name +} + export interface ClusterStatsClusterProcess { cpu: ClusterStatsClusterProcessCpu open_file_descriptors: ClusterStatsClusterProcessOpenFileDescriptors @@ -7696,7 +8501,7 @@ export interface ClusterStatsResponse extends NodesNodesResponseBase { cluster_uuid: Uuid indices: ClusterStatsClusterIndices nodes: ClusterStatsClusterNodes - status: ClusterClusterStatus + status: HealthStatus timestamp: long } @@ -7717,45 +8522,38 @@ export interface ClusterStatsRuntimeFieldTypes { doc_total: integer } -export interface DanglingIndicesIndexDeleteRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface DanglingIndicesDeleteDanglingIndexRequest extends RequestBase { + index_uuid: Uuid + accept_data_loss: boolean + master_timeout?: Time + timeout?: Time } -export interface DanglingIndicesIndexDeleteResponse { - stub: integer +export interface DanglingIndicesDeleteDanglingIndexResponse extends AcknowledgedResponseBase { } -export interface DanglingIndicesIndexImportRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface DanglingIndicesImportDanglingIndexRequest extends RequestBase { + index_uuid: Uuid + accept_data_loss: boolean + master_timeout?: Time + timeout?: Time } -export interface DanglingIndicesIndexImportResponse { - stub: integer +export interface DanglingIndicesImportDanglingIndexResponse extends AcknowledgedResponseBase { } -export interface DanglingIndicesIndicesListRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface DanglingIndicesListDanglingIndicesDanglingIndex { + index_name: string + index_uuid: string + creation_date_millis: EpochMillis + node_ids: Ids } -export interface DanglingIndicesIndicesListResponse { - stub: integer +export interface DanglingIndicesListDanglingIndicesRequest extends RequestBase { } -export interface EnrichConfiguration { - geo_match?: EnrichPolicy - match: EnrichPolicy +export interface DanglingIndicesListDanglingIndicesResponse { + dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[] } export interface EnrichPolicy { @@ -7764,10 +8562,13 @@ export interface EnrichPolicy { match_field: Field query?: string name?: Name + elasticsearch_version?: string } +export type EnrichPolicyType = 'geo_match' | 'match' | 'range' + export interface EnrichSummary { - config: EnrichConfiguration + config: Partial> } export interface EnrichDeletePolicyRequest extends RequestBase { @@ -7812,6 +8613,14 @@ export interface EnrichPutPolicyRequest extends RequestBase { export interface EnrichPutPolicyResponse extends AcknowledgedResponseBase { } +export interface EnrichStatsCacheStats { + node_id: Id + count: integer + hits: integer + misses: integer + evictions: integer +} + export interface EnrichStatsCoordinatorStats { executed_searches_total: long node_id: Id @@ -7822,7 +8631,7 @@ export interface EnrichStatsCoordinatorStats { export interface EnrichStatsExecutingPolicy { name: Name - task: TaskInfo + task: TasksInfo } export interface EnrichStatsRequest extends RequestBase { @@ -7831,6 +8640,7 @@ export interface EnrichStatsRequest extends RequestBase { export interface EnrichStatsResponse { coordinator_stats: EnrichStatsCoordinatorStats[] executing_policies: EnrichStatsExecutingPolicy[] + cache_stats?: EnrichStatsCacheStats[] } export interface EqlEqlHits { @@ -7908,8 +8718,8 @@ export interface EqlSearchRequest extends RequestBase { keep_alive?: Time keep_on_completion?: boolean wait_for_completion_timeout?: Time - size?: uint | float - fields?: (Field | EqlSearchSearchFieldFormatted)[] + size?: uint + fields?: QueryDslFieldAndFormat | Field result_position?: EqlSearchResultPosition } } @@ -7919,33 +8729,38 @@ export interface EqlSearchResponse extends EqlEqlSearchRespons export type EqlSearchResultPosition = 'tail' | 'head' -export interface EqlSearchSearchFieldFormatted { - field: Field - format?: string +export interface FeaturesFeature { + name: string + description: string } export interface FeaturesGetFeaturesRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } } export interface FeaturesGetFeaturesResponse { - stub: integer + features: FeaturesFeature[] } export interface FeaturesResetFeaturesRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } } export interface FeaturesResetFeaturesResponse { - stub: integer + features: FeaturesFeature[] +} + +export type FleetCheckpoint = long + +export interface FleetGlobalCheckpointsRequest extends RequestBase { + index: IndexName | IndexAlias + wait_for_advance?: boolean + wait_for_index?: boolean + checkpoints?: FleetCheckpoint[] + timeout?: Time +} + +export interface FleetGlobalCheckpointsResponse { + global_checkpoints: FleetCheckpoint[] + timed_out: boolean } export interface GraphConnection { @@ -8015,11 +8830,10 @@ export interface GraphExploreResponse { vertices: GraphVertex[] } -export interface IlmAction { -} +export type IlmActions = any export interface IlmPhase { - actions: Record | string[] + actions?: IlmActions min_age?: Time } @@ -8032,27 +8846,31 @@ export interface IlmPhases { export interface IlmPolicy { phases: IlmPhases - name?: Name + _meta?: Metadata } export interface IlmDeleteLifecycleRequest extends RequestBase { - policy?: Name - policy_id: Id + name: Name + master_timeout?: Time + timeout?: Time } export interface IlmDeleteLifecycleResponse extends AcknowledgedResponseBase { } -export interface IlmExplainLifecycleLifecycleExplain { +export type IlmExplainLifecycleLifecycleExplain = IlmExplainLifecycleLifecycleExplainManaged | IlmExplainLifecycleLifecycleExplainUnmanaged + +export interface IlmExplainLifecycleLifecycleExplainManaged { action: Name action_time_millis: EpochMillis age: Time failed_step?: Name failed_step_retry_count?: integer index: IndexName + index_creation_date_millis?: EpochMillis is_auto_retryable_error?: boolean lifecycle_date_millis: EpochMillis - managed: boolean + managed: true phase: Name phase_time_millis: EpochMillis policy: Name @@ -8060,6 +8878,7 @@ export interface IlmExplainLifecycleLifecycleExplain { step_info?: Record step_time_millis: EpochMillis phase_execution: IlmExplainLifecycleLifecycleExplainPhaseExecution + time_since_index_creation?: Time } export interface IlmExplainLifecycleLifecycleExplainPhaseExecution { @@ -8068,23 +8887,21 @@ export interface IlmExplainLifecycleLifecycleExplainPhaseExecution { modified_date_in_millis: EpochMillis } -export interface IlmExplainLifecycleLifecycleExplainProject { - project: IlmExplainLifecycleLifecycleExplainProjectSummary -} - -export interface IlmExplainLifecycleLifecycleExplainProjectSummary { +export interface IlmExplainLifecycleLifecycleExplainUnmanaged { index: IndexName - managed: boolean + managed: false } export interface IlmExplainLifecycleRequest extends RequestBase { index: IndexName only_errors?: boolean only_managed?: boolean + master_timeout?: Time + timeout?: Time } export interface IlmExplainLifecycleResponse { - indices: Record | IlmExplainLifecycleLifecycleExplainProject + indices: Record } export interface IlmGetLifecycleLifecycle { @@ -8094,8 +8911,9 @@ export interface IlmGetLifecycleLifecycle { } export interface IlmGetLifecycleRequest extends RequestBase { - policy?: Name - policy_id?: Id + name?: Name + master_timeout?: Time + timeout?: Time } export interface IlmGetLifecycleResponse extends DictionaryResponseBase { @@ -8108,6 +8926,24 @@ export interface IlmGetStatusResponse { operation_mode: LifecycleOperationMode } +export interface IlmMigrateToDataTiersRequest extends RequestBase { + dry_run?: boolean + body?: { + legacy_template_to_delete?: string + node_attribute?: string + } +} + +export interface IlmMigrateToDataTiersResponse { + dry_run: boolean + removed_legacy_template: string + migrated_ilm_policies: string[] + migrated_indices: Indices + migrated_legacy_templates: string[] + migrated_composable_templates: string[] + migrated_component_templates: string[] +} + export interface IlmMoveToStepRequest extends RequestBase { index: IndexName body?: { @@ -8126,8 +8962,9 @@ export interface IlmMoveToStepStepKey { } export interface IlmPutLifecycleRequest extends RequestBase { - policy?: Name - policy_id?: Id + name: Name + master_timeout?: Time + timeout?: Time body?: { policy?: IlmPolicy } @@ -8153,18 +8990,16 @@ export interface IlmRetryResponse extends AcknowledgedResponseBase { } export interface IlmStartRequest extends RequestBase { - body?: { - stub: boolean - } + master_timeout?: Time + timeout?: Time } export interface IlmStartResponse extends AcknowledgedResponseBase { } export interface IlmStopRequest extends RequestBase { - body?: { - stub: boolean - } + master_timeout?: Time + timeout?: Time } export interface IlmStopResponse extends AcknowledgedResponseBase { @@ -8187,7 +9022,9 @@ export interface IndicesAliasDefinition { search_routing?: string } -export type IndicesDataStreamHealthStatus = 'GREEN' | 'green' | 'YELLOW' | 'yellow' | 'RED' | 'red' +export interface IndicesDataStream { + hidden?: boolean +} export interface IndicesFielddataFrequencyFilter { max: double @@ -8195,7 +9032,7 @@ export interface IndicesFielddataFrequencyFilter { min_segment_size: integer } -export type IndicesIndexCheckOnStartup = 'false' | 'checksum' | 'true' +export type IndicesIndexCheckOnStartup = boolean | 'true' | 'false' | 'checksum' export interface IndicesIndexRouting { allocation?: IndicesIndexRoutingAllocation @@ -8210,7 +9047,7 @@ export interface IndicesIndexRoutingAllocation { } export interface IndicesIndexRoutingAllocationDisk { - threshold_enabled: boolean | string + threshold_enabled?: boolean | string } export interface IndicesIndexRoutingAllocationInclude { @@ -8230,124 +9067,159 @@ export interface IndicesIndexRoutingRebalance { export type IndicesIndexRoutingRebalanceOptions = 'all' | 'primaries' | 'replicas' | 'none' +export interface IndicesIndexSegmentSort { + field: Fields + order: IndicesSegmentSortOrder | IndicesSegmentSortOrder[] + mode?: IndicesSegmentSortMode | IndicesSegmentSortMode[] + missing?: IndicesSegmentSortMissing | IndicesSegmentSortMissing[] +} + export interface IndicesIndexSettingBlocks { read_only?: boolean - 'index.blocks.read_only'?: boolean read_only_allow_delete?: boolean - 'index.blocks.read_only_allow_delete'?: boolean read?: boolean - 'index.blocks.read'?: boolean write?: boolean | string - 'index.blocks.write'?: boolean | string metadata?: boolean - 'index.blocks.metadata'?: boolean } -export interface IndicesIndexSettings { +export interface IndicesIndexSettingsKeys { + index?: IndicesIndexSettings + mode?: string + routing_path?: string[] + soft_deletes?: IndicesSoftDeletes + sort?: IndicesIndexSegmentSort number_of_shards?: integer | string - 'index.number_of_shards'?: integer | string number_of_replicas?: integer | string - 'index.number_of_replicas'?: integer | string number_of_routing_shards?: integer - 'index.number_of_routing_shards'?: integer check_on_startup?: IndicesIndexCheckOnStartup - 'index.check_on_startup'?: IndicesIndexCheckOnStartup codec?: string - 'index.codec'?: string - routing_partition_size?: integer | string - 'index.routing_partition_size'?: integer | string + routing_partition_size?: integer 'soft_deletes.retention_lease.period'?: Time - 'index.soft_deletes.retention_lease.period'?: Time load_fixed_bitset_filters_eagerly?: boolean - 'index.load_fixed_bitset_filters_eagerly'?: boolean hidden?: boolean | string - 'index.hidden'?: boolean | string auto_expand_replicas?: string - 'index.auto_expand_replicas'?: string + 'merge.scheduler.max_thread_count'?: integer 'search.idle.after'?: Time - 'index.search.idle.after'?: Time refresh_interval?: Time - 'index.refresh_interval'?: Time max_result_window?: integer - 'index.max_result_window'?: integer max_inner_result_window?: integer - 'index.max_inner_result_window'?: integer max_rescore_window?: integer - 'index.max_rescore_window'?: integer max_docvalue_fields_search?: integer - 'index.max_docvalue_fields_search'?: integer max_script_fields?: integer - 'index.max_script_fields'?: integer max_ngram_diff?: integer - 'index.max_ngram_diff'?: integer max_shingle_diff?: integer - 'index.max_shingle_diff'?: integer blocks?: IndicesIndexSettingBlocks - 'index.blocks'?: IndicesIndexSettingBlocks + 'blocks.read_only'?: boolean + 'blocks.read_only_allow_delete'?: boolean + 'blocks.read'?: boolean + 'blocks.write'?: boolean | string + 'blocks.metadata'?: boolean max_refresh_listeners?: integer - 'index.max_refresh_listeners'?: integer 'analyze.max_token_count'?: integer - 'index.analyze.max_token_count'?: integer 'highlight.max_analyzed_offset'?: integer - 'index.highlight.max_analyzed_offset'?: integer max_terms_count?: integer - 'index.max_terms_count'?: integer max_regex_length?: integer - 'index.max_regex_length'?: integer routing?: IndicesIndexRouting - 'index.routing'?: IndicesIndexRouting gc_deletes?: Time - 'index.gc_deletes'?: Time default_pipeline?: PipelineName - 'index.default_pipeline'?: PipelineName final_pipeline?: PipelineName - 'index.final_pipeline'?: PipelineName lifecycle?: IndicesIndexSettingsLifecycle - 'index.lifecycle'?: IndicesIndexSettingsLifecycle + 'lifecycle.name'?: string provided_name?: Name - 'index.provided_name'?: Name creation_date?: DateString - 'index.creation_date'?: DateString uuid?: Uuid - 'index.uuid'?: Uuid version?: IndicesIndexVersioning - 'index.version'?: IndicesIndexVersioning - verified_before_close?: boolean | string - 'index.verified_before_close'?: boolean | string + verified_before_close?: boolean format?: string | integer - 'index.format'?: string | integer max_slices_per_scroll?: integer - 'index.max_slices_per_scroll'?: integer - 'translog.durability'?: string - 'index.translog.durability'?: string - 'query_string.lenient'?: boolean | string - 'index.query_string.lenient'?: boolean | string + translog?: IndicesTranslog + 'query_string.lenient'?: boolean priority?: integer | string - 'index.priority'?: integer | string top_metrics_max_size?: integer analysis?: IndicesIndexSettingsAnalysis + settings?: IndicesIndexSettings + mapping?: IndicesMappingLimitSettings + 'indexing.slowlog'?: IndicesSlowlogSettings + indexing_pressure?: IndicesIndexingPressure + store?: IndicesStorage } +export type IndicesIndexSettings = IndicesIndexSettingsKeys + & { [property: string]: any } export interface IndicesIndexSettingsAnalysis { + analyzer?: Record char_filter?: Record + filter?: Record + normalizer?: Record + tokenizer?: Record } export interface IndicesIndexSettingsLifecycle { name: Name + indexing_complete?: boolean + origination_date?: long + parse_origination_date?: boolean + step?: IndicesIndexSettingsLifecycleStep + rollover_alias?: string +} + +export interface IndicesIndexSettingsLifecycleStep { + wait_time_threshold?: Time } export interface IndicesIndexState { aliases?: Record mappings?: MappingTypeMapping - settings: IndicesIndexSettings | IndicesIndexStatePrefixedSettings + settings?: IndicesIndexSettings + defaults?: IndicesIndexSettings + data_stream?: DataStreamName +} + +export interface IndicesIndexVersioning { + created?: VersionString } -export interface IndicesIndexStatePrefixedSettings { - index: IndicesIndexSettings +export interface IndicesIndexingPressure { + memory: IndicesIndexingPressureMemory } -export interface IndicesIndexVersioning { - created: VersionString +export interface IndicesIndexingPressureMemory { + limit?: integer +} + +export interface IndicesMappingLimitSettings { + coerce?: boolean + total_fields?: IndicesMappingLimitSettingsTotalFields + depth?: IndicesMappingLimitSettingsDepth + nested_fields?: IndicesMappingLimitSettingsNestedFields + nested_objects?: IndicesMappingLimitSettingsNestedObjects + field_name_length?: IndicesMappingLimitSettingsFieldNameLength + dimension_fields?: IndicesMappingLimitSettingsDimensionFields + ignore_malformed?: boolean +} + +export interface IndicesMappingLimitSettingsDepth { + limit?: integer +} + +export interface IndicesMappingLimitSettingsDimensionFields { + limit?: integer +} + +export interface IndicesMappingLimitSettingsFieldNameLength { + limit?: long +} + +export interface IndicesMappingLimitSettingsNestedFields { + limit?: integer +} + +export interface IndicesMappingLimitSettingsNestedObjects { + limit?: integer +} + +export interface IndicesMappingLimitSettingsTotalFields { + limit?: integer } export interface IndicesNumericFielddata { @@ -8361,11 +9233,47 @@ export interface IndicesOverlappingIndexTemplate { index_patterns?: IndexName[] } -export interface IndicesStringFielddata { - format: IndicesStringFielddataFormat +export interface IndicesRetentionLease { + period: Time +} + +export type IndicesSegmentSortMissing = '_last' | '_first' + +export type IndicesSegmentSortMode = 'min' | 'max' + +export type IndicesSegmentSortOrder = 'asc' | 'desc' + +export interface IndicesSlowlogSettings { + level?: string + source?: integer + reformat?: boolean + threshold?: IndicesSlowlogTresholds +} + +export interface IndicesSlowlogTresholdLevels { + warn?: Time + info?: Time + debug?: Time + trace?: Time +} + +export interface IndicesSlowlogTresholds { + query?: IndicesSlowlogTresholdLevels + fetch?: IndicesSlowlogTresholdLevels + index?: IndicesSlowlogTresholdLevels } -export type IndicesStringFielddataFormat = 'paged_bytes' | 'disabled' +export interface IndicesSoftDeletes { + enabled?: boolean + retention_lease?: IndicesRetentionLease +} + +export interface IndicesStorage { + type: IndicesStorageType + allow_mmap?: boolean +} + +export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs' export interface IndicesTemplateMapping { aliases: Record @@ -8376,6 +9284,20 @@ export interface IndicesTemplateMapping { version?: VersionNumber } +export interface IndicesTranslog { + sync_interval?: Time + durability?: IndicesTranslogDurability + flush_threshold_size?: ByteSize + retention?: IndicesTranslogRetention +} + +export type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC' + +export interface IndicesTranslogRetention { + size?: ByteSize + age?: Time +} + export type IndicesAddBlockIndicesBlockOptions = 'metadata' | 'read' | 'read_only' | 'write' export interface IndicesAddBlockIndicesBlockStatus { @@ -8409,7 +9331,7 @@ export interface IndicesAnalyzeAnalyzeDetail { export interface IndicesAnalyzeAnalyzeToken { end_offset: long position: long - position_length?: long + positionLength?: long start_offset: long token: string type: string @@ -8425,7 +9347,7 @@ export interface IndicesAnalyzeCharFilterDetail { name: string } -export interface IndicesAnalyzeExplainAnalyzeToken { +export interface IndicesAnalyzeExplainAnalyzeTokenKeys { bytes: string end_offset: long keyword?: boolean @@ -8436,19 +9358,21 @@ export interface IndicesAnalyzeExplainAnalyzeToken { token: string type: string } +export type IndicesAnalyzeExplainAnalyzeToken = IndicesAnalyzeExplainAnalyzeTokenKeys + & { [property: string]: any } export interface IndicesAnalyzeRequest extends RequestBase { index?: IndexName body?: { analyzer?: string attributes?: string[] - char_filter?: (string | AnalysisCharFilter)[] + char_filter?: AnalysisCharFilter[] explain?: boolean field?: Field - filter?: (string | AnalysisTokenFilter)[] + filter?: AnalysisTokenFilter[] normalizer?: string text?: IndicesAnalyzeTextToAnalyze - tokenizer?: string | AnalysisTokenizer + tokenizer?: AnalysisTokenizer } } @@ -8526,15 +9450,16 @@ export interface IndicesCreateRequest extends RequestBase { timeout?: Time wait_for_active_shards?: WaitForActiveShards body?: { - aliases?: Record - mappings?: Record | MappingTypeMapping - settings?: Record + aliases?: Record + mappings?: MappingTypeMapping + settings?: IndicesIndexSettings } } -export interface IndicesCreateResponse extends AcknowledgedResponseBase { +export interface IndicesCreateResponse { index: IndexName shards_acknowledged: boolean + acknowledged: boolean } export interface IndicesCreateDataStreamRequest extends RequestBase { @@ -8549,7 +9474,7 @@ export interface IndicesDataStreamsStatsDataStreamsStatsItem { data_stream: Name store_size?: ByteSize store_size_bytes: integer - maximum_timestamp: integer + maximum_timestamp: long } export interface IndicesDataStreamsStatsRequest extends RequestBase { @@ -8589,14 +9514,17 @@ export interface IndicesDeleteAliasResponse extends AcknowledgedResponseBase { } export interface IndicesDeleteDataStreamRequest extends RequestBase { - name: DataStreamName + name: DataStreamNames + expand_wildcards?: ExpandWildcards } export interface IndicesDeleteDataStreamResponse extends AcknowledgedResponseBase { } export interface IndicesDeleteIndexTemplateRequest extends RequestBase { - name: Name + name: Names + master_timeout?: Time + timeout?: Time } export interface IndicesDeleteIndexTemplateResponse extends AcknowledgedResponseBase { @@ -8611,6 +9539,20 @@ export interface IndicesDeleteTemplateRequest extends RequestBase { export interface IndicesDeleteTemplateResponse extends AcknowledgedResponseBase { } +export interface IndicesDiskUsageRequest extends RequestBase { + index: IndexName + allow_no_indices?: boolean + expand_wildcards?: ExpandWildcards + flush?: boolean + ignore_unavailable?: boolean + master_timeout?: TimeUnit + timeout?: TimeUnit + run_expensive_tasks?: boolean + wait_for_active_shards?: string +} + +export type IndicesDiskUsageResponse = any + export interface IndicesExistsRequest extends RequestBase { index: Indices allow_no_indices?: boolean @@ -8750,7 +9692,7 @@ export interface IndicesGetDataStreamIndicesGetDataStreamItem { template: Name hidden: boolean system?: boolean - status: IndicesDataStreamHealthStatus + status: HealthStatus ilm_policy?: Name _meta?: Metadata } @@ -8765,7 +9707,7 @@ export interface IndicesGetDataStreamIndicesGetDataStreamItemTimestampField { } export interface IndicesGetDataStreamRequest extends RequestBase { - name?: IndexName + name?: DataStreamNames expand_wildcards?: ExpandWildcards } @@ -8795,7 +9737,7 @@ export interface IndicesGetFieldMappingTypeFieldMappings { export interface IndicesGetIndexTemplateIndexTemplate { index_patterns: Name[] composed_of: Name[] - template: IndicesGetIndexTemplateIndexTemplateSummary + template?: IndicesGetIndexTemplateIndexTemplateSummary version?: VersionNumber priority?: long _meta?: Metadata @@ -8817,11 +9759,9 @@ export interface IndicesGetIndexTemplateIndexTemplateSummary { export interface IndicesGetIndexTemplateRequest extends RequestBase { name?: Name local?: boolean - body?: { - flat_settings?: boolean - include_type_name?: boolean - master_timeout?: Time - } + flat_settings?: boolean + include_type_name?: boolean + master_timeout?: Time } export interface IndicesGetIndexTemplateResponse { @@ -8874,7 +9814,7 @@ export interface IndicesGetTemplateResponse extends DictionaryResponseBase | Record[] - field_names_field?: MappingFieldNamesField - index_field?: MappingIndexField - meta?: Record + _field_names?: MappingFieldNamesField + _meta?: Record numeric_detection?: boolean properties?: Record - routing_field?: MappingRoutingField - size_field?: MappingSizeField - source_field?: MappingSourceField + _routing?: MappingRoutingField + _source?: MappingSourceField runtime?: MappingRuntimeFields } } @@ -8981,10 +9916,6 @@ export interface IndicesPutMappingRequest extends RequestBase { export interface IndicesPutMappingResponse extends IndicesResponseBase { } -export interface IndicesPutSettingsIndexSettingsBody extends IndicesIndexSettings { - settings?: IndicesIndexSettings -} - export interface IndicesPutSettingsRequest extends RequestBase { index?: Indices allow_no_indices?: boolean @@ -8994,7 +9925,7 @@ export interface IndicesPutSettingsRequest extends RequestBase { master_timeout?: Time preserve_existing?: boolean timeout?: Time - body?: IndicesPutSettingsIndexSettingsBody + body?: IndicesIndexSettings } export interface IndicesPutSettingsResponse extends AcknowledgedResponseBase { @@ -9007,6 +9938,7 @@ export interface IndicesPutTemplateRequest extends RequestBase { include_type_name?: boolean master_timeout?: Time timeout?: Time + order?: integer body?: { aliases?: Record index_patterns?: string | string[] @@ -9030,6 +9962,8 @@ export interface IndicesRecoveryRecoveryBytes { percent: Percentage recovered?: ByteSize recovered_in_bytes: ByteSize + recovered_from_snapshot?: ByteSize + recovered_from_snapshot_in_bytes?: ByteSize reused?: ByteSize reused_in_bytes: ByteSize total?: ByteSize @@ -9099,7 +10033,7 @@ export interface IndicesRecoveryShardRecovery { start_time?: DateString start_time_in_millis: EpochMillis stop_time?: DateString - stop_time_in_millis: EpochMillis + stop_time_in_millis?: EpochMillis target: IndicesRecoveryRecoveryOrigin total_time?: DateString total_time_in_millis: EpochMillis @@ -9181,6 +10115,8 @@ export interface IndicesResolveIndexResponse { data_streams: IndicesResolveIndexResolveIndexDataStreamsItem[] } +export type IndicesRolloverIndexRolloverMapping = MappingTypeMapping | Record + export interface IndicesRolloverRequest extends RequestBase { alias: IndexAlias new_index?: IndexName @@ -9192,7 +10128,7 @@ export interface IndicesRolloverRequest extends RequestBase { body?: { aliases?: Record conditions?: IndicesRolloverRolloverConditions - mappings?: Record | MappingTypeMapping + mappings?: IndicesRolloverIndexRolloverMapping settings?: Record } } @@ -9209,8 +10145,13 @@ export interface IndicesRolloverResponse extends AcknowledgedResponseBase { export interface IndicesRolloverRolloverConditions { max_age?: Time max_docs?: long - max_size?: string + max_size?: ByteSize + min_size?: ByteSize + max_size_bytes?: ByteSize max_primary_shard_size?: ByteSize + min_primary_shard_size?: ByteSize + max_primary_shard_docs?: long + min_primary_shard_docs?: long } export interface IndicesSegmentsIndexSegment { @@ -9265,7 +10206,7 @@ export interface IndicesShardStoresRequest extends RequestBase { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean - status?: string | string[] + status?: IndicesShardStoresShardStoreStatus | IndicesShardStoresShardStoreStatus[] } export interface IndicesShardStoresResponse { @@ -9290,6 +10231,8 @@ export interface IndicesShardStoresShardStoreException { type: string } +export type IndicesShardStoresShardStoreStatus = 'green' | 'yellow' | 'red' | 'all' + export interface IndicesShardStoresShardStoreWrapper { stores: IndicesShardStoresShardStore[] } @@ -9312,18 +10255,29 @@ export interface IndicesShrinkResponse extends AcknowledgedResponseBase { } export interface IndicesSimulateIndexTemplateRequest extends RequestBase { - name?: Name + name: Name + create?: boolean + master_timeout?: Time body?: { - index_patterns?: IndexName[] + allow_auto_create?: boolean + index_patterns?: Indices composed_of?: Name[] - overlapping?: IndicesOverlappingIndexTemplate[] - template?: IndicesTemplateMapping + template?: IndicesPutIndexTemplateIndexTemplateMapping + data_stream?: IndicesDataStream + priority?: integer + version?: VersionNumber + _meta?: Metadata } } export interface IndicesSimulateIndexTemplateResponse { } +export interface IndicesSimulateTemplateOverlapping { + name: Name + index_patterns: string[] +} + export interface IndicesSimulateTemplateRequest extends RequestBase { name?: Name create?: boolean @@ -9332,7 +10286,14 @@ export interface IndicesSimulateTemplateRequest extends RequestBase { } export interface IndicesSimulateTemplateResponse { - stub: string + template: IndicesSimulateTemplateTemplate +} + +export interface IndicesSimulateTemplateTemplate { + aliases: Record + mappings: MappingTypeMapping + settings: Record + overlapping: IndicesSimulateTemplateOverlapping[] } export interface IndicesSplitRequest extends RequestBase { @@ -9359,6 +10320,7 @@ export interface IndicesStatsIndexStats { flush?: FlushStats get?: GetStats indexing?: IndexingStats + indices?: IndicesStatsIndicesStats merges?: MergesStats query_cache?: QueryCacheStats recovery?: RecoveryStats @@ -9370,12 +10332,13 @@ export interface IndicesStatsIndexStats { translog?: TranslogStats warmer?: WarmerStats bulk?: BulkStats + shard_stats?: IndicesStatsShardsTotalStats } export interface IndicesStatsIndicesStats { - primaries: IndicesStatsIndexStats + primaries?: IndicesStatsIndexStats shards?: Record - total: IndicesStatsIndexStats + total?: IndicesStatsIndexStats uuid?: Uuid } @@ -9461,28 +10424,35 @@ export interface IndicesStatsShardSequenceNumber { } export interface IndicesStatsShardStats { - commit: IndicesStatsShardCommit - completion: CompletionStats - docs: DocStats - fielddata: FielddataStats - flush: FlushStats - get: GetStats - indexing: IndexingStats - merges: MergesStats - shard_path: IndicesStatsShardPath - query_cache: IndicesStatsShardQueryCache - recovery: RecoveryStats - refresh: RefreshStats - request_cache: RequestCacheStats - retention_leases: IndicesStatsShardRetentionLeases - routing: IndicesStatsShardRouting - search: SearchStats - segments: SegmentsStats - seq_no: IndicesStatsShardSequenceNumber - store: StoreStats - translog: TranslogStats - warmer: WarmerStats + commit?: IndicesStatsShardCommit + completion?: CompletionStats + docs?: DocStats + fielddata?: FielddataStats + flush?: FlushStats + get?: GetStats + indexing?: IndexingStats + merges?: MergesStats + shard_path?: IndicesStatsShardPath + query_cache?: IndicesStatsShardQueryCache + recovery?: RecoveryStats + refresh?: RefreshStats + request_cache?: RequestCacheStats + retention_leases?: IndicesStatsShardRetentionLeases + routing?: IndicesStatsShardRouting + search?: SearchStats + segments?: SegmentsStats + seq_no?: IndicesStatsShardSequenceNumber + store?: StoreStats + translog?: TranslogStats + warmer?: WarmerStats bulk?: BulkStats + shards?: IndicesStatsShardsTotalStats + shard_stats?: IndicesStatsShardsTotalStats + indices?: IndicesStatsIndicesStats +} + +export interface IndicesStatsShardsTotalStats { + total_count: long } export interface IndicesUnfreezeRequest extends RequestBase { @@ -9499,14 +10469,43 @@ export interface IndicesUnfreezeResponse extends AcknowledgedResponseBase { shards_acknowledged: boolean } -export interface IndicesUpdateAliasesIndicesUpdateAliasBulk { +export interface IndicesUpdateAliasesAction { + add?: IndicesUpdateAliasesAddAction + remove?: IndicesUpdateAliasesRemoveAction + remove_index?: IndicesUpdateAliasesRemoveIndexAction +} + +export interface IndicesUpdateAliasesAddAction { + alias?: IndexAlias + aliases?: IndexAlias | IndexAlias[] + filter?: QueryDslQueryContainer + index?: IndexName + indices?: Indices + index_routing?: Routing + is_hidden?: boolean + is_write_index?: boolean + routing?: Routing + search_routing?: Routing +} + +export interface IndicesUpdateAliasesRemoveAction { + alias?: IndexAlias + aliases?: IndexAlias | IndexAlias[] + index?: IndexName + indices?: Indices + must_exist?: boolean +} + +export interface IndicesUpdateAliasesRemoveIndexAction { + index?: IndexName + indices?: Indices } export interface IndicesUpdateAliasesRequest extends RequestBase { master_timeout?: Time timeout?: Time body?: { - actions?: IndicesUpdateAliasesIndicesUpdateAliasBulk[] + actions?: IndicesUpdateAliasesAction[] } } @@ -9514,15 +10513,15 @@ export interface IndicesUpdateAliasesResponse extends AcknowledgedResponseBase { } export interface IndicesUpgradeRequest extends RequestBase { - stub_b: integer - stub_a: integer - body?: { - stub_c: integer - } + index?: IndexName + allow_no_indices?: boolean + expand_wildcards?: ExpandWildcards + ignore_unavailable?: boolean + wait_for_completion?: boolean + only_ancient_segments?: boolean } -export interface IndicesUpgradeResponse { - stub: integer +export interface IndicesUpgradeResponse extends AcknowledgedResponseBase { } export interface IndicesValidateQueryIndicesValidationExplanation { @@ -9539,13 +10538,12 @@ export interface IndicesValidateQueryRequest extends RequestBase { all_shards?: boolean analyzer?: string analyze_wildcard?: boolean - default_operator?: DefaultOperator + default_operator?: QueryDslOperator df?: string expand_wildcards?: ExpandWildcards explain?: boolean ignore_unavailable?: boolean lenient?: boolean - query_on_query_string?: string rewrite?: boolean q?: string body?: { @@ -9573,6 +10571,7 @@ export interface IngestAttachmentProcessor extends IngestProcessorBase { indexed_chars_field?: Field properties?: string[] target_field?: Field + remove_binary?: boolean resource_name?: string } @@ -9585,39 +10584,38 @@ export interface IngestBytesProcessor extends IngestProcessorBase { export interface IngestCircleProcessor extends IngestProcessorBase { error_distance: double field: Field - ignore_missing: boolean + ignore_missing?: boolean shape_type: IngestShapeType - target_field: Field + target_field?: Field } export interface IngestConvertProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean - target_field: Field + target_field?: Field type: IngestConvertType } export type IngestConvertType = 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto' export interface IngestCsvProcessor extends IngestProcessorBase { - empty_value: any - description?: string + empty_value?: any field: Field ignore_missing?: boolean quote?: string separator?: string target_fields: Fields - trim: boolean + trim?: boolean } export interface IngestDateIndexNameProcessor extends IngestProcessorBase { date_formats: string[] - date_rounding: string | IngestDateRounding + date_rounding: string field: Field - index_name_format: string - index_name_prefix: string - locale: string - timezone: string + index_name_format?: string + index_name_prefix?: string + locale?: string + timezone?: string } export interface IngestDateProcessor extends IngestProcessorBase { @@ -9628,12 +10626,10 @@ export interface IngestDateProcessor extends IngestProcessorBase { timezone?: string } -export type IngestDateRounding = 's' | 'm' | 'h' | 'd' | 'w' | 'M' | 'y' - export interface IngestDissectProcessor extends IngestProcessorBase { - append_separator: string + append_separator?: string field: Field - ignore_missing: boolean + ignore_missing?: boolean pattern: string } @@ -9666,18 +10662,18 @@ export interface IngestForeachProcessor extends IngestProcessorBase { } export interface IngestGeoIpProcessor extends IngestProcessorBase { - database_file: string + database_file?: string field: Field - first_only: boolean - ignore_missing: boolean - properties: string[] - target_field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field } export interface IngestGrokProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean - pattern_definitions: Record + pattern_definitions?: Record patterns: string[] trace_match?: boolean } @@ -9700,7 +10696,7 @@ export interface IngestInferenceConfigRegression { export interface IngestInferenceProcessor extends IngestProcessorBase { model_id: Id - target_field: Field + target_field?: Field field_map?: Record inference_config?: IngestInferenceConfig } @@ -9712,11 +10708,15 @@ export interface IngestJoinProcessor extends IngestProcessorBase { } export interface IngestJsonProcessor extends IngestProcessorBase { - add_to_root: boolean + add_to_root?: boolean + add_to_root_conflict_strategy?: IngestJsonProcessorConflictStrategy + allow_duplicate_keys?: boolean field: Field - target_field: Field + target_field?: Field } +export type IngestJsonProcessorConflictStrategy = 'replace' | 'merge' + export interface IngestKeyValueProcessor extends IngestProcessorBase { exclude_keys?: string[] field: Field @@ -9752,9 +10752,11 @@ export interface IngestPipelineConfig { export interface IngestPipelineProcessor extends IngestProcessorBase { name: Name + ignore_missing_pipeline?: boolean } export interface IngestProcessorBase { + description?: string if?: string ignore_failure?: boolean on_failure?: IngestProcessorContainer[] @@ -9782,7 +10784,7 @@ export interface IngestProcessorContainer { lowercase?: IngestLowercaseProcessor remove?: IngestRemoveProcessor rename?: IngestRenameProcessor - script?: Script + script?: IngestScriptProcessor set?: IngestSetProcessor sort?: IngestSortProcessor split?: IngestSplitProcessor @@ -9809,10 +10811,20 @@ export interface IngestRenameProcessor extends IngestProcessorBase { target_field: Field } +export interface IngestScriptProcessor extends IngestProcessorBase { + id?: Id + lang?: string + params?: Record + source?: string +} + export interface IngestSetProcessor extends IngestProcessorBase { + copy_from?: Field field: Field + ignore_empty_value?: boolean + media_type?: string override?: boolean - value: any + value?: any } export interface IngestSetSecurityUserProcessor extends IngestProcessorBase { @@ -9824,8 +10836,8 @@ export type IngestShapeType = 'geo_shape' | 'shape' export interface IngestSortProcessor extends IngestProcessorBase { field: Field - order: SearchSortOrder - target_field: Field + order?: SortOrder + target_field?: Field } export interface IngestSplitProcessor extends IngestProcessorBase { @@ -9856,10 +10868,10 @@ export interface IngestUrlDecodeProcessor extends IngestProcessorBase { export interface IngestUserAgentProcessor extends IngestProcessorBase { field: Field - ignore_missing: boolean - options: IngestUserAgentProperty[] - regex_file: string - target_field: Field + ignore_missing?: boolean + options?: IngestUserAgentProperty[] + regex_file?: string + target_field?: Field } export type IngestUserAgentProperty = 'NAME' | 'MAJOR' | 'MINOR' | 'PATCH' | 'OS' | 'OS_NAME' | 'OS_MAJOR' | 'OS_MINOR' | 'DEVICE' | 'BUILD' @@ -9919,6 +10931,7 @@ export interface IngestPutPipelineRequest extends RequestBase { master_timeout?: Time timeout?: Time body?: { + _meta?: Metadata description?: string on_failure?: IngestProcessorContainer[] processors?: IngestProcessorContainer[] @@ -9929,46 +10942,49 @@ export interface IngestPutPipelineRequest extends RequestBase { export interface IngestPutPipelineResponse extends AcknowledgedResponseBase { } -export interface IngestSimulatePipelineDocument { +export interface IngestSimulateDocument { _id?: Id _index?: IndexName _source: any } -export interface IngestSimulatePipelineDocumentSimulation { +export interface IngestSimulateDocumentSimulationKeys { _id: Id _index: IndexName - _ingest: IngestSimulatePipelineIngest - _parent?: string + _ingest: IngestSimulateIngest _routing?: string _source: Record _type?: Type + _version?: SpecUtilsStringified + _version_type?: VersionType } +export type IngestSimulateDocumentSimulation = IngestSimulateDocumentSimulationKeys + & { [property: string]: string | Id | IndexName | IngestSimulateIngest | Record | Type | SpecUtilsStringified | VersionType } -export interface IngestSimulatePipelineIngest { +export interface IngestSimulateIngest { timestamp: DateString pipeline?: Name } -export interface IngestSimulatePipelinePipelineSimulation { - doc?: IngestSimulatePipelineDocumentSimulation - processor_results?: IngestSimulatePipelinePipelineSimulation[] +export interface IngestSimulatePipelineSimulation { + doc?: IngestSimulateDocumentSimulation + processor_results?: IngestSimulatePipelineSimulation[] tag?: string processor_type?: string status?: WatcherActionStatusOptions } -export interface IngestSimulatePipelineRequest extends RequestBase { +export interface IngestSimulateRequest extends RequestBase { id?: Id verbose?: boolean body?: { - docs?: IngestSimulatePipelineDocument[] + docs?: IngestSimulateDocument[] pipeline?: IngestPipeline } } -export interface IngestSimulatePipelineResponse { - docs: IngestSimulatePipelinePipelineSimulation[] +export interface IngestSimulateResponse { + docs: IngestSimulatePipelineSimulation[] } export interface LicenseLicense { @@ -10068,74 +11084,130 @@ export interface LicensePostStartTrialRequest extends RequestBase { export interface LicensePostStartTrialResponse extends AcknowledgedResponseBase { error_message?: string - acknowledged: boolean trial_was_started: boolean type: LicenseLicenseType } -export interface LogstashPipelineDeleteRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface LogstashPipeline { + description: string + last_modified: Timestamp + pipeline_metadata: LogstashPipelineMetadata + username: string + pipeline: string + pipeline_settings: LogstashPipelineSettings } -export interface LogstashPipelineDeleteResponse { - stub: integer +export interface LogstashPipelineMetadata { + type: string + version: string } -export interface LogstashPipelineGetRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface LogstashPipelineSettings { + 'pipeline.workers': integer + 'pipeline.batch.size': integer + 'pipeline.batch.delay': integer + 'queue.type': string + 'queue.max_bytes.number': integer + 'queue.max_bytes.units': string + 'queue.checkpoint.writes': integer } -export interface LogstashPipelineGetResponse { - stub: integer +export interface LogstashDeletePipelineRequest extends RequestBase { + id: Id } -export interface LogstashPipelinePutRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export type LogstashDeletePipelineResponse = boolean + +export interface LogstashGetPipelineRequest extends RequestBase { + id: Ids } -export interface LogstashPipelinePutResponse { - stub: integer +export type LogstashGetPipelineResponse = Record + +export interface LogstashPutPipelineRequest extends RequestBase { + id: Id + body?: LogstashPipeline } -export interface MigrationDeprecationInfoDeprecation { +export type LogstashPutPipelineResponse = boolean + +export interface MigrationDeprecationsDeprecation { details: string - level: MigrationDeprecationInfoDeprecationLevel + level: MigrationDeprecationsDeprecationLevel message: string url: string } -export type MigrationDeprecationInfoDeprecationLevel = 'none' | 'info' | 'warning' | 'critical' +export type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical' -export interface MigrationDeprecationInfoRequest extends RequestBase { +export interface MigrationDeprecationsRequest extends RequestBase { index?: IndexName } -export interface MigrationDeprecationInfoResponse { - cluster_settings: MigrationDeprecationInfoDeprecation[] - index_settings: Record - node_settings: MigrationDeprecationInfoDeprecation[] - ml_settings: MigrationDeprecationInfoDeprecation[] +export interface MigrationDeprecationsResponse { + cluster_settings: MigrationDeprecationsDeprecation[] + index_settings: Record + node_settings: MigrationDeprecationsDeprecation[] + ml_settings: MigrationDeprecationsDeprecation[] +} + +export interface MigrationGetFeatureUpgradeStatusMigrationFeature { + feature_name: string + minimum_index_version: VersionString + migration_status: MigrationGetFeatureUpgradeStatusMigrationStatus + indices: MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo[] +} + +export interface MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo { + index: IndexName + version: VersionString + failure_cause?: ErrorCause +} + +export type MigrationGetFeatureUpgradeStatusMigrationStatus = 'NO_MIGRATION_NEEDED' | 'MIGRATION_NEEDED' | 'IN_PROGRESS' | 'ERROR' + +export interface MigrationGetFeatureUpgradeStatusRequest extends RequestBase { +} + +export interface MigrationGetFeatureUpgradeStatusResponse { + features: MigrationGetFeatureUpgradeStatusMigrationFeature[] + migration_status: MigrationGetFeatureUpgradeStatusMigrationStatus +} + +export interface MigrationPostFeatureUpgradeMigrationFeature { + feature_name: string +} + +export interface MigrationPostFeatureUpgradeRequest extends RequestBase { +} + +export interface MigrationPostFeatureUpgradeResponse { + accepted: boolean + features: MigrationPostFeatureUpgradeMigrationFeature[] +} + +export interface MlAnalysisConfig { + bucket_span: TimeSpan + categorization_analyzer?: MlCategorizationAnalyzer + categorization_field_name?: Field + categorization_filters?: string[] + detectors: MlDetector[] + influencers?: Field[] + model_prune_window?: Time + latency?: Time + multivariate_by_fields?: boolean + per_partition_categorization?: MlPerPartitionCategorization + summary_count_field_name?: Field } -export interface MlAnalysisConfig { +export interface MlAnalysisConfigRead { bucket_span: TimeSpan - categorization_analyzer?: MlCategorizationAnalyzer | string + categorization_analyzer?: MlCategorizationAnalyzer categorization_field_name?: Field categorization_filters?: string[] - detectors: MlDetector[] - influencers?: Field[] + detectors: MlDetectorRead[] + influencers: Field[] + model_prune_window?: Time latency?: Time multivariate_by_fields?: boolean per_partition_categorization?: MlPerPartitionCategorization @@ -10196,17 +11268,16 @@ export interface MlAnomalyCause { export type MlAppliesTo = 'actual' | 'typical' | 'diff_from_typical' | 'time' export interface MlBucketInfluencer { + anomaly_score: double bucket_span: long - influencer_score: double influencer_field_name: Field - influencer_field_value: string - initial_influencer_score: double + initial_anomaly_score: double is_interim: boolean job_id: Id probability: double + raw_anomaly_score: double result_type: string timestamp: Time - foo?: string } export interface MlBucketSummary { @@ -10217,7 +11288,6 @@ export interface MlBucketSummary { initial_anomaly_score: double is_interim: boolean job_id: Id - partition_scores?: MlPartitionScore[] processing_time_ms: double result_type: string timestamp: Time @@ -10231,10 +11301,12 @@ export interface MlCalendarEvent { start_time: EpochMillis } -export interface MlCategorizationAnalyzer { - char_filter?: (string | AnalysisCharFilter)[] - filter?: (string | AnalysisTokenFilter)[] - tokenizer?: string | AnalysisTokenizer +export type MlCategorizationAnalyzer = string | MlCategorizationAnalyzerDefinition + +export interface MlCategorizationAnalyzerDefinition { + char_filter?: AnalysisCharFilter[] + filter?: AnalysisTokenFilter[] + tokenizer?: AnalysisTokenizer } export type MlCategorizationStatus = 'ok' | 'warn' @@ -10265,13 +11337,7 @@ export type MlChunkingMode = 'auto' | 'manual' | 'off' export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte' -export interface MlCustomSettingsKeys { - custom_urls?: XpackUsageUrlConfig[] - created_by?: string - job_tags?: Record -} -export type MlCustomSettings = MlCustomSettingsKeys | - { [property: string]: any } +export type MlCustomSettings = any export interface MlDataCounts { bucket_count: long @@ -10287,6 +11353,7 @@ export interface MlDataCounts { latest_record_timestamp?: long latest_sparse_bucket_timestamp?: long latest_bucket_timestamp?: long + log_time?: long missing_field_count: long out_of_order_timestamp_count: long processed_field_count: long @@ -10317,7 +11384,7 @@ export interface MlDatafeed { scroll_size?: integer delayed_data_check_config: MlDelayedDataCheckConfig runtime_mappings?: MappingRuntimeFields - indices_options?: MlDatafeedIndicesOptions + indices_options?: IndicesOptions } export interface MlDatafeedConfig { @@ -10327,25 +11394,18 @@ export interface MlDatafeedConfig { datafeed_id?: Id delayed_data_check_config?: MlDelayedDataCheckConfig frequency?: Timestamp - indexes?: Indices - indices?: Indices - indices_options?: MlDatafeedIndicesOptions + indexes?: string[] + indices: string[] + indices_options?: IndicesOptions job_id?: Id max_empty_searches?: integer - query?: QueryDslQueryContainer + query: QueryDslQueryContainer query_delay?: Timestamp runtime_mappings?: MappingRuntimeFields script_fields?: Record scroll_size?: integer } -export interface MlDatafeedIndicesOptions { - allow_no_indices?: boolean - expand_wildcards?: ExpandWildcards - ignore_unavailable?: boolean - ignore_throttled?: boolean -} - export interface MlDatafeedRunningState { real_time_configured: boolean real_time_running: boolean @@ -10372,30 +11432,28 @@ export interface MlDatafeedTimingStats { } export interface MlDataframeAnalysis { - dependent_variable: string - prediction_field_name?: Field alpha?: double - lambda?: double - gamma?: double + dependent_variable: string + downsample_factor?: double + early_stopping_enabled?: boolean eta?: double eta_growth_rate_per_tree?: double feature_bag_fraction?: double + feature_processors?: MlDataframeAnalysisFeatureProcessor[] + gamma?: double + lambda?: double + max_optimization_rounds_per_hyperparameter?: integer max_trees?: integer maximum_number_trees?: integer - soft_tree_depth_limit?: integer - soft_tree_depth_tolerance?: double - downsample_factor?: double - max_optimization_rounds_per_hyperparameter?: integer - early_stopping_enabled?: boolean num_top_feature_importance_values?: integer - feature_processors?: MlDataframeAnalysisFeatureProcessor[] + prediction_field_name?: Field randomize_seed?: double + soft_tree_depth_limit?: integer + soft_tree_depth_tolerance?: double training_percent?: Percentage } -export type MlDataframeAnalysisAnalyzedFields = string[] | MlDataframeAnalysisAnalyzedFieldsIncludeExclude - -export interface MlDataframeAnalysisAnalyzedFieldsIncludeExclude { +export interface MlDataframeAnalysisAnalyzedFields { includes: string[] excludes: string[] } @@ -10406,9 +11464,9 @@ export interface MlDataframeAnalysisClassification extends MlDataframeAnalysis { } export interface MlDataframeAnalysisContainer { + classification?: MlDataframeAnalysisClassification outlier_detection?: MlDataframeAnalysisOutlierDetection regression?: MlDataframeAnalysisRegression - classification?: MlDataframeAnalysisClassification } export interface MlDataframeAnalysisFeatureProcessor { @@ -10451,10 +11509,10 @@ export interface MlDataframeAnalysisFeatureProcessorTargetMeanEncoding { } export interface MlDataframeAnalysisOutlierDetection { - n_neighbors?: integer - method?: string - feature_influence_threshold?: double compute_feature_influence?: boolean + feature_influence_threshold?: double + method?: string + n_neighbors?: integer outlier_fraction?: double standardization_enabled?: boolean } @@ -10497,8 +11555,8 @@ export interface MlDataframeAnalyticsMemoryEstimation { export interface MlDataframeAnalyticsSource { index: Indices query?: QueryDslQueryContainer - _source?: MlDataframeAnalysisAnalyzedFields runtime_mappings?: MappingRuntimeFields + _source?: MlDataframeAnalysisAnalyzedFields | string[] } export interface MlDataframeAnalyticsStatsContainer { @@ -10547,7 +11605,7 @@ export interface MlDataframeAnalyticsSummary { description?: string model_memory_limit?: string max_num_threads?: integer - analyzed_fields?: MlDataframeAnalysisAnalyzedFields + analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] allow_lazy_start?: boolean create_time?: long version?: VersionString @@ -10633,11 +11691,23 @@ export interface MlDetector { detector_index?: integer exclude_frequent?: MlExcludeFrequent field_name?: Field - function?: string + function: string + over_field_name?: Field + partition_field_name?: Field + use_null?: boolean +} + +export interface MlDetectorRead { + by_field_name?: Field + custom_rules?: MlDetectionRule[] + detector_description?: string + detector_index?: integer + exclude_frequent?: MlExcludeFrequent + field_name?: Field + function: string over_field_name?: Field partition_field_name?: Field use_null?: boolean - description?: string } export interface MlDiscoveryNode { @@ -10688,11 +11758,27 @@ export interface MlHyperparameters { soft_tree_depth_tolerance?: double } +export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' + export interface MlInfluence { influencer_field_name: string influencer_field_values: string[] } +export interface MlInfluencer { + bucket_span: long + influencer_score: double + influencer_field_name: Field + influencer_field_value: string + initial_influencer_score: double + is_interim: boolean + job_id: Id + probability: double + result_type: string + timestamp: Time + foo?: string +} + export interface MlJob { allow_lazy_open: boolean analysis_config: MlAnalysisConfig @@ -10717,7 +11803,6 @@ export interface MlJob { renormalization_window_days?: long results_index_name: IndexName results_retention_days?: long - system_annotations_retention_days?: long } export interface MlJobBlocked { @@ -10745,7 +11830,6 @@ export interface MlJobConfig { renormalization_window_days?: long results_index_name?: IndexName results_retention_days?: long - system_annotations_retention_days?: long } export interface MlJobForecastStatistics { @@ -10803,10 +11887,10 @@ export interface MlModelSizeStats { job_id: Id log_time: Time memory_status: MlMemoryStatus - model_bytes: long - model_bytes_exceeded?: long - model_bytes_memory_limit?: long - peak_model_bytes?: long + model_bytes: ByteSize + model_bytes_exceeded?: ByteSize + model_bytes_memory_limit?: ByteSize + peak_model_bytes?: ByteSize assignment_memory_basis?: string result_type: string total_by_field_count: long @@ -10832,7 +11916,15 @@ export interface MlModelSnapshot { retain: boolean snapshot_doc_count: long snapshot_id: Id - timestamp: integer + timestamp: long +} + +export interface MlModelSnapshotUpgrade { + job_id: Id + snapshot_id: Id + state: MlSnapshotUpgradeState + node: MlDiscoveryNode + assignment_explanation: string } export interface MlOutlierDetectionParameters { @@ -10863,14 +11955,6 @@ export interface MlPage { size?: integer } -export interface MlPartitionScore { - initial_record_score: double - partition_field_name: Field - partition_field_value: string - probability: double - record_score: double -} - export interface MlPerPartitionCategorization { enabled?: boolean stop_on_warn?: boolean @@ -10884,6 +11968,8 @@ export interface MlRuleCondition { value: double } +export type MlSnapshotUpgradeState = 'loading_old_state' | 'saving_new_state' | 'stopped' | 'failed' + export interface MlTimingStats { elapsed_time: integer iteration_time?: integer @@ -10914,7 +12000,7 @@ export interface MlTrainedModelConfig { created_by?: string create_time?: Time default_field_map?: Record - description: string + description?: string estimated_heap_memory_usage_bytes?: integer estimated_operations?: integer inference_config: AggregationsInferenceConfigContainer @@ -10956,9 +12042,15 @@ export interface MlValidationLoss { export interface MlCloseJobRequest extends RequestBase { job_id: Id + allow_no_match?: boolean allow_no_jobs?: boolean force?: boolean timeout?: Time + body?: { + allow_no_match?: boolean + force?: boolean + timeout?: Time + } } export interface MlCloseJobResponse { @@ -11009,7 +12101,7 @@ export interface MlDeleteDatafeedResponse extends AcknowledgedResponseBase { } export interface MlDeleteExpiredDataRequest extends RequestBase { - name?: Name + job_id?: Id requests_per_second?: float timeout?: Time body?: { @@ -11181,11 +12273,11 @@ export interface MlExplainDataFrameAnalyticsRequest extends RequestBase { body?: { source?: MlDataframeAnalyticsSource dest?: MlDataframeAnalyticsDestination - analysis: MlDataframeAnalysisContainer + analysis?: MlDataframeAnalysisContainer description?: string model_memory_limit?: string max_num_threads?: integer - analyzed_fields?: MlDataframeAnalysisAnalyzedFields + analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] allow_lazy_start?: boolean } } @@ -11195,14 +12287,6 @@ export interface MlExplainDataFrameAnalyticsResponse { memory_estimation: MlDataframeAnalyticsMemoryEstimation } -export interface MlFindFileStructureRequest extends RequestBase { - stub: string -} - -export interface MlFindFileStructureResponse { - stub: string -} - export interface MlFlushJobRequest extends RequestBase { job_id: Id skip_time?: string @@ -11219,60 +12303,40 @@ export interface MlFlushJobResponse { last_finalized_bucket_end?: integer } -export interface MlForecastJobRequest extends RequestBase { +export interface MlForecastRequest extends RequestBase { job_id: Id body?: { duration?: Time expires_in?: Time + max_model_memory?: string } } -export interface MlForecastJobResponse extends AcknowledgedResponseBase { +export interface MlForecastResponse extends AcknowledgedResponseBase { forecast_id: Id } -export interface MlGetAnomalyRecordsRequest extends RequestBase { - job_id: Id - exclude_interim?: boolean - from?: integer - size?: integer - start?: DateString - end?: DateString - body?: { - desc?: boolean - exclude_interim?: boolean - page?: MlPage - record_score?: double - sort?: Field - start?: DateString - end?: DateString - } -} - -export interface MlGetAnomalyRecordsResponse { - count: long - records: MlAnomaly[] -} - export interface MlGetBucketsRequest extends RequestBase { job_id: Id timestamp?: Timestamp + anomaly_score?: double + desc?: boolean + end?: DateString + exclude_interim?: boolean + expand?: boolean from?: integer size?: integer - exclude_interim?: boolean sort?: Field - desc?: boolean start?: DateString - end?: DateString body?: { anomaly_score?: double desc?: boolean + end?: DateString exclude_interim?: boolean expand?: boolean page?: MlPage sort?: Field start?: DateString - end?: DateString } } @@ -11283,17 +12347,11 @@ export interface MlGetBucketsResponse { export interface MlGetCalendarEventsRequest extends RequestBase { calendar_id: Id - job_id?: Id end?: DateString from?: integer - start?: string + job_id?: Id size?: integer - body?: { - end?: DateString - from?: integer - start?: string - size?: integer - } + start?: string } export interface MlGetCalendarEventsResponse { @@ -11325,8 +12383,8 @@ export interface MlGetCategoriesRequest extends RequestBase { job_id: Id category_id?: CategoryId from?: integer - size?: integer partition_field_value?: string + size?: integer body?: { page?: MlPage } @@ -11366,6 +12424,7 @@ export interface MlGetDataFrameAnalyticsStatsResponse { export interface MlGetDatafeedStatsRequest extends RequestBase { datafeed_id?: Ids allow_no_datafeeds?: boolean + allow_no_match?: boolean } export interface MlGetDatafeedStatsResponse { @@ -11376,6 +12435,7 @@ export interface MlGetDatafeedStatsResponse { export interface MlGetDatafeedsRequest extends RequestBase { datafeed_id?: Ids allow_no_datafeeds?: boolean + allow_no_match?: boolean exclude_generated?: boolean } @@ -11385,7 +12445,7 @@ export interface MlGetDatafeedsResponse { } export interface MlGetFiltersRequest extends RequestBase { - filter_id?: Id + filter_id?: Ids from?: integer size?: integer } @@ -11412,7 +12472,7 @@ export interface MlGetInfluencersRequest extends RequestBase { export interface MlGetInfluencersResponse { count: long - influencers: MlBucketInfluencer[] + influencers: MlInfluencer[] } export interface MlGetJobStatsRequest extends RequestBase { @@ -11437,6 +12497,17 @@ export interface MlGetJobsResponse { jobs: MlJob[] } +export interface MlGetModelSnapshotUpgradeStatsRequest extends RequestBase { + job_id: Id + snapshot_id?: Id + allow_no_match?: boolean +} + +export interface MlGetModelSnapshotUpgradeStatsResponse { + count: long + model_snapshot_upgrades: MlModelSnapshotUpgrade[] +} + export interface MlGetModelSnapshotsRequest extends RequestBase { job_id: Id snapshot_id?: Id @@ -11447,8 +12518,11 @@ export interface MlGetModelSnapshotsRequest extends RequestBase { sort?: Field start?: Time body?: { - start?: Time + desc?: boolean end?: Time + page?: MlPage + sort?: Field + start?: Time } } @@ -11468,6 +12542,13 @@ export interface MlGetOverallBucketsRequest extends RequestBase { allow_no_match?: boolean body?: { allow_no_jobs?: boolean + allow_no_match?: boolean + bucket_span?: Time + end?: Time + exclude_interim?: boolean + overall_score?: double | string + start?: Time + top_n?: integer } } @@ -11476,13 +12557,39 @@ export interface MlGetOverallBucketsResponse { overall_buckets: MlOverallBucket[] } +export interface MlGetRecordsRequest extends RequestBase { + job_id: Id + desc?: boolean + end?: DateString + exclude_interim?: boolean + from?: integer + record_score?: double + size?: integer + sort?: Field + start?: DateString + body?: { + desc?: boolean + end?: DateString + exclude_interim?: boolean + page?: MlPage + record_score?: double + sort?: Field + start?: DateString + } +} + +export interface MlGetRecordsResponse { + count: long + records: MlAnomaly[] +} + export interface MlGetTrainedModelsRequest extends RequestBase { model_id?: Id allow_no_match?: boolean decompress_definition?: boolean exclude_generated?: boolean from?: integer - include?: string + include?: MlInclude size?: integer tags?: string } @@ -11544,6 +12651,7 @@ export interface MlInfoResponse { export interface MlOpenJobRequest extends RequestBase { job_id: Id + timeout?: Time body?: { timeout?: Time } @@ -11551,11 +12659,10 @@ export interface MlOpenJobRequest extends RequestBase { export interface MlOpenJobResponse { opened: boolean - node: Id } export interface MlPostCalendarEventsRequest extends RequestBase { - calendar_id?: Id + calendar_id: Id body?: { events: MlCalendarEvent[] } @@ -11565,22 +12672,16 @@ export interface MlPostCalendarEventsResponse { events: MlCalendarEvent[] } -export type MlPostDataInput = any | MlPostDataMultipleInputs - -export interface MlPostDataMultipleInputs { - data: any[] -} - -export interface MlPostDataRequest extends RequestBase { +export interface MlPostDataRequest extends RequestBase { job_id: Id reset_end?: DateString reset_start?: DateString - body?: MlPostDataInput + body?: TData[] } export interface MlPostDataResponse { bucket_count: long - earliest_record_timestamp?: integer + earliest_record_timestamp: long empty_bucket_count: long input_bytes: long input_field_count: long @@ -11588,7 +12689,7 @@ export interface MlPostDataResponse { invalid_date_count: long job_id: Id last_data_time: integer - latest_record_timestamp?: integer + latest_record_timestamp: long missing_field_count: long out_of_order_timestamp_count: long processed_field_count: long @@ -11601,7 +12702,7 @@ export interface MlPreviewDataFrameAnalyticsDataframePreviewConfig { analysis: MlDataframeAnalysisContainer model_memory_limit?: string max_num_threads?: integer - analyzed_fields?: MlDataframeAnalysisAnalyzedFields + analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] } export interface MlPreviewDataFrameAnalyticsRequest extends RequestBase { @@ -11623,19 +12724,21 @@ export interface MlPreviewDatafeedRequest extends RequestBase { } } -export type MlPreviewDatafeedResponse = TDocument[] +export interface MlPreviewDatafeedResponse { + data: TDocument[] +} export interface MlPutCalendarRequest extends RequestBase { calendar_id: Id body?: { - job_ids?: Ids + job_ids?: Id[] description?: string } } export interface MlPutCalendarResponse { calendar_id: Id - description?: string + description: string job_ids: Ids } @@ -11653,14 +12756,14 @@ export interface MlPutCalendarJobResponse { export interface MlPutDataFrameAnalyticsRequest extends RequestBase { id: Id body?: { - source?: MlDataframeAnalyticsSource - dest: MlDataframeAnalyticsDestination + allow_lazy_start?: boolean analysis: MlDataframeAnalysisContainer + analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] description?: string - model_memory_limit?: string + dest: MlDataframeAnalyticsDestination max_num_threads?: integer - analyzed_fields?: MlDataframeAnalysisAnalyzedFields - allow_lazy_start?: boolean + model_memory_limit?: string + source: MlDataframeAnalyticsSource } } @@ -11675,7 +12778,7 @@ export interface MlPutDataFrameAnalyticsResponse { allow_lazy_start: boolean max_num_threads: integer analysis: MlDataframeAnalysisContainer - analyzed_fields?: MlDataframeAnalysisAnalyzedFields + analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] } export interface MlPutDatafeedRequest extends RequestBase { @@ -11685,14 +12788,13 @@ export interface MlPutDatafeedRequest extends RequestBase { ignore_throttled?: boolean ignore_unavailable?: boolean body?: { - aggs?: Record aggregations?: Record chunking_config?: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig frequency?: Time - indices?: Indices - indexes?: Indices - indices_options?: MlDatafeedIndicesOptions + indices?: string[] + indexes?: string[] + indices_options?: IndicesOptions job_id?: Id max_empty_searches?: integer query?: QueryDslQueryContainer @@ -11704,15 +12806,15 @@ export interface MlPutDatafeedRequest extends RequestBase { } export interface MlPutDatafeedResponse { - aggregations?: Record + aggregations: Record chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig datafeed_id: Id - frequency?: Time + frequency: Time indices: string[] job_id: Id - indices_options?: MlDatafeedIndicesOptions - max_empty_searches?: integer + indices_options?: IndicesOptions + max_empty_searches: integer query: QueryDslQueryContainer query_delay: Time runtime_mappings?: MappingRuntimeFields @@ -11729,7 +12831,7 @@ export interface MlPutFilterRequest extends RequestBase { } export interface MlPutFilterResponse { - description?: string + description: string filter_id: Id items: string[] } @@ -11752,13 +12854,12 @@ export interface MlPutJobRequest extends RequestBase { renormalization_window_days?: long results_index_name?: IndexName results_retention_days?: long - system_annotations_retention_days?: long } } export interface MlPutJobResponse { allow_lazy_open: boolean - analysis_config: MlAnalysisConfig + analysis_config: MlAnalysisConfigRead analysis_limits: MlAnalysisLimits background_persist_interval?: Time create_time: DateString @@ -11777,22 +12878,102 @@ export interface MlPutJobResponse { renormalization_window_days?: long results_index_name: string results_retention_days?: long - system_annotations_retention_days?: long +} + +export interface MlPutTrainedModelAggregateOutput { + logistic_regression?: MlPutTrainedModelWeights + weighted_sum?: MlPutTrainedModelWeights + weighted_mode?: MlPutTrainedModelWeights + exponent?: MlPutTrainedModelWeights +} + +export interface MlPutTrainedModelDefinition { + preprocessors?: MlPutTrainedModelPreprocessor[] + trained_model: MlPutTrainedModelTrainedModel +} + +export interface MlPutTrainedModelEnsemble { + aggregate_output?: MlPutTrainedModelAggregateOutput + classification_labels?: string[] + feature_names?: string[] + target_type?: string + trained_models: MlPutTrainedModelTrainedModel[] +} + +export interface MlPutTrainedModelFrequencyEncodingPreprocessor { + field: string + feature_name: string + frequency_map: Record +} + +export interface MlPutTrainedModelInput { + field_names: Names +} + +export interface MlPutTrainedModelOneHotEncodingPreprocessor { + field: string + hot_map: Record +} + +export interface MlPutTrainedModelPreprocessor { + frequency_encoding?: MlPutTrainedModelFrequencyEncodingPreprocessor + one_hot_encoding?: MlPutTrainedModelOneHotEncodingPreprocessor + target_mean_encoding?: MlPutTrainedModelTargetMeanEncodingPreprocessor } export interface MlPutTrainedModelRequest extends RequestBase { - stub: string + model_id: Id body?: { - stub?: string + compressed_definition?: string + definition?: MlPutTrainedModelDefinition + description?: string + inference_config: AggregationsInferenceConfigContainer + input: MlPutTrainedModelInput + metadata?: any + tags?: string[] } } -export interface MlPutTrainedModelResponse { - stub: boolean +export type MlPutTrainedModelResponse = MlTrainedModelConfig + +export interface MlPutTrainedModelTargetMeanEncodingPreprocessor { + field: string + feature_name: string + target_map: Record + default_value: double +} + +export interface MlPutTrainedModelTrainedModel { + tree?: MlPutTrainedModelTrainedModelTree + tree_node?: MlPutTrainedModelTrainedModelTreeNode + ensemble?: MlPutTrainedModelEnsemble +} + +export interface MlPutTrainedModelTrainedModelTree { + classification_labels?: string[] + feature_names: string[] + target_type?: string + tree_structure: MlPutTrainedModelTrainedModelTreeNode[] +} + +export interface MlPutTrainedModelTrainedModelTreeNode { + decision_type?: string + default_left?: boolean + leaf_value?: double + left_child?: integer + node_index: integer + right_child?: integer + split_feature?: integer + split_gain?: integer + threshold?: double +} + +export interface MlPutTrainedModelWeights { + weights: double } export interface MlPutTrainedModelAliasRequest extends RequestBase { - model_alias: string + model_alias: Name model_id: Id reassign?: boolean } @@ -11811,7 +12992,6 @@ export interface MlResetJobResponse extends AcknowledgedResponseBase { export interface MlRevertModelSnapshotRequest extends RequestBase { job_id: Id snapshot_id: Id - delete_intervening_results?: boolean body?: { delete_intervening_results?: boolean } @@ -11866,6 +13046,7 @@ export interface MlStopDataFrameAnalyticsResponse { export interface MlStopDatafeedRequest extends RequestBase { datafeed_id: Id + allow_no_datafeeds?: boolean allow_no_match?: boolean force?: boolean body?: { @@ -11899,7 +13080,47 @@ export interface MlUpdateDataFrameAnalyticsResponse { allow_lazy_start: boolean max_num_threads: integer analysis: MlDataframeAnalysisContainer - analyzed_fields?: MlDataframeAnalysisAnalyzedFields + analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] +} + +export interface MlUpdateDatafeedRequest extends RequestBase { + datafeed_id: Id + allow_no_indices?: boolean + expand_wildcards?: ExpandWildcards + ignore_throttled?: boolean + ignore_unavailable?: boolean + body?: { + aggregations?: Record + chunking_config?: MlChunkingConfig + delayed_data_check_config?: MlDelayedDataCheckConfig + frequency?: Time + indices?: string[] + indexes?: string[] + indices_options?: IndicesOptions + max_empty_searches?: integer + query?: QueryDslQueryContainer + query_delay?: Time + runtime_mappings?: MappingRuntimeFields + script_fields?: Record + scroll_size?: integer + } +} + +export interface MlUpdateDatafeedResponse { + aggregations: Record + chunking_config: MlChunkingConfig + delayed_data_check_config?: MlDelayedDataCheckConfig + datafeed_id: Id + frequency: Time + indices: string[] + job_id: Id + indices_options?: IndicesOptions + max_empty_searches: integer + query: QueryDslQueryContainer + query_delay: Time + runtime_mappings?: MappingRuntimeFields + script_fields?: Record + scroll_size: integer } export interface MlUpdateFilterRequest extends RequestBase { @@ -11934,17 +13155,17 @@ export interface MlUpdateJobRequest extends RequestBase { groups?: string[] detectors?: MlDetector[] per_partition_categorization?: MlPerPartitionCategorization - system_annotations_retention_days?: long } } export interface MlUpdateJobResponse { allow_lazy_open: boolean - analysis_config: MlAnalysisConfig + analysis_config: MlAnalysisConfigRead analysis_limits: MlAnalysisLimits background_persist_interval?: Time - create_time: Time - custom_settings?: MlCustomSettings + create_time: EpochMillis + finished_time?: EpochMillis + custom_settings?: Record daily_model_snapshot_retention_after_days: long data_description: MlDataDescription datafeed_config?: MlDatafeed @@ -11952,13 +13173,12 @@ export interface MlUpdateJobResponse { groups?: string[] job_id: Id job_type: string - job_version: string - finished_time?: Time + job_version: VersionString model_plot_config?: MlModelPlotConfig model_snapshot_id?: Id model_snapshot_retention_days: long renormalization_window_days?: long - results_index_name: string + results_index_name: IndexName results_retention_days?: long } @@ -11987,14 +13207,7 @@ export interface MlUpgradeJobSnapshotResponse { completed: boolean } -export interface MlValidateDetectorRequest extends RequestBase { - body?: MlDetector -} - -export interface MlValidateDetectorResponse extends AcknowledgedResponseBase { -} - -export interface MlValidateJobRequest extends RequestBase { +export interface MlValidateRequest extends RequestBase { body?: { job_id?: Id analysis_config?: MlAnalysisConfig @@ -12007,42 +13220,126 @@ export interface MlValidateJobRequest extends RequestBase { } } -export interface MlValidateJobResponse extends AcknowledgedResponseBase { +export interface MlValidateResponse extends AcknowledgedResponseBase { } -export interface MonitoringBulkRequest extends RequestBase { - stub_a: string - stub_b: string - body?: { - stub_c: string - } +export interface MlValidateDetectorRequest extends RequestBase { + body?: MlDetector +} + +export interface MlValidateDetectorResponse extends AcknowledgedResponseBase { +} + +export interface MonitoringBulkRequest extends RequestBase { + type?: string + system_id: string + system_api_version: string + interval: TimeSpan + body?: (BulkOperationContainer | BulkUpdateAction | TDocument)[] } export interface MonitoringBulkResponse { - stub: integer + error?: ErrorCause + errors: boolean + ignored: boolean + took: long } export interface NodesAdaptiveSelection { - avg_queue_size: long - avg_response_time: long - avg_response_time_ns: long - avg_service_time: string - avg_service_time_ns: long - outgoing_searches: long - rank: string + avg_queue_size?: long + avg_response_time?: long + avg_response_time_ns?: long + avg_service_time?: string + avg_service_time_ns?: long + outgoing_searches?: long + rank?: string } export interface NodesBreaker { - estimated_size: string - estimated_size_in_bytes: long - limit_size: string - limit_size_in_bytes: long - overhead: float - tripped: float + estimated_size?: string + estimated_size_in_bytes?: long + limit_size?: string + limit_size_in_bytes?: long + overhead?: float + tripped?: float +} + +export interface NodesCgroup { + cpuacct?: NodesCpuAcct + cpu?: NodesCgroupCpu + memory?: NodesCgroupMemory +} + +export interface NodesCgroupCpu { + control_group?: string + cfs_period_micros?: integer + cfs_quota_micros?: integer + stat?: NodesCgroupCpuStat +} + +export interface NodesCgroupCpuStat { + number_of_elapsed_periods?: long + number_of_times_throttled?: long + time_throttled_nanos?: long +} + +export interface NodesCgroupMemory { + control_group?: string + limit_in_bytes?: string + usage_in_bytes?: string +} + +export interface NodesClient { + id?: long + agent?: string + local_address?: string + remote_address?: string + last_uri?: string + opened_time_millis?: long + closed_time_millis?: long + last_request_time_millis?: long + request_count?: long + request_size_bytes?: long + x_opaque_id?: string +} + +export interface NodesClusterAppliedStats { + recordings?: NodesRecording[] +} + +export interface NodesClusterStateQueue { + total?: long + pending?: long + committed?: long +} + +export interface NodesClusterStateUpdate { + count?: long + computation_time?: string + computation_time_millis?: long + publication_time?: string + publication_time_millis?: long + context_construction_time?: string + context_construction_time_millis?: long + commit_time?: string + commit_time_millis?: long + completion_time?: string + completion_time_millis?: long + master_apply_time?: string + master_apply_time_millis?: long + notification_time?: string + notification_time_millis?: long +} + +export interface NodesContext { + context?: string + compilations?: long + cache_evictions?: long + compilation_limit_triggered?: long } export interface NodesCpu { - percent: integer + percent?: integer sys?: string sys_in_millis?: long total?: string @@ -12052,185 +13349,364 @@ export interface NodesCpu { load_average?: Record } +export interface NodesCpuAcct { + control_group?: string + usage_nanos?: long +} + export interface NodesDataPathStats { - available: string - available_in_bytes: long - disk_queue: string - disk_reads: long - disk_read_size: string - disk_read_size_in_bytes: long - disk_writes: long - disk_write_size: string - disk_write_size_in_bytes: long - free: string - free_in_bytes: long - mount: string - path: string - total: string - total_in_bytes: long - type: string + available?: string + available_in_bytes?: long + disk_queue?: string + disk_reads?: long + disk_read_size?: string + disk_read_size_in_bytes?: long + disk_writes?: long + disk_write_size?: string + disk_write_size_in_bytes?: long + free?: string + free_in_bytes?: long + mount?: string + path?: string + total?: string + total_in_bytes?: long + type?: string +} + +export interface NodesDiscovery { + cluster_state_queue?: NodesClusterStateQueue + published_cluster_states?: NodesPublishedClusterStates + cluster_state_update?: Record + serialized_cluster_states?: NodesSerializedClusterState + cluster_applier_stats?: NodesClusterAppliedStats } export interface NodesExtendedMemoryStats extends NodesMemoryStats { - free_percent: integer - used_percent: integer - total_in_bytes: integer - free_in_bytes: integer - used_in_bytes: integer + free_percent?: integer + used_percent?: integer } export interface NodesFileSystem { - data: NodesDataPathStats[] - timestamp: long - total: NodesFileSystemTotal + data?: NodesDataPathStats[] + timestamp?: long + total?: NodesFileSystemTotal + io_stats?: NodesIoStats } export interface NodesFileSystemTotal { - available: string - available_in_bytes: long - free: string - free_in_bytes: long - total: string - total_in_bytes: long + available?: string + available_in_bytes?: long + free?: string + free_in_bytes?: long + total?: string + total_in_bytes?: long } export interface NodesGarbageCollector { - collectors: Record + collectors?: Record } export interface NodesGarbageCollectorTotal { - collection_count: long - collection_time: string - collection_time_in_millis: long + collection_count?: long + collection_time?: string + collection_time_in_millis?: long } export interface NodesHttp { - current_open: integer - total_opened: long + current_open?: integer + total_opened?: long + clients?: NodesClient[] +} + +export interface NodesIndexingPressure { + memory?: NodesIndexingPressureMemory +} + +export interface NodesIndexingPressureMemory { + limit_in_bytes?: long + current?: NodesPressureMemory + total?: NodesPressureMemory } export interface NodesIngest { - pipelines: Record - total: NodesIngestTotal + pipelines?: Record + total?: NodesIngestTotal } export interface NodesIngestTotal { - count: long - current: long - failed: long - processors: NodesKeyedProcessor[] - time_in_millis: long + count?: long + current?: long + failed?: long + processors?: Record[] + time_in_millis?: long +} + +export interface NodesIoStatDevice { + device_name?: string + operations?: long + read_kilobytes?: long + read_operations?: long + write_kilobytes?: long + write_operations?: long +} + +export interface NodesIoStats { + devices?: NodesIoStatDevice[] + total?: NodesIoStatDevice } export interface NodesJvm { - buffer_pools: Record - classes: NodesJvmClasses - gc: NodesGarbageCollector - mem: NodesMemoryStats - threads: NodesJvmThreads - timestamp: long - uptime: string - uptime_in_millis: long + buffer_pools?: Record + classes?: NodesJvmClasses + gc?: NodesGarbageCollector + mem?: NodesJvmMemoryStats + threads?: NodesJvmThreads + timestamp?: long + uptime?: string + uptime_in_millis?: long } export interface NodesJvmClasses { - current_loaded_count: long - total_loaded_count: long - total_unloaded_count: long + current_loaded_count?: long + total_loaded_count?: long + total_unloaded_count?: long +} + +export interface NodesJvmMemoryStats { + heap_used_in_bytes?: long + heap_used_percent?: long + heap_committed_in_bytes?: long + heap_max_in_bytes?: long + non_heap_used_in_bytes?: long + non_heap_committed_in_bytes?: long + pools?: Record } export interface NodesJvmThreads { - count: long - peak_count: long + count?: long + peak_count?: long } export interface NodesKeyedProcessor { - statistics: NodesProcess - type: string + stats?: NodesProcessor + type?: string } export interface NodesMemoryStats { + adjusted_total_in_bytes?: long resident?: string resident_in_bytes?: long share?: string share_in_bytes?: long total_virtual?: string total_virtual_in_bytes?: long - total_in_bytes: long - free_in_bytes: long - used_in_bytes: long + total_in_bytes?: long + free_in_bytes?: long + used_in_bytes?: long } export interface NodesNodeBufferPool { - count: long - total_capacity: string - total_capacity_in_bytes: long - used: string - used_in_bytes: long + count?: long + total_capacity?: string + total_capacity_in_bytes?: long + used?: string + used_in_bytes?: long +} + +export interface NodesNodeReloadError { + name: Name + reload_exception?: ErrorCause } +export type NodesNodeReloadResult = NodesStats | NodesNodeReloadError + export interface NodesNodesResponseBase { - _nodes: NodeStatistics + _nodes?: NodeStatistics } export interface NodesOperatingSystem { - cpu: NodesCpu - mem: NodesExtendedMemoryStats - swap: NodesMemoryStats - timestamp: long + cpu?: NodesCpu + mem?: NodesExtendedMemoryStats + swap?: NodesMemoryStats + cgroup?: NodesCgroup + timestamp?: long +} + +export interface NodesPool { + used_in_bytes?: long + max_in_bytes?: long + peak_used_in_bytes?: long + peak_max_in_bytes?: long +} + +export interface NodesPressureMemory { + combined_coordinating_and_primary_in_bytes?: long + coordinating_in_bytes?: long + primary_in_bytes?: long + replica_in_bytes?: long + all_in_bytes?: long + coordinating_rejections?: long + primary_rejections?: long + replica_rejections?: long } export interface NodesProcess { - cpu: NodesCpu - mem: NodesMemoryStats - open_file_descriptors: integer - timestamp: long + cpu?: NodesCpu + mem?: NodesMemoryStats + open_file_descriptors?: integer + max_file_descriptors?: integer + timestamp?: long +} + +export interface NodesProcessor { + count?: long + current?: long + failed?: long + time_in_millis?: long +} + +export interface NodesPublishedClusterStates { + full_states?: long + incompatible_diffs?: long + compatible_diffs?: long +} + +export interface NodesRecording { + name?: string + cumulative_execution_count?: long + cumulative_execution_time?: string + cumulative_execution_time_millis?: long +} + +export interface NodesRepositoryLocation { + base_path: string + container?: string + bucket?: string +} + +export interface NodesRepositoryMeteringInformation { + repository_name: Name + repository_type: string + repository_location: NodesRepositoryLocation + repository_ephemeral_id: Id + repository_started_at: EpochMillis + repository_stopped_at?: EpochMillis + archived: boolean + cluster_version?: VersionNumber + request_counts: NodesRequestCounts +} + +export interface NodesRequestCounts { + GetBlobProperties?: long + GetBlob?: long + ListBlobs?: long + PutBlob?: long + PutBlock?: long + PutBlockList?: long + GetObject?: long + ListObjects?: long + InsertObject?: long + PutObject?: long + PutMultipartObject?: long +} + +export interface NodesScriptCache { + cache_evictions?: long + compilation_limit_triggered?: long + compilations?: long + context?: string } export interface NodesScripting { - cache_evictions: long - compilations: long + cache_evictions?: long + compilations?: long + compilation_limit_triggered?: long + contexts?: NodesContext[] +} + +export interface NodesSerializedClusterState { + full_states?: NodesSerializedClusterStateDetail + diffs?: NodesSerializedClusterStateDetail +} + +export interface NodesSerializedClusterStateDetail { + count?: long + uncompressed_size?: string + uncompressed_size_in_bytes?: long + compressed_size?: string + compressed_size_in_bytes?: long } export interface NodesStats { - adaptive_selection: Record - breakers: Record - fs: NodesFileSystem - host: Host - http: NodesHttp - indices: IndicesStatsIndexStats - ingest: NodesIngest - ip: Ip | Ip[] - jvm: NodesJvm - name: Name - os: NodesOperatingSystem - process: NodesProcess - roles: NodeRoles - script: NodesScripting - thread_pool: Record - timestamp: long - transport: NodesTransport - transport_address: TransportAddress - attributes: Record + adaptive_selection?: Record + breakers?: Record + fs?: NodesFileSystem + host?: Host + http?: NodesHttp + ingest?: NodesIngest + ip?: Ip | Ip[] + jvm?: NodesJvm + name?: Name + os?: NodesOperatingSystem + process?: NodesProcess + roles?: NodeRoles + script?: NodesScripting + script_cache?: Record + thread_pool?: Record + timestamp?: long + transport?: NodesTransport + transport_address?: TransportAddress + attributes?: Record + discovery?: NodesDiscovery + indexing_pressure?: NodesIndexingPressure + indices?: IndicesStatsShardStats } export interface NodesThreadCount { - active: long - completed: long - largest: long - queue: long - rejected: long - threads: long + active?: long + completed?: long + largest?: long + queue?: long + rejected?: long + threads?: long } export interface NodesTransport { - rx_count: long - rx_size: string - rx_size_in_bytes: long - server_open: integer - tx_count: long - tx_size: string - tx_size_in_bytes: long + inbound_handling_time_histogram?: NodesTransportHistogram[] + outbound_handling_time_histogram?: NodesTransportHistogram[] + rx_count?: long + rx_size?: string + rx_size_in_bytes?: long + server_open?: integer + tx_count?: long + tx_size?: string + tx_size_in_bytes?: long + total_outbound_connections?: long +} + +export interface NodesTransportHistogram { + count?: long + lt_millis?: long + ge_millis?: long +} + +export interface NodesClearRepositoriesMeteringArchiveRequest extends RequestBase { + node_id: NodeIds + max_archive_version: long +} + +export interface NodesClearRepositoriesMeteringArchiveResponse extends NodesNodesResponseBase { + cluster_name: Name + nodes: Record +} + +export interface NodesGetRepositoriesMeteringInfoRequest extends RequestBase { + node_id: NodeIds +} + +export interface NodesGetRepositoriesMeteringInfoResponse extends NodesNodesResponseBase { + cluster_name: Name + nodes: Record } export interface NodesHotThreadsHotThread { @@ -12245,15 +13721,20 @@ export interface NodesHotThreadsRequest extends RequestBase { ignore_idle_threads?: boolean interval?: Time snapshots?: long + master_timeout?: Time threads?: long - thread_type?: ThreadType timeout?: Time + type?: ThreadType } export interface NodesHotThreadsResponse { hot_threads: NodesHotThreadsHotThread[] } +export interface NodesInfoDeprecationIndexing { + enabled: boolean | string +} + export interface NodesInfoNodeInfo { attributes: Record build_flavor: string @@ -12297,9 +13778,13 @@ export interface NodesInfoNodeInfoClient { type: string } -export interface NodesInfoNodeInfoDiscover { - seed_hosts: string +export interface NodesInfoNodeInfoDiscoverKeys { + seed_hosts?: string[] + type?: string + seed_providers?: string[] } +export type NodesInfoNodeInfoDiscover = NodesInfoNodeInfoDiscoverKeys + & { [property: string]: any } export interface NodesInfoNodeInfoHttp { bound_address: string[] @@ -12312,6 +13797,14 @@ export interface NodesInfoNodeInfoIngest { processors: NodesInfoNodeInfoIngestProcessor[] } +export interface NodesInfoNodeInfoIngestDownloader { + enabled: string +} + +export interface NodesInfoNodeInfoIngestInfo { + downloader: NodesInfoNodeInfoIngestDownloader +} + export interface NodesInfoNodeInfoIngestProcessor { type: string } @@ -12357,9 +13850,9 @@ export interface NodesInfoNodeInfoOSCPU { } export interface NodesInfoNodeInfoPath { - logs: string - home: string - repo: string[] + logs?: string + home?: string + repo?: string[] data?: string[] } @@ -12387,7 +13880,7 @@ export interface NodesInfoNodeInfoSearchRemote { export interface NodesInfoNodeInfoSettings { cluster: NodesInfoNodeInfoSettingsCluster node: NodesInfoNodeInfoSettingsNode - path: NodesInfoNodeInfoPath + path?: NodesInfoNodeInfoPath repositories?: NodesInfoNodeInfoRepositories discovery?: NodesInfoNodeInfoDiscover action?: NodesInfoNodeInfoAction @@ -12399,13 +13892,15 @@ export interface NodesInfoNodeInfoSettings { xpack?: NodesInfoNodeInfoXpack script?: NodesInfoNodeInfoScript search?: NodesInfoNodeInfoSearch + ingest?: NodesInfoNodeInfoSettingsIngest } export interface NodesInfoNodeInfoSettingsCluster { name: Name routing?: IndicesIndexRouting election: NodesInfoNodeInfoSettingsClusterElection - initial_master_nodes?: string + initial_master_nodes?: string[] + deprecation_indexing?: NodesInfoDeprecationIndexing } export interface NodesInfoNodeInfoSettingsClusterElection { @@ -12413,7 +13908,7 @@ export interface NodesInfoNodeInfoSettingsClusterElection { } export interface NodesInfoNodeInfoSettingsHttp { - type: string | NodesInfoNodeInfoSettingsHttpType + type: NodesInfoNodeInfoSettingsHttpType | string 'type.default'?: string compression?: boolean | string port?: integer | string @@ -12423,6 +13918,43 @@ export interface NodesInfoNodeInfoSettingsHttpType { default: string } +export interface NodesInfoNodeInfoSettingsIngest { + attachment?: NodesInfoNodeInfoIngestInfo + append?: NodesInfoNodeInfoIngestInfo + csv?: NodesInfoNodeInfoIngestInfo + convert?: NodesInfoNodeInfoIngestInfo + date?: NodesInfoNodeInfoIngestInfo + date_index_name?: NodesInfoNodeInfoIngestInfo + dot_expander?: NodesInfoNodeInfoIngestInfo + enrich?: NodesInfoNodeInfoIngestInfo + fail?: NodesInfoNodeInfoIngestInfo + foreach?: NodesInfoNodeInfoIngestInfo + json?: NodesInfoNodeInfoIngestInfo + user_agent?: NodesInfoNodeInfoIngestInfo + kv?: NodesInfoNodeInfoIngestInfo + geoip?: NodesInfoNodeInfoIngestInfo + grok?: NodesInfoNodeInfoIngestInfo + gsub?: NodesInfoNodeInfoIngestInfo + join?: NodesInfoNodeInfoIngestInfo + lowercase?: NodesInfoNodeInfoIngestInfo + remove?: NodesInfoNodeInfoIngestInfo + rename?: NodesInfoNodeInfoIngestInfo + script?: NodesInfoNodeInfoIngestInfo + set?: NodesInfoNodeInfoIngestInfo + sort?: NodesInfoNodeInfoIngestInfo + split?: NodesInfoNodeInfoIngestInfo + trim?: NodesInfoNodeInfoIngestInfo + uppercase?: NodesInfoNodeInfoIngestInfo + urldecode?: NodesInfoNodeInfoIngestInfo + bytes?: NodesInfoNodeInfoIngestInfo + dissect?: NodesInfoNodeInfoIngestInfo + set_security_user?: NodesInfoNodeInfoIngestInfo + pipeline?: NodesInfoNodeInfoIngestInfo + drop?: NodesInfoNodeInfoIngestInfo + circle?: NodesInfoNodeInfoIngestInfo + inference?: NodesInfoNodeInfoIngestInfo +} + export interface NodesInfoNodeInfoSettingsNetwork { host: Host } @@ -12434,7 +13966,7 @@ export interface NodesInfoNodeInfoSettingsNode { } export interface NodesInfoNodeInfoSettingsTransport { - type: string | NodesInfoNodeInfoSettingsTransportType + type: NodesInfoNodeInfoSettingsTransportType | string 'type.default'?: string features?: NodesInfoNodeInfoSettingsTransportFeatures } @@ -12470,7 +14002,7 @@ export interface NodesInfoNodeInfoXpackLicenseType { export interface NodesInfoNodeInfoXpackSecurity { http: NodesInfoNodeInfoXpackSecuritySsl enabled: string - transport: NodesInfoNodeInfoXpackSecuritySsl + transport?: NodesInfoNodeInfoXpackSecuritySsl authc?: NodesInfoNodeInfoXpackSecurityAuthc } @@ -12555,17 +14087,6 @@ export interface NodesInfoResponse extends NodesNodesResponseBase { nodes: Record } -export interface NodesReloadSecureSettingsNodeReloadException { - name: Name - reload_exception?: NodesReloadSecureSettingsNodeReloadExceptionCausedBy -} - -export interface NodesReloadSecureSettingsNodeReloadExceptionCausedBy { - type: string - reason: string - caused_by?: NodesReloadSecureSettingsNodeReloadExceptionCausedBy -} - export interface NodesReloadSecureSettingsRequest extends RequestBase { node_id?: NodeIds timeout?: Time @@ -12576,7 +14097,7 @@ export interface NodesReloadSecureSettingsRequest extends RequestBase { export interface NodesReloadSecureSettingsResponse extends NodesNodesResponseBase { cluster_name: Name - nodes: Record + nodes: Record } export interface NodesStatsRequest extends RequestBase { @@ -12596,7 +14117,7 @@ export interface NodesStatsRequest extends RequestBase { } export interface NodesStatsResponse extends NodesNodesResponseBase { - cluster_name: Name + cluster_name?: Name nodes: Record } @@ -12650,142 +14171,138 @@ export interface RollupTermsGrouping { fields: Fields } -export interface RollupCreateRollupJobRequest extends RequestBase { - id: Id - body?: { - cron?: string - groups?: RollupGroupings - index_pattern?: string - metrics?: RollupFieldMetric[] - page_size?: long - rollup_index?: IndexName - } -} - -export interface RollupCreateRollupJobResponse extends AcknowledgedResponseBase { -} - -export interface RollupDeleteRollupJobRequest extends RequestBase { +export interface RollupDeleteJobRequest extends RequestBase { id: Id } -export interface RollupDeleteRollupJobResponse extends AcknowledgedResponseBase { - task_failures?: RollupDeleteRollupJobTaskFailure[] +export interface RollupDeleteJobResponse extends AcknowledgedResponseBase { + task_failures?: RollupDeleteJobTaskFailure[] } -export interface RollupDeleteRollupJobTaskFailure { +export interface RollupDeleteJobTaskFailure { task_id: TaskId node_id: Id status: string - reason: RollupDeleteRollupJobTaskFailureReason + reason: RollupDeleteJobTaskFailureReason } -export interface RollupDeleteRollupJobTaskFailureReason { +export interface RollupDeleteJobTaskFailureReason { type: string reason: string } -export interface RollupGetRollupCapabilitiesRequest extends RequestBase { +export type RollupGetJobsIndexingJobState = 'started' | 'indexing' | 'stopping' | 'stopped' | 'aborting' + +export interface RollupGetJobsRequest extends RequestBase { id?: Id } -export interface RollupGetRollupCapabilitiesResponse extends DictionaryResponseBase { +export interface RollupGetJobsResponse { + jobs: RollupGetJobsRollupJob[] } -export interface RollupGetRollupCapabilitiesRollupCapabilities { - rollup_jobs: RollupGetRollupCapabilitiesRollupCapabilitySummary[] +export interface RollupGetJobsRollupJob { + config: RollupGetJobsRollupJobConfiguration + stats: RollupGetJobsRollupJobStats + status: RollupGetJobsRollupJobStatus } -export interface RollupGetRollupCapabilitiesRollupCapabilitySummary { - fields: Record> +export interface RollupGetJobsRollupJobConfiguration { + cron: string + groups: RollupGroupings + id: Id index_pattern: string - job_id: string - rollup_index: string + metrics: RollupFieldMetric[] + page_size: long + rollup_index: IndexName + timeout: Time } -export interface RollupGetRollupIndexCapabilitiesIndexCapabilities { - rollup_jobs: RollupGetRollupIndexCapabilitiesRollupJobSummary[] +export interface RollupGetJobsRollupJobStats { + documents_processed: long + index_failures: long + index_time_in_ms: long + index_total: long + pages_processed: long + rollups_indexed: long + search_failures: long + search_time_in_ms: long + search_total: long + trigger_count: long + processing_time_in_ms: long + processing_total: long } -export interface RollupGetRollupIndexCapabilitiesRequest extends RequestBase { - index: Id +export interface RollupGetJobsRollupJobStatus { + current_position?: Record + job_state: RollupGetJobsIndexingJobState + upgraded_doc_id?: boolean } -export interface RollupGetRollupIndexCapabilitiesResponse extends DictionaryResponseBase { +export interface RollupGetRollupCapsRequest extends RequestBase { + id?: Id } -export interface RollupGetRollupIndexCapabilitiesRollupJobSummary { - fields: Record - index_pattern: string - job_id: Id - rollup_index: IndexName +export interface RollupGetRollupCapsResponse extends DictionaryResponseBase { } -export interface RollupGetRollupIndexCapabilitiesRollupJobSummaryField { - agg: string - time_zone?: string - calendar_interval?: Time +export interface RollupGetRollupCapsRollupCapabilities { + rollup_jobs: RollupGetRollupCapsRollupCapabilitySummary[] } -export type RollupGetRollupJobIndexingJobState = 'started' | 'indexing' | 'stopping' | 'stopped' | 'aborting' +export interface RollupGetRollupCapsRollupCapabilitySummary { + fields: Record> + index_pattern: string + job_id: string + rollup_index: string +} -export interface RollupGetRollupJobRequest extends RequestBase { - id?: Id +export interface RollupGetRollupIndexCapsIndexCapabilities { + rollup_jobs: RollupGetRollupIndexCapsRollupJobSummary[] } -export interface RollupGetRollupJobResponse { - jobs: RollupGetRollupJobRollupJob[] +export interface RollupGetRollupIndexCapsRequest extends RequestBase { + index: Id } -export interface RollupGetRollupJobRollupJob { - config: RollupGetRollupJobRollupJobConfiguration - stats: RollupGetRollupJobRollupJobStats - status: RollupGetRollupJobRollupJobStatus +export interface RollupGetRollupIndexCapsResponse extends DictionaryResponseBase { } -export interface RollupGetRollupJobRollupJobConfiguration { - cron: string - groups: RollupGroupings - id: Id +export interface RollupGetRollupIndexCapsRollupJobSummary { + fields: Record index_pattern: string - metrics: RollupFieldMetric[] - page_size: long + job_id: Id rollup_index: IndexName - timeout: Time } -export interface RollupGetRollupJobRollupJobStats { - documents_processed: long - index_failures: long - index_time_in_ms: long - index_total: long - pages_processed: long - rollups_indexed: long - search_failures: long - search_time_in_ms: long - search_total: long - trigger_count: long - processing_time_in_ms: long - processing_total: long +export interface RollupGetRollupIndexCapsRollupJobSummaryField { + agg: string + time_zone?: string + calendar_interval?: Time +} + +export interface RollupPutJobRequest extends RequestBase { + id: Id + body?: { + cron?: string + groups?: RollupGroupings + index_pattern?: string + metrics?: RollupFieldMetric[] + page_size?: long + rollup_index?: IndexName + } } -export interface RollupGetRollupJobRollupJobStatus { - current_position?: Record - job_state: RollupGetRollupJobIndexingJobState - upgraded_doc_id?: boolean +export interface RollupPutJobResponse extends AcknowledgedResponseBase { } export interface RollupRollupRequest extends RequestBase { - stubb: integer - stuba: integer - body?: { - stub: integer - } + index: IndexName + rollup_index: IndexName + body?: any } -export interface RollupRollupResponse { - stub: integer -} +export type RollupRollupResponse = any export interface RollupRollupSearchRequest extends RequestBase { index: Indices @@ -12793,6 +14310,7 @@ export interface RollupRollupSearchRequest extends RequestBase { rest_total_hits_as_int?: boolean typed_keys?: boolean body?: { + aggregations?: Record aggs?: Record query?: QueryDslQueryContainer size?: integer @@ -12808,24 +14326,50 @@ export interface RollupRollupSearchResponse { aggregations?: Record } -export interface RollupStartRollupJobRequest extends RequestBase { +export interface RollupStartJobRequest extends RequestBase { id: Id } -export interface RollupStartRollupJobResponse { +export interface RollupStartJobResponse { started: boolean } -export interface RollupStopRollupJobRequest extends RequestBase { +export interface RollupStopJobRequest extends RequestBase { id: Id timeout?: Time wait_for_completion?: boolean } -export interface RollupStopRollupJobResponse { +export interface RollupStopJobResponse { stopped: boolean } +export type SearchableSnapshotsStatsLevel = 'cluster' | 'indices' | 'shards' + +export interface SearchableSnapshotsCacheStatsNode { + shared_cache: SearchableSnapshotsCacheStatsShared +} + +export interface SearchableSnapshotsCacheStatsRequest extends RequestBase { + node_id?: NodeIds + master_timeout?: Time +} + +export interface SearchableSnapshotsCacheStatsResponse { + nodes: Record +} + +export interface SearchableSnapshotsCacheStatsShared { + reads: long + bytes_read_in_bytes: ByteSize + writes: long + bytes_written_in_bytes: ByteSize + evictions: long + num_regions: integer + size_in_bytes: ByteSize + region_size_in_bytes: ByteSize +} + export interface SearchableSnapshotsClearCacheRequest extends RequestBase { index?: Indices expand_wildcards?: ExpandWildcards @@ -12835,9 +14379,7 @@ export interface SearchableSnapshotsClearCacheRequest extends RequestBase { human?: boolean } -export interface SearchableSnapshotsClearCacheResponse { - stub: integer -} +export type SearchableSnapshotsClearCacheResponse = any export interface SearchableSnapshotsMountMountedSnapshot { snapshot: Name @@ -12863,28 +14405,14 @@ export interface SearchableSnapshotsMountResponse { snapshot: SearchableSnapshotsMountMountedSnapshot } -export interface SearchableSnapshotsRepositoryStatsRequest extends RequestBase { - stub_a: integer - stub_b: integer - body?: { - stub_c: integer - } -} - -export interface SearchableSnapshotsRepositoryStatsResponse { - stub: integer -} - export interface SearchableSnapshotsStatsRequest extends RequestBase { - stub_a: integer - stub_b: integer - body?: { - stub_c: integer - } + index?: Indices + level?: SearchableSnapshotsStatsLevel } export interface SearchableSnapshotsStatsResponse { - stub: integer + stats: any + total: any } export interface SecurityApplicationGlobalUserPrivileges { @@ -12901,27 +14429,39 @@ export interface SecurityClusterNode { name: Name } +export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_ccr' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_watcher' | 'monitor' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'read_ccr' | 'read_ilm' | 'read_pipeline' | 'read_slm' | 'transport_client' + export interface SecurityCreatedStatus { created: boolean } +export interface SecurityFieldRule { + username?: Names + dn?: Names + groups?: Names +} + export interface SecurityFieldSecurity { except?: Fields - grant: Fields + grant?: Fields } -export interface SecurityGlobalPrivileges { +export interface SecurityGlobalPrivilege { application: SecurityApplicationGlobalUserPrivileges } +export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' + export interface SecurityIndicesPrivileges { - field_security?: SecurityFieldSecurity + field_security?: SecurityFieldSecurity | SecurityFieldSecurity[] names: Indices - privileges: string[] - query?: string | QueryDslQueryContainer + privileges: SecurityIndexPrivilege[] + query?: SecurityIndicesPrivilegesQuery allow_restricted_indices?: boolean } +export type SecurityIndicesPrivilegesQuery = string | QueryDslQueryContainer | SecurityRoleTemplateQuery + export interface SecurityManageUserPrivileges { applications: string[] } @@ -12935,10 +14475,40 @@ export interface SecurityRoleMapping { enabled: boolean metadata: Metadata roles: string[] - rules: SecurityRoleMappingRuleBase + rules: SecurityRoleMappingRule + role_templates?: SecurityRoleTemplate[] +} + +export interface SecurityRoleMappingRule { + any?: SecurityRoleMappingRule[] + all?: SecurityRoleMappingRule[] + field?: SecurityFieldRule + except?: SecurityRoleMappingRule +} + +export interface SecurityRoleTemplate { + format?: SecurityTemplateFormat + template: Script +} + +export type SecurityRoleTemplateInlineQuery = string | QueryDslQueryContainer + +export interface SecurityRoleTemplateInlineScript extends ScriptBase { + lang?: ScriptLanguage + options?: Record + source: SecurityRoleTemplateInlineQuery } -export interface SecurityRoleMappingRuleBase { +export interface SecurityRoleTemplateQuery { + template?: SecurityRoleTemplateScript +} + +export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | SecurityRoleTemplateInlineQuery | StoredScriptId + +export type SecurityTemplateFormat = 'string' | 'json' + +export interface SecurityTransientMetadataConfig { + enabled: boolean } export interface SecurityUser { @@ -12950,13 +14520,27 @@ export interface SecurityUser { enabled: boolean } +export interface SecurityUserIndicesPrivileges { + field_security?: SecurityFieldSecurity[] + names: Indices + privileges: SecurityIndexPrivilege[] + query?: SecurityIndicesPrivilegesQuery[] + allow_restricted_indices: boolean +} + +export interface SecurityAuthenticateApiKey { + id: string + name: Name +} + export interface SecurityAuthenticateRequest extends RequestBase { } export interface SecurityAuthenticateResponse { + api_key?: SecurityAuthenticateApiKey authentication_realm: SecurityRealmInfo - email?: string - full_name?: Name + email?: string | null + full_name?: Name | null lookup_realm: SecurityRealmInfo metadata: Metadata roles: string[] @@ -12968,6 +14552,7 @@ export interface SecurityAuthenticateResponse { export interface SecurityAuthenticateToken { name: Name + type?: string } export interface SecurityChangePasswordRequest extends RequestBase { @@ -12975,6 +14560,7 @@ export interface SecurityChangePasswordRequest extends RequestBase { refresh?: Refresh body?: { password?: Password + password_hash?: string } } @@ -12982,7 +14568,7 @@ export interface SecurityChangePasswordResponse { } export interface SecurityClearApiKeyCacheRequest extends RequestBase { - ids?: Ids + ids: Ids } export interface SecurityClearApiKeyCacheResponse { @@ -13034,11 +14620,6 @@ export interface SecurityClearCachedServiceTokensResponse { nodes: Record } -export interface SecurityCreateApiKeyIndexPrivileges { - names: Indices - privileges: string[] -} - export interface SecurityCreateApiKeyRequest extends RequestBase { refresh?: Refresh body?: { @@ -13054,12 +14635,18 @@ export interface SecurityCreateApiKeyResponse { expiration?: long id: Id name: Name + encoded: string } export interface SecurityCreateApiKeyRoleDescriptor { cluster: string[] - index: SecurityCreateApiKeyIndexPrivileges[] + indices: SecurityIndicesPrivileges[] + index: SecurityIndicesPrivileges[] + global?: SecurityGlobalPrivilege[] | SecurityGlobalPrivilege applications?: SecurityApplicationPrivileges[] + metadata?: Metadata + run_as?: string[] + transient_metadata?: SecurityTransientMetadataConfig } export interface SecurityCreateServiceTokenRequest extends RequestBase { @@ -13184,20 +14771,6 @@ export interface SecurityGetPrivilegesRequest extends RequestBase { export interface SecurityGetPrivilegesResponse extends DictionaryResponseBase> { } -export interface SecurityGetRoleInlineRoleTemplate { - template: SecurityGetRoleInlineRoleTemplateSource - format?: SecurityGetRoleTemplateFormat -} - -export interface SecurityGetRoleInlineRoleTemplateSource { - source: string -} - -export interface SecurityGetRoleInvalidRoleTemplate { - template: string - format?: SecurityGetRoleTemplateFormat -} - export interface SecurityGetRoleRequest extends RequestBase { name?: Name } @@ -13212,22 +14785,9 @@ export interface SecurityGetRoleRole { run_as: string[] transient_metadata: SecurityGetRoleTransientMetadata applications: SecurityApplicationPrivileges[] - role_templates?: SecurityGetRoleRoleTemplate[] -} - -export type SecurityGetRoleRoleTemplate = SecurityGetRoleInlineRoleTemplate | SecurityGetRoleStoredRoleTemplate | SecurityGetRoleInvalidRoleTemplate - -export interface SecurityGetRoleStoredRoleTemplate { - template: SecurityGetRoleStoredRoleTemplateId - format?: SecurityGetRoleTemplateFormat -} - -export interface SecurityGetRoleStoredRoleTemplateId { - id: string + role_templates?: SecurityRoleTemplate[] } -export type SecurityGetRoleTemplateFormat = 'string' | 'json' - export interface SecurityGetRoleTransientMetadata { enabled: boolean } @@ -13250,7 +14810,8 @@ export interface SecurityGetServiceAccountsResponse extends DictionaryResponseBa export interface SecurityGetServiceAccountsRoleDescriptor { cluster: string[] indices: SecurityIndicesPrivileges[] - global?: SecurityGlobalPrivileges[] + index: SecurityIndicesPrivileges[] + global?: SecurityGlobalPrivilege[] applications?: SecurityApplicationPrivileges[] metadata?: Metadata run_as?: string[] @@ -13304,7 +14865,7 @@ export interface SecurityGetTokenResponse { expires_in: long scope?: string type: string - refresh_token: string + refresh_token?: string kerberos_authentication_response_token?: string authentication: SecurityGetTokenAuthenticatedUser } @@ -13329,8 +14890,8 @@ export interface SecurityGetUserPrivilegesRequest extends RequestBase { export interface SecurityGetUserPrivilegesResponse { applications: SecurityApplicationPrivileges[] cluster: string[] - global: SecurityGlobalPrivileges[] - indices: SecurityIndicesPrivileges[] + global: SecurityGlobalPrivilege[] + indices: SecurityUserIndicesPrivileges[] run_as: string[] } @@ -13368,8 +14929,8 @@ export interface SecurityHasPrivilegesApplicationPrivilegesCheck { export type SecurityHasPrivilegesApplicationsPrivileges = Record export interface SecurityHasPrivilegesIndexPrivilegesCheck { - names: string[] - privileges: string[] + names: Indices + privileges: SecurityIndexPrivilege[] } export type SecurityHasPrivilegesPrivileges = Record @@ -13378,7 +14939,7 @@ export interface SecurityHasPrivilegesRequest extends RequestBase { user?: Name body?: { application?: SecurityHasPrivilegesApplicationPrivilegesCheck[] - cluster?: string[] + cluster?: SecurityClusterPrivilege[] index?: SecurityHasPrivilegesIndexPrivilegesCheck[] } } @@ -13447,7 +15008,7 @@ export interface SecurityPutRoleRequest extends RequestBase { refresh?: Refresh body?: { applications?: SecurityApplicationPrivileges[] - cluster?: string[] + cluster?: SecurityClusterPrivilege[] global?: Record indices?: SecurityIndicesPrivileges[] metadata?: Metadata @@ -13467,7 +15028,8 @@ export interface SecurityPutRoleMappingRequest extends RequestBase { enabled?: boolean metadata?: Metadata roles?: string[] - rules?: SecurityRoleMappingRuleBase + role_templates?: SecurityRoleTemplate[] + rules?: SecurityRoleMappingRule run_as?: string[] } } @@ -13497,39 +15059,61 @@ export interface SecurityPutUserResponse { } export interface ShutdownDeleteNodeRequest extends RequestBase { - body?: { - stub: string - } + node_id: NodeId +} + +export interface ShutdownDeleteNodeResponse extends AcknowledgedResponseBase { +} + +export interface ShutdownGetNodeNodeShutdownStatus { + node_id: NodeId + type: ShutdownGetNodeShutdownType + reason: string + shutdown_startedmillis: EpochMillis + status: ShutdownGetNodeShutdownStatus + shard_migration: ShutdownGetNodeShardMigrationStatus + persistent_tasks: ShutdownGetNodePersistentTaskStatus + plugins: ShutdownGetNodePluginsStatus +} + +export interface ShutdownGetNodePersistentTaskStatus { + status: ShutdownGetNodeShutdownStatus } -export interface ShutdownDeleteNodeResponse { - stub: boolean +export interface ShutdownGetNodePluginsStatus { + status: ShutdownGetNodeShutdownStatus } export interface ShutdownGetNodeRequest extends RequestBase { - body?: { - stub: string - } + node_id?: NodeIds } export interface ShutdownGetNodeResponse { - stub: boolean + nodes: ShutdownGetNodeNodeShutdownStatus[] } +export interface ShutdownGetNodeShardMigrationStatus { + status: ShutdownGetNodeShutdownStatus +} + +export type ShutdownGetNodeShutdownStatus = 'not_started' | 'in_progress' | 'stalled' | 'complete' + +export type ShutdownGetNodeShutdownType = 'remove' | 'restart' + export interface ShutdownPutNodeRequest extends RequestBase { - body?: { - stub: string - } + node_id: NodeId } -export interface ShutdownPutNodeResponse { - stub: boolean +export interface ShutdownPutNodeResponse extends AcknowledgedResponseBase { } export interface SlmConfiguration { ignore_unavailable?: boolean + indices?: Indices include_global_state?: boolean - indices: Indices + feature_states?: string[] + metadata?: Metadata + partial?: boolean } export interface SlmInProgress { @@ -13545,10 +15129,10 @@ export interface SlmInvocation { } export interface SlmPolicy { - config: SlmConfiguration + config?: SlmConfiguration name: Name repository: string - retention: SlmRetention + retention?: SlmRetention schedule: WatcherCronExpression } @@ -13641,6 +15225,8 @@ export interface SlmGetStatusResponse { export interface SlmPutLifecycleRequest extends RequestBase { policy_id: Name + master_timeout?: Time + timeout?: Time body?: { config?: SlmConfiguration name?: Name @@ -13738,6 +15324,7 @@ export interface SnapshotSnapshotInfo { index_details?: Record metadata?: Metadata reason?: string + repository?: Name snapshot: Name shards?: ShardStatistics start_time?: Time @@ -13762,6 +15349,8 @@ export interface SnapshotSnapshotShardsStatus { stats: SnapshotShardsStatsSummary } +export type SnapshotSnapshotSort = 'start_time' | 'duration' | 'name' | 'index_count' | 'repository' | 'shard_count' | 'failed_shard_count' + export interface SnapshotSnapshotStats { incremental: SnapshotFileCountSnapshotStats start_time_in_millis: long @@ -13786,7 +15375,7 @@ export interface SnapshotCleanupRepositoryCleanupRepositoryResults { } export interface SnapshotCleanupRepositoryRequest extends RequestBase { - repository: Name + name: Name master_timeout?: Time timeout?: Time } @@ -13818,6 +15407,7 @@ export interface SnapshotCreateRequest extends RequestBase { ignore_unavailable?: boolean include_global_state?: boolean indices?: Indices + feature_states?: string[] metadata?: Metadata partial?: boolean } @@ -13829,7 +15419,7 @@ export interface SnapshotCreateResponse { } export interface SnapshotCreateRepositoryRequest extends RequestBase { - repository: Name + name: Name master_timeout?: Time timeout?: Time verify?: boolean @@ -13853,7 +15443,7 @@ export interface SnapshotDeleteResponse extends AcknowledgedResponseBase { } export interface SnapshotDeleteRepositoryRequest extends RequestBase { - repository: Names + name: Names master_timeout?: Time timeout?: Time } @@ -13869,11 +15459,21 @@ export interface SnapshotGetRequest extends RequestBase { verbose?: boolean index_details?: boolean human?: boolean + include_repository?: boolean + sort?: SnapshotSnapshotSort + size?: integer + order?: SortOrder + after?: string + offset?: integer + from_sort_value?: string + slm_policy_filter?: Name } export interface SnapshotGetResponse { responses?: SnapshotGetSnapshotResponseItem[] snapshots?: SnapshotSnapshotInfo[] + total: integer + remaining: integer } export interface SnapshotGetSnapshotResponseItem { @@ -13883,7 +15483,7 @@ export interface SnapshotGetSnapshotResponseItem { } export interface SnapshotGetRepositoryRequest extends RequestBase { - repository?: Names + name?: Names local?: boolean master_timeout?: Time } @@ -13897,6 +15497,7 @@ export interface SnapshotRestoreRequest extends RequestBase { master_timeout?: Time wait_for_completion?: boolean body?: { + feature_states?: string[] ignore_index_settings?: string[] ignore_unavailable?: boolean include_aliases?: boolean @@ -13935,7 +15536,7 @@ export interface SnapshotVerifyRepositoryCompactNodeInfo { } export interface SnapshotVerifyRepositoryRequest extends RequestBase { - repository: Name + name: Name master_timeout?: Time timeout?: Time } @@ -13962,6 +15563,7 @@ export interface SqlQueryColumn { export interface SqlQueryRequest extends RequestBase { format?: string body?: { + catalog?: string columnar?: boolean cursor?: string fetch_size?: integer @@ -13971,6 +15573,12 @@ export interface SqlQueryRequest extends RequestBase { page_timeout?: Time time_zone?: string field_multi_value_leniency?: boolean + runtime_mappings?: MappingRuntimeFields + wait_for_completion_timeout?: Time + params?: Record + keep_alive?: Time + keep_on_completion?: boolean + index_using_frozen?: boolean } } @@ -13992,43 +15600,49 @@ export interface SqlTranslateRequest extends RequestBase { } export interface SqlTranslateResponse { - size: long - _source: boolean | Fields | SearchSourceFilter - fields: Record[] - sort: SearchSort + aggregations?: Record + size?: long + _source?: SearchSourceConfig + fields?: (QueryDslFieldAndFormat | Field)[] + query?: QueryDslQueryContainer + sort?: Sort } -export interface SslGetCertificatesCertificateInformation { - alias?: string +export interface SslCertificatesCertificateInformation { + alias: string | null expiry: DateString format: string has_private_key: boolean + issuer?: string path: string serial_number: string subject_dn: string } -export interface SslGetCertificatesRequest extends RequestBase { +export interface SslCertificatesRequest extends RequestBase { } -export type SslGetCertificatesResponse = SslGetCertificatesCertificateInformation[] +export type SslCertificatesResponse = SslCertificatesCertificateInformation[] -export interface TaskInfo { +export type TasksGroupBy = 'nodes' | 'parents' | 'none' + +export interface TasksInfo { action: string + cancelled?: boolean cancellable: boolean - children?: TaskInfo[] + children?: TasksInfo[] description?: string headers: HttpHeaders id: long node: string running_time_in_nanos: long start_time_in_millis: long - status?: TaskStatus + status?: any type: string parent_task_id?: Id } -export interface TaskState { +export interface TasksState { action: string cancellable: boolean description?: string @@ -14038,35 +15652,15 @@ export interface TaskState { parent_task_id?: TaskId running_time_in_nanos: long start_time_in_millis: long - status?: TaskStatus + status?: any type: string } -export interface TaskStatus { - batches: long - canceled?: string - created: long - deleted: long - noops: long - failures?: string[] - requests_per_second: float - retries: Retries - throttled?: Time - throttled_millis: long - throttled_until?: Time - throttled_until_millis: long - timed_out?: boolean - took?: long - total: long - updated: long - version_conflicts: long -} - -export interface TaskTaskExecutingNode extends SpecUtilsBaseNode { - tasks: Record +export interface TasksTaskExecutingNode extends SpecUtilsBaseNode { + tasks: Record } -export interface TaskCancelRequest extends RequestBase { +export interface TasksCancelRequest extends RequestBase { task_id?: TaskId actions?: string | string[] nodes?: string[] @@ -14074,38 +15668,38 @@ export interface TaskCancelRequest extends RequestBase { wait_for_completion?: boolean } -export interface TaskCancelResponse { +export interface TasksCancelResponse { node_failures?: ErrorCause[] - nodes: Record + nodes: Record } -export interface TaskGetRequest extends RequestBase { +export interface TasksGetRequest extends RequestBase { task_id: Id timeout?: Time wait_for_completion?: boolean } -export interface TaskGetResponse { +export interface TasksGetResponse { completed: boolean - task: TaskInfo - response?: TaskStatus + task: TasksInfo + response?: any error?: ErrorCause } -export interface TaskListRequest extends RequestBase { +export interface TasksListRequest extends RequestBase { actions?: string | string[] detailed?: boolean - group_by?: GroupBy + group_by?: TasksGroupBy nodes?: string[] parent_task_id?: Id timeout?: Time wait_for_completion?: boolean } -export interface TaskListResponse { +export interface TasksListResponse { node_failures?: ErrorCause[] - nodes?: Record - tasks?: Record | TaskInfo[] + nodes?: Record + tasks?: Record } export interface TextStructureFindStructureFieldStat { @@ -14176,8 +15770,7 @@ export interface TransformLatest { export interface TransformPivot { aggregations?: Record aggs?: Record - group_by: Record - max_page_search_size?: integer + group_by?: Record } export interface TransformPivotGroupByContainer { @@ -14193,17 +15786,24 @@ export interface TransformRetentionPolicy { } export interface TransformRetentionPolicyContainer { - time: TransformRetentionPolicy + time?: TransformRetentionPolicy } export interface TransformSettings { + align_checkpoints?: boolean dates_as_epoch_millis?: boolean docs_per_second?: float max_page_search_size?: integer } +export interface TransformSource { + index: Indices + query?: QueryDslQueryContainer + runtime_mappings?: MappingRuntimeFields +} + export interface TransformSyncContainer { - time: TransformTimeSync + time?: TransformTimeSync } export interface TransformTimeSync { @@ -14212,15 +15812,16 @@ export interface TransformTimeSync { } export interface TransformDeleteTransformRequest extends RequestBase { - transform_id: Name + transform_id: Id force?: boolean + timeout?: Time } export interface TransformDeleteTransformResponse extends AcknowledgedResponseBase { } export interface TransformGetTransformRequest extends RequestBase { - transform_id?: Name + transform_id?: Names allow_no_match?: boolean from?: integer size?: integer @@ -14229,7 +15830,22 @@ export interface TransformGetTransformRequest extends RequestBase { export interface TransformGetTransformResponse { count: long - transforms: Transform[] + transforms: TransformGetTransformTransformSummary[] +} + +export interface TransformGetTransformTransformSummary { + dest: ReindexDestination + description?: string + frequency?: Time + id: Id + pivot?: TransformPivot + settings?: TransformSettings + source: TransformSource + sync?: TransformSyncContainer + create_time?: EpochMillis + version?: VersionString + latest?: TransformLatest + _meta?: Metadata } export interface TransformGetTransformStatsCheckpointStats { @@ -14250,7 +15866,7 @@ export interface TransformGetTransformStatsCheckpointing { } export interface TransformGetTransformStatsRequest extends RequestBase { - transform_id: Name + transform_id: Names allow_no_match?: boolean from?: long size?: long @@ -14297,6 +15913,8 @@ export interface TransformGetTransformStatsTransformStats { } export interface TransformPreviewTransformRequest extends RequestBase { + transform_id?: Id + timeout?: Time body?: { dest?: ReindexDestination description?: string @@ -14315,16 +15933,29 @@ export interface TransformPreviewTransformResponse { preview: TTransform[] } -export interface TransformPutTransformRequest extends TransformPreviewTransformRequest { +export interface TransformPutTransformRequest extends RequestBase { transform_id: Id defer_validation?: boolean + timeout?: Time + body?: { + dest: ReindexDestination + description?: string + frequency?: Time + latest?: TransformLatest + _meta?: Record + pivot?: TransformPivot + retention_policy?: TransformRetentionPolicyContainer + settings?: TransformSettings + source: ReindexSource + sync?: TransformSyncContainer + } } export interface TransformPutTransformResponse extends AcknowledgedResponseBase { } export interface TransformStartTransformRequest extends RequestBase { - transform_id: Name + transform_id: Id timeout?: Time } @@ -14343,7 +15974,19 @@ export interface TransformStopTransformRequest extends RequestBase { export interface TransformStopTransformResponse extends AcknowledgedResponseBase { } -export interface TransformUpdateTransformRequest extends TransformPutTransformRequest { +export interface TransformUpdateTransformRequest extends RequestBase { + transform_id: Id + defer_validation?: boolean + timeout?: Time + body?: { + dest?: ReindexDestination + description?: string + frequency?: Time + source?: ReindexSource + settings?: TransformSettings + sync?: TransformSyncContainer + retention_policy?: TransformRetentionPolicyContainer + } } export interface TransformUpdateTransformResponse { @@ -14352,13 +15995,26 @@ export interface TransformUpdateTransformResponse { dest: ReindexDestination frequency: Time id: Id - pivot: TransformPivot + latest?: TransformLatest + pivot?: TransformPivot + retention_policy?: TransformRetentionPolicyContainer settings: TransformSettings source: ReindexSource sync?: TransformSyncContainer version: VersionString } +export interface TransformUpgradeTransformsRequest extends RequestBase { + dry_run?: boolean + timeout?: Time +} + +export interface TransformUpgradeTransformsResponse { + needs_update: integer + no_action: integer + updated: integer +} + export interface WatcherAcknowledgeState { state: WatcherAcknowledgementOptions timestamp: DateString @@ -14377,6 +16033,7 @@ export interface WatcherAction { transform?: TransformContainer index?: WatcherIndex logging?: WatcherLogging + webhook?: WatcherActionWebhook } export type WatcherActionExecutionMode = 'simulate' | 'force_simulate' | 'execute' | 'force_execute' | 'skip' @@ -14392,6 +16049,11 @@ export type WatcherActionStatusOptions = 'success' | 'failure' | 'simulated' | ' export type WatcherActionType = 'email' | 'webhook' | 'index' | 'logging' | 'slack' | 'pagerduty' +export interface WatcherActionWebhook { + host: Host + port: integer +} + export type WatcherActions = Record export interface WatcherActivationState { @@ -14406,53 +16068,42 @@ export interface WatcherActivationStatus { } export interface WatcherAlwaysCondition { + [key: string]: never } -export interface WatcherArrayCompareCondition { - array_path: string - comparison: string +export interface WatcherArrayCompareConditionKeys { path: string - quantifier: WatcherQuantifier - value: any -} - -export interface WatcherChainInput { - inputs: WatcherInputContainer[] } +export type WatcherArrayCompareCondition = WatcherArrayCompareConditionKeys + & { [property: string]: WatcherArrayCompareOpParams | string } -export interface WatcherCompareCondition { - comparison?: string - path?: string - value?: any - 'ctx.payload.match'?: WatcherCompareContextPayloadCondition - 'ctx.payload.value'?: WatcherCompareContextPayloadCondition +export interface WatcherArrayCompareOpParams { + quantifier: WatcherQuantifier + value: FieldValue } -export interface WatcherCompareContextPayloadCondition { - eq?: any - lt?: any - gt?: any - lte?: any - gte?: any +export interface WatcherChainInput { + inputs: Partial>[] } export interface WatcherConditionContainer { always?: WatcherAlwaysCondition - array_compare?: WatcherArrayCompareCondition - compare?: WatcherCompareCondition + array_compare?: Partial> + compare?: Partial>>> never?: WatcherNeverCondition script?: WatcherScriptCondition } +export type WatcherConditionOp = 'not_eq' | 'eq' | 'lt' | 'gt' | 'lte' | 'gte' + export type WatcherConditionType = 'always' | 'never' | 'script' | 'compare' | 'array_compare' export type WatcherConnectionScheme = 'http' | 'https' -export interface WatcherCronExpression extends WatcherScheduleBase { -} +export type WatcherCronExpression = string export interface WatcherDailySchedule { - at: string[] | WatcherTimeOfDay + at: WatcherTimeOfDay[] } export type WatcherDay = 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' @@ -14510,12 +16161,16 @@ export interface WatcherExecutionThreadPool { queue_size: long } +export interface WatcherHourAndMinute { + hour: integer[] + minute: integer[] +} + export interface WatcherHourlySchedule { minute: integer[] } export interface WatcherHttpInput { - http?: WatcherHttpInput extract?: string[] request?: WatcherHttpInputRequestDefinition response_content_type?: WatcherResponseContentType @@ -14565,6 +16220,7 @@ export interface WatcherHttpInputResponseResult { export interface WatcherIndex { index: IndexName doc_id?: Id + refresh?: Refresh } export interface WatcherIndexResult { @@ -14580,13 +16236,6 @@ export interface WatcherIndexResultSummary { type?: Type } -export interface WatcherIndicesOptions { - allow_no_indices: boolean - expand_wildcards: ExpandWildcards - ignore_unavailable: boolean - ignore_throttled?: boolean -} - export interface WatcherInputContainer { chain?: WatcherChainInput http?: WatcherHttpInput @@ -14597,8 +16246,9 @@ export interface WatcherInputContainer { export type WatcherInputType = 'http' | 'search' | 'simple' export interface WatcherLogging { - level: string + level?: string text: string + category?: string } export interface WatcherLoggingResult { @@ -14608,6 +16258,7 @@ export interface WatcherLoggingResult { export type WatcherMonth = 'january' | 'february' | 'march' | 'april' | 'may' | 'june' | 'july' | 'august' | 'september' | 'october' | 'november' | 'december' export interface WatcherNeverCondition { + [key: string]: never } export interface WatcherPagerDutyActionEventResult { @@ -14644,11 +16295,16 @@ export interface WatcherPagerDutyResult { export type WatcherQuantifier = 'some' | 'all' -export type WatcherResponseContentType = 'json' | 'yaml' | 'text' - -export interface WatcherScheduleBase { +export interface WatcherQueryWatch { + _id: Id + status?: WatcherWatchStatus + watch?: WatcherWatch + _primary_term?: integer + _seq_no?: SequenceNumber } +export type WatcherResponseContentType = 'json' | 'yaml' | 'text' + export interface WatcherScheduleContainer { cron?: WatcherCronExpression daily?: WatcherDailySchedule @@ -14660,8 +16316,8 @@ export interface WatcherScheduleContainer { } export interface WatcherScheduleTriggerEvent { - scheduled_time: DateString | string - triggered_time?: DateString | string + scheduled_time: DateString + triggered_time?: DateString } export interface WatcherScriptCondition { @@ -14683,7 +16339,7 @@ export interface WatcherSearchInputRequestBody { export interface WatcherSearchInputRequestDefinition { body?: WatcherSearchInputRequestBody indices?: IndexName[] - indices_options?: WatcherIndicesOptions + indices_options?: IndicesOptions search_type?: SearchType template?: SearchTemplateRequest rest_total_hits_as_int?: boolean @@ -14743,10 +16399,7 @@ export interface WatcherThrottleState { timestamp: DateString } -export interface WatcherTimeOfDay { - hour: integer[] - minute: integer[] -} +export type WatcherTimeOfDay = string | WatcherHourAndMinute export interface WatcherTimeOfMonth { at: string[] @@ -14765,11 +16418,11 @@ export interface WatcherTimeOfYear { } export interface WatcherTriggerContainer { - schedule: WatcherScheduleContainer + schedule?: WatcherScheduleContainer } export interface WatcherTriggerEventContainer { - schedule: WatcherScheduleTriggerEvent + schedule?: WatcherScheduleTriggerEvent } export interface WatcherTriggerEventResult { @@ -14889,7 +16542,7 @@ export interface WatcherPutWatchRequest extends RequestBase { id: Id active?: boolean if_primary_term?: long - if_sequence_number?: long + if_seq_no?: SequenceNumber version?: VersionNumber body?: { actions?: Record @@ -14911,15 +16564,18 @@ export interface WatcherPutWatchResponse { } export interface WatcherQueryWatchesRequest extends RequestBase { - stub_a: string - stub_b: string body?: { - stub_c: string + from?: integer + size?: integer + query?: QueryDslQueryContainer + sort?: Sort + search_after?: SortResults } } export interface WatcherQueryWatchesResponse { - stub: integer + count: integer + watches: WatcherQueryWatch[] } export interface WatcherStartRequest extends RequestBase { @@ -14952,7 +16608,7 @@ export interface WatcherStatsWatchRecordStats extends WatcherStatsWatchRecordQue watch_record_id: Id } -export type WatcherStatsWatcherMetric = '_all' | 'queued_watches' | 'current_watches' | 'pending_watches' +export type WatcherStatsWatcherMetric = '_all' | 'all' | 'queued_watches' | 'current_watches' | 'pending_watches' export interface WatcherStatsWatcherNodeStats { current_watches?: WatcherStatsWatchRecordStats[] @@ -15008,7 +16664,7 @@ export interface XpackInfoFeatures { spatial: XpackInfoFeature sql: XpackInfoFeature transform: XpackInfoFeature - vectors: XpackInfoFeature + vectors?: XpackInfoFeature voting_only: XpackInfoFeature watcher: XpackInfoFeature } @@ -15062,11 +16718,6 @@ export interface XpackUsageBase { enabled: boolean } -export interface XpackUsageBaseUrlConfig { - url_name: string - url_value: string -} - export interface XpackUsageCcr extends XpackUsageBase { auto_follow_patterns_count: integer follower_indices_count: integer @@ -15179,13 +16830,17 @@ export interface XpackUsageIpFilter { transport: boolean } -export interface XpackUsageKibanaUrlConfig extends XpackUsageBaseUrlConfig { - time_range?: string +export interface XpackUsageJobUsage { + count: integer + created_by: Record + detectors: MlJobStatistics + forecasts: XpackUsageMlJobForecasts + model_size: MlJobStatistics } export interface XpackUsageMachineLearning extends XpackUsageBase { datafeeds: Record - jobs: Record + jobs: Record node_count: integer data_frame_analytics_jobs: XpackUsageMlDataFrameAnalyticsJobs inference: XpackUsageMlInference @@ -15238,10 +16893,16 @@ export interface XpackUsageMlInferenceTrainedModelsCount { total: long prepackaged: long other: long + pass_through?: long regression: long classification: long } +export interface XpackUsageMlJobForecasts { + total: long + forecasted_jobs: long +} + export interface XpackUsageMonitoring extends XpackUsageBase { collection_enabled: boolean enabled_exporters: Record @@ -15299,7 +16960,7 @@ export interface XpackUsageResponse { slm: XpackUsageSlm sql: XpackUsageSql transform: XpackUsageBase - vectors: XpackUsageVector + vectors?: XpackUsageVector voting_only: XpackUsageBase } @@ -15393,8 +17054,6 @@ export interface XpackUsageSsl { transport: XpackUsageFeatureToggle } -export type XpackUsageUrlConfig = XpackUsageBaseUrlConfig | XpackUsageKibanaUrlConfig - export interface XpackUsageVector extends XpackUsageBase { dense_vector_dims_avg_count: integer dense_vector_fields_count: integer @@ -15434,6 +17093,11 @@ export interface XpackUsageWatcherWatchTriggerSchedule extends XpackUsageCounter } export interface SpecUtilsAdditionalProperties { + [key: string]: never +} + +export interface SpecUtilsAdditionalProperty { + [key: string]: never } export interface SpecUtilsCommonQueryParameters { @@ -15441,10 +17105,6 @@ export interface SpecUtilsCommonQueryParameters { filter_path?: string | string[] human?: boolean pretty?: boolean - source_query_string?: string -} - -export interface SpecUtilsAdditionalProperty { } export interface SpecUtilsCommonCatQueryParameters { @@ -15457,3 +17117,7 @@ export interface SpecUtilsCommonCatQueryParameters { v?: boolean } +export interface SpecUtilsOverloadOf { + [key: string]: never +} + diff --git a/run-validations.sh b/run-validations.sh deleted file mode 100755 index 20b11698bc..0000000000 --- a/run-validations.sh +++ /dev/null @@ -1,35 +0,0 @@ -#!/usr/bin/env bash - -function require_stack_version() { - if [[ -z $STACK_VERSION ]]; then - echo -e "\033[31;1mERROR:\033[0m Required environment variable [STACK_VERSION] not set\033[0m" - exit 1 - fi -} - -require_stack_version - -set -euo pipefail - -npm install --prefix compiler -npm install --prefix typescript-generator - -npm run compile:specification --prefix compiler -npm run generate-schema --prefix compiler -npm run start --prefix typescript-generator - -recorderFolder="../clients-flight-recorder" -recorderScript="${recorderFolder}/run-validations.sh" -if [[ ! -f "${recorderScript}" ]]; then - echo "Skipping running spec validation tests, not found: ${recorderScript}" - exit -fi - -# assumes the flight recorder is checked out next to generator -pushd "${recorderFolder}" -function finish { popd; } -trap finish EXIT -STACK_VERSION=${STACK_VERSION} ./run-validations.sh $@ - - - diff --git a/specification/_global/bulk/BulkRequest.ts b/specification/_global/bulk/BulkRequest.ts index dad77e356f..014e99929b 100644 --- a/specification/_global/bulk/BulkRequest.ts +++ b/specification/_global/bulk/BulkRequest.ts @@ -27,7 +27,8 @@ import { WaitForActiveShards } from '@_types/common' import { Time } from '@_types/Time' -import { OperationContainer } from './types' +import { OperationContainer, UpdateAction } from './types' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * @rest_spec_name bulk @@ -35,22 +36,29 @@ import { OperationContainer } from './types' * @stability stable * */ -export interface Request extends RequestBase { - path_parts?: { +export interface Request extends RequestBase { + path_parts: { index?: IndexName type?: Type } - query_parameters?: { + query_parameters: { pipeline?: string refresh?: Refresh routing?: Routing - _source?: boolean | Fields + _source?: SourceConfigParam _source_excludes?: Fields _source_includes?: Fields timeout?: Time - type?: string + type?: Type wait_for_active_shards?: WaitForActiveShards require_alias?: boolean } - body?: Array + /** @codegen_name operations */ + // This declaration captures action_and_meta_data (OperationContainer) and the two kinds of sources + // that can follow: an update action for update operations and anything for index or create operations. + // + // /!\ must be kept in sync with BulkMonitoringRequest + body?: Array< + OperationContainer | UpdateAction | TDocument + > } diff --git a/specification/_global/bulk/BulkResponse.ts b/specification/_global/bulk/BulkResponse.ts index 711e768022..c5789fccc0 100644 --- a/specification/_global/bulk/BulkResponse.ts +++ b/specification/_global/bulk/BulkResponse.ts @@ -18,12 +18,13 @@ */ import { long } from '@_types/Numeric' -import { ResponseItemContainer } from './types' +import { OperationType, ResponseItem } from './types' +import { SingleKeyDictionary } from '@spec_utils/Dictionary' export class Response { body: { errors: boolean - items: ResponseItemContainer[] + items: SingleKeyDictionary[] took: long ingest_took?: long } diff --git a/specification/_global/bulk/types.ts b/specification/_global/bulk/types.ts index c8d4b198df..5596161f63 100644 --- a/specification/_global/bulk/types.ts +++ b/specification/_global/bulk/types.ts @@ -16,7 +16,6 @@ * specific language governing permissions and limitations * under the License. */ -// TODO remap this as a good bulk response item and an error response item import { InlineGet } from '@_types/common' import { Dictionary } from '@spec_utils/Dictionary' @@ -32,8 +31,10 @@ import { import { ErrorCause } from '@_types/Errors' import { integer, long } from '@_types/Numeric' import { ShardStatistics } from '@_types/Stats' +import { Script } from '@_types/Scripting' +import { SourceConfig } from '@global/search/_types/SourceFilter' -export class ResponseItemBase { +export class ResponseItem { _id?: string | null _index: string status: integer @@ -49,29 +50,38 @@ export class ResponseItemBase { get?: InlineGet> } -/** @variants container */ -export class ResponseItemContainer { - index?: IndexResponseItem - create?: CreateResponseItem - update?: UpdateResponseItem - delete?: DeleteResponseItem +export enum OperationType { + index, + create, + update, + delete +} + +export class OperationBase { + _id?: Id + _index?: IndexName + routing?: Routing + if_primary_term?: long + if_seq_no?: SequenceNumber + version?: VersionNumber + version_type?: VersionType } -export class IndexResponseItem extends ResponseItemBase {} +export class WriteOperation extends OperationBase { + dynamic_templates?: Dictionary + pipeline?: string + require_alias?: boolean +} -export class CreateResponseItem extends ResponseItemBase {} +export class CreateOperation extends WriteOperation {} -export class UpdateResponseItem extends ResponseItemBase {} +export class IndexOperation extends WriteOperation {} -export class DeleteResponseItem extends ResponseItemBase {} +export class DeleteOperation extends OperationBase {} -export class Operation { - _id: Id - _index: IndexName - retry_on_conflict: integer - routing: Routing - version: VersionNumber - version_type: VersionType +export class UpdateOperation extends OperationBase { + require_alias?: boolean + retry_on_conflict?: integer } /** @variants container */ @@ -82,10 +92,40 @@ export class OperationContainer { delete?: DeleteOperation } -export class IndexOperation extends Operation {} - -export class CreateOperation extends Operation {} - -export class UpdateOperation extends Operation {} - -export class DeleteOperation extends Operation {} +export class UpdateAction { + /** + * Set to false to disable setting 'result' in the response + * to 'noop' if no change to the document occurred. + * @server_default true + */ + detect_noop?: boolean + /** + * A partial update to an existing document. + */ + doc?: TPartialDocument + /** + * Set to true to use the contents of 'doc' as the value of 'upsert' + * @server_default false + */ + doc_as_upsert?: boolean + /** + * Script to execute to update the document. + */ + script?: Script + /** + * Set to true to execute the script whether or not the document exists. + * @server_default false + */ + scripted_upsert?: boolean + /** + * Set to false to disable source retrieval. You can also specify a comma-separated + * list of the fields you want to retrieve. + * @server_default true + */ + _source?: SourceConfig + /** + * If the document does not already exist, the contents of 'upsert' are inserted as a + * new document. If the document exists, the 'script' is executed. + */ + upsert?: TDocument +} diff --git a/specification/_global/clear_scroll/ClearScrollRequest.ts b/specification/_global/clear_scroll/ClearScrollRequest.ts index ebf14e050f..4a826e609e 100644 --- a/specification/_global/clear_scroll/ClearScrollRequest.ts +++ b/specification/_global/clear_scroll/ClearScrollRequest.ts @@ -23,14 +23,13 @@ import { Ids } from '@_types/common' /** * @rest_spec_name clear_scroll * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { scroll_id?: Ids } - query_parameters?: {} - body?: { + body: { scroll_id?: Ids } } diff --git a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts index c0d1b26367..0321ae7dd6 100644 --- a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts +++ b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts @@ -23,12 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name close_point_in_time * @since 7.10.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: {} - query_parameters?: {} - body?: { + body: { id: Id } } diff --git a/specification/_global/count/CountRequest.ts b/specification/_global/count/CountRequest.ts index b6573a76a5..62e9dcc255 100644 --- a/specification/_global/count/CountRequest.ts +++ b/specification/_global/count/CountRequest.ts @@ -18,31 +18,26 @@ */ import { RequestBase } from '@_types/Base' -import { - DefaultOperator, - ExpandWildcards, - Indices, - Routing, - Types -} from '@_types/common' +import { ExpandWildcards, Indices, Routing, Types } from '@_types/common' import { double, long } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' +import { Operator } from '@_types/query_dsl/Operator' /** * @rest_spec_name count * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean - default_operator?: DefaultOperator + default_operator?: Operator df?: string expand_wildcards?: ExpandWildcards ignore_throttled?: boolean @@ -50,12 +45,11 @@ export interface Request extends RequestBase { lenient?: boolean min_score?: double preference?: string - query_on_query_string?: string routing?: Routing terminate_after?: long q?: string } - body?: { + body: { query?: QueryContainer } } diff --git a/specification/_global/create/CreateRequest.ts b/specification/_global/create/CreateRequest.ts index f745590e2c..81c9081efd 100644 --- a/specification/_global/create/CreateRequest.ts +++ b/specification/_global/create/CreateRequest.ts @@ -37,12 +37,12 @@ import { Time } from '@_types/Time' * */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { pipeline?: string refresh?: Refresh routing?: Routing @@ -51,5 +51,6 @@ export interface Request extends RequestBase { version_type?: VersionType wait_for_active_shards?: WaitForActiveShards } + /** @codegen_name document */ body?: TDocument } diff --git a/specification/_global/delete/DeleteRequest.ts b/specification/_global/delete/DeleteRequest.ts index dbf97f70bc..6271204c45 100644 --- a/specification/_global/delete/DeleteRequest.ts +++ b/specification/_global/delete/DeleteRequest.ts @@ -35,15 +35,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name delete * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { if_primary_term?: long if_seq_no?: SequenceNumber refresh?: Refresh @@ -53,5 +53,4 @@ export interface Request extends RequestBase { version_type?: VersionType wait_for_active_shards?: WaitForActiveShards } - body?: {} } diff --git a/specification/_global/delete_by_query/DeleteByQueryRequest.ts b/specification/_global/delete_by_query/DeleteByQueryRequest.ts index f0f11867ce..430d3f85a1 100644 --- a/specification/_global/delete_by_query/DeleteByQueryRequest.ts +++ b/specification/_global/delete_by_query/DeleteByQueryRequest.ts @@ -20,36 +20,36 @@ import { RequestBase } from '@_types/Base' import { Conflicts, - DefaultOperator, ExpandWildcards, - Fields, Indices, Routing, SearchType, Types, + Slices, WaitForActiveShards } from '@_types/common' import { long } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' import { SlicedScroll } from '@_types/SlicedScroll' import { Time } from '@_types/Time' +import { Operator } from '@_types/query_dsl/Operator' /** * @rest_spec_name delete_by_query * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean conflicts?: Conflicts - default_operator?: DefaultOperator + default_operator?: Operator df?: string expand_wildcards?: ExpandWildcards from?: long @@ -67,11 +67,8 @@ export interface Request extends RequestBase { search_timeout?: Time search_type?: SearchType size?: long - slices?: long + slices?: Slices sort?: string[] - _source?: boolean | Fields - _source_excludes?: Fields - _source_includes?: Fields stats?: string[] terminate_after?: long timeout?: Time @@ -79,7 +76,7 @@ export interface Request extends RequestBase { wait_for_active_shards?: WaitForActiveShards wait_for_completion?: boolean } - body?: { + body: { max_docs?: long query?: QueryContainer slice?: SlicedScroll diff --git a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts index d63337cb9c..d2d4461e51 100644 --- a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts +++ b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts @@ -24,14 +24,13 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name delete_by_query_rethrottle * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { task_id: Id } - query_parameters?: { + query_parameters: { requests_per_second?: long } - body?: {} } diff --git a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts index 8feb076af3..ed1e03b70c 100644 --- a/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts +++ b/specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleResponse.ts @@ -17,6 +17,6 @@ * under the License. */ -import { Response as ListTasksResponse } from '@task/list/ListTasksResponse' +import { Response as ListTasksResponse } from '@tasks/list/ListTasksResponse' export class Response extends ListTasksResponse {} diff --git a/specification/_global/delete_script/DeleteScriptRequest.ts b/specification/_global/delete_script/DeleteScriptRequest.ts index 8dc926a13a..ff7d53df89 100644 --- a/specification/_global/delete_script/DeleteScriptRequest.ts +++ b/specification/_global/delete_script/DeleteScriptRequest.ts @@ -24,15 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name delete_script * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: {} } diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts index 2a6f0d0a44..9cf152bc2a 100644 --- a/specification/_global/exists/DocumentExistsRequest.ts +++ b/specification/_global/exists/DocumentExistsRequest.ts @@ -27,29 +27,29 @@ import { VersionNumber, VersionType } from '@_types/common' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * @rest_spec_name exists * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { preference?: string realtime?: boolean refresh?: boolean routing?: Routing - source_enabled?: boolean - source_excludes?: Fields - source_includes?: Fields + _source?: SourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields stored_fields?: Fields version?: VersionNumber version_type?: VersionType } - body?: {} } diff --git a/specification/_global/exists_source/SourceExistsRequest.ts b/specification/_global/exists_source/SourceExistsRequest.ts index 1307ce90a6..66e6c94106 100644 --- a/specification/_global/exists_source/SourceExistsRequest.ts +++ b/specification/_global/exists_source/SourceExistsRequest.ts @@ -27,28 +27,28 @@ import { VersionNumber, VersionType } from '@_types/common' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * @rest_spec_name exists_source * @since 5.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { preference?: string realtime?: boolean refresh?: boolean routing?: Routing - source_enabled?: boolean - source_excludes?: Fields - source_includes?: Fields + _source?: SourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields version?: VersionNumber version_type?: VersionType } - body?: {} } diff --git a/specification/_global/explain/ExplainRequest.ts b/specification/_global/explain/ExplainRequest.ts index 8c16a7964e..e628925879 100644 --- a/specification/_global/explain/ExplainRequest.ts +++ b/specification/_global/explain/ExplainRequest.ts @@ -18,43 +18,37 @@ */ import { RequestBase } from '@_types/Base' -import { - DefaultOperator, - Fields, - Id, - IndexName, - Routing, - Type -} from '@_types/common' +import { Fields, Id, IndexName, Routing, Type } from '@_types/common' import { QueryContainer } from '@_types/query_dsl/abstractions' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' +import { Operator } from '@_types/query_dsl/Operator' /** * @rest_spec_name explain * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { analyzer?: string analyze_wildcard?: boolean - default_operator?: DefaultOperator + default_operator?: Operator df?: string lenient?: boolean preference?: string - query_on_query_string?: string routing?: Routing - _source?: boolean | Fields + _source?: SourceConfigParam _source_excludes?: Fields _source_includes?: Fields stored_fields?: Fields q?: string } - body?: { + body: { query?: QueryContainer } } diff --git a/specification/_global/field_caps/FieldCapabilitiesRequest.ts b/specification/_global/field_caps/FieldCapabilitiesRequest.ts index 71d4c7ef39..26437c2631 100644 --- a/specification/_global/field_caps/FieldCapabilitiesRequest.ts +++ b/specification/_global/field_caps/FieldCapabilitiesRequest.ts @@ -18,50 +18,60 @@ */ import { RequestBase } from '@_types/Base' -import { EmptyObject, ExpandWildcards, Fields, Indices } from '@_types/common' -import { integer } from '@_types/Numeric' +import { ExpandWildcards, Fields, Indices } from '@_types/common' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' +import { QueryContainer } from '@_types/query_dsl/abstractions' /** * @rest_spec_name field_caps * @since 5.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. + */ index?: Indices } - query_parameters?: { + query_parameters: { + /** + * If false, the request returns an error if any wildcard expression, index alias, + * or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + * targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + * @server_default true + */ allow_no_indices?: boolean + /** + * Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. + * @server_default open + */ expand_wildcards?: ExpandWildcards + /** + * Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + */ fields?: Fields + /** + * If `true`, missing or closed indices are not included in the response. + * @server_default false + */ ignore_unavailable?: boolean + /** + * If true, unmapped fields are included in the response. + * @server_default false + */ include_unmapped?: boolean } - body?: { - index_filter?: FieldCapabilitiesBodyIndexFilter + body: { + /** + * Allows to filter indices if the provided query rewrites to match_none on every shard. + */ + index_filter?: QueryContainer + /** + * Defines ad-hoc runtime fields in the request similar to the way it is done in search requests. + * These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. + * @since 7.12.0 + */ + runtime_mappings?: RuntimeFields } } -export class FieldCapabilitiesBodyIndexFilter { - range?: FieldCapabilitiesBodyIndexFilterRange - match_none?: EmptyObject - term?: FieldCapabilitiesBodyIndexFilterTerm -} - -export class FieldCapabilitiesBodyIndexFilterRange { - timestamp: FieldCapabilitiesBodyIndexFilterRangeTimestamp -} - -export class FieldCapabilitiesBodyIndexFilterRangeTimestamp { - gte?: integer - gt?: integer - lte?: integer - lt?: integer -} - -export class FieldCapabilitiesBodyIndexFilterTerm { - versionControl: FieldCapabilitiesBodyIndexFilterTermVersionControl -} - -export class FieldCapabilitiesBodyIndexFilterTermVersionControl { - value: string -} diff --git a/specification/_global/field_caps/types.ts b/specification/_global/field_caps/types.ts index d363c80312..390cfa7ab0 100644 --- a/specification/_global/field_caps/types.ts +++ b/specification/_global/field_caps/types.ts @@ -28,4 +28,5 @@ export class FieldCapability { non_searchable_indices?: Indices searchable: boolean type: string + metadata_field?: boolean } diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts index d5cb074379..7d37d512be 100644 --- a/specification/_global/get/GetRequest.ts +++ b/specification/_global/get/GetRequest.ts @@ -27,11 +27,12 @@ import { VersionNumber, VersionType } from '@_types/common' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * @rest_spec_name get * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { @@ -41,7 +42,7 @@ export interface Request extends RequestBase { index: IndexName type?: Type } - query_parameters?: { + query_parameters: { /** * Specifies the node or shard the operation should be performed on. Random by default. */ @@ -62,7 +63,10 @@ export interface Request extends RequestBase { * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing */ routing?: Routing - source_enabled?: boolean + /** + * True or false to return the _source field or not, or a list of fields to return. + */ + _source?: SourceConfigParam /** * A comma-separated list of source fields to exclude in the response. */ @@ -80,9 +84,5 @@ export interface Request extends RequestBase { * Specific version type: internal, external, external_gte. */ version_type?: VersionType - /** - * True or false to return the _source field or not, or a list of fields to return. - */ - _source?: boolean | Fields } } diff --git a/specification/_global/get/GetResponse.ts b/specification/_global/get/GetResponse.ts index c5beaad839..39eaa39be0 100644 --- a/specification/_global/get/GetResponse.ts +++ b/specification/_global/get/GetResponse.ts @@ -17,29 +17,9 @@ * under the License. */ -import { Dictionary } from '@spec_utils/Dictionary' -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -import { - Id, - IndexName, - SequenceNumber, - Type, - VersionNumber -} from '@_types/common' -import { long } from '@_types/Numeric' +import { GetResult } from '@global/get/types' +import { ErrorResponseBase } from '@_types/Base' export class Response { - body: { - _index: IndexName - fields?: Dictionary - found: boolean - _id: Id - _primary_term?: long - _routing?: string - _seq_no?: SequenceNumber - _source?: TDocument - /** @obsolete 7.0.0 */ - _type?: Type - _version?: VersionNumber - } + body: GetResult } diff --git a/specification/_global/get/types.ts b/specification/_global/get/types.ts new file mode 100644 index 0000000000..0793b84a16 --- /dev/null +++ b/specification/_global/get/types.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { + Id, + IndexName, + SequenceNumber, + Type, + VersionNumber +} from '@_types/common' +import { Dictionary } from '@spec_utils/Dictionary' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { long } from '@_types/Numeric' + +export class GetResult { + _index: IndexName + fields?: Dictionary + found: boolean + _id: Id + _primary_term?: long + _routing?: string + _seq_no?: SequenceNumber + _source?: TDocument + /** @deprecated 7.0.0 */ + _type?: Type + _version?: VersionNumber +} diff --git a/specification/_global/get_script/GetScriptRequest.ts b/specification/_global/get_script/GetScriptRequest.ts index dde0e52498..ba0f6024e6 100644 --- a/specification/_global/get_script/GetScriptRequest.ts +++ b/specification/_global/get_script/GetScriptRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name get_script * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { id: Id } - query_parameters?: { + query_parameters: { /** Specify timeout for connection to master */ master_timeout?: Time } diff --git a/specification/_global/get_script_context/GetScriptContextRequest.ts b/specification/_global/get_script_context/GetScriptContextRequest.ts index f0b2e2d667..cc3c7f6db6 100644 --- a/specification/_global/get_script_context/GetScriptContextRequest.ts +++ b/specification/_global/get_script_context/GetScriptContextRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name get_script_context * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts b/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts index 5005eed16c..ffe6922fdc 100644 --- a/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts +++ b/specification/_global/get_script_languages/GetScriptLanguagesRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name get_script_languages * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/_global/get_source/SourceRequest.ts b/specification/_global/get_source/SourceRequest.ts index 5e16fa0a30..ab0c01684c 100644 --- a/specification/_global/get_source/SourceRequest.ts +++ b/specification/_global/get_source/SourceRequest.ts @@ -17,11 +17,75 @@ * under the License. */ -import { Request as GetRequest } from '_global/get/GetRequest' +import { RequestBase } from '@_types/Base' +import { + Fields, + Id, + IndexName, + Routing, + VersionNumber, + VersionType +} from '@_types/common' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * @rest_spec_name get_source * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends GetRequest {} +export interface Request extends RequestBase { + path_parts: { + /** Unique identifier of the document. */ + id: Id + /** Name of the index that contains the document. */ + index: IndexName + /** + * The type of the document. + * @deprecated 7.0.0 + */ + type?: string + } + query_parameters: { + /** + * Specifies the node or shard the operation should be performed on. Random by default. + */ + preference?: string + /** + * Boolean) If true, the request is real-time as opposed to near-real-time. + * @server_default true + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime + */ + realtime?: boolean + /** + * If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + * @server_default false + */ + refresh?: boolean + /** + * Target the specified primary shard. + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing + */ + routing?: Routing + /** + * True or false to return the _source field or not, or a list of fields to return. + */ + _source?: SourceConfigParam + /** + * A comma-separated list of source fields to exclude in the response. + */ + _source_excludes?: Fields + /** + * A comma-separated list of source fields to include in the response. + */ + _source_includes?: Fields + stored_fields?: Fields + /** + * Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + */ + version?: VersionNumber + /** + * Specific version type: internal, external, external_gte. + */ + version_type?: VersionType + } +} diff --git a/specification/_global/index/IndexRequest.ts b/specification/_global/index/IndexRequest.ts index 648d0c9229..0d400a0800 100644 --- a/specification/_global/index/IndexRequest.ts +++ b/specification/_global/index/IndexRequest.ts @@ -39,12 +39,12 @@ import { Time } from '@_types/Time' * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id?: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { if_primary_term?: long if_seq_no?: SequenceNumber op_type?: OpType @@ -57,5 +57,6 @@ export interface Request extends RequestBase { wait_for_active_shards?: WaitForActiveShards require_alias?: boolean } + /** @codegen_name document */ body?: TDocument } diff --git a/specification/_global/info/RootNodeInfoRequest.ts b/specification/_global/info/RootNodeInfoRequest.ts index 783507f028..06ca0706d2 100644 --- a/specification/_global/info/RootNodeInfoRequest.ts +++ b/specification/_global/info/RootNodeInfoRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name info * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/_global/mget/MultiGetRequest.ts b/specification/_global/mget/MultiGetRequest.ts index 229004f9a7..4469f33ca2 100644 --- a/specification/_global/mget/MultiGetRequest.ts +++ b/specification/_global/mget/MultiGetRequest.ts @@ -18,8 +18,9 @@ */ import { RequestBase } from '@_types/Base' -import { Fields, IndexName, Routing, Type } from '@_types/common' -import { MultiGetId, Operation } from './types' +import { Fields, Ids, IndexName, Routing, Type } from '@_types/common' +import { Operation } from './types' +import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** * @rest_spec_name mget @@ -28,22 +29,64 @@ import { MultiGetId, Operation } from './types' * */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. + */ index?: IndexName type?: Type } - query_parameters?: { + query_parameters: { + /** + * Specifies the node or shard the operation should be performed on. Random by default. + */ preference?: string - realtime?: boolean // default: true - refresh?: boolean // default: false + /** + * If `true`, the request is real-time as opposed to near-real-time. + * @server_default true + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime + */ + realtime?: boolean + /** + * If `true`, the request refreshes relevant shards before retrieving documents. + * @server_default false + */ + refresh?: boolean + /** + * Custom value used to route operations to a specific shard. + */ routing?: Routing - _source?: boolean | Fields + /** + * True or false to return the `_source` field or not, or a list of fields to return. + */ + _source?: SourceConfigParam + /** + * A comma-separated list of source fields to exclude from the response. + * You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html + */ _source_excludes?: Fields + /** + * A comma-separated list of source fields to include in the response. + * If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. + * If the `_source` parameter is `false`, this parameter is ignored. + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html + */ _source_includes?: Fields + /** + * If `true`, retrieves the document fields stored in the index rather than the document `_source`. + * @server_default false + */ stored_fields?: Fields } - body?: { + body: { + /** + * The documents you want to retrieve. Required if no index is specified in the request URI. + */ docs?: Operation[] - ids?: MultiGetId[] + /** + * The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. + */ + ids?: Ids } } diff --git a/specification/_global/mget/MultiGetResponse.ts b/specification/_global/mget/MultiGetResponse.ts index bf90d6eaf0..52a52424ce 100644 --- a/specification/_global/mget/MultiGetResponse.ts +++ b/specification/_global/mget/MultiGetResponse.ts @@ -17,10 +17,10 @@ * under the License. */ -import { Hit } from './types' +import { ResponseItem } from './types' export class Response { body: { - docs: Hit[] + docs: ResponseItem[] } } diff --git a/specification/_global/mget/types.ts b/specification/_global/mget/types.ts index 24e61b5279..414a652896 100644 --- a/specification/_global/mget/types.ts +++ b/specification/_global/mget/types.ts @@ -17,45 +17,54 @@ * under the License. */ -import { SourceFilter } from '@global/search/_types/SourceFilter' -import { Dictionary } from '@spec_utils/Dictionary' -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { SourceConfig } from '@global/search/_types/SourceFilter' import { Fields, Id, IndexName, Routing, - SequenceNumber, Type, VersionNumber, VersionType } from '@_types/common' -import { MainError } from '@_types/Errors' -import { integer, long } from '@_types/Numeric' +import { ErrorCause } from '@_types/Errors' +import { GetResult } from '@global/get/types' export class Operation { - _id: MultiGetId + /** + * The unique document ID. + */ + _id: Id + /** + * The index that contains the document. + */ _index?: IndexName + /** + * The key for the primary shard the document resides on. Required if routing is used during indexing. + */ routing?: Routing - _source?: boolean | Fields | SourceFilter + /** + * If `false`, excludes all _source fields. + */ + _source?: SourceConfig + /** + * The stored fields you want to retrieve. + */ stored_fields?: Fields _type?: Type version?: VersionNumber version_type?: VersionType } -export type MultiGetId = string | integer +/** + * @codegen_names result, failure + */ +export type ResponseItem = GetResult | MultiGetError -export class Hit { - error?: MainError - fields?: Dictionary - found?: boolean +export class MultiGetError { + error: ErrorCause _id: Id _index: IndexName - _primary_term?: long - _routing?: Routing - _seq_no?: SequenceNumber - _source?: TDocument + /** @deprecated 7.0.0 */ _type?: Type - _version?: VersionNumber } diff --git a/specification/_global/msearch/MultiSearchRequest.ts b/specification/_global/msearch/MultiSearchRequest.ts index dc666d4c9a..fc8632f941 100644 --- a/specification/_global/msearch/MultiSearchRequest.ts +++ b/specification/_global/msearch/MultiSearchRequest.ts @@ -18,24 +18,31 @@ */ import { RequestBase } from '@_types/Base' -import { ExpandWildcards, Indices, SearchType, Types } from '@_types/common' +import { + ExpandWildcards, + Indices, + Routing, + SearchType, + Types +} from '@_types/common' import { long } from '@_types/Numeric' -import { Body, Header } from './types' +import { RequestItem } from './types' /** * @rest_spec_name msearch * @since 1.3.0 * @stability stable + * @index_privileges read */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** * Comma-separated list of data streams, indices, and index aliases to search. */ index?: Indices type?: Types } - query_parameters?: { + query_parameters: { /** * If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. */ @@ -73,19 +80,24 @@ export interface Request extends RequestBase { * Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. */ pre_filter_shard_size?: long - /** - * Indicates whether global term and document frequencies should be used when scoring returned documents. - */ - search_type?: SearchType /** * If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. * @server_default false */ rest_total_hits_as_int?: boolean + /** + * Custom routing value used to route search operations to a specific shard. + */ + routing?: Routing + /** + * Indicates whether global term and document frequencies should be used when scoring returned documents. + */ + search_type?: SearchType /** * Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. */ typed_keys?: boolean } - body?: Array
+ /** @codegen_name searches */ + body?: Array } diff --git a/specification/_global/msearch/MultiSearchResponse.ts b/specification/_global/msearch/MultiSearchResponse.ts index d14c5301b2..59773f70db 100644 --- a/specification/_global/msearch/MultiSearchResponse.ts +++ b/specification/_global/msearch/MultiSearchResponse.ts @@ -17,13 +17,8 @@ * under the License. */ -import { ErrorResponseBase } from '@_types/Base' -import { long } from '@_types/Numeric' -import { SearchResult } from './types' +import { MultiSearchResult } from '@global/msearch/types' export class Response { - body: { - took: long - responses: Array | ErrorResponseBase> - } + body: MultiSearchResult } diff --git a/specification/_global/msearch/types.ts b/specification/_global/msearch/types.ts index 428ce97136..fe3bce08cf 100644 --- a/specification/_global/msearch/types.ts +++ b/specification/_global/msearch/types.ts @@ -18,39 +18,193 @@ */ import { PointInTimeReference } from '@global/search/_types/PointInTimeReference' -import { SuggestContainer } from '@global/search/_types/suggester' +import { Suggester } from '@global/search/_types/suggester' import { Dictionary } from '@spec_utils/Dictionary' import { AggregationContainer } from '@_types/aggregations/AggregationContainer' -import { ExpandWildcards, Indices, SearchType } from '@_types/common' -import { integer } from '@_types/Numeric' -import { QueryContainer } from '@_types/query_dsl/abstractions' -import { Response as SearchResponse } from '@global/search/SearchResponse' +import { + ExpandWildcards, + Fields, + IndexName, + Indices, + Routing, + SearchType +} from '@_types/common' +import { double, integer, long } from '@_types/Numeric' +import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' +import { ResponseBody as SearchResponse } from '@global/search/SearchResponse' +import { TrackHits } from '@global/search/_types/hits' +import { ErrorResponseBase } from '@_types/Base' +import { Sort, SortResults } from '@_types/sort' +import { FieldCollapse } from '@global/search/_types/FieldCollapse' +import { Highlight } from '@global/search/_types/highlighting' +import { Rescore } from '@global/search/_types/rescoring' +import { SourceConfig } from '@global/search/_types/SourceFilter' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' +import { ScriptField } from '@_types/Scripting' +import { SlicedScroll } from '@_types/SlicedScroll' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' + +/** + * @codegen_names header, body + */ +export type RequestItem = MultisearchHeader | MultisearchBody /** * Contains parameters used to limit or change the subsequent search body request. */ -export class Header { +export class MultisearchHeader { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean index?: Indices preference?: string request_cache?: boolean - routing?: string + routing?: Routing search_type?: SearchType + ccs_minimize_roundtrips?: boolean + allow_partial_search_results?: boolean + ignore_throttled?: boolean } -export class Body { +// We should keep this in sync with the normal search request body. +export class MultisearchBody { + /** @aliases aggs */ // ES uses "aggregations" in serialization aggregations?: Dictionary - aggs?: Dictionary + collapse?: FieldCollapse + /** + * Defines the search definition using the Query DSL. + */ query?: QueryContainer + /** + * If true, returns detailed information about score computation as part of a hit. + * @server_default false + */ + explain?: boolean + /** + * Configuration of search extensions defined by Elasticsearch plugins. + */ + ext?: Dictionary + /** + * List of stored fields to return as part of a hit. If no fields are specified, + * no stored fields are included in the response. If this field is specified, the _source + * parameter defaults to false. You can pass _source: true to return both source fields + * and stored fields in the search response. + */ + stored_fields?: Fields + /** + * Array of wildcard (*) patterns. The request returns doc values for field + * names matching these patterns in the hits.fields property of the response. + */ + docvalue_fields?: FieldAndFormat[] + /** + * Starting document offset. By default, you cannot page through more than 10,000 + * hits using the from and size parameters. To page through more hits, use the + * search_after parameter. + * @server_default 0 + */ from?: integer + highlight?: Highlight + /** + * Boosts the _score of documents from specified indices. + */ + indices_boost?: Array> + /** + * Minimum _score for matching documents. Documents with a lower _score are + * not included in the search results. + */ + min_score?: double + post_filter?: QueryContainer + profile?: boolean + rescore?: Rescore | Rescore[] + /** + * Retrieve a script evaluation (based on different fields) for each hit. + */ + script_fields?: Dictionary + search_after?: SortResults + /** + * The number of hits to return. By default, you cannot page through more + * than 10,000 hits using the from and size parameters. To page through more + * hits, use the search_after parameter. + * @server_default 10 + */ size?: integer + /** @doc_id sort-search-results */ + sort?: Sort + /** + * Indicates which source fields are returned for matching documents. These + * fields are returned in the hits._source property of the search response. + */ + _source?: SourceConfig + /** + * Array of wildcard (*) patterns. The request returns values for field names + * matching these patterns in the hits.fields property of the response. + */ + fields?: Array + /** + * Maximum number of documents to collect for each shard. If a query reaches this + * limit, Elasticsearch terminates the query early. Elasticsearch collects documents + * before sorting. Defaults to 0, which does not terminate query execution early. + * @server_default 0 + */ + terminate_after?: long + /** + * Stats groups to associate with the search. Each group maintains a statistics + * aggregation for its associated searches. You can retrieve these stats using + * the indices stats API. + */ + stats?: string[] + /** + * Specifies the period of time to wait for a response from each shard. If no response + * is received before the timeout expires, the request fails and returns an error. + * Defaults to no timeout. + */ + timeout?: string + /** + * If true, calculate and return document scores, even if the scores are not used for sorting. + * @server_default false + */ + track_scores?: boolean + /** + * Number of hits matching the query to count accurately. If true, the exact + * number of hits is returned at the cost of some performance. If false, the + * response does not include the total number of hits matching the query. + * Defaults to 10,000 hits. + */ + track_total_hits?: TrackHits + /** + * If true, returns document version as part of a hit. + * @server_default false + */ + version?: boolean + /** + * Defines one or more runtime fields in the search request. These fields take + * precedence over mapped fields with the same name. + */ + runtime_mappings?: RuntimeFields + /** + * If true, returns sequence number and primary term of the last modification + * of each hit. See Optimistic concurrency control. + */ + seq_no_primary_term?: boolean + /** + * Limits the search to a point in time (PIT). If you provide a PIT, you + * cannot specify an in the request path. + */ pit?: PointInTimeReference - track_total_hits?: boolean | integer - suggest?: SuggestContainer | Dictionary + suggest?: Suggester } -export class SearchResult extends SearchResponse { - status: integer +export class MultiSearchResult { + took: long + responses: Array> +} + +/** @codegen_names result, failure */ +export type ResponseItem = + | MultiSearchItem + | ErrorResponseBase + +export class MultiSearchItem extends SearchResponse { + // Not returned in MultiSearchTemplateResponse + status?: integer } diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts index 1e569d9a7a..81b1bdc35a 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts @@ -20,25 +20,27 @@ import { RequestBase } from '@_types/Base' import { Indices, SearchType, Types } from '@_types/common' import { long } from '@_types/Numeric' -import { TemplateItem } from './types' +import { RequestItem } from './types' /** + * Runs multiple [templated searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#run-multiple-templated-searches) with a single request. * @rest_spec_name msearch_template * @since 5.0.0 - * - * @stability TODO + * @stability stable + * @index_privileges read */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices type?: Types } - query_parameters?: { + query_parameters: { ccs_minimize_roundtrips?: boolean max_concurrent_searches?: long search_type?: SearchType rest_total_hits_as_int?: boolean typed_keys?: boolean } - body: Array + /** @codegen_name search_templates */ + body: Array } diff --git a/specification/_global/msearch_template/MultiSearchTemplateResponse.ts b/specification/_global/msearch_template/MultiSearchTemplateResponse.ts index 394cf32706..59773f70db 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateResponse.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateResponse.ts @@ -17,12 +17,8 @@ * under the License. */ -import { Response as SearchResponse } from '@global/search/SearchResponse' -import { long } from '@_types/Numeric' +import { MultiSearchResult } from '@global/msearch/types' export class Response { - body: { - responses: SearchResponse[] - took: long - } + body: MultiSearchResult } diff --git a/specification/_global/msearch_template/types.ts b/specification/_global/msearch_template/types.ts index a83387513f..59d71c35ec 100644 --- a/specification/_global/msearch_template/types.ts +++ b/specification/_global/msearch_template/types.ts @@ -19,11 +19,27 @@ import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -import { Id, Indices } from '@_types/common' +import { Id } from '@_types/common' +import { MultisearchHeader } from '@global/msearch/types' -export class TemplateItem { +/** @codegen_names header, body */ +export type RequestItem = MultisearchHeader | TemplateConfig + +export class TemplateConfig { + /** @server_default false */ + explain?: boolean + /** + * ID of the search template to use. If no source is specified, + * this parameter is required. + */ id?: Id - index?: Indices params?: Dictionary + /** @server_default false */ + profile?: boolean + /** + * An inline search template. Supports the same parameters as the search API's + * request body. Also supports Mustache variables. If no id is specified, this + * parameter is required. + */ source?: string } diff --git a/specification/_global/mtermvectors/MultiTermVectorsRequest.ts b/specification/_global/mtermvectors/MultiTermVectorsRequest.ts index 65fc289eca..dc512c4b1d 100644 --- a/specification/_global/mtermvectors/MultiTermVectorsRequest.ts +++ b/specification/_global/mtermvectors/MultiTermVectorsRequest.ts @@ -32,14 +32,15 @@ import { Operation } from './types' /** * @rest_spec_name mtermvectors * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: IndexName type?: Type } - query_parameters?: { + query_parameters: { + ids?: Id[] fields?: Fields field_statistics?: boolean offsets?: boolean @@ -52,7 +53,7 @@ export interface Request extends RequestBase { version?: VersionNumber version_type?: VersionType } - body?: { + body: { docs?: Operation[] ids?: Id[] } diff --git a/specification/_global/mtermvectors/types.ts b/specification/_global/mtermvectors/types.ts index 5d9389aebd..e0d0e04521 100644 --- a/specification/_global/mtermvectors/types.ts +++ b/specification/_global/mtermvectors/types.ts @@ -19,6 +19,7 @@ import { Filter, TermVector } from '@global/termvectors/types' import { Dictionary } from '@spec_utils/Dictionary' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Fields, @@ -31,7 +32,7 @@ import { import { long } from '@_types/Numeric' export class Operation { - doc: any + doc: UserDefinedValue fields: Fields field_statistics: boolean filter: Filter diff --git a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts index e1e0dce75c..b93802339b 100644 --- a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts +++ b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts @@ -22,16 +22,24 @@ import { Indices } from '@_types/common' import { Time } from '@_types/Time' /** + * A search request by default executes against the most recent visible data of the target indices, + * which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + * state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + * search requests using the same point in time. For example, if refreshes happen between + * `search_after` requests, then the results of those requests might not be consistent as changes happening + * between searches are only visible to the more recent point in time. * @rest_spec_name open_point_in_time * @since 7.10.0 - * @stability TODO + * @stability stable + * @doc_id point-in-time-api + * @index_privileges read */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } - query_parameters?: { - keep_alive?: Time + query_parameters: { + keep_alive: Time + ignore_unavailable?: boolean } - body?: {} } diff --git a/specification/_global/ping/PingRequest.ts b/specification/_global/ping/PingRequest.ts index 6c05cf0da8..7e230b0720 100644 --- a/specification/_global/ping/PingRequest.ts +++ b/specification/_global/ping/PingRequest.ts @@ -22,9 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ping * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends RequestBase {} diff --git a/specification/_global/put_script/PutScriptRequest.ts b/specification/_global/put_script/PutScriptRequest.ts index f5c0255556..f1112a4ed2 100644 --- a/specification/_global/put_script/PutScriptRequest.ts +++ b/specification/_global/put_script/PutScriptRequest.ts @@ -25,18 +25,18 @@ import { Time } from '@_types/Time' /** * @rest_spec_name put_script * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id context?: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: { - script?: StoredScript + body: { + script: StoredScript } } diff --git a/specification/_global/rank_eval/RankEvalRequest.ts b/specification/_global/rank_eval/RankEvalRequest.ts index 1f54a49707..15881c386c 100644 --- a/specification/_global/rank_eval/RankEvalRequest.ts +++ b/specification/_global/rank_eval/RankEvalRequest.ts @@ -24,7 +24,7 @@ import { RankEvalMetric, RankEvalRequestItem } from './types' /** * @rest_spec_name rank_eval * @since 6.2.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { @@ -34,7 +34,7 @@ export interface Request extends RequestBase { */ index: Indices } - query_parameters?: { + query_parameters: { /** * If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. * @server_default true diff --git a/specification/_global/rank_eval/types.ts b/specification/_global/rank_eval/types.ts index 3448188399..2b0888e01d 100644 --- a/specification/_global/rank_eval/types.ts +++ b/specification/_global/rank_eval/types.ts @@ -135,7 +135,7 @@ export class RankEvalMetricDetail { export class RankEvalHitItem { hit: RankEvalHit - rating?: double + rating?: double | null } export class RankEvalHit { diff --git a/specification/_global/reindex/ReindexRequest.ts b/specification/_global/reindex/ReindexRequest.ts index 9a8f9e8302..eccf89f301 100644 --- a/specification/_global/reindex/ReindexRequest.ts +++ b/specification/_global/reindex/ReindexRequest.ts @@ -18,7 +18,7 @@ */ import { RequestBase } from '@_types/Base' -import { Conflicts, WaitForActiveShards } from '@_types/common' +import { Conflicts, Slices, WaitForActiveShards } from '@_types/common' import { long } from '@_types/Numeric' import { Script } from '@_types/Scripting' import { Time } from '@_types/Time' @@ -27,25 +27,25 @@ import { Destination, Source } from './types' /** * @rest_spec_name reindex * @since 2.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { refresh?: boolean requests_per_second?: long scroll?: Time - slices?: long + slices?: Slices timeout?: Time wait_for_active_shards?: WaitForActiveShards wait_for_completion?: boolean require_alias?: boolean } - body?: { + body: { conflicts?: Conflicts - dest?: Destination + dest: Destination max_docs?: long script?: Script size?: long - source?: Source + source: Source } } diff --git a/specification/_global/reindex/types.ts b/specification/_global/reindex/types.ts index 58a454da92..dbca81a4fb 100644 --- a/specification/_global/reindex/types.ts +++ b/specification/_global/reindex/types.ts @@ -17,7 +17,6 @@ * under the License. */ -import { Sort } from '@global/search/_types/sort' import { Fields, IndexName, @@ -28,15 +27,20 @@ import { Username, VersionType } from '@_types/common' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { Host } from '@_types/Networking' import { integer } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' import { SlicedScroll } from '@_types/SlicedScroll' import { Time } from '@_types/Time' +import { Sort } from '@_types/sort' +import { Dictionary } from '@spec_utils/Dictionary' export class Destination { - index: IndexName + /** The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform. */ + index?: IndexName op_type?: OpType + /** The unique identifier for an ingest pipeline. */ pipeline?: string routing?: Routing version_type?: VersionType @@ -49,14 +53,21 @@ export class Source { size?: integer slice?: SlicedScroll sort?: Sort - /** @identifier source_fields */ + /** @codegen_name source_fields */ _source?: Fields + runtime_mappings?: RuntimeFields } export class RemoteSource { - connect_timeout: Time + connect_timeout?: Time + headers?: Dictionary host: Host - username: Username - password: Password - socket_timeout: Time + username?: Username + password?: Password + socket_timeout?: Time +} + +export class SourceRuntimeMapping { + type: string + script?: string } diff --git a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts index 8a66e7cf43..2633f478c1 100644 --- a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts +++ b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts @@ -24,14 +24,13 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name reindex_rethrottle * @since 2.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { task_id: Id } - query_parameters?: { + query_parameters: { requests_per_second?: long } - body?: {} } diff --git a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts index 13bcf5042e..d7653220f0 100644 --- a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts +++ b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts @@ -20,15 +20,18 @@ import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' /** * @rest_spec_name render_search_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { + path_parts: { + id?: Id + } + body: { file?: string params?: Dictionary source?: string diff --git a/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts b/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts index db4b950556..82b8eb7c43 100644 --- a/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts +++ b/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts @@ -24,11 +24,10 @@ import { PainlessContextSetup } from './types' /** * @rest_spec_name scripts_painless_execute * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { + body: { context?: string context_setup?: PainlessContextSetup script?: InlineScript diff --git a/specification/_global/scroll/ScrollRequest.ts b/specification/_global/scroll/ScrollRequest.ts index db8fbde043..de9ff2b94d 100644 --- a/specification/_global/scroll/ScrollRequest.ts +++ b/specification/_global/scroll/ScrollRequest.ts @@ -18,34 +18,33 @@ */ import { RequestBase } from '@_types/Base' -import { Id, ScrollId } from '@_types/common' +import { ScrollId } from '@_types/common' import { Time } from '@_types/Time' /** * @rest_spec_name scroll * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - /** @obsolete 7.0.0 */ - scroll_id?: Id + path_parts: { + /** @deprecated 7.0.0 */ + scroll_id?: ScrollId } - query_parameters?: { + query_parameters: { /** * Period to retain the search context for scrolling. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results * @server_default 1d */ scroll?: Time - /** @obsolete 7.0.0 */ + /** @deprecated 7.0.0 */ scroll_id?: ScrollId /** * If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. * @server_default false */ rest_total_hits_as_int?: boolean - total_hits_as_integer?: boolean } body: { /** @@ -56,10 +55,5 @@ export interface Request extends RequestBase { scroll?: Time /** Scroll ID of the search. */ scroll_id: ScrollId - /** - * If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. - * @server_default false - */ - rest_total_hits_as_int?: boolean } } diff --git a/specification/_global/scroll/ScrollResponse.ts b/specification/_global/scroll/ScrollResponse.ts index af58ea7319..ee5a08b7c9 100644 --- a/specification/_global/scroll/ScrollResponse.ts +++ b/specification/_global/scroll/ScrollResponse.ts @@ -17,6 +17,8 @@ * under the License. */ -import { Response as SearchResponse } from '@global/search/SearchResponse' +import { ResponseBody } from '@global/search/SearchResponse' -export class Response extends SearchResponse {} +export class Response { + body: ResponseBody +} diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts index 32376036dd..428d92bdba 100644 --- a/specification/_global/search/SearchRequest.ts +++ b/specification/_global/search/SearchRequest.ts @@ -21,7 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { AggregationContainer } from '@_types/aggregations/AggregationContainer' import { RequestBase } from '@_types/Base' import { - DefaultOperator, ExpandWildcards, Field, Fields, @@ -35,36 +34,38 @@ import { } from '@_types/common' import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { double, integer, long } from '@_types/Numeric' -import { QueryContainer } from '@_types/query_dsl/abstractions' +import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' import { ScriptField } from '@_types/Scripting' import { SlicedScroll } from '@_types/SlicedScroll' -import { DateField, Time } from '@_types/Time' +import { Time } from '@_types/Time' import { FieldCollapse } from './_types/FieldCollapse' import { Highlight } from './_types/highlighting' import { PointInTimeReference } from './_types/PointInTimeReference' import { Rescore } from './_types/rescoring' -import { Sort } from './_types/sort' -import { DocValueField, SourceFilter } from './_types/SourceFilter' -import { SuggestContainer } from './_types/suggester' - +import { SourceConfigParam, SourceConfig } from './_types/SourceFilter' +import { Suggester } from './_types/suggester' +import { TrackHits } from '@global/search/_types/hits' +import { Operator } from '@_types/query_dsl/Operator' +import { Sort, SortResults } from '@_types/sort' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * @rest_spec_name search * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean allow_partial_search_results?: boolean analyzer?: string analyze_wildcard?: boolean batched_reduce_size?: long ccs_minimize_roundtrips?: boolean - default_operator?: DefaultOperator + default_operator?: Operator df?: string docvalue_fields?: Fields expand_wildcards?: ExpandWildcards @@ -82,18 +83,24 @@ export interface Request extends RequestBase { search_type?: SearchType stats?: string[] stored_fields?: Fields + /** + * Specifies which field to use for suggestions. + */ suggest_field?: Field suggest_mode?: SuggestMode suggest_size?: long + /** + * The source text for which the suggestions should be returned. + */ suggest_text?: string terminate_after?: long timeout?: Time - track_total_hits?: boolean | integer + track_total_hits?: TrackHits track_scores?: boolean typed_keys?: boolean rest_total_hits_as_int?: boolean version?: boolean - _source?: boolean | Fields + _source?: SourceConfigParam _source_excludes?: Fields _source_includes?: Fields seq_no_primary_term?: boolean @@ -102,37 +109,132 @@ export interface Request extends RequestBase { from?: integer sort?: string | string[] } - body?: { - aggs?: Dictionary + // We should keep this in sync with the multi search request body. + body: { + /** @aliases aggs */ // ES uses "aggregations" in serialization aggregations?: Dictionary collapse?: FieldCollapse + /** + * If true, returns detailed information about score computation as part of a hit. + * @server_default false + */ explain?: boolean + /** + * Configuration of search extensions defined by Elasticsearch plugins. + */ + ext?: Dictionary + /** + * Starting document offset. By default, you cannot page through more than 10,000 + * hits using the from and size parameters. To page through more hits, use the + * search_after parameter. + * @server_default 0 + */ from?: integer highlight?: Highlight - track_total_hits?: boolean | integer + /** + * Number of hits matching the query to count accurately. If true, the exact + * number of hits is returned at the cost of some performance. If false, the + * response does not include the total number of hits matching the query. + * Defaults to 10,000 hits. + */ + track_total_hits?: TrackHits + /** + * Boosts the _score of documents from specified indices. + */ indices_boost?: Array> - docvalue_fields?: DocValueField | Array + /** + * Array of wildcard (*) patterns. The request returns doc values for field + * names matching these patterns in the hits.fields property of the response. + */ + docvalue_fields?: FieldAndFormat[] + /** + * Minimum _score for matching documents. Documents with a lower _score are + * not included in the search results. + */ min_score?: double post_filter?: QueryContainer profile?: boolean + /** + * Defines the search definition using the Query DSL. + */ query?: QueryContainer rescore?: Rescore | Rescore[] + /** + * Retrieve a script evaluation (based on different fields) for each hit. + */ script_fields?: Dictionary - search_after?: Array + search_after?: SortResults + /** + * The number of hits to return. By default, you cannot page through more + * than 10,000 hits using the from and size parameters. To page through more + * hits, use the search_after parameter. + * @server_default 10 + */ size?: integer slice?: SlicedScroll + /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html */ sort?: Sort - _source?: boolean | Fields | SourceFilter - fields?: Array - suggest?: SuggestContainer | Dictionary + /** + * Indicates which source fields are returned for matching documents. These + * fields are returned in the hits._source property of the search response. + */ + _source?: SourceConfig + /** + * Array of wildcard (*) patterns. The request returns values for field names + * matching these patterns in the hits.fields property of the response. + */ + fields?: Array + suggest?: Suggester + /** + * Maximum number of documents to collect for each shard. If a query reaches this + * limit, Elasticsearch terminates the query early. Elasticsearch collects documents + * before sorting. Defaults to 0, which does not terminate query execution early. + * @server_default 0 + */ terminate_after?: long + /** + * Specifies the period of time to wait for a response from each shard. If no response + * is received before the timeout expires, the request fails and returns an error. + * Defaults to no timeout. + */ timeout?: string + /** + * If true, calculate and return document scores, even if the scores are not used for sorting. + * @server_default false + */ track_scores?: boolean + /** + * If true, returns document version as part of a hit. + * @server_default false + */ version?: boolean + /** + * If true, returns sequence number and primary term of the last modification + * of each hit. See Optimistic concurrency control. + */ seq_no_primary_term?: boolean + /** + * List of stored fields to return as part of a hit. If no fields are specified, + * no stored fields are included in the response. If this field is specified, the _source + * parameter defaults to false. You can pass _source: true to return both source fields + * and stored fields in the search response. + */ stored_fields?: Fields + /** + * Limits the search to a point in time (PIT). If you provide a PIT, you + * cannot specify an in the request path. + */ pit?: PointInTimeReference + /** + * Defines one or more runtime fields in the search request. These fields take + * precedence over mapped fields with the same name. + */ runtime_mappings?: RuntimeFields + /** + * Stats groups to associate with the search. Each group maintains a statistics + * aggregation for its associated searches. You can retrieve these stats using + * the indices stats API. + */ stats?: string[] } } diff --git a/specification/_global/search/SearchResponse.ts b/specification/_global/search/SearchResponse.ts index 0cc62f2a3f..c0fa8cd20f 100644 --- a/specification/_global/search/SearchResponse.ts +++ b/specification/_global/search/SearchResponse.ts @@ -27,23 +27,28 @@ import { HitsMetadata } from './_types/hits' import { Profile } from './_types/profile' import { Suggest } from './_types/suggester' +// Keep changes in sync with: +// - search +// - fleet.search +// - scroll export class Response { - body: { - took: long - timed_out: boolean - _shards: ShardStatistics - hits: HitsMetadata + body: ResponseBody +} - aggregations?: Dictionary - _clusters?: ClusterStatistics - documents?: TDocument[] - fields?: Dictionary - max_score?: double - num_reduce_phases?: long - profile?: Profile - pit_id?: Id - _scroll_id?: ScrollId - suggest?: Dictionary[]> - terminated_early?: boolean - } +export class ResponseBody { + // Has to be kept in sync with SearchTemplateResponse + took: long + timed_out: boolean + _shards: ShardStatistics + hits: HitsMetadata + aggregations?: Dictionary + _clusters?: ClusterStatistics + fields?: Dictionary + max_score?: double + num_reduce_phases?: long + profile?: Profile + pit_id?: Id + _scroll_id?: ScrollId + suggest?: Dictionary[]> + terminated_early?: boolean } diff --git a/specification/_global/search/_types/SourceFilter.ts b/specification/_global/search/_types/SourceFilter.ts index 4669e80ef4..6b48c59f79 100644 --- a/specification/_global/search/_types/SourceFilter.ts +++ b/specification/_global/search/_types/SourceFilter.ts @@ -20,14 +20,26 @@ import { Field, Fields } from '@_types/common' +/** + * @shortcut_property includes + */ export class SourceFilter { + /** @aliases exclude */ excludes?: Fields + /** @aliases include */ includes?: Fields - exclude?: Fields - include?: Fields } -export class DocValueField { - field: Field - format?: string -} +/** + * Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. + * @codegen_names fetch, filter + */ +export type SourceConfig = boolean | SourceFilter + +/** + * Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. + * Used as a query parameter along with the `_source_includes` and `_source_excludes` parameters. + * + * @codegen_names fetch, fields + */ +export type SourceConfigParam = boolean | Fields diff --git a/specification/_global/search/_types/highlighting.ts b/specification/_global/search/_types/highlighting.ts index 50cc4655cb..a1f71668c3 100644 --- a/specification/_global/search/_types/highlighting.ts +++ b/specification/_global/search/_types/highlighting.ts @@ -21,6 +21,8 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Field, Fields } from '@_types/common' import { integer } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { Analyzer } from '@_types/analysis/analyzers' export enum BoundaryScanner { chars = 0, @@ -28,29 +30,33 @@ export enum BoundaryScanner { word = 2 } -export class Highlight { - fields: Dictionary - +export class HighlightBase { type?: HighlighterType boundary_chars?: string boundary_max_scan?: integer boundary_scanner?: BoundaryScanner boundary_scanner_locale?: string - encoder?: HighlighterEncoder + force_source?: boolean fragmenter?: HighlighterFragmenter - fragment_offset?: integer fragment_size?: integer + highlight_filter?: boolean + highlight_query?: QueryContainer max_fragment_length?: integer + max_analyzed_offset?: integer no_match_size?: integer number_of_fragments?: integer + options?: Dictionary order?: HighlighterOrder + phrase_limit?: integer post_tags?: string[] pre_tags?: string[] require_field_match?: boolean tags_schema?: HighlighterTagsSchema - highlight_query?: QueryContainer - // TODO this is too lenient! test reports "20" is accepted - max_analyzed_offset?: string | integer +} + +export class Highlight extends HighlightBase { + encoder?: HighlighterEncoder + fields: Dictionary } export enum HighlighterEncoder { @@ -71,33 +77,18 @@ export enum HighlighterTagsSchema { styled = 0 } -export enum HighlighterType { +/** @codegen_names builtin, custom */ +export type HighlighterType = BuiltinHighlighterType | string + +export enum BuiltinHighlighterType { plain = 0, + /** @codegen_name fast_vector */ fvh = 1, unified = 2 } -export class HighlightField { - boundary_chars?: string - boundary_max_scan?: integer - boundary_scanner?: BoundaryScanner - boundary_scanner_locale?: string - //TODO I THINK this field does not exist - field?: Field - force_source?: boolean - fragmenter?: HighlighterFragmenter +export class HighlightField extends HighlightBase { fragment_offset?: integer - fragment_size?: integer - highlight_query?: QueryContainer matched_fields?: Fields - max_fragment_length?: integer - no_match_size?: integer - number_of_fragments?: integer - order?: HighlighterOrder - phrase_limit?: integer - post_tags?: string[] - pre_tags?: string[] - require_field_match?: boolean - tags_schema?: HighlighterTagsSchema - type?: HighlighterType | string + analyzer?: Analyzer } diff --git a/specification/_global/search/_types/hits.ts b/specification/_global/search/_types/hits.ts index 026be89a31..e459ef407a 100644 --- a/specification/_global/search/_types/hits.ts +++ b/specification/_global/search/_types/hits.ts @@ -34,11 +34,16 @@ import { double, integer, long } from '@_types/Numeric' import { ScriptField } from '@_types/Scripting' import { FieldCollapse } from './FieldCollapse' import { Highlight } from './highlighting' -import { Sort, SortResults } from './sort' -import { SourceFilter } from './SourceFilter' +import { SourceConfig } from './SourceFilter' +import { FieldAndFormat } from '@_types/query_dsl/abstractions' +import { Sort, SortResults } from '@_types/sort' export class Hit { _index: IndexName + /** + * @es_quirk '_id' is not available when using 'stored_fields: _none_' + * on a search request. Otherwise the field is always present on hits. + */ _id: Id _score?: double @@ -63,7 +68,8 @@ export class Hit { } export class HitsMetadata { - total: TotalHits | long + /** Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. */ + total?: TotalHits | long hits: Hit[] max_score?: double @@ -80,15 +86,8 @@ export class HitMetadata { _version: VersionNumber } -export class InnerHitsMetadata { - total: TotalHits | long - hits: Hit>[] - - max_score?: double -} - export class InnerHitsResult { - hits: InnerHitsMetadata + hits: HitsMetadata } export class NestedIdentity { @@ -122,16 +121,19 @@ export class InnerHits { seq_no_primary_term?: boolean fields?: Fields sort?: Sort - _source?: boolean | SourceFilter + _source?: SourceConfig stored_field?: Fields /** @server_default false */ track_scores?: boolean version?: boolean } -/** @shortcut_property field */ -export class FieldAndFormat { - field: Field - format?: string - include_unmapped?: boolean -} +/** + * Number of hits matching the query to count accurately. If true, the exact + * number of hits is returned at the cost of some performance. If false, the + * response does not include the total number of hits matching the query. + * Defaults to 10,000 hits. + * + * @codegen_names enabled, count + */ +export type TrackHits = boolean | integer diff --git a/specification/_global/search/_types/profile.ts b/specification/_global/search/_types/profile.ts index a03c35e575..c0f862552e 100644 --- a/specification/_global/search/_types/profile.ts +++ b/specification/_global/search/_types/profile.ts @@ -17,7 +17,7 @@ * under the License. */ -import { long } from '@_types/Numeric' +import { integer, long } from '@_types/Numeric' export class AggregationBreakdown { build_aggregation: long @@ -34,7 +34,46 @@ export class AggregationBreakdown { reduce_count: long } -export class AggregationProfileDebug {} +export class AggregationProfileDebug { + segments_with_multi_valued_ords?: integer + collection_strategy?: string + segments_with_single_valued_ords?: integer + total_buckets?: integer + built_buckets?: integer + result_strategy?: string + has_filter?: boolean + delegate?: string + delegate_debug?: AggregationProfileDelegateDebug + chars_fetched?: integer + extract_count?: integer + extract_ns?: integer + values_fetched?: integer + collect_analyzed_ns?: integer + collect_analyzed_count?: integer + surviving_buckets?: integer + ordinals_collectors_used?: integer + ordinals_collectors_overhead_too_high?: integer + string_hashing_collectors_used?: integer + numeric_collectors_used?: integer + empty_collectors_used?: integer + deferred_aggregators?: string[] +} + +export class AggregationProfileDelegateDebug { + segments_with_doc_count_field?: integer + segments_with_deleted_docs?: integer + filters?: AggregationProfileDelegateDebugFilter[] + segments_counted?: integer + segments_collected?: integer + map_reducer?: string +} + +export class AggregationProfileDelegateDebugFilter { + results_from_metadata?: integer + query?: string + specialized_for?: string + segments_counted_in_constant_time?: integer +} export class AggregationProfile { breakdown: AggregationBreakdown @@ -42,14 +81,13 @@ export class AggregationProfile { time_in_nanos: long type: string debug?: AggregationProfileDebug - children?: AggregationProfileDebug[] + children?: AggregationProfile[] } export class Collector { name: string reason: string time_in_nanos: long - children?: Collector[] } @@ -83,7 +121,6 @@ export class QueryProfile { description: string time_in_nanos: long type: string - children?: QueryProfile[] } @@ -97,4 +134,30 @@ export class ShardProfile { aggregations: AggregationProfile[] id: string searches: SearchProfile[] + fetch?: FetchProfile +} + +export class FetchProfile { + type: string + description: string + time_in_nanos: long + breakdown: FetchProfileBreakdown + debug?: FetchProfileDebug + children?: FetchProfile[] +} + +export class FetchProfileBreakdown { + load_source?: integer + load_source_count?: integer + load_stored_fields?: integer + load_stored_fields_count?: integer + next_reader?: integer + next_reader_count?: integer + process_count?: integer + process?: integer +} + +export class FetchProfileDebug { + stored_fields?: string[] + fast_path?: integer } diff --git a/specification/_global/search/_types/rescoring.ts b/specification/_global/search/_types/rescoring.ts index cd7bf5a740..f56030a9bc 100644 --- a/specification/_global/search/_types/rescoring.ts +++ b/specification/_global/search/_types/rescoring.ts @@ -26,7 +26,7 @@ export class Rescore { } export class RescoreQuery { - /** @identifier Query */ + /** @codegen_name Query */ rescore_query: QueryContainer query_weight?: double rescore_query_weight?: double diff --git a/specification/_global/search/_types/suggester.ts b/specification/_global/search/_types/suggester.ts index 4d6d611596..a7ed9f5ae7 100644 --- a/specification/_global/search/_types/suggester.ts +++ b/specification/_global/search/_types/suggester.ts @@ -28,72 +28,109 @@ import { SuggestMode, Type } from '@_types/common' -import { Distance } from '@_types/Geo' +import { GeoHash, GeoHashPrecision, GeoLocation } from '@_types/Geo' import { double, float, integer, long } from '@_types/Numeric' -import { GeoLocation } from '@_types/query_dsl/geo' +import { AdditionalProperties } from '@spec_utils/behaviors' -export class Suggest { +/** + * @variants external + */ +export type Suggest = + | CompletionSuggest + | PhraseSuggest + | TermSuggest + +export class SuggestBase { length: integer offset: integer - options: SuggestOption[] text: string } /** - * @variants container + * @variant name=completion */ -export class SuggestContainer { - completion?: CompletionSuggester - phrase?: PhraseSuggester - prefix?: string - regex?: string - term?: TermSuggester - text?: string +export class CompletionSuggest extends SuggestBase { + options: + | CompletionSuggestOption + | CompletionSuggestOption[] } -export class SuggesterBase { - field: Field - analyzer?: string - size?: integer +/** + * @variant name=phrase + */ +export class PhraseSuggest extends SuggestBase { + options: PhraseSuggestOption | PhraseSuggestOption[] } -export type SuggestOption = - | CompletionSuggestOption - | PhraseSuggestOption - | TermSuggestOption +/** + * @variant name=term + */ +export class TermSuggest extends SuggestBase { + options: TermSuggestOption | TermSuggestOption[] +} +// In the ES code a nested Hit object is expanded inline. Not all Hit fields have been +// added below as many do not make sense in the context of a suggestion. export class CompletionSuggestOption { collate_match?: boolean contexts?: Dictionary fields?: Dictionary - _id: string - _index: IndexName + _id?: string + _index?: IndexName _type?: Type _routing?: Routing - _score: double - _source: TDocument + _score?: double + _source?: TDocument text: string + score?: double } export class PhraseSuggestOption { text: string - highlighted: string score: double + highlighted?: string + collate_match?: boolean } export class TermSuggestOption { text: string - freq?: long score: double + freq: long + highlighted?: string + collate_match?: boolean +} + +export class Suggester implements AdditionalProperties { + /** Global suggest text, to avoid repetition when the same text is used in several suggesters */ + text?: string +} + +/** + * @variants container + * @non_exhaustive + */ +export class FieldSuggester { + completion?: CompletionSuggester + phrase?: PhraseSuggester + term?: TermSuggester + /** @variant container_property */ + prefix?: string + /** @variant container_property */ + regex?: string + /** @variant container_property */ + text?: string +} + +export class SuggesterBase { + field: Field + analyzer?: string + size?: integer } // completion suggester export class CompletionSuggester extends SuggesterBase { - contexts?: Dictionary< - string, - string | string[] | GeoLocation | SuggestContextQuery[] - > + contexts?: Dictionary fuzzy?: SuggestFuzziness prefix?: string regex?: string @@ -101,27 +138,29 @@ export class CompletionSuggester extends SuggesterBase { } export class SuggestFuzziness { - fuzziness: Fuzziness - min_length: integer - prefix_length: integer - transpositions: boolean - unicode_aware: boolean + fuzziness?: Fuzziness + min_length?: integer + prefix_length?: integer + transpositions?: boolean + unicode_aware?: boolean } // context suggester /** - * Text that we want similar documents for or a lookup to a document's field for the text. + * Text or location that we want similar documents for or a lookup to a document's field for the text. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters * + * @codegen_names category, location */ export type Context = string | GeoLocation -export class SuggestContextQuery { +/** @shortcut_property context */ +export class CompletionContext { boost?: double context: Context - neighbours?: Distance[] | integer[] - precision?: Distance | integer + neighbours?: GeoHashPrecision[] + precision?: GeoHashPrecision prefix?: boolean } diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts new file mode 100644 index 0000000000..b0738f0e92 --- /dev/null +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -0,0 +1,156 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Dictionary } from '@spec_utils/Dictionary' +import { RequestBase } from '@_types/Base' +import { Field, Fields, Indices } from '@_types/common' +import { AggregationContainer } from '@_types/aggregations/AggregationContainer' +import { GridType } from './_types/GridType' +import { Coordinate } from './_types/Coordinate' +import { Sort } from '@_types/sort' +import { QueryContainer } from '@_types/query_dsl/abstractions' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' +import { integer } from '@_types/Numeric' +import { ZoomLevel } from './_types/ZoomLevel' + +/** + * @rest_spec_name search_mvt + * @since 7.15.0 + * @stability experimental + */ +export interface Request extends RequestBase { + path_parts: { + /* List of indices, data streams, or aliases to search */ + index: Indices + /* Field containing geospatial data to return */ + field: Field + /* Zoom level of the vector tile to search */ + zoom: ZoomLevel + /* X coordinate for the vector tile to search */ + x: Coordinate + /* Y coordinate for the vector tile to search */ + y: Coordinate + } + query_parameters: { + /** + * If false, the meta layer’s feature is the bounding box of the tile. + * If true, the meta layer’s feature is a bounding box resulting from a + * geo_bounds aggregation. The aggregation runs on values that intersect + * the // tile with wrap_longitude set to false. The resulting + * bounding box may be larger than the vector tile. + * @server_default false + */ + exact_bounds?: boolean + /** + * Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + * @server_default 4096 + */ + extent?: integer + /** + * Additional zoom levels available through the aggs layer. For example, if is 7 + * and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + * don’t include the aggs layer. + * @server_default 8 + */ + grid_precision?: integer + /** + * Determines the geometry type for features in the aggs layer. In the aggs layer, + * each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + * of the cells bounding box. If 'point' each feature is a Point that is the centroid + * of the cell. + * @server_default grid + */ + grid_type?: GridType + /** + * Maximum number of features to return in the hits layer. Accepts 0-10000. + * If 0, results don’t include the hits layer. + * @server_default 10000 + */ + size?: integer + } + body: { + /** + * Sub-aggregations for the geotile_grid. + * + * Supports the following aggregation types: + * - avg + * - cardinality + * - max + * - min + * - sum + */ + aggs?: Dictionary + /** + * If false, the meta layer’s feature is the bounding box of the tile. + * If true, the meta layer’s feature is a bounding box resulting from a + * geo_bounds aggregation. The aggregation runs on values that intersect + * the // tile with wrap_longitude set to false. The resulting + * bounding box may be larger than the vector tile. + * @server_default false + */ + exact_bounds?: boolean + /** + * Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. + * @server_default 4096 + */ + extent?: integer + /** + * Fields to return in the `hits` layer. Supports wildcards (`*`). + * This parameter does not support fields with array values. Fields with array + * values may return inconsistent results. + */ + fields?: Fields + /** + * Additional zoom levels available through the aggs layer. For example, if is 7 + * and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + * don’t include the aggs layer. + * @server_default 8 + */ + grid_precision?: integer + /** + * Determines the geometry type for features in the aggs layer. In the aggs layer, + * each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + * of the cells bounding box. If 'point' each feature is a Point that is the centroid + * of the cell. + * @server_default grid + */ + grid_type?: GridType + /** + * Query DSL used to filter documents for the search. + */ + query?: QueryContainer + /** + * Defines one or more runtime fields in the search request. These fields take + * precedence over mapped fields with the same name. + */ + runtime_mappings?: RuntimeFields + /** + * Maximum number of features to return in the hits layer. Accepts 0-10000. + * If 0, results don’t include the hits layer. + * @server_default 10000 + */ + size?: integer + /** + * Sorts features in the hits layer. By default, the API calculates a bounding + * box for each feature. It sorts features based on this box’s diagonal length, + * from longest to shortest. + */ + sort?: Sort + } +} diff --git a/specification/dangling_indices/index_delete/DeleteDanglingIndexResponse.ts b/specification/_global/search_mvt/SearchMvtResponse.ts similarity index 91% rename from specification/dangling_indices/index_delete/DeleteDanglingIndexResponse.ts rename to specification/_global/search_mvt/SearchMvtResponse.ts index 25b5bd6764..691bf7d06c 100644 --- a/specification/dangling_indices/index_delete/DeleteDanglingIndexResponse.ts +++ b/specification/_global/search_mvt/SearchMvtResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { MapboxVectorTiles } from '@_types/Binary' export class Response { - body: { stub: integer } + body: MapboxVectorTiles } diff --git a/specification/autoscaling/capacity_get/GetAutoscalingCapacityResponse.ts b/specification/_global/search_mvt/_types/Coordinate.ts similarity index 94% rename from specification/autoscaling/capacity_get/GetAutoscalingCapacityResponse.ts rename to specification/_global/search_mvt/_types/Coordinate.ts index 25b5bd6764..c6d1bb88f5 100644 --- a/specification/autoscaling/capacity_get/GetAutoscalingCapacityResponse.ts +++ b/specification/_global/search_mvt/_types/Coordinate.ts @@ -19,6 +19,4 @@ import { integer } from '@_types/Numeric' -export class Response { - body: { stub: integer } -} +export type Coordinate = integer diff --git a/specification/_global/search_mvt/_types/GridType.ts b/specification/_global/search_mvt/_types/GridType.ts new file mode 100644 index 0000000000..2886dc0460 --- /dev/null +++ b/specification/_global/search_mvt/_types/GridType.ts @@ -0,0 +1,25 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export enum GridType { + grid, + point, + /** @since 7.16.0 */ + centroid +} diff --git a/specification/autoscaling/policy_delete/DeleteAutoscalingPolicyResponse.ts b/specification/_global/search_mvt/_types/ZoomLevel.ts similarity index 94% rename from specification/autoscaling/policy_delete/DeleteAutoscalingPolicyResponse.ts rename to specification/_global/search_mvt/_types/ZoomLevel.ts index 25b5bd6764..11127ff809 100644 --- a/specification/autoscaling/policy_delete/DeleteAutoscalingPolicyResponse.ts +++ b/specification/_global/search_mvt/_types/ZoomLevel.ts @@ -19,6 +19,4 @@ import { integer } from '@_types/Numeric' -export class Response { - body: { stub: integer } -} +export type ZoomLevel = integer diff --git a/specification/_global/search_shards/SearchShardsRequest.ts b/specification/_global/search_shards/SearchShardsRequest.ts index fd267a339f..f403eed450 100644 --- a/specification/_global/search_shards/SearchShardsRequest.ts +++ b/specification/_global/search_shards/SearchShardsRequest.ts @@ -23,13 +23,13 @@ import { ExpandWildcards, Indices, Routing } from '@_types/common' /** * @rest_spec_name search_shards * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index 2c121aba82..64922c3744 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -33,20 +33,24 @@ import { Time } from '@_types/Time' /** * @rest_spec_name search_template * @since 2.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Comma-separated list of data streams, indices, + * and aliases to search. Supports wildcards (*). + */ index?: Indices type?: Types // deprecated: 7.0 } - query_parameters?: { + query_parameters: { /** @server_default true */ allow_no_indices?: boolean /** @server_default false */ ccs_minimize_roundtrips?: boolean expand_wildcards?: ExpandWildcards - /** server_default false */ + /** @server_default false */ explain?: boolean /** @server_default true */ ignore_throttled?: boolean @@ -55,21 +59,40 @@ export interface Request extends RequestBase { preference?: string /** @server_default false */ profile?: boolean + /** Custom value used to route operations to a specific shard. */ routing?: Routing + /** + * Specifies how long a consistent view of the index + * should be maintained for scrolled search. + */ scroll?: Time + /** The type of the search operation. */ search_type?: SearchType /** * If true, hits.total are rendered as an integer in the response. * @since 7.0.0 * @server_default false */ - total_hits_as_integer?: boolean + rest_total_hits_as_int?: boolean /** @server_default false */ typed_keys?: boolean } - body?: { + body: { + /** @server_default false */ + explain?: boolean + /** + * ID of the search template to use. If no source is specified, + * this parameter is required. + */ id?: Id params?: Dictionary + /** @server_default false */ + profile?: boolean + /** + * An inline search template. Supports the same parameters as the search API's + * request body. Also supports Mustache variables. If no id is specified, this + * parameter is required. + */ source?: string } } diff --git a/specification/_global/search_template/SearchTemplateResponse.ts b/specification/_global/search_template/SearchTemplateResponse.ts index 8c72b6c61a..2bceac23d8 100644 --- a/specification/_global/search_template/SearchTemplateResponse.ts +++ b/specification/_global/search_template/SearchTemplateResponse.ts @@ -18,14 +18,31 @@ */ import { HitsMetadata } from '@global/search/_types/hits' -import { integer } from '@_types/Numeric' -import { ShardStatistics } from '@_types/Stats' +import { double, integer, long } from '@_types/Numeric' +import { ClusterStatistics, ShardStatistics } from '@_types/Stats' +import { Dictionary } from '@spec_utils/Dictionary' +import { AggregateName, Id, ScrollId, SuggestionName } from '@_types/common' +import { Aggregate } from '@_types/aggregations/Aggregate' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { Profile } from '@global/search/_types/profile' +import { Suggest } from '@global/search/_types/suggester' export class Response { body: { - _shards: ShardStatistics + // Has to be kept in sync with SearchResponse + took: long timed_out: boolean - took: integer + _shards: ShardStatistics hits: HitsMetadata + aggregations?: Dictionary + _clusters?: ClusterStatistics + fields?: Dictionary + max_score?: double + num_reduce_phases?: long + profile?: Profile + pit_id?: Id + _scroll_id?: ScrollId + suggest?: Dictionary[]> + terminated_early?: boolean } } diff --git a/specification/_global/terms_enum/TermsEnumRequest.ts b/specification/_global/terms_enum/TermsEnumRequest.ts index 2a11c18ffa..024d5a4378 100644 --- a/specification/_global/terms_enum/TermsEnumRequest.ts +++ b/specification/_global/terms_enum/TermsEnumRequest.ts @@ -26,7 +26,7 @@ import { Time } from '@_types/Time' /** * @rest_spec_name terms_enum * @since 7.14.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/termvectors/TermVectorsRequest.ts b/specification/_global/termvectors/TermVectorsRequest.ts index 4d9c529f1a..1358c70384 100644 --- a/specification/_global/termvectors/TermVectorsRequest.ts +++ b/specification/_global/termvectors/TermVectorsRequest.ts @@ -34,15 +34,15 @@ import { Filter } from './types' /** * @rest_spec_name termvectors * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName id?: Id type?: Type } - query_parameters?: { + query_parameters: { fields?: Fields field_statistics?: boolean offsets?: boolean @@ -55,7 +55,7 @@ export interface Request extends RequestBase { version?: VersionNumber version_type?: VersionType } - body?: { + body: { doc?: TDocument filter?: Filter per_field_analyzer?: Dictionary diff --git a/specification/_global/termvectors/types.ts b/specification/_global/termvectors/types.ts index 721bb7da0e..501bada5c7 100644 --- a/specification/_global/termvectors/types.ts +++ b/specification/_global/termvectors/types.ts @@ -35,7 +35,7 @@ export class Term { doc_freq?: integer score?: double term_freq: integer - tokens: Token[] + tokens?: Token[] ttf?: integer } diff --git a/specification/_global/update/UpdateRequest.ts b/specification/_global/update/UpdateRequest.ts index eb6b1e6545..610c4aff42 100644 --- a/specification/_global/update/UpdateRequest.ts +++ b/specification/_global/update/UpdateRequest.ts @@ -17,7 +17,10 @@ * under the License. */ -import { SourceFilter } from '@global/search/_types/SourceFilter' +import { + SourceConfigParam, + SourceConfig +} from '@global/search/_types/SourceFilter' import { RequestBase } from '@_types/Base' import { Fields, @@ -29,45 +32,122 @@ import { Type, WaitForActiveShards } from '@_types/common' -import { long } from '@_types/Numeric' +import { integer, long } from '@_types/Numeric' import { Script } from '@_types/Scripting' import { Time } from '@_types/Time' /** * @rest_spec_name update * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id index: IndexName type?: Type } - query_parameters?: { + query_parameters: { + /** + * Only perform the operation if the document has this primary term. + */ if_primary_term?: long + /** + * Only perform the operation if the document has this sequence number. + */ if_seq_no?: SequenceNumber + /** + * The script language. + * @server_default painless + */ lang?: string + /** + * If 'true', Elasticsearch refreshes the affected shards to make this operation + * visible to search, if 'wait_for' then wait for a refresh to make this operation + * visible to search, if 'false' do nothing with refreshes. + * @server_default false + */ refresh?: Refresh + /** + * If true, the destination must be an index alias. + * @server_default false + */ require_alias?: boolean - retry_on_conflict?: long + /** + * Specify how many times should the operation be retried when a conflict occurs. + * @server_default 0 + */ + retry_on_conflict?: integer + /** + * Custom value used to route operations to a specific shard. + */ routing?: Routing - source_enabled?: boolean + /** + * Period to wait for dynamic mapping updates and active shards. + * This guarantees Elasticsearch waits for at least the timeout before failing. + * The actual wait time could be longer, particularly when multiple waits occur. + * @server_default 1m + */ timeout?: Time + /** + * The number of shard copies that must be active before proceeding with the operations. + * Set to 'all' or any positive integer up to the total number of shards in the index + * (number_of_replicas+1). Defaults to 1 meaning the primary shard. + * @server_default 1 + */ wait_for_active_shards?: WaitForActiveShards - _source?: boolean | Fields + /** + * Set to false to disable source retrieval. You can also specify a comma-separated + * list of the fields you want to retrieve. + * @server_default true + */ + _source?: SourceConfigParam + /** + * Specify the source fields you want to exclude. + */ _source_excludes?: Fields + /** + * Specify the source fields you want to retrieve. + */ _source_includes?: Fields } - body?: { + body: { + /** + * Set to false to disable setting 'result' in the response + * to 'noop' if no change to the document occurred. + * @server_default true + */ detect_noop?: boolean - /** @prop_serializer SourceFormatter`1 */ + /** + * A partial update to an existing document. + * @prop_serializer SourceFormatter`1 + */ doc?: TPartialDocument + /** + * Set to true to use the contents of 'doc' as the value of 'upsert' + * @server_default false + */ doc_as_upsert?: boolean + /** + * Script to execute to update the document. + */ script?: Script + /** + * Set to true to execute the script whether or not the document exists. + * @server_default false + */ scripted_upsert?: boolean - _source?: boolean | SourceFilter - /** @prop_serializer SourceFormatter`1 */ + /** + * Set to false to disable source retrieval. You can also specify a comma-separated + * list of the fields you want to retrieve. + * @server_default true + */ + _source?: SourceConfig + /** + * If the document does not already exist, the contents of 'upsert' are inserted as a + * new document. If the document exists, the 'script' is executed. + * @prop_serializer SourceFormatter`1 + */ upsert?: TDocument } } diff --git a/specification/_global/update_by_query/UpdateByQueryRequest.ts b/specification/_global/update_by_query/UpdateByQueryRequest.ts index 53c0dcec0a..7e2e185e9c 100644 --- a/specification/_global/update_by_query/UpdateByQueryRequest.ts +++ b/specification/_global/update_by_query/UpdateByQueryRequest.ts @@ -20,13 +20,12 @@ import { RequestBase } from '@_types/Base' import { Conflicts, - DefaultOperator, ExpandWildcards, - Fields, Indices, Routing, SearchType, Types, + Slices, WaitForActiveShards } from '@_types/common' import { long } from '@_types/Numeric' @@ -34,23 +33,24 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Script } from '@_types/Scripting' import { SlicedScroll } from '@_types/SlicedScroll' import { Time } from '@_types/Time' +import { Operator } from '@_types/query_dsl/Operator' /** * @rest_spec_name update_by_query * @since 2.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean conflicts?: Conflicts - default_operator?: DefaultOperator + default_operator?: Operator df?: string expand_wildcards?: ExpandWildcards from?: long @@ -58,7 +58,6 @@ export interface Request extends RequestBase { lenient?: boolean pipeline?: string preference?: string - query_on_query_string?: string refresh?: boolean request_cache?: boolean requests_per_second?: long @@ -68,11 +67,8 @@ export interface Request extends RequestBase { search_timeout?: Time search_type?: SearchType size?: long - slices?: long + slices?: Slices sort?: string[] - source_enabled?: boolean - source_excludes?: Fields - source_includes?: Fields stats?: string[] terminate_after?: long timeout?: Time @@ -81,7 +77,7 @@ export interface Request extends RequestBase { wait_for_active_shards?: WaitForActiveShards wait_for_completion?: boolean } - body?: { + body: { max_docs?: long query?: QueryContainer script?: Script diff --git a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts index 8fa48a19f5..f8afbb1c9c 100644 --- a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts +++ b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts @@ -19,7 +19,7 @@ import { BaseNode } from '@spec_utils/BaseNode' import { Dictionary } from '@spec_utils/Dictionary' -import { Info } from '@task/_types/TaskInfo' +import { Info } from '@tasks/_types/TaskInfo' import { TaskId } from '@_types/common' export class UpdateByQueryRethrottleNode extends BaseNode { diff --git a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts index d2efb8ef5e..13c24ff70e 100644 --- a/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts +++ b/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts @@ -24,14 +24,13 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name update_by_query_rethrottle * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { task_id: Id } - query_parameters?: { + query_parameters: { requests_per_second?: long } - body?: {} } diff --git a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json index 8cb7554810..4ad428d80a 100644 --- a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json @@ -5,7 +5,7 @@ "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, "stability": "stable", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/autoscaling.get_autoscaling_capacity.json b/specification/_json_spec/autoscaling.get_autoscaling_capacity.json index 175b1aa3a4..11258845e1 100644 --- a/specification/_json_spec/autoscaling.get_autoscaling_capacity.json +++ b/specification/_json_spec/autoscaling.get_autoscaling_capacity.json @@ -5,7 +5,7 @@ "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, "stability": "stable", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/autoscaling.get_autoscaling_policy.json b/specification/_json_spec/autoscaling.get_autoscaling_policy.json index d68ed741c7..29880406c4 100644 --- a/specification/_json_spec/autoscaling.get_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.get_autoscaling_policy.json @@ -5,7 +5,7 @@ "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, "stability": "stable", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/autoscaling.put_autoscaling_policy.json b/specification/_json_spec/autoscaling.put_autoscaling_policy.json index 22244dbb62..5e5361ce6d 100644 --- a/specification/_json_spec/autoscaling.put_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.put_autoscaling_policy.json @@ -5,7 +5,7 @@ "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, "stability": "stable", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/close_point_in_time.json b/specification/_json_spec/close_point_in_time.json index 59d46fe3db..8d1676913c 100644 --- a/specification/_json_spec/close_point_in_time.json +++ b/specification/_json_spec/close_point_in_time.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ diff --git a/specification/_json_spec/cluster.allocation_explain.json b/specification/_json_spec/cluster.allocation_explain.json index ca4a8c1c4f..7fc4ee9d4e 100644 --- a/specification/_json_spec/cluster.allocation_explain.json +++ b/specification/_json_spec/cluster.allocation_explain.json @@ -29,7 +29,7 @@ } }, "body": { - "description": "The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'" + "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'" } } } diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index dbc22e4cc3..ddcd458859 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -127,18 +127,6 @@ "type": "list", "description": "A comma-separated list of : pairs" }, - "_source": { - "type": "list", - "description": "True or false to return the _source field or not, or a list of fields to return" - }, - "_source_excludes": { - "type": "list", - "description": "A list of fields to exclude from the returned _source field" - }, - "_source_includes": { - "type": "list", - "description": "A list of fields to extract and return from the _source field" - }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." diff --git a/specification/_json_spec/eql.search.json b/specification/_json_spec/eql.search.json index 317db8b7ab..430a2a5ac8 100644 --- a/specification/_json_spec/eql.search.json +++ b/specification/_json_spec/eql.search.json @@ -5,8 +5,7 @@ "description": "Returns results matching a query expressed in Event Query Language (EQL)" }, "stability": "stable", - "visibility": "feature_flag", - "feature_flag": "es.eql_feature_flag_registered", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index 1987ac0013..e809afd39e 100644 --- a/specification/_json_spec/field_caps.json +++ b/specification/_json_spec/field_caps.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ diff --git a/specification/_json_spec/fleet.global_checkpoints.json b/specification/_json_spec/fleet.global_checkpoints.json index 08ba5de027..1b48e57c8e 100644 --- a/specification/_json_spec/fleet.global_checkpoints.json +++ b/specification/_json_spec/fleet.global_checkpoints.json @@ -1,10 +1,10 @@ { "fleet.global_checkpoints": { "documentation": { - "url": null, + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project." }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/fleet.msearch.json b/specification/_json_spec/fleet.msearch.json new file mode 100644 index 0000000000..bc3fcafb8c --- /dev/null +++ b/specification/_json_spec/fleet.msearch.json @@ -0,0 +1,38 @@ +{ + "fleet.msearch": { + "documentation": { + "url": null, + "description": "Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/x-ndjson"] + }, + "url": { + "paths": [ + { + "path": "/_fleet/_fleet_msearch", + "methods": ["GET", "POST"] + }, + { + "path": "/{index}/_fleet/_fleet_msearch", + "methods": ["GET", "POST"], + "parts": { + "index": { + "type": "string", + "description": "The index name to use as the default" + } + } + } + ] + }, + "params": {}, + "body": { + "description": "The request definitions (metadata-fleet search request definition pairs), separated by newlines", + "required": true, + "serialize": "bulk" + } + } +} diff --git a/specification/_json_spec/fleet.search.json b/specification/_json_spec/fleet.search.json new file mode 100644 index 0000000000..b865853c9d --- /dev/null +++ b/specification/_json_spec/fleet.search.json @@ -0,0 +1,47 @@ +{ + "fleet.search": { + "documentation": { + "url": null, + "description": "Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_fleet/_fleet_search", + "methods": ["GET", "POST"], + "parts": { + "index": { + "type": "string", + "description": "The index name to search." + } + } + } + ] + }, + "params": { + "wait_for_checkpoints": { + "type": "list", + "description": "Comma separated list of checkpoints, one per shard", + "default": "" + }, + "wait_for_checkpoints_timeout": { + "type": "time", + "description": "Explicit wait_for_checkpoints timeout" + }, + "allow_partial_search_results": { + "type": "boolean", + "default": true, + "description": "Indicate if an error should be returned if there is a partial search failure or timeout" + } + }, + "body": { + "description": "The search definition using the Query DSL" + } + } +} diff --git a/specification/_json_spec/get_script_context.json b/specification/_json_spec/get_script_context.json index cc0833234b..dcc641af7a 100644 --- a/specification/_json_spec/get_script_context.json +++ b/specification/_json_spec/get_script_context.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "description": "Returns all script contexts." }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/get_script_languages.json b/specification/_json_spec/get_script_languages.json index ba3f39e301..9af189bee1 100644 --- a/specification/_json_spec/get_script_languages.json +++ b/specification/_json_spec/get_script_languages.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "description": "Returns available script types, languages and contexts" }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/indices.delete.json b/specification/_json_spec/indices.delete.json index de91341e05..8e49e457f6 100644 --- a/specification/_json_spec/indices.delete.json +++ b/specification/_json_spec/indices.delete.json @@ -43,8 +43,8 @@ "expand_wildcards": { "type": "enum", "options": ["open", "closed", "hidden", "none", "all"], - "default": "open", - "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)" + "default": "open,closed", + "description": "Whether wildcard expressions should get expanded to open, closed, or hidden indices" } } } diff --git a/specification/_json_spec/indices.get_index_template.json b/specification/_json_spec/indices.get_index_template.json index cf52d64265..e9443c426f 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -20,8 +20,8 @@ "methods": ["GET"], "parts": { "name": { - "type": "list", - "description": "The comma separated names of the index templates" + "type": "string", + "description": "A pattern that returned template names must match" } } } diff --git a/specification/_json_spec/indices.modify_data_stream.json b/specification/_json_spec/indices.modify_data_stream.json new file mode 100644 index 0000000000..c279a51304 --- /dev/null +++ b/specification/_json_spec/indices.modify_data_stream.json @@ -0,0 +1,27 @@ +{ + "indices.modify_data_stream": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "description": "Modifies a data stream" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_data_stream/_modify", + "methods": ["POST"] + } + ] + }, + "params": {}, + "body": { + "description": "The data stream modifications", + "required": true + } + } +} diff --git a/specification/_json_spec/indices.resolve_index.json b/specification/_json_spec/indices.resolve_index.json index 314ed77506..07d6775fd0 100644 --- a/specification/_json_spec/indices.resolve_index.json +++ b/specification/_json_spec/indices.resolve_index.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "description": "Returns information about any matching indices, aliases, and data streams" }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/ingest.put_pipeline.json b/specification/_json_spec/ingest.put_pipeline.json index 14147e04bb..f0ccd500c8 100644 --- a/specification/_json_spec/ingest.put_pipeline.json +++ b/specification/_json_spec/ingest.put_pipeline.json @@ -25,6 +25,10 @@ ] }, "params": { + "if_version": { + "type": "int", + "description": "Required version for optimistic concurrency control for pipeline updates" + }, "master_timeout": { "type": "time", "description": "Explicit operation timeout for connection to master node" diff --git a/specification/_json_spec/migration.get_feature_upgrade_status.json b/specification/_json_spec/migration.get_feature_upgrade_status.json new file mode 100644 index 0000000000..5a508adf4b --- /dev/null +++ b/specification/_json_spec/migration.get_feature_upgrade_status.json @@ -0,0 +1,22 @@ +{ + "migration.get_feature_upgrade_status": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "description": "Find out whether system features need to be upgraded or not" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/system_features", + "methods": ["GET"] + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/migration.post_feature_upgrade.json b/specification/_json_spec/migration.post_feature_upgrade.json new file mode 100644 index 0000000000..cfd99f0992 --- /dev/null +++ b/specification/_json_spec/migration.post_feature_upgrade.json @@ -0,0 +1,22 @@ +{ + "migration.post_feature_upgrade": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "description": "Begin upgrades for system features" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/system_features", + "methods": ["POST"] + } + ] + }, + "params": {} + } +} diff --git a/specification/_json_spec/ml.delete_expired_data.json b/specification/_json_spec/ml.delete_expired_data.json index 2349c2fcfe..73932205ec 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ diff --git a/specification/_json_spec/ml.forecast.json b/specification/_json_spec/ml.forecast.json index bf6ab479a3..f54cd04b51 100644 --- a/specification/_json_spec/ml.forecast.json +++ b/specification/_json_spec/ml.forecast.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ @@ -39,6 +40,10 @@ "required": false, "description": "The max memory able to be used by the forecast. Default is 20mb." } + }, + "body": { + "description": "Query parameters can be specified in the body", + "required": false } } } diff --git a/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json b/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json new file mode 100644 index 0000000000..cf610477e8 --- /dev/null +++ b/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json @@ -0,0 +1,38 @@ +{ + "ml.get_model_snapshot_upgrade_stats": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", + "description": "Gets stats for anomaly detection job model snapshot upgrades that are in progress." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats", + "methods": ["GET"], + "parts": { + "job_id": { + "type": "string", + "description": "The ID of the job. May be a wildcard, comma separated list or `_all`." + }, + "snapshot_id": { + "type": "string", + "description": "The ID of the snapshot. May be a wildcard, comma separated list or `_all`." + } + } + } + ] + }, + "params": { + "allow_no_match": { + "type": "boolean", + "required": false, + "description": "Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.)" + } + } + } +} diff --git a/specification/_json_spec/ml.open_job.json b/specification/_json_spec/ml.open_job.json index 118fbfd172..5e8bf45bad 100644 --- a/specification/_json_spec/ml.open_job.json +++ b/specification/_json_spec/ml.open_job.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ @@ -22,6 +23,10 @@ } } ] + }, + "body": { + "description": "Query parameters can be specified in the body", + "required": false } } } diff --git a/specification/_json_spec/ml.preview_datafeed.json b/specification/_json_spec/ml.preview_datafeed.json index 156cd22771..5e39b0db64 100644 --- a/specification/_json_spec/ml.preview_datafeed.json +++ b/specification/_json_spec/ml.preview_datafeed.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ diff --git a/specification/_json_spec/ml.put_trained_model.json b/specification/_json_spec/ml.put_trained_model.json index 9cd4e69a0a..a41bb732c2 100644 --- a/specification/_json_spec/ml.put_trained_model.json +++ b/specification/_json_spec/ml.put_trained_model.json @@ -24,6 +24,14 @@ } ] }, + "params": { + "defer_definition_decompression": { + "required": false, + "type": "boolean", + "description": "If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.", + "default": false + } + }, "body": { "description": "The trained model configuration", "required": true diff --git a/specification/_json_spec/ml.stop_datafeed.json b/specification/_json_spec/ml.stop_datafeed.json index 099bbe0fa4..316c0dd24f 100644 --- a/specification/_json_spec/ml.stop_datafeed.json +++ b/specification/_json_spec/ml.stop_datafeed.json @@ -7,7 +7,8 @@ "stability": "stable", "visibility": "public", "headers": { - "accept": ["application/json"] + "accept": ["application/json"], + "content_type": ["application/json"] }, "url": { "paths": [ diff --git a/specification/_json_spec/ml.validate.json b/specification/_json_spec/ml.validate.json index 3239353c06..b70c729627 100644 --- a/specification/_json_spec/ml.validate.json +++ b/specification/_json_spec/ml.validate.json @@ -5,7 +5,7 @@ "description": "Validates an anomaly detection job." }, "stability": "stable", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/ml.validate_detector.json b/specification/_json_spec/ml.validate_detector.json index 36f2f3d767..85a301cd9a 100644 --- a/specification/_json_spec/ml.validate_detector.json +++ b/specification/_json_spec/ml.validate_detector.json @@ -5,7 +5,7 @@ "description": "Validates an anomaly detection detector." }, "stability": "stable", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/monitoring.bulk.json b/specification/_json_spec/monitoring.bulk.json index c8acc16d41..f58c1629d3 100644 --- a/specification/_json_spec/monitoring.bulk.json +++ b/specification/_json_spec/monitoring.bulk.json @@ -4,8 +4,8 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "description": "Used by the monitoring features to send monitoring data." }, - "stability": "experimental", - "visibility": "public", + "stability": "stable", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/x-ndjson"] diff --git a/specification/_json_spec/nodes.clear_metering_archive.json b/specification/_json_spec/nodes.clear_repositories_metering_archive.json similarity index 95% rename from specification/_json_spec/nodes.clear_metering_archive.json rename to specification/_json_spec/nodes.clear_repositories_metering_archive.json index 56134e8efb..1bc51fe08b 100644 --- a/specification/_json_spec/nodes.clear_metering_archive.json +++ b/specification/_json_spec/nodes.clear_repositories_metering_archive.json @@ -1,5 +1,5 @@ { - "nodes.clear_metering_archive": { + "nodes.clear_repositories_metering_archive": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", "description": "Removes the archived repositories metering information present in the cluster." diff --git a/specification/_json_spec/nodes.get_metering_info.json b/specification/_json_spec/nodes.get_repositories_metering_info.json similarity index 94% rename from specification/_json_spec/nodes.get_metering_info.json rename to specification/_json_spec/nodes.get_repositories_metering_info.json index 0c735f6ea3..7d393683d5 100644 --- a/specification/_json_spec/nodes.get_metering_info.json +++ b/specification/_json_spec/nodes.get_repositories_metering_info.json @@ -1,5 +1,5 @@ { - "nodes.get_metering_info": { + "nodes.get_repositories_metering_info": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", "description": "Returns cluster repositories metering information." diff --git a/specification/_json_spec/nodes.hot_threads.json b/specification/_json_spec/nodes.hot_threads.json index 3aed896b1d..967c5e07b5 100644 --- a/specification/_json_spec/nodes.hot_threads.json +++ b/specification/_json_spec/nodes.hot_threads.json @@ -115,9 +115,14 @@ }, "type": { "type": "enum", - "options": ["cpu", "wait", "block"], + "options": ["cpu", "wait", "block", "mem"], "description": "The type to sample (default: cpu)" }, + "sort": { + "type": "enum", + "options": ["cpu", "total"], + "description": "The sort order for 'cpu' type (default: total)" + }, "timeout": { "type": "time", "description": "Explicit operation timeout" diff --git a/specification/_json_spec/nodes.info.json b/specification/_json_spec/nodes.info.json index dec543b19c..4beefc22d5 100644 --- a/specification/_json_spec/nodes.info.json +++ b/specification/_json_spec/nodes.info.json @@ -40,9 +40,11 @@ "transport", "http", "plugins", - "ingest" + "ingest", + "indices", + "aggregations" ], - "description": "A comma-separated list of metrics you wish returned. Leave empty to return all." + "description": "A comma-separated list of metrics you wish returned. Leave empty to return all metrics." } } }, @@ -65,9 +67,13 @@ "transport", "http", "plugins", - "ingest" + "ingest", + "indices", + "aggregations", + "_all", + "_none" ], - "description": "A comma-separated list of metrics you wish returned. Leave empty to return all." + "description": "A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics." } } } diff --git a/specification/_json_spec/nodes.stats.json b/specification/_json_spec/nodes.stats.json index 6567cb2537..0324c4d9ee 100644 --- a/specification/_json_spec/nodes.stats.json +++ b/specification/_json_spec/nodes.stats.json @@ -117,7 +117,8 @@ "segments", "store", "warmer", - "suggest" + "suggest", + "shard_stats" ], "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified." } @@ -163,7 +164,8 @@ "segments", "store", "warmer", - "suggest" + "suggest", + "shard_stats" ], "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified." }, diff --git a/specification/_json_spec/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json index 5482c3090c..5652b5e953 100644 --- a/specification/_json_spec/open_point_in_time.json +++ b/specification/_json_spec/open_point_in_time.json @@ -11,10 +11,6 @@ }, "url": { "paths": [ - { - "path": "/_pit", - "methods": ["POST"] - }, { "path": "/{index}/_pit", "methods": ["POST"], @@ -48,7 +44,8 @@ }, "keep_alive": { "type": "string", - "description": "Specific the time to live for the point in time" + "description": "Specific the time to live for the point in time", + "required": true } } } diff --git a/specification/_json_spec/rank_eval.json b/specification/_json_spec/rank_eval.json index c265d9ae0d..801d72a4ec 100644 --- a/specification/_json_spec/rank_eval.json +++ b/specification/_json_spec/rank_eval.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries" }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/search_mvt.json b/specification/_json_spec/search_mvt.json new file mode 100644 index 0000000000..181a327a43 --- /dev/null +++ b/specification/_json_spec/search_mvt.json @@ -0,0 +1,80 @@ +{ + "search_mvt": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", + "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/vnd.mapbox-vector-tile"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_mvt/{field}/{zoom}/{x}/{y}", + "methods": ["POST", "GET"], + "parts": { + "index": { + "type": "list", + "description": "Comma-separated list of data streams, indices, or aliases to search" + }, + "field": { + "type": "string", + "description": "Field containing geospatial data to return" + }, + "zoom": { + "type": "int", + "description": "Zoom level for the vector tile to search" + }, + "x": { + "type": "int", + "description": "X coordinate for the vector tile to search" + }, + "y": { + "type": "int", + "description": "Y coordinate for the vector tile to search" + } + } + } + ] + }, + "params": { + "exact_bounds": { + "type": "boolean", + "description": "If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation.", + "default": false + }, + "extent": { + "type": "int", + "description": "Size, in pixels, of a side of the vector tile.", + "default": 4096 + }, + "grid_precision": { + "type": "int", + "description": "Additional zoom levels available through the aggs layer. Accepts 0-8.", + "default": 8 + }, + "grid_type": { + "type": "enum", + "options": ["grid", "point", "centroid"], + "description": "Determines the geometry type for features in the aggs layer.", + "default": "grid" + }, + "size": { + "type": "int", + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.", + "default": 10000 + }, + "track_total_hits": { + "type": "boolean|long", + "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number." + } + }, + "body": { + "description": "Search request body.", + "required": false + } + } +} diff --git a/specification/_json_spec/searchable_snapshots.mount.json b/specification/_json_spec/searchable_snapshots.mount.json index 98da820b5c..5c50ada9a3 100644 --- a/specification/_json_spec/searchable_snapshots.mount.json +++ b/specification/_json_spec/searchable_snapshots.mount.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html", "description": "Mount a snapshot as a searchable index." }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/searchable_snapshots.stats.json b/specification/_json_spec/searchable_snapshots.stats.json index be318587dc..bd7cfdb4d1 100644 --- a/specification/_json_spec/searchable_snapshots.stats.json +++ b/specification/_json_spec/searchable_snapshots.stats.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html", "description": "Retrieve shard-level statistics about searchable snapshots." }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/security.clear_cached_service_tokens.json b/specification/_json_spec/security.clear_cached_service_tokens.json index 118e863eb0..5dfd13d621 100644 --- a/specification/_json_spec/security.clear_cached_service_tokens.json +++ b/specification/_json_spec/security.clear_cached_service_tokens.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "description": "Evicts tokens from the service account token caches." }, - "stability": "beta", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/security.create_service_token.json b/specification/_json_spec/security.create_service_token.json index f36b391ef4..3df72e92c1 100644 --- a/specification/_json_spec/security.create_service_token.json +++ b/specification/_json_spec/security.create_service_token.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "description": "Creates a service account token for access without requiring basic authentication." }, - "stability": "beta", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/security.delete_service_token.json b/specification/_json_spec/security.delete_service_token.json index 8e86f9bef1..f00f3e7450 100644 --- a/specification/_json_spec/security.delete_service_token.json +++ b/specification/_json_spec/security.delete_service_token.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "description": "Deletes a service account token." }, - "stability": "beta", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/security.get_service_accounts.json b/specification/_json_spec/security.get_service_accounts.json index db98218af2..01d38e241b 100644 --- a/specification/_json_spec/security.get_service_accounts.json +++ b/specification/_json_spec/security.get_service_accounts.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "description": "Retrieves information about service accounts." }, - "stability": "beta", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/security.get_service_credentials.json b/specification/_json_spec/security.get_service_credentials.json index a57e601eee..95e9940b5e 100644 --- a/specification/_json_spec/security.get_service_credentials.json +++ b/specification/_json_spec/security.get_service_credentials.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", "description": "Retrieves information of all service credentials for a service account." }, - "stability": "beta", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/security.query_api_keys.json b/specification/_json_spec/security.query_api_keys.json new file mode 100644 index 0000000000..ec11db8955 --- /dev/null +++ b/specification/_json_spec/security.query_api_keys.json @@ -0,0 +1,27 @@ +{ + "security.query_api_keys": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", + "description": "Retrieves information for API keys using a subset of query DSL" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_security/_query/api_key", + "methods": ["GET", "POST"] + } + ] + }, + "params": {}, + "body": { + "description": "From, size, query, sort and search_after", + "required": false + } + } +} diff --git a/specification/_json_spec/shutdown.delete_node.json b/specification/_json_spec/shutdown.delete_node.json index 09ebdaecf9..c8e2b8856b 100644 --- a/specification/_json_spec/shutdown.delete_node.json +++ b/specification/_json_spec/shutdown.delete_node.json @@ -2,10 +2,10 @@ "shutdown.delete_node": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "description": "Removes a node from the shutdown list" + "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, - "stability": "experimental", - "visibility": "public", + "stability": "stable", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/shutdown.get_node.json b/specification/_json_spec/shutdown.get_node.json index dab9fd57fc..6510d14f9b 100644 --- a/specification/_json_spec/shutdown.get_node.json +++ b/specification/_json_spec/shutdown.get_node.json @@ -2,10 +2,10 @@ "shutdown.get_node": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "description": "Retrieve status of a node or nodes that are currently marked as shutting down" + "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, - "stability": "experimental", - "visibility": "public", + "stability": "stable", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/shutdown.put_node.json b/specification/_json_spec/shutdown.put_node.json index ba21b0dde2..3aa5f1b0c7 100644 --- a/specification/_json_spec/shutdown.put_node.json +++ b/specification/_json_spec/shutdown.put_node.json @@ -2,10 +2,10 @@ "shutdown.put_node": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "description": "Adds a node to be shut down" + "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." }, - "stability": "experimental", - "visibility": "public", + "stability": "stable", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/snapshot.get.json b/specification/_json_spec/snapshot.get.json index a230a99594..e0b9bf5547 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -44,6 +44,46 @@ "type": "boolean", "description": "Whether to include the repository name in the snapshot info. Defaults to true." }, + "sort": { + "type": "enum", + "default": "start_time", + "options": [ + "start_time", + "duration", + "name", + "repository", + "index_count", + "shard_count", + "failed_shard_count" + ], + "description": "Allows setting a sort order for the result. Defaults to start_time" + }, + "size": { + "type": "integer", + "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit." + }, + "order": { + "type": "enum", + "default": "asc", + "options": ["asc", "desc"], + "description": "Sort order" + }, + "from_sort_value": { + "type": "string", + "description": "Value of the current sort column at which to start retrieval." + }, + "after": { + "type": "string", + "description": "Offset identifier to start pagination from as returned by the 'next' field in the response body." + }, + "offset": { + "type": "integer", + "description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0" + }, + "slm_policy_filter": { + "type": "string", + "description": "Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy" + }, "verbose": { "type": "boolean", "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob" diff --git a/specification/_json_spec/terms_enum.json b/specification/_json_spec/terms_enum.json index 0da3073250..e8018491f9 100644 --- a/specification/_json_spec/terms_enum.json +++ b/specification/_json_spec/terms_enum.json @@ -4,7 +4,7 @@ "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios." }, - "stability": "beta", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/transform.delete_transform.json b/specification/_json_spec/transform.delete_transform.json index 3a9e92f7aa..46566108c1 100644 --- a/specification/_json_spec/transform.delete_transform.json +++ b/specification/_json_spec/transform.delete_transform.json @@ -28,6 +28,11 @@ "type": "boolean", "required": false, "description": "When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted." + }, + "timeout": { + "type": "time", + "required": false, + "description": "Controls the time to wait for the transform deletion" } } } diff --git a/specification/_json_spec/transform.preview_transform.json b/specification/_json_spec/transform.preview_transform.json index d701c0114d..6ea0764d4a 100644 --- a/specification/_json_spec/transform.preview_transform.json +++ b/specification/_json_spec/transform.preview_transform.json @@ -12,15 +12,32 @@ }, "url": { "paths": [ + { + "path": "/_transform/{transform_id}/_preview", + "methods": ["GET", "POST"], + "parts": { + "transform_id": { + "type": "string", + "description": "The id of the transform to preview." + } + } + }, { "path": "/_transform/_preview", - "methods": ["POST"] + "methods": ["GET", "POST"] } ] }, + "params": { + "timeout": { + "type": "time", + "required": false, + "description": "Controls the time to wait for the preview" + } + }, "body": { "description": "The definition for the transform to preview", - "required": true + "required": false } } } diff --git a/specification/_json_spec/transform.put_transform.json b/specification/_json_spec/transform.put_transform.json index 63b4d23e60..79214c0b0b 100644 --- a/specification/_json_spec/transform.put_transform.json +++ b/specification/_json_spec/transform.put_transform.json @@ -29,6 +29,11 @@ "type": "boolean", "required": false, "description": "If validations should be deferred until transform starts, defaults to false." + }, + "timeout": { + "type": "time", + "required": false, + "description": "Controls the time to wait for the transform to start" } }, "body": { diff --git a/specification/_json_spec/transform.update_transform.json b/specification/_json_spec/transform.update_transform.json index c21972228f..47ef2d4126 100644 --- a/specification/_json_spec/transform.update_transform.json +++ b/specification/_json_spec/transform.update_transform.json @@ -30,6 +30,11 @@ "type": "boolean", "required": false, "description": "If validations should be deferred until transform starts, defaults to false." + }, + "timeout": { + "type": "time", + "required": false, + "description": "Controls the time to wait for the update" } }, "body": { diff --git a/specification/_json_spec/transform.upgrade_transforms.json b/specification/_json_spec/transform.upgrade_transforms.json new file mode 100644 index 0000000000..55dc5a3679 --- /dev/null +++ b/specification/_json_spec/transform.upgrade_transforms.json @@ -0,0 +1,34 @@ +{ + "transform.upgrade_transforms": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", + "description": "Upgrades all transforms." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_transform/_upgrade", + "methods": ["POST"] + } + ] + }, + "params": { + "dry_run": { + "type": "boolean", + "required": false, + "description": "Whether to only check for updates but don't execute" + }, + "timeout": { + "type": "time", + "required": false, + "description": "Controls the time to wait for the upgrade" + } + } + } +} diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 7004803952..15cc3272b2 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -2,7 +2,7 @@ "update_by_query": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", - "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change." + "description": "Updates documents that match the specified query. If no query is specified,\n performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change." }, "stability": "stable", "visibility": "public", @@ -131,18 +131,6 @@ "type": "list", "description": "A comma-separated list of : pairs" }, - "_source": { - "type": "list", - "description": "True or false to return the _source field or not, or a list of fields to return" - }, - "_source_excludes": { - "type": "list", - "description": "A list of fields to exclude from the returned _source field" - }, - "_source_includes": { - "type": "list", - "description": "A list of fields to extract and return from the _source field" - }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." diff --git a/specification/ml/find_file_structure/MlFindFileStructureRequest.ts b/specification/_spec_utils/Stringified.ts similarity index 68% rename from specification/ml/find_file_structure/MlFindFileStructureRequest.ts rename to specification/_spec_utils/Stringified.ts index 7b8c02536d..c0917b06f3 100644 --- a/specification/ml/find_file_structure/MlFindFileStructureRequest.ts +++ b/specification/_spec_utils/Stringified.ts @@ -17,18 +17,11 @@ * under the License. */ -import { RequestBase } from '@_types/Base' - /** - * Depreacted in 7.12 - * see: https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-find-file-structure.html + * Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior + * is used to capture this behavior while keeping the semantics of the field type. * - * @rest_spec_name ml.find_file_structure - * @since 5.4.0 - * @stability TODO + * Depending on the target language, code generators can keep the union or remove it and leniently parse + * strings to the target type. */ -export interface Request extends RequestBase { - path_parts: { - stub: string - } -} +export type Stringified = T | string diff --git a/specification/_spec_utils/VoidValue.ts b/specification/_spec_utils/VoidValue.ts index 74d6ae0e58..b837730bbd 100644 --- a/specification/_spec_utils/VoidValue.ts +++ b/specification/_spec_utils/VoidValue.ts @@ -18,6 +18,11 @@ */ /** - * The absence of any type. This is commonly used in APIs that returns an empty body. + * The absence of any type. This is commonly used in APIs that don't return a body. + * + * Although "void" is generally used for the unit type that has only one value, this is to be interpreted as + * the bottom type that has no value at all. Most languages have a unit type, but few have a bottom type. + * + * See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type */ export type Void = void diff --git a/specification/_spec_utils/behaviors.ts b/specification/_spec_utils/behaviors.ts index ab760dbca8..10fc7697f6 100644 --- a/specification/_spec_utils/behaviors.ts +++ b/specification/_spec_utils/behaviors.ts @@ -55,11 +55,32 @@ export interface AdditionalProperty {} * @behavior Defines a common set of query parameters all API's support that alter the overall response. */ export interface CommonQueryParameters { + /** + * When set to `true` Elasticsearch will include the full stack trace of errors + * when they occur. + * @server_default false + */ error_trace?: boolean + /** + * Comma-separated list of filters in dot notation which reduce the response + * returned by Elasticsearch. + */ filter_path?: string | string[] + /** + * When set to `true` will return statistics in a format suitable for humans. + * For example `"exists_time": "1h"` for humans and + * `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + * readable values will be omitted. This makes sense for responses being consumed + * only by machines. + * @server_default false + */ human?: boolean + /** + * If set to `true` the returned JSON will be "pretty-formatted". Only use + * this option for debugging only. + * @server_default false + */ pretty?: boolean - source_query_string?: string } /** @@ -68,11 +89,52 @@ export interface CommonQueryParameters { * @behavior Defines a common set of query parameters all Cat API's support that alter the overall response. */ export interface CommonCatQueryParameters { + /** + * Specifies the format to return the columnar data in, can be set to + * `text`, `json`, `cbor`, `yaml`, or `smile`. + * @server_default text + */ format?: string + /** + * List of columns to appear in the response. Supports simple wildcards. + */ h?: Names + /** + * When set to `true` will output available columns. This option + * can't be combined with any other query string option. + * @server_default false + */ help?: boolean + /** + * If `true`, the request computes the list of selected nodes from the + * local cluster state. If `false` the list of selected nodes are computed + * from the cluster state of the master node. In both cases the coordinating + * node will send requests for further information to each selected node. + * @server_default false + */ local?: boolean + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ master_timeout?: Time + /** + * List of columns that determine how the table should be sorted. + * Sorting defaults to ascending and can be changed by setting `:asc` + * or `:desc` as a suffix to the column name. + */ s?: string[] + /** + * When set to `true` will enable verbose output. + * @server_default false + */ v?: boolean } + +/** + * A class that implements `OverloadOf` should have the exact same properties with the same types. + * It can change if a property is required or not. There is no need to port the descriptions + * and js doc tags, the compiler will do that for you. + * @behavior Defines a class that is the "read" version of a definition used when writing a property. + */ +export interface OverloadOf {} diff --git a/specification/_types/Base.ts b/specification/_types/Base.ts index 8ec55d83bd..02dd6fca7a 100644 --- a/specification/_types/Base.ts +++ b/specification/_types/Base.ts @@ -26,7 +26,7 @@ import { VersionNumber, VersionString } from './common' -import { ErrorCause, MainError } from './Errors' +import { ErrorCause } from './Errors' import { integer, long } from './Numeric' import { Result } from './Result' import { ShardStatistics } from './Stats' @@ -67,8 +67,14 @@ export class ElasticsearchVersionInfo { number: string } +/** + * The response returned by Elasticsearch when request execution did not succeed. + */ export class ErrorResponseBase { - error: MainError | string + // In some edge cases `error` can be a string that is a shortcut to `error.reason`, for example if you call `GET _cat/foo`. + // If the error is a string, it means that it was not caused by an exception on ES side, but on the HTTP routing layer. + // This should never happen in clients, because we assume we will never send malformed request. + error: ErrorCause status: integer } diff --git a/specification/_types/Binary.ts b/specification/_types/Binary.ts new file mode 100644 index 0000000000..8bc826754b --- /dev/null +++ b/specification/_types/Binary.ts @@ -0,0 +1,21 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// Vector tile response +export type MapboxVectorTiles = ArrayBuffer diff --git a/specification/_types/Errors.ts b/specification/_types/Errors.ts index 7dd4906d09..d37e60c291 100644 --- a/specification/_types/Errors.ts +++ b/specification/_types/Errors.ts @@ -17,55 +17,34 @@ * under the License. */ -import { PainlessExecutionPosition } from '@global/scripts_painless_execute/types' -import { Dictionary } from '@spec_utils/Dictionary' -import { HttpHeaders, Id, Ids, IndexName, Uuid } from './common' +import { Id, IndexName } from './common' import { integer, long } from './Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { AdditionalProperties } from '@spec_utils/behaviors' -export class ErrorCause { +/** + * Cause and details about a request failure. This class defines the properties common to all error types. + * Additional details are also provided, that depend on the error type. + */ +export class ErrorCause + implements AdditionalProperties +{ + /** + * The type of error + */ type: string - reason: string - - caused_by?: ErrorCause - shard?: integer | string - stack_trace?: string - - root_cause?: ErrorCause[] - - bytes_limit?: long - bytes_wanted?: long - column?: integer - col?: integer - failed_shards?: ShardFailure[] - grouped?: boolean - index?: IndexName - index_uuid?: Uuid - language?: string - licensed_expired_feature?: string - line?: integer - max_buckets?: integer - phase?: string - property_name?: string - processor_type?: string /** - * resource id - * @aliases resource.id + * A human-readable explanation of the error, in english */ - resource_id?: Ids + reason?: string /** - * resource type - * @aliases resource.type + * The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. */ - resource_type?: string - script?: string - script_stack?: string[] - header?: HttpHeaders - lang?: string - position?: PainlessExecutionPosition -} + stack_trace?: string -export class MainError extends ErrorCause { - headers?: Dictionary + caused_by?: ErrorCause + root_cause?: ErrorCause[] + suppressed?: ErrorCause[] } export class ShardFailure { @@ -77,7 +56,7 @@ export class ShardFailure { } export class BulkIndexByScrollFailure { - cause: MainError + cause: ErrorCause id: Id index: IndexName status: integer diff --git a/specification/_types/Geo.ts b/specification/_types/Geo.ts index 783a4e2219..4ae000cd34 100644 --- a/specification/_types/Geo.ts +++ b/specification/_types/Geo.ts @@ -28,14 +28,23 @@ export class DistanceParsed { export type Distance = string export enum DistanceUnit { + /** @codegen_name inches */ in = 0, + /** @codegen_name feet */ ft = 1, + /** @codegen_name yards */ yd = 2, + /** @codegen_name miles */ mi = 3, + /** @codegen_name nautic_miles */ nmi = 4, + /** @codegen_name kilometers */ km = 5, + /** @codegen_name meters */ m = 6, + /** @codegen_name centimeters */ cm = 7, + /** @codegen_name millimeters */ mm = 8 } @@ -47,6 +56,14 @@ export enum GeoDistanceType { /** A GeoJson shape, that can also use Elasticsearch's `envelope` extension. */ export type GeoShape = UserDefinedValue +/** A GeoJson GeoLine. */ +export class GeoLine { + /** Always `"LineString"` */ + type: string + /** Array of `[lon, lat]` coordinates */ + coordinates: Array> +} + export enum GeoShapeRelation { intersects = 0, disjoint = 1, @@ -55,9 +72,79 @@ export enum GeoShapeRelation { } export type GeoTilePrecision = number -export type GeoHashPrecision = number + +/** + * A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". + * @codegen_names geohash_length, distance + */ +export type GeoHashPrecision = number | string +export type GeoHash = string + +/** A map tile reference, represented as `{zoom}/{x}/{y}` */ +export type GeoTile = string export class LatLon { lat: double lon: double } + +/** + * A latitude/longitude as a 2 dimensional point. It can be represented in various ways: + * - as a `{lat, long}` object + * - as a geo hash value + * - as a `[lon, lat]` array + * - as a string in `", "` or WKT point formats + * + * @codegen_names latlon, geohash, coords, text + */ +// ES: GeoUtils.parseGeoPoint() +export type GeoLocation = + | LatLonGeoLocation + | GeoHashLocation + | double[] + | string + +export class LatLonGeoLocation { + lat: double + lon: double +} + +export class GeoHashLocation { + geohash: GeoHash +} + +/** + * A geo bounding box. It can be represented in various ways: + * - as 4 top/bottom/left/right coordinates + * - as 2 top_left / bottom_right points + * - as 2 top_right / bottom_left points + * - as a WKT bounding box + * + * @codegen_names coords, tlbr, trbl, wkt + */ +export type GeoBounds = + | CoordsGeoBounds + | TopLeftBottomRightGeoBounds + | TopRightBottomLeftGeoBounds + | WktGeoBounds + +export class WktGeoBounds { + wkt: string +} + +export class CoordsGeoBounds { + top: double + bottom: double + left: double + right: double +} + +export class TopLeftBottomRightGeoBounds { + top_left: GeoLocation + bottom_right: GeoLocation +} + +export class TopRightBottomLeftGeoBounds { + top_right: GeoLocation + bottom_left: GeoLocation +} diff --git a/specification/_types/Node.ts b/specification/_types/Node.ts index 4b4476ad4d..5510399d03 100644 --- a/specification/_types/Node.ts +++ b/specification/_types/Node.ts @@ -22,7 +22,7 @@ import { ShardRoutingState } from '@indices/stats/types' import { Dictionary } from '@spec_utils/Dictionary' import { ErrorCause } from '@_types/Errors' import { integer } from '@_types/Numeric' -import { Id, IndexName, Name, NodeName } from './common' +import { Id, IndexName, Name, NodeId, NodeName } from './common' import { TransportAddress } from './Networking' export class NodeStatistics { @@ -41,12 +41,16 @@ export class NodeAttributes { /** The ephemeral ID of the node. */ ephemeral_id: Id /** The unique identifier of the node. */ - id?: Id + id?: NodeId /** The unique identifier of the node. */ name: NodeName /** The host and port where transport HTTP connections are accepted. */ transport_address: TransportAddress roles?: NodeRoles + /** + * @since 8.3.0 + */ + external_id: string } export class NodeShard { @@ -58,6 +62,7 @@ export class NodeShard { allocation_id?: Dictionary recovery_source?: Dictionary unassigned_info?: UnassignedInformation + relocating_node?: NodeId | null } /** diff --git a/specification/_types/Result.ts b/specification/_types/Result.ts index 54a3dbde3e..200791b166 100644 --- a/specification/_types/Result.ts +++ b/specification/_types/Result.ts @@ -18,10 +18,10 @@ */ export enum Result { - Error = 0, created = 1, updated = 2, deleted = 3, not_found = 4, + /** @codegen_name no_op */ noop = 5 } diff --git a/specification/_types/Scripting.ts b/specification/_types/Scripting.ts index 46cef80f3e..d6102d68ff 100644 --- a/specification/_types/Scripting.ts +++ b/specification/_types/Scripting.ts @@ -21,34 +21,42 @@ import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Id } from './common' -/** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html */ -export enum ScriptLanguage { +/** + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html + * @codegen_names builtin, custom + */ +export type ScriptLanguage = BuiltinScriptLanguage | string + +export enum BuiltinScriptLanguage { painless = 0, expression = 1, mustache = 2, - java = 0 + java = 3 } export class StoredScript { - lang?: ScriptLanguage + lang: ScriptLanguage + options?: Dictionary source: string } export class ScriptBase { - lang?: ScriptLanguage params?: Dictionary } +/** @shortcut_property source */ export class InlineScript extends ScriptBase { + lang?: ScriptLanguage + options?: Dictionary source: string } -export class IndexedScript extends ScriptBase { +export class StoredScriptId extends ScriptBase { id: Id } -// 'string' is a shortcut for InlineScript.source -export type Script = InlineScript | IndexedScript | string +/** @codegen_names inline, stored */ +export type Script = InlineScript | StoredScriptId export class ScriptField { script: Script diff --git a/specification/_types/SlicedScroll.ts b/specification/_types/SlicedScroll.ts index 4a7d545a27..679b417552 100644 --- a/specification/_types/SlicedScroll.ts +++ b/specification/_types/SlicedScroll.ts @@ -17,11 +17,11 @@ * under the License. */ -import { Field } from './common' +import { Field, Id } from './common' import { integer } from './Numeric' export class SlicedScroll { field?: Field - id: integer + id: Id max: integer } diff --git a/specification/_types/Stats.ts b/specification/_types/Stats.ts index 708c2bea69..f6f2e83584 100644 --- a/specification/_types/Stats.ts +++ b/specification/_types/Stats.ts @@ -62,7 +62,7 @@ export class FieldSizeUsage { export class DocStats { count: long - deleted: long + deleted?: long } export class FielddataStats { @@ -208,7 +208,7 @@ export class SegmentsStats { index_writer_memory?: ByteSize index_writer_max_memory_in_bytes?: integer index_writer_memory_in_bytes: integer - max_unsafe_auto_id_timestamp: integer + max_unsafe_auto_id_timestamp: long memory?: ByteSize memory_in_bytes: integer norms_memory?: ByteSize diff --git a/specification/_types/Time.ts b/specification/_types/Time.ts index f0deb90f51..2b5826a88c 100644 --- a/specification/_types/Time.ts +++ b/specification/_types/Time.ts @@ -17,7 +17,6 @@ * under the License. */ -import { Field } from './common' import { integer, long } from './Numeric' export class DateMathTimeParsed { @@ -25,13 +24,6 @@ export class DateMathTimeParsed { interval: DateMathTimeUnit } -/** A reference to a date field with formatting instructions on how to return the date */ -export class DateField { - field: Field - format?: string - include_unmapped?: boolean -} - export type DateString = string export type Timestamp = string export type TimeSpan = string @@ -51,36 +43,43 @@ export enum DateMathOperation { } export enum DateMathTimeUnit { - /** @identifier Second */ + /** @codegen_name seconds */ s = 0, - /** @identifier Minute */ + /** @codegen_name minutes */ m = 1, - /** @identifier Hour */ + /** @codegen_name hours */ h = 2, - /** @identifier Day */ + /** @codegen_name days */ d = 3, - /** @identifier Week */ + /** @codegen_name weeks */ w = 4, - /** @identifier Month */ + /** @codegen_name months */ M = 5, - /** @identifier Year */ + /** @codegen_name years */ y = 6 } /** * Whenever durations need to be specified, e.g. for a timeout parameter, the duration must specify the unit, like 2d for 2 days. - * @doc_url https://github.com/elastic/elasticsearch/blob/master/libs/core/src/main/java/org/elasticsearch/common/unit/TimeValue.java - * https://github.com/elastic/elasticsearch/blob/master/libs/core/src/main/java/org/elasticsearch/common/unit/TimeValue.java - * Only support 0 and -1 but we have no way to encode these as constants at the moment + * @doc_url https://github.com/elastic/elasticsearch/blob/master/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java + * @codegen_names time, offset */ +//FIXME: need to distinguish durations (has to be a string), offsets (can be a string or number) export type Time = string | integer export enum TimeUnit { - nanos = 0, - micros = 1, - ms = 2, - s = 3, - m = 4, - h = 5, - d = 6 + /** @codegen_name nanoseconds */ + nanos, + /** @codegen_name microseconds */ + micros, + /** @codegen_name milliseconds */ + ms, + /** @codegen_name seconds */ + s, + /** @codegen_name minutes */ + m, + /** @codegen_name hours */ + h, + /** @codegen_name days */ + d } diff --git a/specification/_types/Transform.ts b/specification/_types/Transform.ts index 18b470e7b2..22cf226350 100644 --- a/specification/_types/Transform.ts +++ b/specification/_types/Transform.ts @@ -28,15 +28,11 @@ export class Transform {} * @variants container */ export class TransformContainer { - chain?: ChainTransform + chain?: TransformContainer[] script?: ScriptTransform search?: SearchTransform } -export class ChainTransform { - transforms: TransformContainer[] -} - export class ScriptTransform { lang: string params: Dictionary diff --git a/specification/_types/aggregations/Aggregate.ts b/specification/_types/aggregations/Aggregate.ts index 7c17483cdb..46a07a502e 100644 --- a/specification/_types/aggregations/Aggregate.ts +++ b/specification/_types/aggregations/Aggregate.ts @@ -18,257 +18,739 @@ */ import { HitsMetadata } from '@global/search/_types/hits' -import { AdditionalProperties } from '@spec_utils/behaviors' +import { AdditionalProperties, AdditionalProperty } from '@spec_utils/behaviors' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -import { AggregateName } from '@_types/common' -import { LatLon } from '@_types/Geo' +import { AggregateName, Field, FieldValue } from '@_types/common' +import { GeoBounds, GeoHash, GeoLine, GeoLocation, GeoTile } from '@_types/Geo' import { double, integer, long } from '@_types/Numeric' -import { GeoCoordinate, GeoLocation } from '@_types/query_dsl/geo' -import { DateMathTime } from '@_types/Time' - -export type Bucket = - | CompositeBucket - | DateHistogramBucket - | FiltersBucketItem - | IpRangeBucket - | RangeBucket - | RareTermsBucket - | SignificantTermsBucket - | KeyedBucket - -export class CompositeBucket - implements AdditionalProperties {} -export class DateHistogramBucket - implements AdditionalProperties {} -export class FiltersBucketItem - implements AdditionalProperties { - doc_count: long -} -export class IpRangeBucket - implements AdditionalProperties {} -export class RangeBucket - implements AdditionalProperties {} -export class RareTermsBucket - implements AdditionalProperties {} -export class SignificantTermsBucket - implements AdditionalProperties {} - -export class KeyedBucket - implements AdditionalProperties { - doc_count: long - key: TKey - key_as_string: string -} +import { DateMathTime, EpochMillis } from '@_types/Time' +import { Void } from '@spec_utils/VoidValue' +import { CompositeAggregateKey } from '@_types/aggregations/bucket' +/** + * @variants external + * @non_exhaustive + */ export type Aggregate = - | SingleBucketAggregate - | AutoDateHistogramAggregate - | FiltersAggregate - | SignificantTermsAggregate - | TermsAggregate - | BucketAggregate - | CompositeBucketAggregate - | MultiBucketAggregate - | MatrixStatsAggregate - | KeyedValueAggregate - | MetricAggregate - -export type MetricAggregate = - | ValueAggregate - | BoxPlotAggregate + | CardinalityAggregate + // Digests + | HdrPercentilesAggregate + | HdrPercentileRanksAggregate + | TDigestPercentilesAggregate + | TDigestPercentileRanksAggregate + | PercentilesBucketAggregate + // Single value + | MedianAbsoluteDeviationAggregate + | MinAggregate + | MaxAggregate + | SumAggregate + | AvgAggregate + | WeightedAvgAggregate + | ValueCountAggregate + | SimpleValueAggregate + | DerivativeAggregate + | BucketMetricValueAggregate + // Multi value + | StatsAggregate + | StatsBucketAggregate + | ExtendedStatsAggregate + | ExtendedStatsBucketAggregate + // Geo | GeoBoundsAggregate | GeoCentroidAggregate - | GeoLineAggregate - | PercentilesAggregate + // Histograms + | HistogramAggregate + | DateHistogramAggregate + | AutoDateHistogramAggregate + | VariableWidthHistogramAggregate + // Terms + | StringTermsAggregate + | LongTermsAggregate + | DoubleTermsAggregate + | UnmappedTermsAggregate + | LongRareTermsAggregate + | StringRareTermsAggregate + | UnmappedRareTermsAggregate + | MultiTermsAggregate + // Single bucket + | MissingAggregate + | NestedAggregate + | ReverseNestedAggregate + | GlobalAggregate + | FilterAggregate + | ChildrenAggregate + | ParentAggregate + | SamplerAggregate + | UnmappedSamplerAggregate + // Geo grid + | GeoHashGridAggregate + | GeoTileGridAggregate + // Range + | RangeAggregate + | DateRangeAggregate + | GeoDistanceAggregate + | IpRangeAggregate + // Other multi-bucket + | FiltersAggregate + | AdjacencyMatrixAggregate + | SignificantLongTermsAggregate + | SignificantStringTermsAggregate + | UnmappedSignificantTermsAggregate + | CompositeAggregate + // | ScriptedMetricAggregate - | StatsAggregate - | StringStatsAggregate | TopHitsAggregate + | InferenceAggregate + // Analytics + | StringStatsAggregate + | BoxPlotAggregate | TopMetricsAggregate - | ExtendedStatsAggregate - | TDigestPercentilesAggregate - | HdrPercentilesAggregate + | TTestAggregate + | RateAggregate + | CumulativeCardinalityAggregate + | MatrixStatsAggregate + | GeoLineAggregate + +// Aggregations are defined in the ES code base in two ways: +// - in SearchModule.registerAggregations() +// - in implementations of SearchPlugin, through the getAggregations() and getPipelineAggregations() methods +// +// For an aggregate FooAggregate, the reference code in ES lives in two places: +// - ES aggregations: InternalFoo, the actual aggregate implementation, with the `doXContentBody` methods +// - HLRC classes: ParsedFoo, that have a parser and `toXContent` implementations +// Exceptions to this scheme exist and are indicated in the relevant aggregates export class AggregateBase { meta?: Dictionary } -export class MultiBucketAggregate extends AggregateBase { - buckets: TBucket[] +/** @variant name=cardinality */ +export class CardinalityAggregate extends AggregateBase { + value: long } -export class ValueAggregate extends AggregateBase { - value: double +//----- Percentiles + +// ES: AbstractInternalHDRPercentiles, AbstractInternalTDigestPercentiles, InternalPercentilesBucket +export class PercentilesAggregateBase extends AggregateBase { + values: Percentiles +} + +/** @codegen_names keyed, array */ +type Percentiles = KeyedPercentiles | Array + +// In keyed form, percentiles are represented as an object with 1 or 2 properties for each key: +// : double | null - always present (null means there were no values for this percentile) +// _as_string? string - present if a format was provided +// +// Note: defined as type alias and not inline, as some clients may want to implement it in a more usable way. +type KeyedPercentiles = Dictionary + +export class ArrayPercentilesItem { + key: string + value: double | null value_as_string?: string } -export class SingleBucketAggregate - extends AggregateBase - implements AdditionalProperties { - doc_count: double +/** @variant name=hdr_percentiles */ +export class HdrPercentilesAggregate extends PercentilesAggregateBase {} + +/** @variant name=hdr_percentile_ranks */ +export class HdrPercentileRanksAggregate extends PercentilesAggregateBase {} + +/** @variant name=tdigest_percentiles */ +export class TDigestPercentilesAggregate extends PercentilesAggregateBase {} + +/** @variant name=tdigest_percentile_ranks */ +export class TDigestPercentileRanksAggregate extends PercentilesAggregateBase {} + +/** @variant name=percentiles_bucket */ +export class PercentilesBucketAggregate extends PercentilesAggregateBase {} + +//----- Single value + +export class SingleMetricAggregateBase extends AggregateBase { + // HLRC: ParsedSingleValueNumericMetricsAggregation + // ES: InternalNumericMetricsAggregation.SingleValue + /** + * The metric value. A missing value generally means that there was no data to aggregate, + * unless specified otherwise. + */ + value: double | null + value_as_string?: string } -export class KeyedValueAggregate extends ValueAggregate { + +/** @variant name=median_absolute_deviation */ +export class MedianAbsoluteDeviationAggregate extends SingleMetricAggregateBase {} + +/** @variant name=min */ +export class MinAggregate extends SingleMetricAggregateBase {} + +/** @variant name=max */ +export class MaxAggregate extends SingleMetricAggregateBase {} + +/** + * Sum aggregation result. `value` is always present and is zero if there were no values to process. + * @variant name=sum + */ +export class SumAggregate extends SingleMetricAggregateBase {} + +/** @variant name=avg */ +export class AvgAggregate extends SingleMetricAggregateBase {} + +/** + * Weighted average aggregation result. `value` is missing if the weight was set to zero. + * @variant name=weighted_avg + */ +export class WeightedAvgAggregate extends SingleMetricAggregateBase {} + +/** + * Value count aggregation result. `value` is always present. + * @variant name=value_count + */ +export class ValueCountAggregate extends SingleMetricAggregateBase {} + +/** @variant name=simple_value */ +export class SimpleValueAggregate extends SingleMetricAggregateBase {} + +/** @variant name=derivative */ +export class DerivativeAggregate extends SingleMetricAggregateBase { + normalized_value?: double + normalized_value_as_string?: string +} + +/** @variant name=bucket_metric_value */ +export class BucketMetricValueAggregate extends SingleMetricAggregateBase { keys: string[] } -export class AutoDateHistogramAggregate extends MultiBucketAggregate< - KeyedBucket -> { - interval: DateMathTime +//----- Multi value + +/** + * Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process + * (`count` is zero). + * @variant name=stats + */ +export class StatsAggregate extends AggregateBase { + count: long + min: double | null + max: double | null + avg: double | null + sum: double + min_as_string?: string + max_as_string?: string + avg_as_string?: string + sum_as_string?: string } -export class FiltersAggregate extends AggregateBase { - buckets: FiltersBucketItem[] | Dictionary +/** @variant name=stats_bucket */ +export class StatsBucketAggregate extends StatsAggregate {} + +export class StandardDeviationBounds { + upper: double | null + lower: double | null + upper_population: double | null + lower_population: double | null + upper_sampling: double | null + lower_sampling: double | null } -export class SignificantTermsAggregate< - TKey -> extends MultiBucketAggregate { - bg_count: long - doc_count: long +export class StandardDeviationBoundsAsString { + upper: string + lower: string + upper_population: string + lower_population: string + upper_sampling: string + lower_sampling: string } -export class TermsAggregate extends MultiBucketAggregate { - doc_count_error_upper_bound: long - sum_other_doc_count: long +/** @variant name=extended_stats */ +export class ExtendedStatsAggregate extends StatsAggregate { + sum_of_squares: double | null + variance: double | null + variance_population: double | null + variance_sampling: double | null + std_deviation: double | null + std_deviation_population: double | null + std_deviation_sampling: double | null + // Always sent (see InternalExtendedStats), but semantically it's useless if std_deviation is null + std_deviation_bounds?: StandardDeviationBounds + + sum_of_squares_as_string?: string + variance_as_string?: string + variance_population_as_string?: string + variance_sampling_as_string?: string + std_deviation_as_string?: string + std_deviation_bounds_as_string?: StandardDeviationBoundsAsString } -// TODO this is an intermediate type in NEST -export class BucketAggregate extends AggregateBase { - after_key: Dictionary - bg_count: long +/** @variant name=extended_stats_bucket */ +export class ExtendedStatsBucketAggregate extends ExtendedStatsAggregate {} + +//----- Geo + +/** @variant name=geo_bounds */ +export class GeoBoundsAggregate extends AggregateBase { + bounds?: GeoBounds +} + +/** @variant name=geo_centroid */ +export class GeoCentroidAggregate extends AggregateBase { + count: long + location?: GeoLocation +} + +//----- Histograms + +/** + * Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for + * the different buckets, the result is a dictionary. + * + * @codegen_names keyed, array + */ +// Note: not all aggregations support keys in their configuration, meaning they will never return the dictionary +// variant. However we use this union for all aggregates to future-proof the spec if some key-less aggregations finally +// add support for keys. +export type Buckets = Dictionary | Array + +export class MultiBucketAggregateBase extends AggregateBase { + buckets: Buckets +} + +/** + * Base type for multi-bucket aggregation results that can hold sub-aggregations results. + */ +export class MultiBucketBase + implements AdditionalProperties +{ doc_count: long - doc_count_error_upper_bound: long - sum_other_doc_count: long - interval: DateMathTime - items: Bucket } -export class CompositeBucketAggregate extends MultiBucketAggregate< - Dictionary -> { - after_key: Dictionary +/** @variant name=histogram */ +export class HistogramAggregate extends MultiBucketAggregateBase {} + +export class HistogramBucket extends MultiBucketBase { + key_as_string?: string + key: double } -export class MatrixStatsAggregate extends AggregateBase { - correlation: Dictionary - covariance: Dictionary - count: integer - kurtosis: double - mean: double - skewness: double - variance: double - name: string +/** @variant name=date_histogram */ +export class DateHistogramAggregate extends MultiBucketAggregateBase {} + +export class DateHistogramBucket extends MultiBucketBase { + key_as_string?: string + key: EpochMillis } -export class BoxPlotAggregate extends AggregateBase { +/** @variant name=auto_date_histogram */ +// Note: no keyed variant in `InternalAutoDateHistogram` +export class AutoDateHistogramAggregate extends MultiBucketAggregateBase { + interval: DateMathTime +} + +/** @variant name=variable_width_histogram */ +// Note: no keyed variant in `InternalVariableWidthHistogram` +export class VariableWidthHistogramAggregate extends MultiBucketAggregateBase {} + +export class VariableWidthHistogramBucket extends MultiBucketBase { min: double + key: double max: double - q1: double - q2: double - q3: double + min_as_string?: string + key_as_string?: string + max_as_string?: string } -export class StatsAggregate extends AggregateBase { - count: double - sum: double +//----- Terms - // not returned if count is 0 - avg?: double - max?: double - min?: double +export class TermsAggregateBase< + TBucket +> extends MultiBucketAggregateBase { + doc_count_error_upper_bound?: long + sum_other_doc_count?: long } -// extended stats can return a completely empty object hence all optional "std_deviation_bounds": {}, -export class StandardDeviationBounds { - lower?: double - upper?: double - lower_population?: double - upper_population?: double - lower_sampling?: double - upper_sampling?: double +/** + * Result of a `terms` aggregation when the field is a string. + * @variant name=sterms + */ +// ES: StringTerms +export class StringTermsAggregate extends TermsAggregateBase {} + +export class TermsBucketBase extends MultiBucketBase { + doc_count_error?: long } -export class ExtendedStatsAggregate extends StatsAggregate { - // if count is 0 this is an empty object - std_deviation_bounds: StandardDeviationBounds +export class StringTermsBucket extends TermsBucketBase { + key: FieldValue +} + +/** + * Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date. + * @variant name=lterms + */ +// ES: LongTerms +export class LongTermsAggregate extends TermsAggregateBase {} - sum_of_squares?: double - variance?: double - variance_population?: double - variance_sampling?: double - std_deviation?: double - std_deviation_population?: double - std_deviation_sampling?: double +export class LongTermsBucket extends TermsBucketBase { + key: string + key_as_string?: string } -export class GeoBounds { - bottom_right: LatLon - top_left: LatLon + +/** + * Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance. + * @variant name=dterms + */ +// ES: DoubleTerms +export class DoubleTermsAggregate extends TermsAggregateBase {} + +export class DoubleTermsBucket extends TermsBucketBase { + key: double + key_as_string?: string } -export class GeoBoundsAggregate extends AggregateBase { - bounds: GeoBounds + +/** + * Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty. + * @variant name=umterms + */ +// ES: UnmappedTerms +// Since the buckets array is present but always empty, we use `Void` as the bucket type. +export class UnmappedTermsAggregate extends TermsAggregateBase {} + +/** + * Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date. + * @variant name=lrareterms + */ +// ES: LongRareTerms +export class LongRareTermsAggregate extends MultiBucketAggregateBase {} + +export class LongRareTermsBucket extends MultiBucketBase { + key: long + key_as_string?: string } -export class GeoCentroidAggregate extends AggregateBase { - count: long - location: GeoLocation +/** + * Result of the `rare_terms` aggregation when the field is a string. + * @variant name=srareterms + */ +export class StringRareTermsAggregate extends MultiBucketAggregateBase {} + +export class StringRareTermsBucket extends MultiBucketBase { + key: string } -export class GeoLineAggregate extends AggregateBase { - type: string - geometry: LineStringGeoShape - properties: GeoLineProperties + +/** + * Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty. + * @variant name=umrareterms + */ +// ES: UnmappedRareTerms +// Since the buckets array is present but always empty, we use `Void` as the bucket type. +export class UnmappedRareTermsAggregate extends MultiBucketAggregateBase {} + +/** @variant name=multi_terms */ +// Note: no keyed variant +export class MultiTermsAggregate extends TermsAggregateBase {} + +export class MultiTermsBucket extends MultiBucketBase { + key: Array + key_as_string?: string + doc_count_error_upper_bound?: long } -export class GeoLineProperties { - complete: boolean - sort_values: double[] + +//----- Single bucket + +/** + * Base type for single-bucket aggregation results that can hold sub-aggregations results. + */ +export class SingleBucketAggregateBase + extends AggregateBase + implements AdditionalProperties +{ + doc_count: long } -export class LineStringGeoShape { - coordinates: GeoCoordinate[] + +/** @variant name=missing */ +export class MissingAggregate extends SingleBucketAggregateBase {} + +/** @variant name=nested */ +export class NestedAggregate extends SingleBucketAggregateBase {} + +/** @variant name=reverse_nested */ +export class ReverseNestedAggregate extends SingleBucketAggregateBase {} + +/** @variant name=global */ +export class GlobalAggregate extends SingleBucketAggregateBase {} + +/** @variant name=filter */ +export class FilterAggregate extends SingleBucketAggregateBase {} + +/** @variant name=sampler */ +export class SamplerAggregate extends SingleBucketAggregateBase {} + +/** @variant name=unmapped_sampler */ +export class UnmappedSamplerAggregate extends SingleBucketAggregateBase {} + +//----- Geo grid + +/** @variant name=geohash_grid */ +// Note: no keyed variant in the `InternalGeoGrid` parent class +export class GeoHashGridAggregate extends MultiBucketAggregateBase {} + +export class GeoHashGridBucket extends MultiBucketBase { + key: GeoHash } -export class PercentileItem { - percentile: double - value: double +/** @variant name=geotile_grid */ +// Note: no keyed variant in the `InternalGeoGrid` parent class +export class GeoTileGridAggregate extends MultiBucketAggregateBase {} + +export class GeoTileGridBucket extends MultiBucketBase { + key: GeoTile } -export class PercentilesAggregate extends AggregateBase { - items: PercentileItem[] +//----- Ranges + +/** @variant name=range */ +export class RangeAggregate extends MultiBucketAggregateBase {} + +export class RangeBucket extends MultiBucketBase { + from?: double + to?: double + from_as_string?: string + to_as_string?: string + /** The bucket key. Present if the aggregation is _not_ keyed */ + key?: string } -export class TDigestPercentilesAggregate extends AggregateBase { - values: Dictionary + +/** + * Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to` + * in `buckets` are milliseconds since the Epoch, represented as a floating point number. + * @variant name=date_range + */ +export class DateRangeAggregate extends RangeAggregate {} + +/** + * Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default. + * @variant name=geo_distance + */ +export class GeoDistanceAggregate extends RangeAggregate {} + +/** @variant name=ip_range */ +// ES: InternalBinaryRange +export class IpRangeAggregate extends MultiBucketAggregateBase {} + +export class IpRangeBucket extends MultiBucketBase { + key?: string + from?: string + to?: string } -export class HdrPercentileItem { - key: double - value: double + +//----- Other multi-bucket + +/** @variant name=filters */ +export class FiltersAggregate extends MultiBucketAggregateBase {} + +export class FiltersBucket extends MultiBucketBase {} + +/** @variant name=adjacency_matrix */ +// Note: no keyed variant in the `InternalAdjacencyMatrix` +export class AdjacencyMatrixAggregate extends MultiBucketAggregateBase {} + +export class AdjacencyMatrixBucket extends MultiBucketBase { + key: string +} + +export class SignificantTermsAggregateBase< + T +> extends MultiBucketAggregateBase { + bg_count?: long + doc_count?: long +} + +/** @variant name=siglterms */ +// ES: SignificantLongTerms & InternalSignificantTerms +export class SignificantLongTermsAggregate extends SignificantTermsAggregateBase {} + +export class SignificantTermsBucketBase extends MultiBucketBase { + score: double + bg_count: long +} + +export class SignificantLongTermsBucket extends SignificantTermsBucketBase { + key: long + key_as_string?: string +} + +/** @variant name=sigsterms */ +// ES: SignificantStringTerms & InternalSignificantTerms +export class SignificantStringTermsAggregate extends SignificantTermsAggregateBase {} + +export class SignificantStringTermsBucket extends SignificantTermsBucketBase { + key: string +} + +/** + * Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty. + * @variant name=umsigterms + */ +// ES: UnmappedSignificantTerms +// See note in UnmappedTermsAggregate +export class UnmappedSignificantTermsAggregate extends SignificantTermsAggregateBase {} + +/** @variant name=composite */ +// Note: no keyed variant +export class CompositeAggregate extends MultiBucketAggregateBase { + // Must be consistent with CompositeAggregation.after and CompositeBucket.key + after_key?: CompositeAggregateKey } -export class HdrPercentilesAggregate extends AggregateBase { - values: HdrPercentileItem[] + +export class CompositeBucket extends MultiBucketBase { + key: CompositeAggregateKey } +//----- Misc + +/** @variant name=scripted_metric */ export class ScriptedMetricAggregate extends AggregateBase { value: UserDefinedValue } +/** @variant name=top_hits */ +export class TopHitsAggregate extends AggregateBase { + hits: HitsMetadata +} + +/** @variant name=inference */ +// This is a union with widely different fields, many of them being runtime-defined. We mimic below the few fields +// present in `ParsedInference` with an additional properties spillover to not loose any data. +export class InferenceAggregate + extends AggregateBase + implements AdditionalProperties +{ + value?: FieldValue + feature_importance?: InferenceFeatureImportance[] + top_classes?: InferenceTopClassEntry[] + warning?: string +} + +export class InferenceTopClassEntry { + class_name: FieldValue + class_probability: double + class_score: double +} + +export class InferenceFeatureImportance { + feature_name: string + importance?: double + classes?: InferenceClassImportance[] +} + +export class InferenceClassImportance { + class_name: string + importance: double +} + +//------ Plugin aggregations + +// Analytics + +/** @variant name=string_stats */ export class StringStatsAggregate extends AggregateBase { count: long - min_length: integer - max_length: integer - avg_length: double - entropy: double - distribution?: Dictionary + min_length: integer | null + max_length: integer | null + avg_length: double | null + entropy: double | null + distribution?: Dictionary | null + min_length_as_string?: string + max_length_as_string?: string + avg_length_as_string?: string } -//hard -export class TopHitsAggregate extends AggregateBase { - hits: HitsMetadata> +/** @variant name=box_plot */ +export class BoxPlotAggregate extends AggregateBase { + min: double + max: double + q1: double + q2: double + q3: double + lower: double + upper: double + min_as_string?: string + max_as_string?: string + q1_as_string?: string + q2_as_string?: string + q3_as_string?: string + lower_as_string?: string + upper_as_string?: string } +/** @variant name=top_metrics */ export class TopMetricsAggregate extends AggregateBase { top: TopMetrics[] } export class TopMetrics { - sort: Array - metrics: Dictionary + // Always contains a single element since `top_metrics` only accepts a single sort field + sort: Array + metrics: Dictionary +} + +/** @variant name=t_test */ +export class TTestAggregate extends AggregateBase { + value: double | null + value_as_string?: string +} + +/** @variant name=rate */ +export class RateAggregate extends AggregateBase { + value: double + value_as_string?: string +} + +/** + * Result of the `cumulative_cardinality` aggregation + * @variant name=simple_long_value + */ +// ES: InternalSimpleLongValue +export class CumulativeCardinalityAggregate extends AggregateBase { + value: long + value_as_string?: string +} + +/** @variant name=matrix_stats */ +export class MatrixStatsAggregate extends AggregateBase { + doc_count: long + fields: MatrixStatsFields[] +} + +export class MatrixStatsFields { + name: Field + count: long + mean: double + variance: double + skewness: double + kurtosis: double + covariance: Dictionary + correlation: Dictionary +} + +//----- Parent join plugin + +/** @variant name=children */ +export class ChildrenAggregate extends SingleBucketAggregateBase {} + +/** @variant name=parent */ +export class ParentAggregate extends SingleBucketAggregateBase {} + +//----- Spatial plugin + +/** @variant name=geo_line */ +export class GeoLineAggregate extends AggregateBase { + type: string // should be "Feature" + geometry: GeoLine + // https://www.rfc-editor.org/rfc/rfc7946#section-3.2 + // "The value of the properties member is an object (any JSON object or a JSON null value)" + properties: UserDefinedValue } diff --git a/specification/_types/aggregations/AggregationContainer.ts b/specification/_types/aggregations/AggregationContainer.ts index 024b258fb6..d7d16ac89d 100644 --- a/specification/_types/aggregations/AggregationContainer.ts +++ b/specification/_types/aggregations/AggregationContainer.ts @@ -98,15 +98,22 @@ import { /** * @variants container + * @non_exhaustive */ export class AggregationContainer { - /** @variant container_property */ - aggs?: Dictionary - /** @variant container_property */ + /** + * Sub-aggregations for this aggregation. Only applies to bucket aggregations. + * + * @variant container_property + * @aliases aggs + */ + aggregations?: Dictionary + /** + * @variant container_property + */ meta?: Dictionary adjacency_matrix?: AdjacencyMatrixAggregation - aggregations?: Dictionary auto_date_histogram?: AutoDateHistogramAggregation avg?: AverageAggregation avg_bucket?: AverageBucketAggregation @@ -179,3 +186,8 @@ export class AggregationContainer { } export type Missing = string | integer | double | boolean +export enum MissingOrder { + first, + last, + default +} diff --git a/specification/_types/aggregations/bucket.ts b/specification/_types/aggregations/bucket.ts index 6731c74ac9..f33f2944cb 100644 --- a/specification/_types/aggregations/bucket.ts +++ b/specification/_types/aggregations/bucket.ts @@ -17,28 +17,33 @@ * under the License. */ -import { SortOrder } from '@global/search/_types/sort' -import { Dictionary } from '@spec_utils/Dictionary' +import { SortOrder } from '@_types/sort' +import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { EmptyObject, FieldValue } from '@_types/common' import { Field, RelationName, Fields } from '@_types/common' import { GeoDistanceType, DistanceUnit, GeoHashPrecision, - GeoTilePrecision + GeoTilePrecision, + GeoLocation, + GeoBounds } from '@_types/Geo' import { integer, float, long, double } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' -import { GeoLocation, BoundingBox } from '@_types/query_dsl/geo' import { Script } from '@_types/Scripting' import { DateString, Time, DateMath } from '@_types/Time' -import { GeoBounds } from './Aggregate' +import { Buckets } from './Aggregate' import { Aggregation } from './Aggregation' -import { AggregationContainer, Missing } from './AggregationContainer' +import { Missing, MissingOrder } from './AggregationContainer' -export class BucketAggregationBase extends Aggregation { - aggregations?: Dictionary -} +/** + * Base type for bucket aggregations. These aggregations also accept sub-aggregations. + */ +// Note: since sub-aggregations exist only for bucket aggregations, this empty base class is a placeholder for client +// code generators that would want to lift the 'AggregationContainer.aggregations' container property here. +export class BucketAggregationBase extends Aggregation {} export class AdjacencyMatrixAggregation extends BucketAggregationBase { filters?: Dictionary @@ -69,18 +74,16 @@ export class ChildrenAggregation extends BucketAggregationBase { type?: RelationName } +export type CompositeAggregateKey = Dictionary + export class CompositeAggregation extends BucketAggregationBase { - after?: Dictionary + // Must be consistent with CompositeAggregate.after_key + after?: CompositeAggregateKey size?: integer sources?: Array> } export class CompositeAggregationSource { - // field: Field; - // missing_bucket: boolean; - // name: string; - // order: SortOrder; - // source_type: string; terms?: TermsAggregation histogram?: HistogramAggregation date_histogram?: DateHistogramAggregation @@ -88,31 +91,40 @@ export class CompositeAggregationSource { } export class DateHistogramAggregation extends BucketAggregationBase { - calendar_interval?: DateInterval | Time - extended_bounds?: ExtendedBounds - hard_bounds?: ExtendedBounds + calendar_interval?: CalendarInterval // CalendarInterval is too restrictive here + extended_bounds?: ExtendedBounds + hard_bounds?: ExtendedBounds field?: Field - fixed_interval?: DateInterval | Time + fixed_interval?: Time // CalendarInterval is too restrictive here format?: string - interval?: DateInterval | Time + interval?: Time min_doc_count?: integer missing?: DateString offset?: Time - order?: HistogramOrder + order?: AggregateOrder params?: Dictionary script?: Script time_zone?: string -} - -export enum DateInterval { - second = 0, - minute = 1, - hour = 2, - day = 3, - week = 4, - month = 5, - quarter = 6, - year = 7 + keyed?: boolean +} + +export enum CalendarInterval { + /** @aliases 1s */ + second, + /** @aliases 1m */ + minute, + /** @aliases 1h */ + hour, + /** @aliases 1d */ + day, + /** @aliases 1w */ + week, + /** @aliases 1M */ + month, + /** @aliases 1q */ + quarter, + /** @aliases 1Y */ + year } export class DateRangeAggregation extends BucketAggregationBase { @@ -121,15 +133,22 @@ export class DateRangeAggregation extends BucketAggregationBase { missing?: Missing ranges?: DateRangeExpression[] time_zone?: string + keyed?: boolean } +/** + * A date range limit, represented either as a DateMath expression or a number expressed + * according to the target field's precision. + * + * @codegen_names expr, value + */ +// ES: DateRangeAggregationBuilder.innerBuild() +export type FieldDateMath = DateMath | double + export class DateRangeExpression { - from?: DateMath | float - from_as_string?: string - to_as_string?: string + from?: FieldDateMath key?: string - to?: DateMath | float - doc_count?: long + to?: FieldDateMath } export class DiversifiedSamplerAggregation extends BucketAggregationBase { @@ -147,21 +166,22 @@ export enum SamplerAggregationExecutionHint { } export class FiltersAggregation extends BucketAggregationBase { - filters?: Dictionary | QueryContainer[] + filters?: Buckets other_bucket?: boolean other_bucket_key?: string + keyed?: boolean } export class GeoDistanceAggregation extends BucketAggregationBase { distance_type?: GeoDistanceType field?: Field - origin?: GeoLocation | string + origin?: GeoLocation ranges?: AggregationRange[] unit?: DistanceUnit } export class GeoHashGridAggregation extends BucketAggregationBase { - bounds?: BoundingBox + bounds?: GeoBounds field?: Field precision?: GeoHashPrecision shard_size?: integer @@ -191,14 +211,10 @@ export class HistogramAggregation extends BucketAggregationBase { min_doc_count?: integer missing?: double offset?: double - order?: HistogramOrder + order?: AggregateOrder script?: Script format?: string -} - -export class HistogramOrder { - _count?: SortOrder - _key?: SortOrder + keyed?: boolean } export class IpRangeAggregation extends BucketAggregationBase { @@ -218,11 +234,19 @@ export class MissingAggregation extends BucketAggregationBase { } export class MultiTermsAggregation extends BucketAggregationBase { + collect_mode?: TermsAggregationCollectMode + order?: AggregateOrder + min_doc_count?: long + shard_min_doc_count?: long + shard_size?: integer + show_term_doc_count_error?: boolean + size?: integer terms: MultiTermLookup[] } export class MultiTermLookup { field: Field + missing?: Missing } export class NestedAggregation extends BucketAggregationBase { @@ -235,8 +259,10 @@ export class ParentAggregation extends BucketAggregationBase { export class RangeAggregation extends BucketAggregationBase { field?: Field + missing?: integer ranges?: AggregationRange[] script?: Script + keyed?: boolean } export class AggregationRange { @@ -246,9 +272,9 @@ export class AggregationRange { } export class RareTermsAggregation extends BucketAggregationBase { - exclude?: string | string[] + exclude?: TermsExclude field?: Field - include?: string | string[] | TermsInclude + include?: TermsInclude max_doc_count?: long missing?: Missing precision?: double @@ -269,12 +295,12 @@ export class ChiSquareHeuristic { } export class GoogleNormalizedDistanceHeuristic { - background_is_superset: boolean + background_is_superset?: boolean } export class MutualInformationHeuristic { - background_is_superset: boolean - include_negatives: boolean + background_is_superset?: boolean + include_negatives?: boolean } export class PercentageScoreHeuristic {} @@ -286,11 +312,11 @@ export class ScriptedHeuristic { export class SignificantTermsAggregation extends BucketAggregationBase { background_filter?: QueryContainer chi_square?: ChiSquareHeuristic - exclude?: string | string[] + exclude?: TermsExclude execution_hint?: TermsAggregationExecutionHint field?: Field gnd?: GoogleNormalizedDistanceHeuristic - include?: string | string[] + include?: TermsInclude min_doc_count?: long mutual_information?: MutualInformationHeuristic percentage?: PercentageScoreHeuristic @@ -303,12 +329,12 @@ export class SignificantTermsAggregation extends BucketAggregationBase { export class SignificantTextAggregation extends BucketAggregationBase { background_filter?: QueryContainer chi_square?: ChiSquareHeuristic - exclude?: string | string[] + exclude?: TermsExclude execution_hint?: TermsAggregationExecutionHint field?: Field filter_duplicate_text?: boolean gnd?: GoogleNormalizedDistanceHeuristic - include?: string | string[] + include?: TermsInclude min_doc_count?: long mutual_information?: MutualInformationHeuristic percentage?: PercentageScoreHeuristic @@ -321,25 +347,29 @@ export class SignificantTextAggregation extends BucketAggregationBase { export class TermsAggregation extends BucketAggregationBase { collect_mode?: TermsAggregationCollectMode - exclude?: string | string[] + exclude?: TermsExclude execution_hint?: TermsAggregationExecutionHint field?: Field - include?: string | string[] | TermsInclude + include?: TermsInclude min_doc_count?: integer missing?: Missing + missing_order?: MissingOrder missing_bucket?: boolean value_type?: string - order?: TermsAggregationOrder + order?: AggregateOrder script?: Script shard_size?: integer show_term_doc_count_error?: boolean size?: integer } -export type TermsAggregationOrder = - | SortOrder - | Dictionary - | Dictionary[] +// Note: ES is very lazy when parsing this data type: it accepts any number of properties in the objects below, +// but will only keep the *last* property in JSON document order and ignore others. +// This means that something like `"order": { "downloads": "desc", "_key": "asc" }` will actually be interpreted +// as `"order": [ { "_key": "asc" } ]` +export type AggregateOrder = + | SingleKeyDictionary + | SingleKeyDictionary[] export enum TermsAggregationCollectMode { depth_first = 0, @@ -353,7 +383,13 @@ export enum TermsAggregationExecutionHint { global_ordinals_low_cardinality = 3 } -export class TermsInclude { +/** @codegen_names regexp, terms, partition */ +export type TermsInclude = string | string[] | TermsPartition + +/** @codegen_names regexp, terms */ +export type TermsExclude = string | string[] + +export class TermsPartition { num_partitions: long partition: long } diff --git a/specification/_types/aggregations/matrix.ts b/specification/_types/aggregations/matrix.ts index 9626b6aae6..0ea8bcdb99 100644 --- a/specification/_types/aggregations/matrix.ts +++ b/specification/_types/aggregations/matrix.ts @@ -21,6 +21,7 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Fields, Field } from '@_types/common' import { double } from '@_types/Numeric' import { Aggregation } from './Aggregation' +import { SortMode } from '@_types/sort' export class MatrixAggregation extends Aggregation { fields?: Fields @@ -28,13 +29,5 @@ export class MatrixAggregation extends Aggregation { } export class MatrixStatsAggregation extends MatrixAggregation { - mode?: MatrixStatsMode -} - -export enum MatrixStatsMode { - avg = 0, - min = 1, - max = 2, - sum = 3, - median = 4 + mode?: SortMode } diff --git a/specification/_types/aggregations/metric.ts b/specification/_types/aggregations/metric.ts index 4dcbff40c9..409afbb6b5 100644 --- a/specification/_types/aggregations/metric.ts +++ b/specification/_types/aggregations/metric.ts @@ -18,18 +18,18 @@ */ import { Highlight } from '@global/search/_types/highlighting' -import { SortOrder, Sort } from '@global/search/_types/sort' -import { SourceFilter } from '@global/search/_types/SourceFilter' +import { SortOrder, Sort } from '@_types/sort' +import { SourceConfig } from '@global/search/_types/SourceFilter' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Fields } from '@_types/common' import { double, integer, long } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' -import { GeoLocation } from '@_types/query_dsl/geo' import { Script, ScriptField } from '@_types/Scripting' import { Aggregation } from './Aggregation' import { Missing } from './AggregationContainer' -import { DateInterval } from './bucket' +import { CalendarInterval } from './bucket' +import { GeoLocation } from '@_types/Geo' export class MetricAggregationBase { field?: Field @@ -95,7 +95,7 @@ export class MinAggregation extends FormatMetricAggregationBase {} export class PercentileRanksAggregation extends FormatMetricAggregationBase { keyed?: boolean - values?: double[] + values?: double[] | null hdr?: HdrMethod tdigest?: TDigest } @@ -116,7 +116,7 @@ export class TDigest { } export class RateAggregation extends FormatMetricAggregationBase { - unit?: DateInterval + unit?: CalendarInterval mode?: RateMode } @@ -167,7 +167,7 @@ export class TopHitsAggregation extends MetricAggregationBase { script_fields?: Dictionary size?: integer sort?: Sort - _source?: boolean | SourceFilter | Fields + _source?: SourceConfig stored_fields?: Fields track_scores?: boolean version?: boolean diff --git a/specification/_types/aggregations/pipeline.ts b/specification/_types/aggregations/pipeline.ts index a017086c36..e39b92b346 100644 --- a/specification/_types/aggregations/pipeline.ts +++ b/specification/_types/aggregations/pipeline.ts @@ -17,8 +17,9 @@ * under the License. */ -import { Sort } from '@global/search/_types/sort' -import { Name, Field } from '@_types/common' +import { Sort } from '@_types/sort' +import { Dictionary } from '@spec_utils/Dictionary' +import { Name, Field, EmptyObject } from '@_types/common' import { integer, double, float } from '@_types/Numeric' import { Script } from '@_types/Scripting' import { Aggregation } from './Aggregation' @@ -29,13 +30,31 @@ export class PipelineAggregationBase extends Aggregation { gap_policy?: GapPolicy } +/** + * Buckets path can be expressed in different ways, and an aggregation may accept some or all of these + * forms depending on its type. Please refer to each aggregation's documentation to know what buckets + * path forms they accept. + * @codegen_names single, array, dict + */ +export type BucketsPath = string | string[] | Dictionary + export enum GapPolicy { - skip = 0, - insert_zeros = 1 + /** + * Treats missing data as if the bucket does not exist. It will skip the bucket and + * continue calculating using the next available value. + */ + skip, + /** + * Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal. + */ + insert_zeros, + /** + * Similar to skip, except if the metric provides a non-null, non-NaN value this value is used, + * otherwise the empty bucket is skipped. + */ + keep_values } -export class BucketsPath {} - export class AverageBucketAggregation extends PipelineAggregationBase {} export class BucketScriptAggregation extends PipelineAggregationBase { @@ -77,7 +96,7 @@ export class InferenceConfigContainer { export class RegressionInferenceOptions { /** The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. */ - results_field: Field + results_field?: Field /** * Specifies the maximum number of feature importance values per document. By default, it is zero and no feature importance calculation occurs. * @doc_url https://www.elastic.co/guide/en/machine-learning/7.12/ml-feature-importance.html @@ -105,26 +124,44 @@ export class MaxBucketAggregation extends PipelineAggregationBase {} export class MinBucketAggregation extends PipelineAggregationBase {} -export class MovingAverageAggregation extends PipelineAggregationBase { +/** @variants internal tag=model */ +export type MovingAverageAggregation = + | LinearMovingAverageAggregation + | SimpleMovingAverageAggregation + | EwmaMovingAverageAggregation + | HoltMovingAverageAggregation + | HoltWintersMovingAverageAggregation + +export class MovingAverageAggregationBase extends PipelineAggregationBase { minimize?: boolean - model?: MovingAverageModel - settings: MovingAverageSettings predict?: integer window?: integer } -export enum MovingAverageModel { - linear, - simple, - ewma, - holt, - holt_winters +export class LinearMovingAverageAggregation extends MovingAverageAggregationBase { + model: 'linear' + settings: EmptyObject +} + +export class SimpleMovingAverageAggregation extends MovingAverageAggregationBase { + model: 'simple' + settings: EmptyObject +} + +export class EwmaMovingAverageAggregation extends MovingAverageAggregationBase { + model: 'ewma' + settings: EwmaModelSettings +} + +export class HoltMovingAverageAggregation extends MovingAverageAggregationBase { + model: 'holt' + settings: HoltLinearModelSettings } -export type MovingAverageSettings = - | EwmaModelSettings - | HoltLinearModelSettings - | HoltWintersModelSettings +export class HoltWintersMovingAverageAggregation extends MovingAverageAggregationBase { + model: 'holt_winters' + settings: HoltWintersModelSettings +} export class EwmaModelSettings { alpha?: float @@ -143,9 +180,9 @@ export class HoltWintersModelSettings { type?: HoltWintersType } export enum HoltWintersType { - /** @identifier Additive */ + /** @codegen_name Additive */ add, - /** @identifier Multiplicative */ + /** @codegen_name Multiplicative */ mult } @@ -158,6 +195,7 @@ export class MovingFunctionAggregation extends PipelineAggregationBase { export class MovingPercentilesAggregation extends PipelineAggregationBase { window?: integer shift?: integer + keyed?: boolean } export class NormalizeAggregation extends PipelineAggregationBase { @@ -169,7 +207,8 @@ export enum NormalizeMethod { rescale_0_100, percent_of_sum, mean, - zscore, + /** @codegen_name z_score */ + 'z-score', softmax } diff --git a/specification/_types/analysis/StopWords.ts b/specification/_types/analysis/StopWords.ts index 34af8ace40..03fa0490a3 100644 --- a/specification/_types/analysis/StopWords.ts +++ b/specification/_types/analysis/StopWords.ts @@ -23,4 +23,4 @@ * Also accepts an array of stop words. * @class_serializer: StopWordsFormatter */ -export type StopWords = string[] +export type StopWords = string | string[] diff --git a/specification/_types/analysis/analyzers.ts b/specification/_types/analysis/analyzers.ts index 32e308ebb6..33cf6d7e92 100644 --- a/specification/_types/analysis/analyzers.ts +++ b/specification/_types/analysis/analyzers.ts @@ -22,66 +22,110 @@ import { integer } from '@_types/Numeric' import { Language, SnowballLanguage } from './languages' import { StopWords } from './StopWords' import { NoriDecompoundMode } from './tokenizers' +import { IcuAnalyzer } from './icu-plugin' +import { KuromojiAnalyzer } from './kuromoji-plugin' -export class AnalyzerBase { - type: string - version: VersionString -} - -export class CustomAnalyzer extends AnalyzerBase { - char_filter: string[] - filter: string[] - position_increment_gap: integer - position_offset_gap: integer +export class CustomAnalyzer { + type: 'custom' + char_filter?: string[] + filter?: string[] + position_increment_gap?: integer + position_offset_gap?: integer tokenizer: string } -export class FingerprintAnalyzer extends AnalyzerBase { +export class FingerprintAnalyzer { + type: 'fingerprint' + version?: VersionString max_output_size: integer preserve_original: boolean separator: string - stopwords: StopWords - stopwords_path: string + stopwords?: StopWords + stopwords_path?: string } -export class KeywordAnalyzer extends AnalyzerBase {} +export class KeywordAnalyzer { + type: 'keyword' + version?: VersionString +} -export class LanguageAnalyzer extends AnalyzerBase { +export class LanguageAnalyzer { + type: 'language' + version?: VersionString language: Language stem_exclusion: string[] - stopwords: StopWords - stopwords_path: string - type: string + stopwords?: StopWords + stopwords_path?: string +} + +export class DutchAnalyzer { + type: 'dutch' + stopwords?: StopWords } -export class NoriAnalyzer extends AnalyzerBase { - decompound_mode: NoriDecompoundMode - stoptags: string[] - user_dictionary: string +export class NoriAnalyzer { + type: 'nori' + version?: VersionString + decompound_mode?: NoriDecompoundMode + stoptags?: string[] + user_dictionary?: string } -export class PatternAnalyzer extends AnalyzerBase { - flags: string - lowercase: boolean +export class PatternAnalyzer { + type: 'pattern' + version?: VersionString + flags?: string + lowercase?: boolean pattern: string - stopwords: StopWords + stopwords?: StopWords } -export class SimpleAnalyzer extends AnalyzerBase {} +export class SimpleAnalyzer { + type: 'simple' + version?: VersionString +} -export class SnowballAnalyzer extends AnalyzerBase { +export class SnowballAnalyzer { + type: 'snowball' + version?: VersionString language: SnowballLanguage - stopwords: StopWords + stopwords?: StopWords +} + +export class StandardAnalyzer { + type: 'standard' + max_token_length?: integer + stopwords?: StopWords } -export class StandardAnalyzer extends AnalyzerBase { - max_token_length: integer - stopwords: StopWords +export class StopAnalyzer { + type: 'stop' + version?: VersionString + stopwords?: StopWords + stopwords_path?: string } -export class StopAnalyzer extends AnalyzerBase { - stopwords: StopWords - stopwords_path: string +export class WhitespaceAnalyzer { + type: 'whitespace' + version?: VersionString } -export class WhitespaceAnalyzer extends AnalyzerBase {} +/** + * @variants internal tag='type' default='custom' + * @non_exhaustive + */ +export type Analyzer = + | CustomAnalyzer + | FingerprintAnalyzer + | KeywordAnalyzer + | LanguageAnalyzer + | NoriAnalyzer + | PatternAnalyzer + | SimpleAnalyzer + | StandardAnalyzer + | StopAnalyzer + | WhitespaceAnalyzer + | IcuAnalyzer + | KuromojiAnalyzer + | SnowballAnalyzer + | DutchAnalyzer diff --git a/specification/_types/analysis/char_filters.ts b/specification/_types/analysis/char_filters.ts index 93a49cc86d..c0d17cc833 100644 --- a/specification/_types/analysis/char_filters.ts +++ b/specification/_types/analysis/char_filters.ts @@ -18,27 +18,41 @@ */ import { VersionString } from '@_types/common' -import { PatternReplaceTokenFilter } from './token_filters' +import { IcuNormalizationCharFilter } from './icu-plugin' +import { KuromojiIterationMarkCharFilter } from './kuromoji-plugin' export class CharFilterBase { - type: string version?: VersionString } -export type CharFilter = +/** @codegen_names name, definition */ +// ES: NameOrDefinition, used everywhere charfilter, tokenfilter or tokenizer is used +export type CharFilter = string | CharFilterDefinition + +/** + * @variants internal tag='type' + * @non_exhaustive + */ +export type CharFilterDefinition = | HtmlStripCharFilter | MappingCharFilter - | PatternReplaceTokenFilter + | PatternReplaceCharFilter + | IcuNormalizationCharFilter + | KuromojiIterationMarkCharFilter -export class HtmlStripCharFilter extends CharFilterBase {} +export class HtmlStripCharFilter extends CharFilterBase { + type: 'html_strip' +} export class MappingCharFilter extends CharFilterBase { - mappings: string[] - mappings_path: string + type: 'mapping' + mappings?: string[] + mappings_path?: string } export class PatternReplaceCharFilter extends CharFilterBase { - flags: string + type: 'pattern_replace' + flags?: string pattern: string - replacement: string + replacement?: string } diff --git a/specification/_types/analysis/icu-plugin.ts b/specification/_types/analysis/icu-plugin.ts index 1a4f424d53..8ce2741cfb 100644 --- a/specification/_types/analysis/icu-plugin.ts +++ b/specification/_types/analysis/icu-plugin.ts @@ -17,48 +17,55 @@ * under the License. */ -import { AnalyzerBase } from './analyzers' import { CharFilterBase } from './char_filters' import { TokenizerBase } from './tokenizers' import { TokenFilterBase } from './token_filters' export class IcuTransformTokenFilter extends TokenFilterBase { - dir: IcuTransformDirection + type: 'icu_transform' + dir?: IcuTransformDirection id: string } export class IcuTokenizer extends TokenizerBase { + type: 'icu_tokenizer' rule_files: string } export class IcuNormalizationTokenFilter extends TokenFilterBase { + type: 'icu_normalizer' name: IcuNormalizationType } export class IcuNormalizationCharFilter extends CharFilterBase { - mode: IcuNormalizationMode - name: IcuNormalizationType + type: 'icu_normalizer' + mode?: IcuNormalizationMode + name?: IcuNormalizationType } export class IcuFoldingTokenFilter extends TokenFilterBase { + type: 'icu_folding' unicode_set_filter: string } export class IcuCollationTokenFilter extends TokenFilterBase { - alternate: IcuCollationAlternate - caseFirst: IcuCollationCaseFirst - caseLevel: boolean - country: string - decomposition: IcuCollationDecomposition - hiraganaQuaternaryMode: boolean - language: string - numeric: boolean - strength: IcuCollationStrength - variableTop: string - variant: string + type: 'icu_collation' + alternate?: IcuCollationAlternate + caseFirst?: IcuCollationCaseFirst + caseLevel?: boolean + country?: string + decomposition?: IcuCollationDecomposition + hiraganaQuaternaryMode?: boolean + language?: string + numeric?: boolean + rules?: string + strength?: IcuCollationStrength + variableTop?: string + variant?: string } -export class IcuAnalyzer extends AnalyzerBase { +export class IcuAnalyzer { + type: 'icu_analyzer' method: IcuNormalizationType mode: IcuNormalizationMode } diff --git a/specification/_types/analysis/kuromoji-plugin.ts b/specification/_types/analysis/kuromoji-plugin.ts index 563d417491..41f3aef321 100644 --- a/specification/_types/analysis/kuromoji-plugin.ts +++ b/specification/_types/analysis/kuromoji-plugin.ts @@ -18,30 +18,34 @@ */ import { integer } from '@_types/Numeric' -import { AnalyzerBase } from './analyzers' import { CharFilterBase } from './char_filters' import { TokenizerBase } from './tokenizers' import { TokenFilterBase } from './token_filters' -export class KuromojiAnalyzer extends AnalyzerBase { +export class KuromojiAnalyzer { + type: 'kuromoji' mode: KuromojiTokenizationMode - user_dictionary: string + user_dictionary?: string } export class KuromojiIterationMarkCharFilter extends CharFilterBase { + type: 'kuromoji_iteration_mark' normalize_kana: boolean normalize_kanji: boolean } export class KuromojiPartOfSpeechTokenFilter extends TokenFilterBase { + type: 'kuromoji_part_of_speech' stoptags: string[] } export class KuromojiReadingFormTokenFilter extends TokenFilterBase { + type: 'kuromoji_readingform' use_romaji: boolean } export class KuromojiStemmerTokenFilter extends TokenFilterBase { + type: 'kuromoji_stemmer' minimum_length: integer } @@ -52,10 +56,12 @@ export enum KuromojiTokenizationMode { } export class KuromojiTokenizer extends TokenizerBase { - discard_punctuation: boolean + type: 'kuromoji_tokenizer' + discard_punctuation?: boolean mode: KuromojiTokenizationMode - nbest_cost: integer - nbest_examples: string - user_dictionary: string - user_dictionary_rules: string[] + nbest_cost?: integer + nbest_examples?: string + user_dictionary?: string + user_dictionary_rules?: string[] + discard_compound_token?: boolean } diff --git a/specification/cat/datafeeds/CatDatafeedsRequest.ts b/specification/_types/analysis/normalizers.ts similarity index 69% rename from specification/cat/datafeeds/CatDatafeedsRequest.ts rename to specification/_types/analysis/normalizers.ts index 9b11bfcda0..36c16fa736 100644 --- a/specification/cat/datafeeds/CatDatafeedsRequest.ts +++ b/specification/_types/analysis/normalizers.ts @@ -17,20 +17,18 @@ * under the License. */ -import { CatRequestBase } from '@cat/_types/CatBase' -import { Id } from '@_types/common' - /** - * @rest_spec_name cat.ml_datafeeds - * @since 7.7.0 - * @stability TODO + * @variants internal tag='type' + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html */ -export interface Request extends CatRequestBase { - path_parts?: { - datafeed_id?: Id - } - query_parameters?: { - allow_no_datafeeds?: boolean - } - body?: {} +export type Normalizer = LowercaseNormalizer | CustomNormalizer + +export class LowercaseNormalizer { + type: 'lowercase' +} + +export class CustomNormalizer { + type: 'custom' + char_filter?: string[] + filter?: string[] } diff --git a/specification/_types/analysis/phonetic-plugin.ts b/specification/_types/analysis/phonetic-plugin.ts index d0afe53559..a88a1c864d 100644 --- a/specification/_types/analysis/phonetic-plugin.ts +++ b/specification/_types/analysis/phonetic-plugin.ts @@ -37,7 +37,7 @@ export enum PhoneticEncoder { export enum PhoneticLanguage { any = 0, - comomon = 1, + common = 1, cyrillic = 2, english = 3, french = 4, @@ -62,10 +62,11 @@ export enum PhoneticRuleType { } export class PhoneticTokenFilter extends TokenFilterBase { + type: 'phonetic' encoder: PhoneticEncoder languageset: PhoneticLanguage[] - max_code_len: integer + max_code_len?: integer name_type: PhoneticNameType - replace: boolean + replace?: boolean rule_type: PhoneticRuleType } diff --git a/specification/_types/analysis/token_filters.ts b/specification/_types/analysis/token_filters.ts index 22f753612b..9f1ed0d35f 100644 --- a/specification/_types/analysis/token_filters.ts +++ b/specification/_types/analysis/token_filters.ts @@ -22,25 +22,41 @@ import { integer } from '@_types/Numeric' import { Script } from '@_types/Scripting' import { SnowballLanguage } from './languages' import { StopWords } from './StopWords' +import { + KuromojiStemmerTokenFilter, + KuromojiReadingFormTokenFilter, + KuromojiPartOfSpeechTokenFilter +} from './kuromoji-plugin' +import { + IcuCollationTokenFilter, + IcuFoldingTokenFilter, + IcuNormalizationTokenFilter, + IcuTokenizer, + IcuTransformTokenFilter +} from './icu-plugin' +import { PhoneticTokenFilter } from './phonetic-plugin' export class TokenFilterBase { - type: string version?: VersionString } export class CompoundWordTokenFilterBase extends TokenFilterBase { - hyphenation_patterns_path: string - max_subword_size: integer - min_subword_size: integer - min_word_size: integer - only_longest_match: boolean - word_list: string[] - word_list_path: string + hyphenation_patterns_path?: string + max_subword_size?: integer + min_subword_size?: integer + min_word_size?: integer + only_longest_match?: boolean + word_list?: string[] + word_list_path?: string } -export class DictionaryDecompounderTokenFilter extends CompoundWordTokenFilterBase {} +export class DictionaryDecompounderTokenFilter extends CompoundWordTokenFilterBase { + type: 'dictionary_decompounder' +} -export class HyphenationDecompounderTokenFilter extends CompoundWordTokenFilterBase {} +export class HyphenationDecompounderTokenFilter extends CompoundWordTokenFilterBase { + type: 'hyphenation_decompounder' +} export enum DelimitedPayloadEncoding { int = 0, @@ -49,8 +65,9 @@ export enum DelimitedPayloadEncoding { } export class DelimitedPayloadTokenFilter extends TokenFilterBase { - delimiter: string - encoding: DelimitedPayloadEncoding + type: 'delimited_payload' + delimiter?: string + encoding?: DelimitedPayloadEncoding } export enum EdgeNGramSide { @@ -59,24 +76,28 @@ export enum EdgeNGramSide { } export class EdgeNGramTokenFilter extends TokenFilterBase { - max_gram: integer - min_gram: integer - side: EdgeNGramSide + type: 'edge_ngram' + max_gram?: integer + min_gram?: integer + side?: EdgeNGramSide + preserve_original?: boolean } export class ShingleTokenFilter extends TokenFilterBase { - filler_token: string - max_shingle_size: integer - min_shingle_size: integer - output_unigrams: boolean - output_unigrams_if_no_shingles: boolean - token_separator: string + type: 'shingle' + filler_token?: string + max_shingle_size?: integer | string // TODO: should be only int + min_shingle_size?: integer | string // TODO: should be only int + output_unigrams?: boolean + output_unigrams_if_no_shingles?: boolean + token_separator?: string } export class StopTokenFilter extends TokenFilterBase { + type: 'stop' ignore_case?: boolean remove_trailing?: boolean - stopwords: StopWords + stopwords?: StopWords stopwords_path?: string } @@ -86,89 +107,106 @@ export enum SynonymFormat { } export class SynonymGraphTokenFilter extends TokenFilterBase { - expand: boolean - format: SynonymFormat - lenient: boolean - synonyms: string[] - synonyms_path: string - tokenizer: string - updateable: boolean + type: 'synonym_graph' + expand?: boolean + format?: SynonymFormat + lenient?: boolean + synonyms?: string[] + synonyms_path?: string + tokenizer?: string + updateable?: boolean } export class SynonymTokenFilter extends TokenFilterBase { - expand: boolean - format: SynonymFormat - lenient: boolean - synonyms: string[] - synonyms_path: string - tokenizer: string - updateable: boolean + type: 'synonym' + expand?: boolean + format?: SynonymFormat + lenient?: boolean + synonyms?: string[] + synonyms_path?: string + tokenizer?: string + updateable?: boolean } export class WordDelimiterTokenFilter extends TokenFilterBase { - catenate_all: boolean - catenate_numbers: boolean - catenate_words: boolean - generate_number_parts: boolean - generate_word_parts: boolean - preserve_original: boolean - protected_words: string[] - protected_words_path: string - split_on_case_change: boolean - split_on_numerics: boolean - stem_english_possessive: boolean - type_table: string[] - type_table_path: string + type: 'word_delimiter' + catenate_all?: boolean + catenate_numbers?: boolean + catenate_words?: boolean + generate_number_parts?: boolean + generate_word_parts?: boolean + preserve_original?: boolean + protected_words?: string[] + protected_words_path?: string + split_on_case_change?: boolean + split_on_numerics?: boolean + stem_english_possessive?: boolean + type_table?: string[] + type_table_path?: string } export class WordDelimiterGraphTokenFilter extends TokenFilterBase { - adjust_offsets: boolean - catenate_all: boolean - catenate_numbers: boolean - catenate_words: boolean - generate_number_parts: boolean - generate_word_parts: boolean - preserve_original: boolean - protected_words: string[] - protected_words_path: string - split_on_case_change: boolean - split_on_numerics: boolean - stem_english_possessive: boolean - type_table: string[] - type_table_path: string + type: 'word_delimiter_graph' + adjust_offsets?: boolean + catenate_all?: boolean + catenate_numbers?: boolean + catenate_words?: boolean + generate_number_parts?: boolean + generate_word_parts?: boolean + ignore_keywords?: boolean + preserve_original?: boolean + protected_words?: string[] + protected_words_path?: string + split_on_case_change?: boolean + split_on_numerics?: boolean + stem_english_possessive?: boolean + type_table?: string[] + type_table_path?: string } export class AsciiFoldingTokenFilter extends TokenFilterBase { - preserve_original: boolean + type: 'asciifolding' + preserve_original?: boolean } export class CommonGramsTokenFilter extends TokenFilterBase { - common_words: string[] - common_words_path: string - ignore_case: boolean - query_mode: boolean + type: 'common_grams' + common_words?: string[] + common_words_path?: string + ignore_case?: boolean + query_mode?: boolean } export class ConditionTokenFilter extends TokenFilterBase { + type: 'condition' filter: string[] script: Script } export class ElisionTokenFilter extends TokenFilterBase { - articles: string[] - articles_case: boolean + type: 'elision' + articles?: string[] + articles_path?: string + articles_case?: boolean } export class FingerprintTokenFilter extends TokenFilterBase { - max_output_size: integer - separator: string + type: 'fingerprint' + max_output_size?: integer + separator?: string } export class HunspellTokenFilter extends TokenFilterBase { - dedup: boolean - dictionary: string + type: 'hunspell' + dedup?: boolean + dictionary?: string locale: string - longest_only: boolean + longest_only?: boolean +} + +export class JaStopTokenFilter extends TokenFilterBase { + type: 'ja_stop' + stopwords?: StopWords } export enum KeepTypesMode { @@ -177,100 +215,140 @@ export enum KeepTypesMode { } export class KeepTypesTokenFilter extends TokenFilterBase { - mode: KeepTypesMode - types: string[] + type: 'keep_types' + mode?: KeepTypesMode + types?: string[] } export class KeepWordsTokenFilter extends TokenFilterBase { - keep_words: string[] - keep_words_case: boolean - keep_words_path: string + type: 'keep' + keep_words?: string[] + keep_words_case?: boolean + keep_words_path?: string } export class KeywordMarkerTokenFilter extends TokenFilterBase { - ignore_case: boolean - keywords: string[] - keywords_path: string - keywords_pattern: string + type: 'keyword_marker' + ignore_case?: boolean + keywords?: string[] + keywords_path?: string + keywords_pattern?: string } -export class KStemTokenFilter extends TokenFilterBase {} +export class KStemTokenFilter extends TokenFilterBase { + type: 'kstem' +} export class LengthTokenFilter extends TokenFilterBase { - max: integer - min: integer + type: 'length' + max?: integer + min?: integer } export class LimitTokenCountTokenFilter extends TokenFilterBase { - consume_all_tokens: boolean - max_token_count: integer + type: 'limit' + consume_all_tokens?: boolean + max_token_count?: integer } export class LowercaseTokenFilter extends TokenFilterBase { - language: string + type: 'lowercase' + language?: string } export class MultiplexerTokenFilter extends TokenFilterBase { + type: 'multiplexer' filters: string[] - preserve_original: boolean + preserve_original?: boolean } export class NGramTokenFilter extends TokenFilterBase { - max_gram: integer - min_gram: integer + type: 'ngram' + max_gram?: integer + min_gram?: integer + preserve_original?: boolean } export class NoriPartOfSpeechTokenFilter extends TokenFilterBase { - stoptags: string[] + type: 'nori_part_of_speech' + stoptags?: string[] } export class PatternCaptureTokenFilter extends TokenFilterBase { + type: 'pattern_capture' patterns: string[] - preserve_original: boolean + preserve_original?: boolean } export class PatternReplaceTokenFilter extends TokenFilterBase { - flags: string + type: 'pattern_replace' + all?: boolean + flags?: string pattern: string - replacement: string + replacement?: string } -export class PorterStemTokenFilter extends TokenFilterBase {} +export class PorterStemTokenFilter extends TokenFilterBase { + type: 'porter_stem' +} export class PredicateTokenFilter extends TokenFilterBase { + type: 'predicate_token_filter' script: Script } -export class RemoveDuplicatesTokenFilter extends TokenFilterBase {} +export class RemoveDuplicatesTokenFilter extends TokenFilterBase { + type: 'remove_duplicates' +} -export class ReverseTokenFilter extends TokenFilterBase {} +export class ReverseTokenFilter extends TokenFilterBase { + type: 'reverse' +} export class SnowballTokenFilter extends TokenFilterBase { + type: 'snowball' language: SnowballLanguage } export class StemmerOverrideTokenFilter extends TokenFilterBase { - rules: string[] - rules_path: string + type: 'stemmer_override' + rules?: string[] + rules_path?: string } export class StemmerTokenFilter extends TokenFilterBase { - language: string + type: 'stemmer' + /** @aliases name */ + language?: string } -export class TrimTokenFilter extends TokenFilterBase {} +export class TrimTokenFilter extends TokenFilterBase { + type: 'trim' +} export class TruncateTokenFilter extends TokenFilterBase { - length: integer + type: 'truncate' + length?: integer } export class UniqueTokenFilter extends TokenFilterBase { - only_on_same_position: boolean + type: 'unique' + only_on_same_position?: boolean } -export class UppercaseTokenFilter extends TokenFilterBase {} +export class UppercaseTokenFilter extends TokenFilterBase { + type: 'uppercase' +} + +/** @codegen_names name, definition */ +// ES: NameOrDefinition, used everywhere charfilter, tokenfilter or tokenizer is used +export type TokenFilter = string | TokenFilterDefinition -export type TokenFilter = +/** + * @variants internal tag='type' + * @non_exhaustive + */ +export type TokenFilterDefinition = | AsciiFoldingTokenFilter | CommonGramsTokenFilter | ConditionTokenFilter @@ -310,3 +388,13 @@ export type TokenFilter = | UppercaseTokenFilter | WordDelimiterGraphTokenFilter | WordDelimiterTokenFilter + | KuromojiStemmerTokenFilter + | KuromojiReadingFormTokenFilter + | KuromojiPartOfSpeechTokenFilter + | IcuTokenizer + | IcuCollationTokenFilter + | IcuFoldingTokenFilter + | IcuNormalizationTokenFilter + | IcuTransformTokenFilter + | PhoneticTokenFilter + | DictionaryDecompounderTokenFilter diff --git a/specification/_types/analysis/tokenizers.ts b/specification/_types/analysis/tokenizers.ts index 0ea173659d..ec5a5e952d 100644 --- a/specification/_types/analysis/tokenizers.ts +++ b/specification/_types/analysis/tokenizers.ts @@ -19,21 +19,25 @@ import { VersionString } from '@_types/common' import { integer } from '@_types/Numeric' +import { IcuTokenizer } from './icu-plugin' +import { KuromojiTokenizer } from './kuromoji-plugin' +import { TokenFilterDefinition } from '@_types/analysis/token_filters' export class TokenizerBase { - type: string version?: VersionString } export class EdgeNGramTokenizer extends TokenizerBase { - custom_token_chars: string + type: 'edge_ngram' + custom_token_chars?: string max_gram: integer min_gram: integer token_chars: TokenChar[] } export class NGramTokenizer extends TokenizerBase { - custom_token_chars: string + type: 'ngram' + custom_token_chars?: string max_gram: integer min_gram: integer token_chars: TokenChar[] @@ -49,16 +53,23 @@ export enum TokenChar { } export class CharGroupTokenizer extends TokenizerBase { + type: 'char_group' tokenize_on_chars: string[] + max_token_length?: integer } export class KeywordTokenizer extends TokenizerBase { + type: 'keyword' buffer_size: integer } -export class LetterTokenizer extends TokenizerBase {} +export class LetterTokenizer extends TokenizerBase { + type: 'letter' +} -export class LowercaseTokenizer extends TokenizerBase {} +export class LowercaseTokenizer extends TokenizerBase { + type: 'lowercase' +} export enum NoriDecompoundMode { discard = 0, @@ -67,13 +78,15 @@ export enum NoriDecompoundMode { } export class NoriTokenizer extends TokenizerBase { - decompound_mode: NoriDecompoundMode - discard_punctuation: boolean - user_dictionary: string - user_dictionary_rules: string[] + type: 'nori_tokenizer' + decompound_mode?: NoriDecompoundMode + discard_punctuation?: boolean + user_dictionary?: string + user_dictionary_rules?: string[] } export class PathHierarchyTokenizer extends TokenizerBase { + type: 'path_hierarchy' buffer_size: integer delimiter: string replacement: string @@ -82,24 +95,36 @@ export class PathHierarchyTokenizer extends TokenizerBase { } export class PatternTokenizer extends TokenizerBase { + type: 'pattern' flags: string group: integer pattern: string } export class StandardTokenizer extends TokenizerBase { - max_token_length: integer + type: 'standard' + max_token_length?: integer } export class UaxEmailUrlTokenizer extends TokenizerBase { - max_token_length: integer + type: 'uax_url_email' + max_token_length?: integer } export class WhitespaceTokenizer extends TokenizerBase { - max_token_length: integer + type: 'whitespace' + max_token_length?: integer } -export type Tokenizer = +/** @codegen_names name, definition */ +// ES: NameOrDefinition, used everywhere charfilter, tokenfilter or tokenizer is used +export type Tokenizer = string | TokenizerDefinition + +/** + * @variants internal tag='type' + * @non_exhaustive + */ +export type TokenizerDefinition = | CharGroupTokenizer | EdgeNGramTokenizer | KeywordTokenizer @@ -111,3 +136,6 @@ export type Tokenizer = | StandardTokenizer | UaxEmailUrlTokenizer | WhitespaceTokenizer + | KuromojiTokenizer + | PatternTokenizer + | IcuTokenizer diff --git a/specification/_types/common.ts b/specification/_types/common.ts index 37a99897a6..8b647144f1 100644 --- a/specification/_types/common.ts +++ b/specification/_types/common.ts @@ -19,7 +19,22 @@ import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -import { integer, long } from './Numeric' +import { double, integer, long } from './Numeric' +import { AdditionalProperties } from '@spec_utils/behaviors' + +/** + * A field value. + * @codegen_names long, double, string, boolean, null, any + */ +// Note: the ending `UserDefinedValue` includes all other union members, but we keep them explicit so that +// code generators can provide direct access to scalar values, which are the most common use case. +export type FieldValue = + | long + | double + | string + | boolean + | null + | UserDefinedValue export class UrlParameter {} @@ -40,9 +55,10 @@ export type ActionIds = string // TODO: check if this should be an array of Acti export type Id = string export type Ids = Id | Id[] export type NodeId = string +export type NodeIds = NodeId | NodeId[] export type IndexName = string -export type Indices = string | string[] +export type Indices = IndexName | IndexName[] export type IndexAlias = string export type IndexPattern = string export type IndexPatterns = IndexPattern[] @@ -57,7 +73,7 @@ export type IndexMetrics = string export type Metrics = string | string[] export type Name = string -export type Names = string | string[] +export type Names = Name | Name[] export type Namespace = string export type Service = string @@ -70,6 +86,8 @@ export type NodeName = string /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html#indices-create-data-stream-api-path-params */ export type DataStreamName = string +export type DataStreamNames = DataStreamName | DataStreamName[] + /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#byte-units */ export type ByteSize = long | string @@ -91,9 +109,8 @@ export enum VersionType { export type Uuid = string // _seq_no -export type SequenceNumber = integer +export type SequenceNumber = long -export type NodeIds = string export type PropertyName = string export type RelationName = string export type TaskId = string | integer @@ -105,6 +122,7 @@ export type MultiTermQueryRewrite = string export type Field = string export type Fields = Field | Field[] +/** @codegen_names count, option */ export type WaitForActiveShards = integer | WaitForActiveShardOptions /** @@ -131,32 +149,25 @@ export class EmptyObject {} */ export type MinimumShouldMatch = integer | string -export enum ShapeRelation { - intersects = 0, - disjoint = 1, - within = 2 -} - -export enum Bytes { - b = 0, - k = 1, - kb = 2, - m = 3, - mb = 4, - g = 5, - gb = 6, - t = 7, - tb = 8, - p = 9, - pb = 10 -} - /** - * Whenever the byte size of data needs to be specified, e.g. when setting a buffer size parameter, the value must specify the unit, like 10kb for 10 kilobytes. Note that these units use powers of 1024, so 1kb means 1024 bytes. + * Byte size units. These units use powers of 1024, so 1 kB means 1024 bytes. + * * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#byte-units */ -//type ByteSize = long | string -// TODO -- move here +export enum Bytes { + /** @codegen_name bytes */ + b, + /** @codegen_name kilo_bytes */ + kb, + /** @codegen_name mega_bytes */ + mb, + /** @codegen_name giga_bytes */ + gb, + /** @codegen_name tera_bytes */ + tb, + /** @codegen_name peta_bytes */ + pb +} export enum Conflicts { abort = 0, @@ -166,11 +177,6 @@ export enum Conflicts { export type Username = string export type Password = string -export enum DefaultOperator { - AND = 0, - OR = 1 -} - export class ElasticsearchResponseBase {} export class ElasticsearchUrlFormatter {} @@ -178,7 +184,7 @@ export class ElasticsearchUrlFormatter {} /** * Type of index that wildcard expressions can match. */ -export enum ExpandWildcardOptions { +export enum ExpandWildcard { /** Match any data stream or index, including hidden ones. */ all = 0, /** Match open, non-hidden indices. Also matches any non-hidden data stream. */ @@ -191,26 +197,27 @@ export enum ExpandWildcardOptions { none = 4 } -export type ExpandWildcards = - | ExpandWildcardOptions - | Array - | string - -export enum GroupBy { - nodes = 0, - parents = 1, - none = 2 -} +export type ExpandWildcards = ExpandWildcard | ExpandWildcard[] /** * Health status of the cluster, based on the state of its primary and replica shards. */ -export enum Health { - /** All shards are assigned. */ +export enum HealthStatus { + // ES will send this enum as upper or lowercase depending on the APIs + /** + * All shards are assigned. + * @aliases GREEN + */ green = 0, - /** All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. */ + /** + * All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. + * @aliases YELLOW + */ yellow = 1, - /** One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. */ + /** + * One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. + * @aliases RED + */ red = 2 } @@ -233,9 +240,13 @@ export enum OpType { create = 1 } -export type Refresh = boolean | RefreshOptions -export enum RefreshOptions { - wait_for = 1 +/** + * @es_quirk This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false. + */ +export enum Refresh { + true, + false, + wait_for } export enum SearchType { @@ -245,15 +256,6 @@ export enum SearchType { dfs_query_then_fetch = 1 } -export enum Size { - Raw = 0, - k = 1, - m = 2, - g = 3, - t = 4, - p = 5 -} - export enum SuggestMode { missing = 0, popular = 1, @@ -268,7 +270,8 @@ export enum ThreadType { // TODO: @see WaitForActiveShards & https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html export enum WaitForActiveShardOptions { - 'all' = 0 + 'all', + 'index-setting' } export enum WaitForEvents { @@ -280,17 +283,60 @@ export enum WaitForEvents { languid = 5 } -export enum WaitForStatus { - green = 0, - yellow = 1, - red = 2 -} - -export class InlineGet { +// Additional properties are the meta fields +export class InlineGet + implements AdditionalProperties +{ fields?: Dictionary found: boolean - _seq_no: SequenceNumber - _primary_term: long + _seq_no?: SequenceNumber + _primary_term?: long _routing?: Routing _source: TDocument } + +/** + * Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded + * to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices. + */ +export class IndicesOptions { + /** + * If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only + * missing or closed indices. This behavior applies even if the request targets other open indices. For example, + * a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + */ + allow_no_indices?: boolean + /** + * Type of index that wildcard patterns can match. If the request can target data streams, this argument + * determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + * such as `open,hidden`. + */ + expand_wildcards?: ExpandWildcards + /** + * If true, missing or closed indices are not included in the response. + * @server_default false + */ + ignore_unavailable?: boolean + /** + * If true, concrete, expanded or aliased indices are ignored when frozen. + * @server_default true + */ + ignore_throttled?: boolean +} + +/** + * Slices configuration used to parallelize a process. + * + * @codegen_names value, computed + */ +export type Slices = integer | SlicesCalculation + +/** + * Named computations to calculate the number of slices + */ +export enum SlicesCalculation { + /** + * Let Elasticsearch choose a reasonable number for most data streams and indices. + */ + auto +} diff --git a/specification/_types/mapping/DenseVectorIndexOptions.ts b/specification/_types/mapping/DenseVectorIndexOptions.ts new file mode 100644 index 0000000000..9876f53942 --- /dev/null +++ b/specification/_types/mapping/DenseVectorIndexOptions.ts @@ -0,0 +1,26 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { integer } from '@_types/Numeric' + +export class DenseVectorIndexOptions { + type: string + m: integer + ef_construction: integer +} diff --git a/specification/_types/mapping/Property.ts b/specification/_types/mapping/Property.ts index fa5e1766a5..a975c74866 100644 --- a/specification/_types/mapping/Property.ts +++ b/specification/_types/mapping/Property.ts @@ -20,9 +20,14 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Metadata, PropertyName } from '@_types/common' import { integer } from '@_types/Numeric' -import { FlattenedProperty } from './complex' +import { + AggregateMetricDoubleProperty, + DenseVectorProperty, + FlattenedProperty +} from './complex' import { CoreProperty, + DynamicProperty, JoinProperty, PercolatorProperty, RankFeatureProperty, @@ -36,16 +41,21 @@ import { } from './specialized' export class PropertyBase { - local_metadata?: Metadata + /** + * Metadata about the field. + * @doc_id mapping-meta-field + */ meta?: Dictionary - name?: PropertyName properties?: Dictionary ignore_above?: integer - dynamic?: boolean | DynamicMapping + dynamic?: DynamicMapping fields?: Dictionary } -/** @variants internal tag='type' */ +/** + * @variants internal tag='type' default='object' + * @non_exhaustive + */ export type Property = | FlattenedProperty | JoinProperty @@ -55,48 +65,54 @@ export type Property = | ConstantKeywordProperty | FieldAliasProperty | HistogramProperty + | DenseVectorProperty + | AggregateMetricDoubleProperty | CoreProperty + | DynamicProperty export enum FieldType { - none = 0, - geo_point = 1, - geo_shape = 2, - ip = 3, - binary = 4, - keyword = 5, - text = 6, - search_as_you_type = 7, - date = 8, - date_nanos = 9, - boolean = 10, - completion = 11, - nested = 12, - object = 13, - murmur3 = 14, - token_count = 15, - percolator = 16, - integer = 17, - long = 18, - short = 19, - byte = 20, - float = 21, - half_float = 22, - scaled_float = 23, - double = 24, - integer_range = 25, - float_range = 26, - long_range = 27, - double_range = 28, - date_range = 29, - ip_range = 30, - alias = 31, - join = 32, - rank_feature = 33, - rank_features = 34, - flattened = 35, - shape = 36, - histogram = 37, - constant_keyword = 38 + none, + geo_point, + geo_shape, + ip, + binary, + keyword, + text, + search_as_you_type, + date, + date_nanos, + boolean, + completion, + nested, + object, + murmur3, + token_count, + percolator, + integer, + long, + short, + byte, + float, + half_float, + scaled_float, + double, + integer_range, + float_range, + long_range, + double_range, + date_range, + ip_range, + alias, + join, + rank_feature, + rank_features, + flattened, + shape, + histogram, + constant_keyword, + aggregate_metric_double, + dense_vector, + match_only_text } export class PropertyWithClrOrigin {} diff --git a/specification/_types/mapping/TermVectorOption.ts b/specification/_types/mapping/TermVectorOption.ts index dba4d57a91..2fccf582e5 100644 --- a/specification/_types/mapping/TermVectorOption.ts +++ b/specification/_types/mapping/TermVectorOption.ts @@ -18,10 +18,11 @@ */ export enum TermVectorOption { - no = 0, - yes = 1, - with_offsets = 2, - with_positions = 3, - with_positions_offsets = 4, - with_positions_offsets_payloads = 5 + no, + yes, + with_offsets, + with_positions, + with_positions_offsets, + with_positions_offsets_payloads, + with_positions_payloads } diff --git a/specification/_types/mapping/TypeMapping.ts b/specification/_types/mapping/TypeMapping.ts index feb46b97bd..49a62a213e 100644 --- a/specification/_types/mapping/TypeMapping.ts +++ b/specification/_types/mapping/TypeMapping.ts @@ -34,11 +34,9 @@ import { RuntimeField } from './RuntimeFields' export class TypeMapping { all_field?: AllField date_detection?: boolean - dynamic?: boolean | DynamicMapping + dynamic?: DynamicMapping dynamic_date_formats?: string[] - dynamic_templates?: - | Dictionary - | Dictionary[] + dynamic_templates?: Dictionary[] _field_names?: FieldNamesField index_field?: IndexField /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html */ @@ -49,4 +47,5 @@ export class TypeMapping { _size?: SizeField _source?: SourceField runtime?: Dictionary + enabled?: boolean } diff --git a/specification/_types/mapping/complex.ts b/specification/_types/mapping/complex.ts index 6087dada0e..bef739e348 100644 --- a/specification/_types/mapping/complex.ts +++ b/specification/_types/mapping/complex.ts @@ -17,12 +17,10 @@ * under the License. */ -import { Dictionary } from '@spec_utils/Dictionary' -import { PropertyName } from '@_types/common' import { double, integer } from '@_types/Numeric' import { CorePropertyBase, IndexOptions } from './core' -import { DynamicMapping } from './dynamic-template' -import { Property, PropertyBase } from './Property' +import { DenseVectorIndexOptions } from './DenseVectorIndexOptions' +import { PropertyBase } from './Property' export class FlattenedProperty extends PropertyBase { boost?: double @@ -48,3 +46,17 @@ export class ObjectProperty extends CorePropertyBase { enabled?: boolean type?: 'object' } + +export class DenseVectorProperty extends PropertyBase { + type: 'dense_vector' + dims: integer + similarity?: string + index?: boolean + index_options?: DenseVectorIndexOptions +} + +export class AggregateMetricDoubleProperty extends PropertyBase { + type: 'aggregate_metric_double' + default_metric: string + metrics: string[] +} diff --git a/specification/_types/mapping/core.ts b/specification/_types/mapping/core.ts index e7313831ff..9541c2b6e2 100644 --- a/specification/_types/mapping/core.ts +++ b/specification/_types/mapping/core.ts @@ -20,22 +20,34 @@ import { FielddataFrequencyFilter } from '@indices/_types/FielddataFrequencyFilter' import { NumericFielddata } from '@indices/_types/NumericFielddata' import { Dictionary } from '@spec_utils/Dictionary' -import { Fields, RelationName } from '@_types/common' -import { double, integer } from '@_types/Numeric' +import { Fields, FieldValue, PropertyName, RelationName } from '@_types/common' +import { + byte, + double, + float, + integer, + long, + short, + ulong +} from '@_types/Numeric' import { DateString } from '@_types/Time' import { NestedProperty, ObjectProperty } from './complex' -import { GeoPointProperty, GeoShapeProperty, PointProperty } from './geo' -import { PropertyBase } from './Property' +import { + GeoPointProperty, + GeoShapeProperty, + PointProperty, + ShapeProperty +} from './geo' +import { Property, PropertyBase } from './Property' import { RangeProperty } from './range' import { CompletionProperty, - GenericProperty, IpProperty, Murmur3HashProperty, - ShapeProperty, TokenCountProperty } from './specialized' import { TermVectorOption } from './TermVectorOption' +import { Script } from '@_types/Scripting' export class CorePropertyBase extends PropertyBase { copy_to?: Fields @@ -49,6 +61,7 @@ export type CoreProperty = | SearchAsYouTypeProperty | TextProperty | DocValuesProperty + | MatchOnlyTextProperty export class DocValuesPropertyBase extends CorePropertyBase { doc_values?: boolean @@ -65,7 +78,6 @@ export type DocValuesProperty = | GeoPointProperty | GeoShapeProperty | CompletionProperty - | GenericProperty | IpProperty | Murmur3HashProperty | ShapeProperty @@ -94,6 +106,7 @@ export class DateProperty extends DocValuesPropertyBase { index?: boolean null_value?: DateString precision_step?: integer + locale?: string type: 'date' } @@ -124,29 +137,80 @@ export class KeywordProperty extends DocValuesPropertyBase { type: 'keyword' } -export class NumberProperty extends DocValuesPropertyBase { - boost?: double - coerce?: boolean - fielddata?: NumericFielddata - ignore_malformed?: boolean +export class NumberPropertyBase extends DocValuesPropertyBase { index?: boolean + ignore_malformed?: boolean +} + +export enum OnScriptError { + fail, + continue +} + +export class StandardNumberProperty extends NumberPropertyBase { + coerce?: boolean + script?: Script + on_script_error?: OnScriptError +} + +export class FloatNumberProperty extends StandardNumberProperty { + type: 'float' + null_value?: float +} + +export class HalfFloatNumberProperty extends StandardNumberProperty { + type: 'half_float' + null_value?: float +} + +export class DoubleNumberProperty extends StandardNumberProperty { + type: 'double' null_value?: double - scaling_factor?: double - type: NumberType } -export enum NumberType { - float = 0, - half_float = 1, - scaled_float = 2, - double = 3, - integer = 4, - long = 5, - short = 6, - byte = 7, - unsigned_long = 8 +export class IntegerNumberProperty extends StandardNumberProperty { + type: 'integer' + null_value?: integer +} + +export class LongNumberProperty extends StandardNumberProperty { + type: 'long' + null_value?: long +} + +export class ShortNumberProperty extends StandardNumberProperty { + type: 'short' + null_value?: short } +export class ByteNumberProperty extends StandardNumberProperty { + type: 'byte' + null_value?: byte +} + +export class UnsignedLongNumberProperty extends NumberPropertyBase { + type: 'unsigned_long' + null_value?: ulong +} + +export class ScaledFloatNumberProperty extends NumberPropertyBase { + type: 'scaled_float' + coerce?: boolean + null_value?: double + scaling_factor?: double +} + +export type NumberProperty = + | FloatNumberProperty + | HalfFloatNumberProperty + | DoubleNumberProperty + | IntegerNumberProperty + | LongNumberProperty + | ShortNumberProperty + | ByteNumberProperty + | UnsignedLongNumberProperty + | ScaledFloatNumberProperty + export class PercolatorProperty extends PropertyBase { type: 'percolator' } @@ -172,11 +236,44 @@ export class SearchAsYouTypeProperty extends CorePropertyBase { type: 'search_as_you_type' } +// MatchOnlyTextProperty is an example of a property which does not derive from PropertyBase. +// We have checked and this property does not support all properties of the base type. +// In a future iteration we may remodel properties and identify truely common properties that should form +// a base type that can be considered a common ancestor for all properties. Some clients will generate +// a synthetic version of this today. + +/** + * A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field + * effectively stores data the same way as a text field that only indexes documents (index_options: docs) and + * disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries + * that need positions such as the match_phrase query perform slower as they need to look at the _source document + * to verify whether a phrase matches. All queries return constant scores that are equal to 1.0. + */ +export class MatchOnlyTextProperty { + type: 'match_only_text' + /** + * Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + * field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. + * @doc_id multi-fields + */ + fields?: Dictionary + /** + * Metadata about the field. + * @doc_id mapping-meta-field + */ + meta?: Dictionary + /** + * Allows you to copy the values of multiple fields into a group + * field, which can then be queried as a single field. + */ + copy_to?: Fields +} + export enum IndexOptions { - docs = 0, - freqs = 1, - positions = 2, - offsets = 3 + docs, + freqs, + positions, + offsets } export class TextIndexPrefixes { @@ -208,4 +305,38 @@ export class VersionProperty extends DocValuesPropertyBase { export class WildcardProperty extends DocValuesPropertyBase { type: 'wildcard' + /** @since 7.15.0 */ + null_value?: string +} + +export class DynamicProperty extends DocValuesPropertyBase { + type: '{dynamic_property}' + + enabled?: boolean + null_value?: FieldValue + boost?: double + + // NumberPropertyBase & long, double + coerce?: boolean + script?: Script + on_script_error?: OnScriptError + ignore_malformed?: boolean + + // string + analyzer?: string + eager_global_ordinals?: boolean + index?: boolean + index_options?: IndexOptions + index_phrases?: boolean + index_prefixes?: TextIndexPrefixes + norms?: boolean + position_increment_gap?: integer + search_analyzer?: string + search_quote_analyzer?: string + term_vector?: TermVectorOption + + // date + format?: string + precision_step?: integer + locale?: string } diff --git a/specification/_types/mapping/dynamic-template.ts b/specification/_types/mapping/dynamic-template.ts index 93fcadb924..30e005226b 100644 --- a/specification/_types/mapping/dynamic-template.ts +++ b/specification/_types/mapping/dynamic-template.ts @@ -17,10 +17,10 @@ * under the License. */ -import { PropertyBase } from './Property' +import { Property } from './Property' export class DynamicTemplate { - mapping?: PropertyBase + mapping?: Property match?: string match_mapping_type?: string match_pattern?: MatchType @@ -34,9 +34,13 @@ export enum MatchType { regex = 1 } +/** + * @es_quirk This is a boolean that evolved into an enum. Boolean values should be accepted on reading, and + * true and false must be serialized as JSON booleans, or it may break Kibana (see elasticsearch-java#139) + */ export enum DynamicMapping { - strict = 0, - runtime = 1, - true = 2, - false = 3 + strict, + runtime, + true, + false } diff --git a/specification/_types/mapping/geo.ts b/specification/_types/mapping/geo.ts index 0753e49771..93e3c870e5 100644 --- a/specification/_types/mapping/geo.ts +++ b/specification/_types/mapping/geo.ts @@ -17,8 +17,8 @@ * under the License. */ -import { GeoLocation } from '@_types/query_dsl/geo' import { DocValuesPropertyBase } from './core' +import { GeoLocation } from '@_types/Geo' export class GeoPointProperty extends DocValuesPropertyBase { ignore_malformed?: boolean @@ -28,20 +28,18 @@ export class GeoPointProperty extends DocValuesPropertyBase { } export enum GeoOrientation { - right = 0, - RIGHT = 1, - counterclockwise = 2, - COUNTERCLOCKWISE = 3, - ccw = 4, - CCW = 5, - left = 6, - LEFT = 7, - clockwise = 8, - CLOCKWISE = 9, - cw = 10, - CW = 11 + /** @aliases RIGHT, counterclockwise, ccw */ + right, + /** @aliases LEFT, clockwise, cw */ + left } +/** + * The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles + * and polygons. + * + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html + */ export class GeoShapeProperty extends DocValuesPropertyBase { coerce?: boolean ignore_malformed?: boolean @@ -67,3 +65,17 @@ export class PointProperty extends DocValuesPropertyBase { null_value?: string type: 'point' } + +/** + * The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as + * rectangles and polygons. + * + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html + */ +export class ShapeProperty extends DocValuesPropertyBase { + coerce?: boolean + ignore_malformed?: boolean + ignore_z_value?: boolean + orientation?: GeoOrientation + type: 'shape' +} diff --git a/specification/_types/mapping/meta-fields.ts b/specification/_types/mapping/meta-fields.ts index 6dbbbe7dc0..2feca7a04b 100644 --- a/specification/_types/mapping/meta-fields.ts +++ b/specification/_types/mapping/meta-fields.ts @@ -17,7 +17,14 @@ * under the License. */ -export class FieldMapping {} +import { SingleKeyDictionary } from '@spec_utils/Dictionary' +import { Property } from './Property' +import { Field } from '@_types/common' + +export class FieldMapping { + full_name: string + mapping: SingleKeyDictionary +} export class AllField { analyzer: string @@ -51,7 +58,7 @@ export class SizeField { export class SourceField { compress?: boolean compress_threshold?: string - enabled: boolean + enabled?: boolean excludes?: string[] includes?: string[] } diff --git a/specification/_types/mapping/specialized.ts b/specification/_types/mapping/specialized.ts index eeff589f49..64bc72b25b 100644 --- a/specification/_types/mapping/specialized.ts +++ b/specification/_types/mapping/specialized.ts @@ -17,13 +17,11 @@ * under the License. */ -import { StringFielddata } from '@indices/_types/StringFielddata' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Name } from '@_types/common' import { double, integer } from '@_types/Numeric' import { DocValuesPropertyBase, IndexOptions } from './core' import { PropertyBase } from './Property' -import { TermVectorOption } from './TermVectorOption' export class CompletionProperty extends DocValuesPropertyBase { analyzer?: string @@ -39,7 +37,7 @@ export class SuggestContext { name: Name path?: Field type: string - precision?: integer + precision?: integer | string } export class ConstantKeywordProperty extends PropertyBase { @@ -52,21 +50,6 @@ export class FieldAliasProperty extends PropertyBase { type: 'alias' } -export class GenericProperty extends DocValuesPropertyBase { - analyzer: string - boost: double - fielddata: StringFielddata - ignore_malformed: boolean - index: boolean - index_options: IndexOptions - norms: boolean - null_value: string - position_increment_gap: integer - search_analyzer: string - term_vector: TermVectorOption - type: string -} - export class HistogramProperty extends PropertyBase { ignore_malformed?: boolean type: 'histogram' @@ -76,6 +59,7 @@ export class IpProperty extends DocValuesPropertyBase { boost?: double index?: boolean null_value?: string + ignore_malformed?: boolean type: 'ip' } @@ -83,23 +67,6 @@ export class Murmur3HashProperty extends DocValuesPropertyBase { type: 'murmur3' } -export enum ShapeOrientation { - right = 0, - counterclockwise = 1, - ccw = 2, - left = 3, - clockwise = 4, - cw = 5 -} - -export class ShapeProperty extends DocValuesPropertyBase { - coerce?: boolean - ignore_malformed?: boolean - ignore_z_value?: boolean - orientation?: ShapeOrientation - type: 'shape' -} - export class TokenCountProperty extends DocValuesPropertyBase { analyzer?: string boost?: double diff --git a/specification/_types/query_dsl/Operator.ts b/specification/_types/query_dsl/Operator.ts index d6201cba3b..751f3351ba 100644 --- a/specification/_types/query_dsl/Operator.ts +++ b/specification/_types/query_dsl/Operator.ts @@ -20,6 +20,8 @@ // Note: corresponding server enum is uppercase, but parsing is case-insensitive. Tests only use lower-case identifiers // so we only keep those. export enum Operator { - and = 0, - or = 1 + /** @aliases AND */ + and, + /** @aliases OR */ + or } diff --git a/specification/_types/query_dsl/abstractions.ts b/specification/_types/query_dsl/abstractions.ts index 391eb62145..f605682e80 100644 --- a/specification/_types/query_dsl/abstractions.ts +++ b/specification/_types/query_dsl/abstractions.ts @@ -17,7 +17,6 @@ * under the License. */ -import { AdditionalProperties } from '@spec_utils/behaviors' import { SingleKeyDictionary } from '@spec_utils/Dictionary' import { Field, @@ -26,7 +25,7 @@ import { MinimumShouldMatch, Routing } from '@_types/common' -import { float, long } from '@_types/Numeric' +import { float } from '@_types/Numeric' import { BoolQuery, BoostingQuery, @@ -96,11 +95,12 @@ import { /** * @variants container + * @non_exhaustive */ export class QueryContainer { bool?: BoolQuery boosting?: BoostingQuery - /** @obsolete 7.3.0 */ + /** @deprecated 7.3.0 */ common?: SingleKeyDictionary /** @since 7.13.0 */ combined_fields?: CombinedFieldsQuery @@ -152,10 +152,10 @@ export class QueryContainer { terms?: TermsQuery terms_set?: SingleKeyDictionary wildcard?: SingleKeyDictionary + wrapper?: WrapperQuery /** - * @obsolete 7.0.0 - * @obsolete_description https://www.elastic.co/guide/en/elasticsearch/reference/7.x/removal-of-types.html + * @deprecated 7.0.0 https://www.elastic.co/guide/en/elasticsearch/reference/7.x/removal-of-types.html */ type?: TypeQuery } @@ -173,7 +173,7 @@ export class FieldNameQuery { export class QueryBase { boost?: float - /** @identifier query_name */ + /** @codegen_name query_name */ _name?: string } @@ -187,12 +187,17 @@ export class CombinedFieldsQuery extends QueryBase { /** @server_default or */ operator?: CombinedFieldsOperator - mimimum_should_match?: MinimumShouldMatch + minimum_should_match?: MinimumShouldMatch /** @server_default none */ zero_terms_query?: CombinedFieldsZeroTerms } +export class WrapperQuery extends QueryBase { + /** A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings */ + query: string +} + export enum CombinedFieldsOperator { or, and @@ -202,3 +207,19 @@ export enum CombinedFieldsZeroTerms { none, all } + +/** + * A reference to a field with formatting instructions on how to return the value + * @shortcut_property field + */ +export class FieldAndFormat { + /** + * Wildcard pattern. The request returns values for field names matching this pattern. + */ + field: Field + /** + * Format in which the values are returned. + */ + format?: string + include_unmapped?: boolean +} diff --git a/specification/_types/query_dsl/compound.ts b/specification/_types/query_dsl/compound.ts index f0db4d47f7..a13af503f8 100644 --- a/specification/_types/query_dsl/compound.ts +++ b/specification/_types/query_dsl/compound.ts @@ -19,12 +19,11 @@ import { AdditionalProperties, AdditionalProperty } from '@spec_utils/behaviors' import { Field, MinimumShouldMatch } from '@_types/common' -import { Distance } from '@_types/Geo' +import { Distance, GeoLocation } from '@_types/Geo' import { double, float, long } from '@_types/Numeric' import { Script } from '@_types/Scripting' import { DateMath, Time } from '@_types/Time' import { QueryBase, QueryContainer } from './abstractions' -import { GeoLocation } from './geo' export class BoolQuery extends QueryBase { filter?: QueryContainer | QueryContainer[] @@ -59,23 +58,16 @@ export class FunctionScoreQuery extends QueryBase { score_mode?: FunctionScoreMode } -export class ScoreFunctionBase { - filter?: QueryContainer - weight?: double -} - -export class WeightScoreFunction extends ScoreFunctionBase {} - -export class ScriptScoreFunction extends ScoreFunctionBase { +export class ScriptScoreFunction { script: Script } -export class RandomScoreFunction extends ScoreFunctionBase { +export class RandomScoreFunction { field?: Field seed?: long | string } -export class FieldValueFactorScoreFunction extends ScoreFunctionBase { +export class FieldValueFactorScoreFunction { field: Field factor?: double missing?: double @@ -89,7 +81,7 @@ export class DecayPlacement { origin?: TOrigin } -export class DecayFunctionBase extends ScoreFunctionBase { +export class DecayFunctionBase { multi_value_mode?: MultiValueMode } @@ -105,16 +97,21 @@ export class GeoDecayFunction extends DecayFunctionBase implements AdditionalProperty> {} +/** @codegen_names date, numeric, geo */ +// Note: deserialization depends on value types export type DecayFunction = | DateDecayFunction | NumericDecayFunction | GeoDecayFunction -/** @variants container */ -// This container is valid without a variant. Also, despite being documented as a function, 'weight' is actually a -// container property that can be combined with a function. From SearchModule#registerScoreFunctions in ES: -// Weight doesn't have its own parser, so every function supports it out of the box. Can be a single function too when -// not associated to any other function, which is why it needs to be registered manually here. +/** + * @variants container + * @es_quirk this container is valid without a variant. Despite being documented as a function, 'weight' + * is actually a container property that can be combined with a function. Comment in the ES code + * (SearchModule#registerScoreFunctions) says: Weight doesn't have its own parser, so every function + * supports it out of the box. Can be a single function too when not associated to any other function, + * which is why it needs to be registered manually here. + */ export class FunctionScoreContainer { exp?: DecayFunction gauss?: DecayFunction diff --git a/specification/_types/query_dsl/fulltext.ts b/specification/_types/query_dsl/fulltext.ts index e578889ad1..3cd87126d7 100644 --- a/specification/_types/query_dsl/fulltext.ts +++ b/specification/_types/query_dsl/fulltext.ts @@ -61,6 +61,7 @@ export class IntervalsAnyOf { } /** @variants container */ +// Note: similar to IntervalsQuery - see comment there export class IntervalsContainer { all_of?: IntervalsAllOf any_of?: IntervalsAnyOf @@ -134,7 +135,7 @@ export class MatchQuery extends QueryBase { analyzer?: string /** @server_default true */ auto_generate_synonyms_phrase_query?: boolean - /** @obsolete 7.3.0 */ + /** @deprecated 7.3.0 */ cutoff_frequency?: double fuzziness?: Fuzziness fuzzy_rewrite?: MultiTermQueryRewrite @@ -191,7 +192,7 @@ export class MultiMatchQuery extends QueryBase { analyzer?: string /** @server_default true */ auto_generate_synonyms_phrase_query?: boolean - /** @obsolete 7.3.0 */ + /** @deprecated 7.3.0 */ cutoff_frequency?: double fields?: Fields fuzziness?: Fuzziness @@ -267,7 +268,14 @@ export class QueryStringQuery extends QueryBase { type?: TextQueryType } -export enum SimpleQueryStringFlags { +/** + * Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/7.15/query-dsl-simple-query-string-query.html#supported-flags + * @codegen_names single, multiple + */ +export type SimpleQueryStringFlags = SimpleQueryStringFlag | string + +export enum SimpleQueryStringFlag { NONE = 1, AND = 2, OR = 4, @@ -292,7 +300,7 @@ export class SimpleQueryStringQuery extends QueryBase { /** @server_default 'or' */ default_operator?: Operator fields?: Field[] - flags?: SimpleQueryStringFlags | string + flags?: SimpleQueryStringFlags fuzzy_max_expansions?: integer fuzzy_prefix_length?: integer fuzzy_transpositions?: boolean diff --git a/specification/_types/query_dsl/geo.ts b/specification/_types/query_dsl/geo.ts index c84dd0bbd5..ff34f815e8 100644 --- a/specification/_types/query_dsl/geo.ts +++ b/specification/_types/query_dsl/geo.ts @@ -17,44 +17,27 @@ * under the License. */ -import { AdditionalProperties, AdditionalProperty } from '@spec_utils/behaviors' +import { AdditionalProperty } from '@spec_utils/behaviors' import { Distance, + GeoBounds, GeoDistanceType, + GeoLocation, GeoShape, - GeoShapeRelation, - LatLon + GeoShapeRelation } from '@_types/Geo' -import { double } from '@_types/Numeric' import { FieldLookup, QueryBase } from './abstractions' import { Field } from '@_types/common' -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' - -/** - * A geo bounding box. The various coordinates can be mixed. When set, `wkt` takes precedence over all other fields. - */ -export class BoundingBox { - bottom_right?: GeoLocation - top_left?: GeoLocation - - top_right?: GeoLocation - bottom_left?: GeoLocation - - top?: double - left?: double - right?: double - bottom?: double - - wkt?: string -} export class GeoBoundingBoxQuery extends QueryBase - implements AdditionalProperty { - /** @obsolete 7.14.0 */ + implements AdditionalProperty +{ + /** @deprecated 7.14.0 */ type?: GeoExecution /** @server_default 'strict' */ validation_method?: GeoValidationMethod + ignore_unmapped?: boolean } export enum GeoExecution { @@ -64,24 +47,33 @@ export enum GeoExecution { export class GeoDistanceQuery extends QueryBase - implements AdditionalProperty { + implements AdditionalProperty +{ distance?: Distance /** @server_default 'arc' */ distance_type?: GeoDistanceType /** @server_default 'strict' */ validation_method?: GeoValidationMethod + /** + * Set to `true` to ignore an unmapped field and not match any documents for this query. + * Set to `false` to throw an exception if the field is not mapped. + * @server_default false + */ + ignore_unmapped?: boolean } export class GeoPolygonPoints { points: GeoLocation[] } -/** @obsolete 7.12.0 Use geo-shape instead. */ +/** @deprecated 7.12.0 Use geo-shape instead. */ export class GeoPolygonQuery extends QueryBase - implements AdditionalProperty { + implements AdditionalProperty +{ /** @server_default 'strict' */ validation_method?: GeoValidationMethod + ignore_unmapped?: boolean } export enum GeoFormat { @@ -99,7 +91,8 @@ export class GeoShapeFieldQuery { // holding also the query base fields (boost and _name) export class GeoShapeQuery extends QueryBase - implements AdditionalProperty { + implements AdditionalProperty +{ ignore_unmapped?: boolean } @@ -117,28 +110,6 @@ export enum TokenType { Comma = 4 } -// TODO -- is duplicate with LatLon -export class TwoDimensionalPoint { - lat: double - lon: double -} - -export class ThreeDimensionalPoint { - lat: double - lon: double - z?: double -} - -/** - * Represents a Latitude/Longitude as a 2 dimensional point - */ -export type GeoLocation = string | double[] | TwoDimensionalPoint - -/** - * Represents a Latitude/Longitude and optional Z value as a 2 or 3 dimensional point - */ -export type GeoCoordinate = string | double[] | ThreeDimensionalPoint - export enum GeoValidationMethod { coerce = 0, ignore_malformed = 1, diff --git a/specification/_types/query_dsl/joining.ts b/specification/_types/query_dsl/joining.ts index fe60976d66..ca5ced6b99 100644 --- a/specification/_types/query_dsl/joining.ts +++ b/specification/_types/query_dsl/joining.ts @@ -22,11 +22,19 @@ import { Field, Id, RelationName } from '@_types/common' import { integer } from '@_types/Numeric' import { QueryBase, QueryContainer } from './abstractions' +/** + * How to aggregate multiple child hit scores into a single parent score. + */ export enum ChildScoreMode { + /* Do no scoring. */ none = 0, + /* Parent hit's score is the average of all child scores. */ avg = 1, + /* Parent hit's score is the max of all child scores. */ sum = 2, + /* Parent hit's score is the sum of all child scores. */ max = 3, + /* Parent hit's score is the min of all child scores. */ min = 4 } @@ -59,15 +67,7 @@ export class NestedQuery extends QueryBase { path: Field query: QueryContainer /** @server_default 'avg' */ - score_mode?: NestedScoreMode -} - -export enum NestedScoreMode { - avg = 0, - sum = 1, - min = 2, - max = 3, - none = 4 + score_mode?: ChildScoreMode } export class ParentIdQuery extends QueryBase { diff --git a/specification/_types/query_dsl/span.ts b/specification/_types/query_dsl/span.ts index 3e317d696b..9bf3b1c435 100644 --- a/specification/_types/query_dsl/span.ts +++ b/specification/_types/query_dsl/span.ts @@ -37,10 +37,9 @@ export class SpanFirstQuery extends QueryBase { match: SpanQuery } -export class SpanGapQuery extends QueryBase { - field: Field - width?: integer -} +/** Can only be used as a clause in a span_near query. */ +// The integer value is the span width +export type SpanGapQuery = SingleKeyDictionary export class SpanMultiTermQuery extends QueryBase { /** Should be a multi term query (one of wildcard, fuzzy, prefix, range or regexp query) */ @@ -82,8 +81,7 @@ export class SpanQuery { span_containing?: SpanContainingQuery field_masking_span?: SpanFieldMaskingQuery span_first?: SpanFirstQuery - /** Can only be used as a clause in a span_near query */ - span_gap?: SingleKeyDictionary + span_gap?: SpanGapQuery span_multi?: SpanMultiTermQuery span_near?: SpanNearQuery span_not?: SpanNotQuery diff --git a/specification/_types/query_dsl/specialized.ts b/specification/_types/query_dsl/specialized.ts index fc8776b224..839801b0c7 100644 --- a/specification/_types/query_dsl/specialized.ts +++ b/specification/_types/query_dsl/specialized.ts @@ -27,17 +27,15 @@ import { IndexName, MinimumShouldMatch, Routing, - ShapeRelation, Type, VersionNumber, VersionType } from '@_types/common' -import { Distance, GeoShape } from '@_types/Geo' +import { Distance, GeoLocation, GeoShape, GeoShapeRelation } from '@_types/Geo' import { double, float, integer, long } from '@_types/Numeric' import { Script } from '@_types/Scripting' import { DateMath, Time } from '@_types/Time' import { FieldLookup, QueryBase, QueryContainer } from './abstractions' -import { GeoCoordinate } from './geo' import { AdditionalProperty } from '@spec_utils/behaviors' export class DistanceFeatureQueryBase extends QueryBase { @@ -47,7 +45,7 @@ export class DistanceFeatureQueryBase extends QueryBase { } export class GeoDistanceFeatureQuery extends DistanceFeatureQueryBase< - GeoCoordinate, + GeoLocation, Distance > {} @@ -56,6 +54,8 @@ export class DateDistanceFeatureQuery extends DistanceFeatureQueryBase< Time > {} +/** @codegen_names geo, date */ +// Note: deserialization depends on value types export type DistanceFeatureQuery = | GeoDistanceFeatureQuery | DateDistanceFeatureQuery @@ -105,7 +105,7 @@ export class LikeDocument { /** * Text that we want similar documents for or a lookup to a document's field for the text. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters - * + * @codegen_names text, document */ export type Like = string | LikeDocument @@ -121,9 +121,19 @@ export class PercolateQuery extends QueryBase { version?: VersionNumber } +/** + * @variants container + */ export class PinnedQuery extends QueryBase { - ids: Id[] + /** @variant container_property */ organic: QueryContainer + ids?: Id[] + docs?: PinnedDoc[] +} + +export class PinnedDoc { + _id: Id + _index: IndexName } export class RankFeatureFunction {} @@ -167,11 +177,13 @@ export class ScriptScoreQuery extends QueryBase { // holding also the query base fields (boost and _name) export class ShapeQuery extends QueryBase - implements AdditionalProperty {} + implements AdditionalProperty +{ + ignore_unmapped?: boolean +} export class ShapeFieldQuery { - ignore_unmapped?: boolean indexed_shape?: FieldLookup - relation?: ShapeRelation + relation?: GeoShapeRelation shape?: GeoShape } diff --git a/specification/_types/query_dsl/term.ts b/specification/_types/query_dsl/term.ts index 210ff64e5e..461e6f77c2 100644 --- a/specification/_types/query_dsl/term.ts +++ b/specification/_types/query_dsl/term.ts @@ -17,7 +17,6 @@ * under the License. */ -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Fuzziness, @@ -25,7 +24,8 @@ import { Ids, IndexName, MultiTermQueryRewrite, - Routing + Routing, + FieldValue } from '@_types/common' import { double, float, integer, long } from '@_types/Numeric' import { Script } from '@_types/Scripting' @@ -47,7 +47,7 @@ export class FuzzyQuery extends QueryBase { // ES is lenient and accepts any primitive type, but ultimately converts it to a string. // Changing this field definition from UserDefinedValue to string breaks a recording produced from Nest tests, // but Nest is probably also overly flexible here and exposes an option that should not exist. - value: string + value: string | double | boolean } export class IdsQuery extends QueryBase { @@ -69,25 +69,28 @@ export class RangeQueryBase extends QueryBase { relation?: RangeRelation } -/** @variant name=date */ export class DateRangeQuery extends RangeQueryBase { gt?: DateMath gte?: DateMath lt?: DateMath lte?: DateMath - + from?: DateMath | null + to?: DateMath | null format?: DateFormat time_zone?: TimeZone } -/** @variant name=number */ export class NumberRangeQuery extends RangeQueryBase { gt?: double gte?: double lt?: double lte?: double + from?: double | null + to?: double | null } +/** @codegen_names date, number */ +// Note: deserialization depends on value types export type RangeQuery = DateRangeQuery | NumberRangeQuery export enum RangeRelation { @@ -112,14 +115,19 @@ export class RegexpQuery extends QueryBase { /** @shortcut_property value */ export class TermQuery extends QueryBase { - value: string | float | boolean + value: FieldValue /** @since 7.10.0 */ case_insensitive?: boolean } export class TermsQuery extends QueryBase - implements AdditionalProperty {} + implements AdditionalProperty {} + +/** + * @codegen_names value, lookup + */ +export type TermsQueryField = FieldValue[] | TermsLookup export class TermsLookup { index: IndexName @@ -128,11 +136,7 @@ export class TermsLookup { routing?: Routing } -export class TermsSetQuery - extends QueryBase - implements AdditionalProperty {} - -export class TermsSetFieldQuery { +export class TermsSetQuery extends QueryBase { minimum_should_match_field?: Field minimum_should_match_script?: Script terms: string[] @@ -144,8 +148,15 @@ export class TypeQuery extends QueryBase { /** @shortcut_property value */ export class WildcardQuery extends QueryBase { - /** @since 7.10.0 */ + /** + * Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + * @since 7.10.0 + */ case_insensitive?: boolean + /** Method used to rewrite the query */ rewrite?: MultiTermQueryRewrite - value: string + /** Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. */ + value?: string + /** Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. */ + wildcard?: string } diff --git a/specification/_global/search/_types/sort.ts b/specification/_types/sort.ts similarity index 62% rename from specification/_global/search/_types/sort.ts rename to specification/_types/sort.ts index 572205c7f8..1000f9ada2 100644 --- a/specification/_global/search/_types/sort.ts +++ b/specification/_types/sort.ts @@ -17,48 +17,50 @@ * under the License. */ -import { AdditionalProperties } from '@spec_utils/behaviors' +import { AdditionalProperty } from '@spec_utils/behaviors' +import { Dictionary } from '@spec_utils/Dictionary' import { Missing } from '@_types/aggregations/AggregationContainer' -import { Field } from '@_types/common' -import { DistanceUnit, GeoDistanceType } from '@_types/Geo' +import { Field, FieldValue } from '@_types/common' +import { DistanceUnit, GeoDistanceType, GeoLocation } from '@_types/Geo' import { FieldType } from '@_types/mapping/Property' import { double, integer, long } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' -import { GeoLocation } from '@_types/query_dsl/geo' import { Script } from '@_types/Scripting' export class NestedSortValue { filter?: QueryContainer max_children?: integer + nested?: NestedSortValue path: Field - // nested: NestedSortValue } -// export type NestedSort = Dictionary - -export enum NumericType { +export enum FieldSortNumericType { long = 0, double = 1, date = 2, date_nanos = 3 } +/** @shortcut_property order */ export class FieldSort { missing?: Missing mode?: SortMode nested?: NestedSortValue order?: SortOrder unmapped_type?: FieldType + numeric_type?: FieldSortNumericType + format?: string } export class ScoreSort { - mode?: SortMode order?: SortOrder } export class GeoDistanceSort - implements AdditionalProperties { + implements AdditionalProperty +{ mode?: SortMode distance_type?: GeoDistanceType + ignore_unmapped?: boolean order?: SortOrder unit?: DistanceUnit } @@ -66,32 +68,41 @@ export class GeoDistanceSort export class ScriptSort { order?: SortOrder script: Script - type?: string + type?: ScriptSortType + mode?: SortMode + nested?: NestedSortValue +} + +export enum ScriptSortType { + string, + number, + version } -export class SortContainer - implements AdditionalProperties { +/** + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html + * @variants container + */ +export class SortOptions implements AdditionalProperty { _score?: ScoreSort _doc?: ScoreSort _geo_distance?: GeoDistanceSort _script?: ScriptSort } -export type SortCombinations = Field | SortContainer | SortOrder +/** + * @codegen_names field, options + */ +// Field is a shortcut for {"":{}}. Default order is asc except for "_score" where it's desc +export type SortCombinations = Field | SortOptions export type Sort = SortCombinations | SortCombinations[] -export type SortResults = Array - -/* -sort?: -| string -| Dictionary -| Array< - SingleKeyDictionary> - > -*/ +export type SortResults = FieldValue[] +/** + * Defines what values to pick in the case a document contains multiple values for a particular field. + */ export enum SortMode { min = 0, max = 1, @@ -102,12 +113,5 @@ export enum SortMode { export enum SortOrder { asc = 0, - desc = 1, - /** @identifier Document */ - _doc = 2 -} - -export enum SortSpecialField { - _score = 0, - _doc = 1 + desc = 1 } diff --git a/specification/async_search/_types/AsyncSearch.ts b/specification/async_search/_types/AsyncSearch.ts index 8b6ac1453c..f07084aa57 100644 --- a/specification/async_search/_types/AsyncSearch.ts +++ b/specification/async_search/_types/AsyncSearch.ts @@ -23,12 +23,12 @@ import { Suggest } from '@global/search/_types/suggester' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Aggregate } from '@_types/aggregations/Aggregate' -import { Id, SuggestionName } from '@_types/common' +import { AggregateName, Id, SuggestionName } from '@_types/common' import { double, long } from '@_types/Numeric' import { ClusterStatistics, ShardStatistics } from '@_types/Stats' export class AsyncSearch { - aggregations?: Dictionary + aggregations?: Dictionary _clusters?: ClusterStatistics fields?: Dictionary hits: HitsMetadata diff --git a/specification/async_search/delete/AsyncSearchDeleteRequest.ts b/specification/async_search/delete/AsyncSearchDeleteRequest.ts index 67302823b8..9c6d9f7c17 100644 --- a/specification/async_search/delete/AsyncSearchDeleteRequest.ts +++ b/specification/async_search/delete/AsyncSearchDeleteRequest.ts @@ -23,7 +23,7 @@ import { Id } from '@_types/common' /** * @rest_spec_name async_search.delete * @since 7.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index e85510d5a1..2cff715c4d 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -24,16 +24,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name async_search.get * @since 7.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } - query_parameters?: { + query_parameters: { keep_alive?: Time typed_keys?: boolean wait_for_completion_timeout?: Time } - body?: {} } diff --git a/specification/async_search/status/AsyncSearchStatusRequest.ts b/specification/async_search/status/AsyncSearchStatusRequest.ts index 2ba788c887..091f2cfae1 100644 --- a/specification/async_search/status/AsyncSearchStatusRequest.ts +++ b/specification/async_search/status/AsyncSearchStatusRequest.ts @@ -23,11 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name async_search.status * @since 7.11.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } - query_parameters?: {} } diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index 0a33394a36..00dff80436 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -17,19 +17,10 @@ * under the License. */ -import { FieldCollapse } from '@global/search/_types/FieldCollapse' -import { Highlight } from '@global/search/_types/highlighting' -import { PointInTimeReference } from '@global/search/_types/PointInTimeReference' -import { Rescore } from '@global/search/_types/rescoring' -import { Sort } from '@global/search/_types/sort' -import { SourceFilter } from '@global/search/_types/SourceFilter' -import { SuggestContainer } from '@global/search/_types/suggester' import { Dictionary } from '@spec_utils/Dictionary' -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { AggregationContainer } from '@_types/aggregations/AggregationContainer' import { RequestBase } from '@_types/Base' import { - DefaultOperator, ExpandWildcards, Field, Fields, @@ -37,81 +28,220 @@ import { Indices, Routing, SearchType, - SuggestMode + SuggestMode, + VersionString } from '@_types/common' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { double, integer, long } from '@_types/Numeric' -import { QueryContainer } from '@_types/query_dsl/abstractions' +import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' import { ScriptField } from '@_types/Scripting' -import { DateField, Time } from '@_types/Time' - +import { SlicedScroll } from '@_types/SlicedScroll' +import { Time } from '@_types/Time' +import { FieldCollapse } from '@global/search/_types/FieldCollapse' +import { Highlight } from '@global/search/_types/highlighting' +import { PointInTimeReference } from '@global/search/_types/PointInTimeReference' +import { Rescore } from '@global/search/_types/rescoring' +import { Sort, SortResults } from '@_types/sort' +import { + SourceConfigParam, + SourceConfig +} from '@global/search/_types/SourceFilter' +import { Suggester } from '@global/search/_types/suggester' +import { TrackHits } from '@global/search/_types/hits' +import { Operator } from '@_types/query_dsl/Operator' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** * @rest_spec_name async_search.submit * @since 7.7.0 - * @stability TODO + * @stability stable */ +// NOTE: this is a SearchRequest with 3 added parameters: wait_for_completion_timeout, keep_on_completion and keep_alive export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { - batched_reduce_size?: long + query_parameters: { + /** @server_default 1s */ wait_for_completion_timeout?: Time + /** @server_default false */ keep_on_completion?: boolean - typed_keys?: boolean - } - body?: { - aggs?: Dictionary + /** @server_default 5d */ + keep_alive?: Time allow_no_indices?: boolean allow_partial_search_results?: boolean analyzer?: string analyze_wildcard?: boolean batched_reduce_size?: long - collapse?: FieldCollapse - default_operator?: DefaultOperator + ccs_minimize_roundtrips?: boolean + default_operator?: Operator df?: string docvalue_fields?: Fields expand_wildcards?: ExpandWildcards explain?: boolean - from?: integer - highlight?: Highlight ignore_throttled?: boolean ignore_unavailable?: boolean - indices_boost?: Dictionary[] - keep_alive?: Time - keep_on_completion?: boolean lenient?: boolean max_concurrent_shard_requests?: long - min_score?: double - post_filter?: QueryContainer + min_compatible_shard_node?: VersionString preference?: string - profile?: boolean - pit?: PointInTimeReference - query?: QueryContainer - query_on_query_string?: string + pre_filter_shard_size?: long request_cache?: boolean - rescore?: Rescore[] routing?: Routing - script_fields?: Dictionary - search_after?: UserDefinedValue[] + scroll?: Time search_type?: SearchType - sequence_number_primary_term?: boolean - size?: integer - sort?: Sort - _source?: boolean | SourceFilter stats?: string[] stored_fields?: Fields - suggest?: Dictionary + /** + * Specifies which field to use for suggestions. + */ suggest_field?: Field suggest_mode?: SuggestMode suggest_size?: long + /** + * The source text for which the suggestions should be returned. + */ suggest_text?: string terminate_after?: long - timeout?: string + timeout?: Time + track_total_hits?: TrackHits track_scores?: boolean - track_total_hits?: boolean typed_keys?: boolean + rest_total_hits_as_int?: boolean version?: boolean - wait_for_completion_timeout?: Time - fields?: Array + _source?: SourceConfigParam + _source_excludes?: Fields + _source_includes?: Fields + seq_no_primary_term?: boolean + q?: string + size?: integer + from?: integer + sort?: string | string[] + } + body: { + /** @aliases aggs */ + aggregations?: Dictionary + collapse?: FieldCollapse + /** + * If true, returns detailed information about score computation as part of a hit. + * @server_default false + */ + explain?: boolean + /** + * Configuration of search extensions defined by Elasticsearch plugins. + */ + ext?: Dictionary + /** + * Starting document offset. By default, you cannot page through more than 10,000 + * hits using the from and size parameters. To page through more hits, use the + * search_after parameter. + * @server_default 0 + */ + from?: integer + highlight?: Highlight + /** + * Number of hits matching the query to count accurately. If true, the exact + * number of hits is returned at the cost of some performance. If false, the + * response does not include the total number of hits matching the query. + * Defaults to 10,000 hits. + */ + track_total_hits?: TrackHits + /** + * Boosts the _score of documents from specified indices. + */ + indices_boost?: Array> + /** + * Array of wildcard (*) patterns. The request returns doc values for field + * names matching these patterns in the hits.fields property of the response. + */ + docvalue_fields?: FieldAndFormat[] + /** + * Minimum _score for matching documents. Documents with a lower _score are + * not included in the search results. + */ + min_score?: double + post_filter?: QueryContainer + profile?: boolean + /** + * Defines the search definition using the Query DSL. + */ + query?: QueryContainer + rescore?: Rescore | Rescore[] + /** + * Retrieve a script evaluation (based on different fields) for each hit. + */ + script_fields?: Dictionary + search_after?: SortResults + /** + * The number of hits to return. By default, you cannot page through more + * than 10,000 hits using the from and size parameters. To page through more + * hits, use the search_after parameter. + * @server_default 10 + */ + size?: integer + slice?: SlicedScroll + /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html */ + sort?: Sort + /** + * Indicates which source fields are returned for matching documents. These + * fields are returned in the hits._source property of the search response. + */ + _source?: SourceConfig + /** + * Array of wildcard (*) patterns. The request returns values for field names + * matching these patterns in the hits.fields property of the response. + */ + fields?: Array + suggest?: Suggester + /** + * Maximum number of documents to collect for each shard. If a query reaches this + * limit, Elasticsearch terminates the query early. Elasticsearch collects documents + * before sorting. Defaults to 0, which does not terminate query execution early. + * @server_default 0 + */ + terminate_after?: long + /** + * Specifies the period of time to wait for a response from each shard. If no response + * is received before the timeout expires, the request fails and returns an error. + * Defaults to no timeout. + */ + timeout?: string + /** + * If true, calculate and return document scores, even if the scores are not used for sorting. + * @server_default false + */ + track_scores?: boolean + /** + * If true, returns document version as part of a hit. + * @server_default false + */ + version?: boolean + /** + * If true, returns sequence number and primary term of the last modification + * of each hit. See Optimistic concurrency control. + */ + seq_no_primary_term?: boolean + /** + * List of stored fields to return as part of a hit. If no fields are specified, + * no stored fields are included in the response. If this field is specified, the _source + * parameter defaults to false. You can pass _source: true to return both source fields + * and stored fields in the search response. + */ + stored_fields?: Fields + /** + * Limits the search to a point in time (PIT). If you provide a PIT, you + * cannot specify an in the request path. + */ + pit?: PointInTimeReference + /** + * Defines one or more runtime fields in the search request. These fields take + * precedence over mapped fields with the same name. + */ + runtime_mappings?: RuntimeFields + /** + * Stats groups to associate with the search. Each group maintains a statistics + * aggregation for its associated searches. You can retrieve these stats using + * the indices stats API. + */ + stats?: string[] } } diff --git a/specification/ml/post_data/types.ts b/specification/autoscaling/_types/AutoscalingPolicy.ts similarity index 82% rename from specification/ml/post_data/types.ts rename to specification/autoscaling/_types/AutoscalingPolicy.ts index fed631febb..00e34f87af 100644 --- a/specification/ml/post_data/types.ts +++ b/specification/autoscaling/_types/AutoscalingPolicy.ts @@ -17,10 +17,11 @@ * under the License. */ +import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -export class MultipleInputs { - data: UserDefinedValue[] +export class AutoscalingPolicy { + roles: string[] + /** Decider settings */ + deciders: Dictionary } - -export type Input = UserDefinedValue | MultipleInputs diff --git a/specification/autoscaling/policy_delete/DeleteAutoscalingPolicyRequest.ts b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts similarity index 87% rename from specification/autoscaling/policy_delete/DeleteAutoscalingPolicyRequest.ts rename to specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts index 411c682118..945abbf03c 100644 --- a/specification/autoscaling/policy_delete/DeleteAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts @@ -18,20 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { Name } from '@_types/common' /** * @rest_spec_name autoscaling.delete_autoscaling_policy * @since 7.11.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + path_parts: { + name: Name } } diff --git a/specification/ccr/pause_follow_index/PauseFollowIndexResponse.ts b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyResponse.ts similarity index 100% rename from specification/ccr/pause_follow_index/PauseFollowIndexResponse.ts rename to specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyResponse.ts diff --git a/specification/autoscaling/capacity_get/GetAutoscalingCapacityRequest.ts b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts similarity index 83% rename from specification/autoscaling/capacity_get/GetAutoscalingCapacityRequest.ts rename to specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts index 2cf0ea1951..263574e029 100644 --- a/specification/autoscaling/capacity_get/GetAutoscalingCapacityRequest.ts +++ b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts @@ -22,16 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name autoscaling.get_autoscaling_capacity * @since 7.11.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string - } -} +export interface Request extends RequestBase {} diff --git a/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts new file mode 100644 index 0000000000..e4a8b5034e --- /dev/null +++ b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts @@ -0,0 +1,56 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { integer } from '@_types/Numeric' +import { Dictionary } from '@spec_utils/Dictionary' +import { NodeName } from '@_types/common' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' + +export class Response { + body: { + policies: Dictionary + } +} + +export class AutoscalingDeciders { + required_capacity: AutoscalingCapacity + current_capacity: AutoscalingCapacity + current_nodes: AutoscalingNode[] + deciders: Dictionary +} + +export class AutoscalingCapacity { + node: AutoscalingResources + total: AutoscalingResources +} + +export class AutoscalingResources { + storage: integer + memory: integer +} + +export class AutoscalingNode { + name: NodeName +} + +export class AutoscalingDecider { + required_capacity: AutoscalingCapacity + reason_summary?: string + reason_details?: UserDefinedValue +} diff --git a/specification/autoscaling/policy_get/GetAutoscalingPolicyRequest.ts b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts similarity index 87% rename from specification/autoscaling/policy_get/GetAutoscalingPolicyRequest.ts rename to specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts index e6558a06e2..655f58ea5e 100644 --- a/specification/autoscaling/policy_get/GetAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts @@ -18,20 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { Name } from '@_types/common' /** * @rest_spec_name autoscaling.get_autoscaling_policy * @since 7.11.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + path_parts: { + name: Name } } diff --git a/specification/autoscaling/policy_get/GetAutoscalingPolicyResponse.ts b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts similarity index 89% rename from specification/autoscaling/policy_get/GetAutoscalingPolicyResponse.ts rename to specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts index 25b5bd6764..9f4b2373fa 100644 --- a/specification/autoscaling/policy_get/GetAutoscalingPolicyResponse.ts +++ b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { AutoscalingPolicy } from '@autoscaling/_types/AutoscalingPolicy' export class Response { - body: { stub: integer } + body: AutoscalingPolicy } diff --git a/specification/autoscaling/policy_put/PutAutoscalingPolicyRequest.ts b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts similarity index 81% rename from specification/autoscaling/policy_put/PutAutoscalingPolicyRequest.ts rename to specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts index 89fb2ee845..002e4eb688 100644 --- a/specification/autoscaling/policy_put/PutAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts @@ -18,20 +18,18 @@ */ import { RequestBase } from '@_types/Base' +import { AutoscalingPolicy } from '@autoscaling/_types/AutoscalingPolicy' +import { Name } from '@_types/common' /** * @rest_spec_name autoscaling.put_autoscaling_policy * @since 7.11.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + path_parts: { + name: Name } + /** @codegen_name policy */ + body: AutoscalingPolicy } diff --git a/specification/ccr/resume_follow_index/ResumeFollowIndexResponse.ts b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts similarity index 100% rename from specification/ccr/resume_follow_index/ResumeFollowIndexResponse.ts rename to specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts diff --git a/specification/cat/_types/CatBase.ts b/specification/cat/_types/CatBase.ts index a8ee0b16c9..0e4b671077 100644 --- a/specification/cat/_types/CatBase.ts +++ b/specification/cat/_types/CatBase.ts @@ -28,3 +28,818 @@ import { RequestBase } from '@_types/Base' export class CatRequestBase extends RequestBase implements CommonCatQueryParameters {} + +export enum CatAnomalyDetectorColumn { + /** + * For open anomaly detection jobs only, contains messages relating to the + * selection of a node to run the job. + * @aliases ae + */ + assignment_explanation, + /** + * The number of bucket results produced by the job. + * @aliases bc, bucketsCount + */ + 'buckets.count', + /** + * Exponential moving average of all bucket processing times, in milliseconds. + * @aliases btea, bucketsTimeExpAvg + */ + 'buckets.time.exp_avg', + /** + * Exponentially-weighted moving average of bucket processing times calculated + * in a 1 hour time window, in milliseconds. + * @aliases bteah, bucketsTimeExpAvgHour + */ + 'buckets.time.exp_avg_hour', + /** + * Maximum among all bucket processing times, in milliseconds. + * @aliases btmax, bucketsTimeMax + */ + 'buckets.time.max', + /** + * Minimum among all bucket processing times, in milliseconds. + * @aliases btmin, bucketsTimeMin + */ + 'buckets.time.min', + /** + * Sum of all bucket processing times, in milliseconds. + * @aliases btt, bucketsTimeTotal + */ + 'buckets.time.total', + /** + * The number of buckets processed. + * @aliases db, dataBuckets + */ + 'data.buckets', + /** + * The timestamp of the earliest chronologically input document. + * @aliases der, dataEarliestRecord + */ + 'data.earliest_record', + /** + * The number of buckets which did not contain any data. + * @aliases deb, dataEmptyBuckets */ + 'data.empty_buckets', + /** + * The number of bytes of input data posted to the anomaly detection job. + * @aliases dib, dataInputBytes + */ + 'data.input_bytes', + /** + * The total number of fields in input documents posted to the anomaly + * detection job. This count includes fields that are not used in the analysis. + * However, be aware that if you are using a datafeed, it extracts only the + * required fields from the documents it retrieves before posting them to the job. + * @aliases dif, dataInputFields + */ + 'data.input_fields', + /** + * The number of input documents posted to the anomaly detection job. + * @aliases dir, dataInputRecords + */ + 'data.input_records', + /** + * The number of input documents with either a missing date field or a date + * that could not be parsed. + * @aliases did, dataInvalidDates + */ + 'data.invalid_dates', + /** + * The timestamp at which data was last analyzed, according to server time. + * @aliases dl, dataLast + */ + 'data.last', + /** + * The timestamp of the last bucket that did not contain any data. + * @aliases dleb, dataLastEmptyBucket + */ + 'data.last_empty_bucket', + /** + * The timestamp of the last bucket that was considered sparse. + * @aliases dlsb, dataLastSparseBucket + */ + 'data.last_sparse_bucket', + /** + * The timestamp of the latest chronologically input document. + * @aliases dlr, dataLatestRecord + */ + 'data.latest_record', + /** + * The number of input documents that are missing a field that the anomaly + * detection job is configured to analyze. Input documents with missing fields + * are still processed because it is possible that not all fields are missing. + * @aliases dmf, dataMissingFields */ + 'data.missing_fields', + /** + * The number of input documents that have a timestamp chronologically + * preceding the start of the current anomaly detection bucket offset by the + * latency window. This information is applicable only when you provide data + * to the anomaly detection job by using the post data API. These out of order + * documents are discarded, since jobs require time series data to be in + * ascending chronological order. + * @aliases doot, dataOutOfOrderTimestamps + */ + 'data.out_of_order_timestamps', + /** + * The total number of fields in all the documents that have been processed by + * the anomaly detection job. Only fields that are specified in the detector + * configuration object contribute to this count. The timestamp is not + * included in this count. + * @aliases dpf, dataProcessedFields + */ + 'data.processed_fields', + /** + * The number of input documents that have been processed by the anomaly + * detection job. This value includes documents with missing fields, since + * they are nonetheless analyzed. If you use datafeeds and have aggregations + * in your search query, the processed record count is the number of + * aggregation results processed, not the number of Elasticsearch documents. + * @aliases dpr, dataProcessedRecords + */ + 'data.processed_records', + /** + * The number of buckets that contained few data points compared to the + * expected number of data points. + * @aliases dsb, dataSparseBuckets + */ + 'data.sparse_buckets', + /** + * The average memory usage in bytes for forecasts related to the anomaly + * detection job. + * @aliases fmavg, forecastsMemoryAvg + */ + 'forecasts.memory.avg', + /** + * The maximum memory usage in bytes for forecasts related to the anomaly + * detection job. + * @aliases fmmax, forecastsMemoryMax + */ + 'forecasts.memory.max', + /** + * The minimum memory usage in bytes for forecasts related to the anomaly + * detection job. + * @aliases fmmin, forecastsMemoryMin + */ + 'forecasts.memory.min', + /** + * The total memory usage in bytes for forecasts related to the anomaly + * detection job. + * @aliases fmt, forecastsMemoryTotal + */ + 'forecasts.memory.total', + /** + * The average number of `m`odel_forecast` documents written for forecasts + * related to the anomaly detection job. + * @aliases fravg, forecastsRecordsAvg + */ + 'forecasts.records.avg', + /** + * The maximum number of `model_forecast` documents written for forecasts + * related to the anomaly detection job. + * @aliases frmax, forecastsRecordsMax + */ + 'forecasts.records.max', + /** + * The minimum number of `model_forecast` documents written for forecasts + * related to the anomaly detection job. + * @aliases frmin, forecastsRecordsMin + */ + 'forecasts.records.min', + /** + * The total number of `model_forecast` documents written for forecasts + * related to the anomaly detection job. + * @aliases frt, forecastsRecordsTotal + */ + 'forecasts.records.total', + /** + * The average runtime in milliseconds for forecasts related to the anomaly + * detection job. + * @aliases ftavg, forecastsTimeAvg + */ + 'forecasts.time.avg', + /** + * The maximum runtime in milliseconds for forecasts related to the anomaly + * detection job. + * @aliases ftmax, forecastsTimeMax + */ + 'forecasts.time.max', + /** + * The minimum runtime in milliseconds for forecasts related to the anomaly + * detection job. + * @aliases ftmin, forecastsTimeMin + */ + 'forecasts.time.min', + /** + * The total runtime in milliseconds for forecasts related to the anomaly + * detection job. + * @aliases ftt, forecastsTimeTotal + */ + 'forecasts.time.total', + /** + * The number of individual forecasts currently available for the job. + * @aliases ft, forecastsTotal + */ + 'forecasts.total', + /** Identifier for the anomaly detection job. */ + id, + /** + * The number of buckets for which new entities in incoming data were not + * processed due to insufficient model memory. + * @aliases mbaf, modelBucketAllocationFailures + */ + 'model.bucket_allocation_failures', + /** + * The number of by field values that were analyzed by the models. This value + * is cumulative for all detectors in the job. + * @aliases mbf, modelByFields + */ + 'model.by_fields', + /** + * The number of bytes of memory used by the models. This is the maximum value + * since the last time the model was persisted. If the job is closed, this + * value indicates the latest size. + * @aliases mb, modelBytes + */ + 'model.bytes', + /** + * The number of bytes over the high limit for memory usage at the last + * allocation failure. + * @aliases mbe, modelBytesExceeded + */ + 'model.bytes_exceeded', + /** + * The status of categorization for the job: `ok` or `warn`. If `ok`, + * categorization is performing acceptably well (or not being used at all). If + * `warn`, categorization is detecting a distribution of categories that + * suggests the input data is inappropriate for categorization. Problems could + * be that there is only one category, more than 90% of categories are rare, + * the number of categories is greater than 50% of the number of categorized + * documents, there are no frequently matched categories, or more than 50% of + * categories are dead. + * @aliases mcs, modelCategorizationStatus + */ + 'model.categorization_status', + /** + * The number of documents that have had a field categorized. + * @aliases mcdc, modelCategorizedDocCount */ + 'model.categorized_doc_count', + /** + * The number of categories created by categorization that will never be + * assigned again because another category’s definition makes it a superset of + * the dead category. Dead categories are a side effect of the way + * categorization has no prior training. + * @aliases mdcc, modelDeadCategoryCount + */ + 'model.dead_category_count', + /** + * The number of times that categorization wanted to create a new category but + * couldn’t because the job had hit its model memory limit. This count does + * not track which specific categories failed to be created. Therefore, you + * cannot use this value to determine the number of unique categories that + * were missed. + * @aliases mdcc, modelFailedCategoryCount */ + 'model.failed_category_count', + /** + * The number of categories that match more than 1% of categorized documents. + * @aliases mfcc, modelFrequentCategoryCount + */ + 'model.frequent_category_count', + /** + * The timestamp when the model stats were gathered, according to server time. + * @aliases mlt, modelLogTime + */ + 'model.log_time', + /** + * The timestamp when the model stats were gathered, according to server time. + * @aliases mml, modelMemoryLimit + */ + 'model.memory_limit', + /** + * The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`. + * If `ok`, the models stayed below the configured value. If `soft_limit`, the + * models used more than 60% of the configured memory limit and older unused + * models will be pruned to free up space. Additionally, in categorization jobs + * no further category examples will be stored. If `hard_limit`, the models + * used more space than the configured memory limit. As a result, not all + * incoming data was processed. + * @aliases mms, modelMemoryStatus + */ + 'model.memory_status', + /** + * The number of over field values that were analyzed by the models. This + * value is cumulative for all detectors in the job. + * @aliases mof, modelOverFields + */ + 'model.over_fields', + /** + * The number of partition field values that were analyzed by the models. This + * value is cumulative for all detectors in the job. + * @aliases mpf, modelPartitionFields + */ + 'model.partition_fields', + /** + * The number of categories that match just one categorized document. + * @aliases mrcc, modelRareCategoryCount + */ + 'model.rare_category_count', + /** + * The timestamp of the last record when the model stats were gathered. + * @aliases mt, modelTimestamp + */ + 'model.timestamp', + /** + * The number of categories created by categorization. + * @aliases mtcc, modelTotalCategoryCount */ + 'model.total_category_count', + /** + * The network address of the node that runs the job. This information is + * available only for open jobs. + * @aliases na, nodeAddress + */ + 'node.address', + /** + * The ephemeral ID of the node that runs the job. This information is + * available only for open jobs. + * @aliases ne, nodeEphemeralId + */ + 'node.ephemeral_id', + /** + * The unique identifier of the node that runs the job. This information is + * available only for open jobs. + * @aliases ni, nodeId + */ + 'node.id', + /** + * The name of the node that runs the job. This information is available only + * for open jobs. + * @aliases nn, nodeName + */ + 'node.name', + /** + * For open jobs only, the elapsed time for which the job has been open. + * @aliases ot + */ + opened_time, + /** + * The status of the anomaly detection job: `closed`, `closing`, `failed`, + * `opened`, or `opening`. If `closed`, the job finished successfully with its + * model state persisted. The job must be opened before it can accept further + * data. If `closing`, the job close action is in progress and has not yet + * completed. A closing job cannot accept further data. If `failed`, the job + * did not finish successfully due to an error. This situation can occur due + * to invalid input data, a fatal error occurring during the analysis, or an + * external interaction such as the process being killed by the Linux out of + * memory (OOM) killer. If the job had irrevocably failed, it must be force + * closed and then deleted. If the datafeed can be corrected, the job can be + * closed and then re-opened. If `opened`, the job is available to receive and + * process data. If `opening`, the job open action is in progress and has not + * yet completed. + * @aliases s + */ + state +} +export type CatAnonalyDetectorColumns = + | CatAnomalyDetectorColumn + | CatAnomalyDetectorColumn[] +export enum CatDatafeedColumn { + /** + * For started datafeeds only, contains messages relating to the selection of + * a node. + * @aliases assignment_explanation + */ + ae, + /** + * The number of buckets processed. + * @aliases buckets.count, bucketsCount + */ + bc, + /** A numerical character string that uniquely identifies the datafeed. */ + id, + /** + * For started datafeeds only, the network address of the node where the + * datafeed is started. + * @aliases node.address, nodeAddress + */ + na, + /** + * For started datafeeds only, the ephemeral ID of the node where the + * datafeed is started. + * @aliases node.ephemeral_id, nodeEphemeralId + */ + ne, + /** + * For started datafeeds only, the unique identifier of the node where the + * datafeed is started. + * @aliases node.id, nodeId + */ + ni, + /** + * For started datafeeds only, the name of the node where the datafeed is + * started. + * @aliases node.name, nodeName + */ + nn, + /** + * The average search time per bucket, in milliseconds. + * @aliases search.bucket_avg, searchBucketAvg + */ + sba, + /** + * The number of searches run by the datafeed. + * @aliases search.count, searchCount */ + sc, + /** + * The exponential average search time per hour, in milliseconds. + * @aliases search.exp_avg_hour, searchExpAvgHour + */ + seah, + /** + * The total time the datafeed spent searching, in milliseconds. + * @aliases search.time, searchTime */ + st, + /** + * The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`. + * If `starting`, the datafeed has been requested to start but has not yet + * started. If `started`, the datafeed is actively receiving data. If + * `stopping`, the datafeed has been requested to stop gracefully and is + * completing its final action. If `stopped`, the datafeed is stopped and will + * not receive data until it is re-started. + * @aliases state + */ + s +} +export enum CatDfaColumn { + /** + * Contains messages relating to the selection of a node. + * @aliases ae + */ + assignment_explanation, + /** + * The time when the data frame analytics job was created. + * @aliases ct, createTime + */ + create_time, + /** + * A description of a job. + * @aliases d + */ + description, + /** + * Name of the destination index. + * @aliases di, destIndex + */ + dest_index, + /** + * Contains messages about the reason why a data frame analytics job failed. + * @aliases fr, failureReason + */ + failure_reason, + /** + * Identifier for the data frame analytics job. + */ + id, + /** + * The approximate maximum amount of memory resources that are permitted for + * the data frame analytics job. + * @aliases mml, modelMemoryLimit + */ + model_memory_limit, + /** + * The network address of the node that the data frame analytics job is + * assigned to. + * @aliases na, nodeAddress + */ + 'node.address', + /** + * The ephemeral ID of the node that the data frame analytics job is assigned + * to. + * @aliases ne, nodeEphemeralId + */ + 'node.ephemeral_id', + /** + * The unique identifier of the node that the data frame analytics job is + * assigned to. + * @aliases ni, nodeId + */ + 'node.id', + /** + * The name of the node that the data frame analytics job is assigned to. + * @aliases nn, nodeName + */ + 'node.name', + /** + * The progress report of the data frame analytics job by phase. + * @aliases p + */ + progress, + /** + * Name of the source index. + * @aliases si, sourceIndex + */ + source_index, + /** + * Current state of the data frame analytics job. + * @aliases s + */ + state, + /** + * The type of analysis that the data frame analytics job performs. + * @aliases t + */ + type, + /** + * The Elasticsearch version number in which the data frame analytics job was + * created. + * @aliases v + */ + version +} +export type CatDfaColumns = CatDfaColumn | CatDfaColumn[] +export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[] + +export enum CatTrainedModelsColumn { + /** + * The time when the trained model was created. + * @aliases ct + */ + create_time, + /** + * Information on the creator of the trained model. + * @aliases c, createdBy + */ + created_by, + /** + * Identifier for the data frame analytics job that created the model. Only + * displayed if it is still available. + * @aliases df, dataFrameAnalytics + */ + data_frame_analytics_id, + /** + * The description of the trained model. + * @aliases d + */ + description, + /** + * The estimated heap size to keep the trained model in memory. + * @aliases hs, modelHeapSize + */ + heap_size, + /** + * Idetifier for the trained model. + */ + id, + /** + * The total number of documents that are processed by the model. + * @aliases ic, ingestCount + */ + 'ingest.count', + /** + * The total number of document that are currently being handled by the + * trained model. + * @aliases icurr, ingestCurrent + */ + 'ingest.current', + /** + * The total number of failed ingest attempts with the trained model. + * @aliases if, ingestFailed + */ + 'ingest.failed', + /** + * The total number of ingest pipelines that are referencing the trained + * model. + * @aliases ip, ingestPipelines + */ + 'ingest.pipelines', + /** + * The total time that is spent processing documents with the trained model. + * @aliases it, ingestTime + */ + 'ingest.time', + /** + * The license level of the trained model. + * @aliases l + */ + license, + /** + * The estimated number of operations to use the trained model. This number + * helps measuring the computational complexity of the model. + * @aliases o, modelOperations + */ + operations, + /** + * The Elasticsearch version number in which the trained model was created. + * @aliases v + */ + version +} +export type CatTrainedModelsColumns = + | CatTrainedModelsColumn + | CatTrainedModelsColumn[] + +export enum CatTransformColumn { + /** + * The timestamp when changes were last detected in the source indices. + * @aliases cldt + */ + changes_last_detection_time, + /** + * The sequence number for the checkpoint. + * @aliases cp + */ + checkpoint, + /** + * Exponential moving average of the duration of the checkpoint, in + * milliseconds. + * @aliases cdtea, checkpointTimeExpAvg + */ + checkpoint_duration_time_exp_avg, + /** + * The progress of the next checkpoint that is currently in progress. + * @aliases c, checkpointProgress + */ + checkpoint_progress, + /** + * The time the transform was created. + * @aliases ct, createTime + */ + create_time, + /** + * The amount of time spent deleting, in milliseconds. + * @aliases dtime + */ + delete_time, + /** + * The description of the transform. + * @aliases d + */ + description, + /** + * The destination index for the transform. The mappings of the destination + * index are deduced based on the source fields when possible. If alternate + * mappings are required, use the Create index API prior to starting the + * transform. + * @aliases di, destIndex + */ + dest_index, + /** + * The number of documents that have been deleted from the destination index + * due to the retention policy for this transform. + * @aliases docd + */ + documents_deleted, + /** + * The number of documents that have been indexed into the destination index + * for the transform. + * @aliases doci + */ + documents_indexed, + /** + * Specifies a limit on the number of input documents per second. This setting + * throttles the transform by adding a wait time between search requests. The + * default value is `null`, which disables throttling. + * @aliases dps + */ + docs_per_second, + /** + * The number of documents that have been processed from the source index of + * the transform. + * @aliases docp + */ + documents_processed, + /** + * The interval between checks for changes in the source indices when the + * transform is running continuously. Also determines the retry interval in + * the event of transient failures while the transform is searching or + * indexing. The minimum value is `1s` and the maximum is `1h`. The default + * value is `1m`. + * @aliases f + */ + frequency, + /** + * Identifier for the transform. + */ + id, + /** + * The number of indexing failures. + * @aliases if + */ + index_failure, + /** + * The amount of time spent indexing, in milliseconds. + * @aliases itime + */ + index_time, + /** + * The number of index operations. + * @aliases it + */ + index_total, + /** + * Exponential moving average of the number of new documents that have been + * indexed. + * @aliases idea + */ + indexed_documents_exp_avg, + /** + * The timestamp of the last search in the source indices. This field is only + * shown if the transform is running. + * @aliases lst, lastSearchTime + */ + last_search_time, + /** + * Defines the initial page size to use for the composite aggregation for each + * checkpoint. If circuit breaker exceptions occur, the page size is + * dynamically adjusted to a lower value. The minimum value is `10` and the + * maximum is `65,536`. The default value is `500`. + * @aliases mpsz + */ + max_page_search_size, + /** + * The number of search or bulk index operations processed. Documents are + * processed in batches instead of individually. + * @aliases pp + */ + pages_processed, + /** + * The unique identifier for an ingest pipeline. + * @aliases p + */ + pipeline, + /** + * Exponential moving average of the number of documents that have been + * processed. + * @aliases pdea + */ + processed_documents_exp_avg, + /** + * The amount of time spent processing results, in milliseconds. + * @aliases pt + */ + processing_time, + /** + * If a transform has a `failed` state, this property provides details about + * the reason for the failure. + * @aliases r + */ + reason, + /** + * The number of search failures. + * @aliases sf + */ + search_failure, + /** + * The amount of time spent searching, in milliseconds. + * @aliases stime + */ + search_time, + /** + * The number of search operations on the source index for the transform. + * @aliases st + */ + search_total, + /** + * The source indices for the transform. It can be a single index, an index + * pattern (for example, `"my-index-*"`), an array of indices (for example, + * `["my-index-000001", "my-index-000002"]`), or an array of index patterns + * (for example, `["my-index-*", "my-other-index-*"]`. For remote indices use + * the syntax `"remote_name:index_name"`. If any indices are in remote + * clusters then the master node and at least one transform node must have the + * `remote_cluster_client` node role. + * @aliases si, sourceIndex + */ + source_index, + /** + * The status of the transform, which can be one of the following values: + * + * * `aborting`: The transform is aborting. + * * `failed`: The transform failed. For more information about the failure, + * check the reason field. + * * `indexing`: The transform is actively processing data and creating new + * documents. + * * `started`: The transform is running but not actively indexing data. + * * `stopped`: The transform is stopped. + * * `stopping`: The transform is stopping. + * @aliases s + */ + state, + /** + * Indicates the type of transform: `batch` or `continuous`. + * @aliases tt + */ + transform_type, + /** + * The number of times the transform has been triggered by the scheduler. For + * example, the scheduler triggers the transform indexer to check for updates + * or ingest new data at an interval specified in the `frequency` property. + * @aliases tc + */ + trigger_count, + /** + * The version of Elasticsearch that existed on the node when the transform + * was created. + * @aliases v + */ + version +} +export type CatTransformColumns = CatTransformColumn | CatTransformColumn[] diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts index 71c9c167f7..3d522b6d47 100644 --- a/specification/cat/aliases/CatAliasesRequest.ts +++ b/specification/cat/aliases/CatAliasesRequest.ts @@ -23,14 +23,13 @@ import { ExpandWildcards, Names } from '@_types/common' /** * @rest_spec_name cat.aliases * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { name?: Names } - query_parameters?: { + query_parameters: { expand_wildcards?: ExpandWildcards } - body?: {} } diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index a441bab90a..277d40a274 100644 --- a/specification/cat/allocation/CatAllocationRequest.ts +++ b/specification/cat/allocation/CatAllocationRequest.ts @@ -23,14 +23,13 @@ import { Bytes, NodeIds } from '@_types/common' /** * @rest_spec_name cat.allocation * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { node_id?: NodeIds } - query_parameters?: { + query_parameters: { bytes?: Bytes } - body?: {} } diff --git a/specification/cat/allocation/types.ts b/specification/cat/allocation/types.ts index cd25127fc9..09067d4583 100644 --- a/specification/cat/allocation/types.ts +++ b/specification/cat/allocation/types.ts @@ -31,36 +31,36 @@ export class AllocationRecord { * disk used by ES indices * @aliases di,diskIndices */ - 'disk.indices'?: ByteSize + 'disk.indices'?: ByteSize | null /** * disk used (total, not just ES) * @aliases du,diskUsed */ - 'disk.used'?: ByteSize + 'disk.used'?: ByteSize | null /** * disk available * @aliases da,diskAvail */ - 'disk.avail'?: ByteSize + 'disk.avail'?: ByteSize | null /** * total capacity of all volumes * @aliases dt,diskTotal */ - 'disk.total'?: ByteSize + 'disk.total'?: ByteSize | null /** * percent disk used * @aliases dp,diskPercent */ - 'disk.percent'?: Percentage + 'disk.percent'?: Percentage | null /** * host of node * @aliases h */ - host?: Host + host?: Host | null /** * ip of node */ - ip?: Ip + ip?: Ip | null /** * name of node * @aliases n diff --git a/specification/cat/count/CatCountRequest.ts b/specification/cat/count/CatCountRequest.ts index 390ff7f093..98cce45637 100644 --- a/specification/cat/count/CatCountRequest.ts +++ b/specification/cat/count/CatCountRequest.ts @@ -23,12 +23,10 @@ import { Indices } from '@_types/common' /** * @rest_spec_name cat.count * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: {} - body?: {} } diff --git a/specification/cat/fielddata/CatFielddataRequest.ts b/specification/cat/fielddata/CatFielddataRequest.ts index 645960533d..4cd28331e2 100644 --- a/specification/cat/fielddata/CatFielddataRequest.ts +++ b/specification/cat/fielddata/CatFielddataRequest.ts @@ -23,14 +23,13 @@ import { Bytes, Fields } from '@_types/common' /** * @rest_spec_name cat.fielddata * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { fields?: Fields } - query_parameters?: { + query_parameters: { bytes?: Bytes } - body?: {} } diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts index 62b00df751..cbb1e129a8 100644 --- a/specification/cat/health/CatHealthRequest.ts +++ b/specification/cat/health/CatHealthRequest.ts @@ -22,12 +22,10 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.health * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - query_parameters?: { - include_timestamp?: boolean + query_parameters: { ts?: boolean } - body?: {} } diff --git a/specification/cat/help/CatHelpRequest.ts b/specification/cat/help/CatHelpRequest.ts index 82ed181e4c..b51783f3f9 100644 --- a/specification/cat/help/CatHelpRequest.ts +++ b/specification/cat/help/CatHelpRequest.ts @@ -22,9 +22,6 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.help * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends CatRequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends CatRequestBase {} diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 8310a1eb08..6aa0531af1 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -18,23 +18,22 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, ExpandWildcards, Health, Indices } from '@_types/common' +import { Bytes, ExpandWildcards, HealthStatus, Indices } from '@_types/common' /** * @rest_spec_name cat.indices * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { bytes?: Bytes expand_wildcards?: ExpandWildcards - health?: Health + health?: HealthStatus include_unloaded_segments?: boolean pri?: boolean } - body?: {} } diff --git a/specification/cat/indices/types.ts b/specification/cat/indices/types.ts index 8021c3da14..afb6b6fcfc 100644 --- a/specification/cat/indices/types.ts +++ b/specification/cat/indices/types.ts @@ -58,13 +58,13 @@ export class IndicesRecord { * available docs * @aliases dc,docsCount */ - 'docs.count'?: string + 'docs.count'?: string | null /** * deleted docs * @aliases dd,docsDeleted */ - 'docs.deleted'?: string + 'docs.deleted'?: string | null /** * index creation date (millisecond value) @@ -82,12 +82,12 @@ export class IndicesRecord { * store size of primaries & replicas * @aliases ss,storeSize */ - 'store.size'?: string + 'store.size'?: string | null /** * store size of primaries */ - 'pri.store.size'?: string + 'pri.store.size'?: string | null /** * size of completion diff --git a/specification/cat/master/CatMasterRequest.ts b/specification/cat/master/CatMasterRequest.ts index c185969a0a..2a7f654b3c 100644 --- a/specification/cat/master/CatMasterRequest.ts +++ b/specification/cat/master/CatMasterRequest.ts @@ -22,9 +22,6 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.master * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends CatRequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends CatRequestBase {} diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts new file mode 100644 index 0000000000..9a8046ad5c --- /dev/null +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -0,0 +1,56 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { CatRequestBase, CatDfaColumns } from '@cat/_types/CatBase' +import { Bytes, Id } from '@_types/common' +import { Time } from '@_types/Time' + +/** + * Returns configuration and usage information about data frame analytics jobs. + * + * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * console or command line. They are not intended for use by applications. For + * application consumption, use the get data frame analytics jobs statistics API. + * + * @rest_spec_name cat.ml_data_frame_analytics + * @since 7.7.0 + * @stability stable + */ +export interface Request extends CatRequestBase { + path_parts: { + id?: Id + } + query_parameters: { + allow_no_match?: boolean + bytes?: Bytes + /** + * Comma-separated list of column names to display. + * @server_default create_time,id,state,type + */ + h?: CatDfaColumns + /** Comma-separated list of column names or column aliases used to sort the + * response. + */ + s?: CatDfaColumns + /** + * Unit used to display time values. + */ + time?: Time + } +} diff --git a/specification/cat/data_frame_analytics/CatDataFrameAnalyticsResponse.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponse.ts similarity index 100% rename from specification/cat/data_frame_analytics/CatDataFrameAnalyticsResponse.ts rename to specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponse.ts diff --git a/specification/cat/data_frame_analytics/types.ts b/specification/cat/ml_data_frame_analytics/types.ts similarity index 100% rename from specification/cat/data_frame_analytics/types.ts rename to specification/cat/ml_data_frame_analytics/types.ts diff --git a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts new file mode 100644 index 0000000000..0c0fde069a --- /dev/null +++ b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts @@ -0,0 +1,86 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { CatRequestBase, CatDatafeedColumns } from '@cat/_types/CatBase' +import { Id } from '@_types/common' +import { TimeUnit } from '@_types/Time' + +/** + * Returns configuration and usage information about datafeeds. + * This API returns a maximum of 10,000 datafeeds. + * If the Elasticsearch security features are enabled, you must have `monitor_ml`, + * `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. + * + * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * console or command line. They are not intended for use by applications. For + * application consumption, use the get datafeed statistics API. + * + * @rest_spec_name cat.ml_datafeeds + * @since 7.7.0 + * @stability stable + */ +export interface Request extends CatRequestBase { + path_parts: { + /** + * A numerical character string that uniquely identifies the datafeed. + */ + datafeed_id?: Id + } + query_parameters: { + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ + allow_no_datafeeds?: boolean + /** + * Specifies what to do when the request: + * + * * Contains wildcard expressions and there are no datafeeds that match. + * * Contains the `_all` string or no identifiers and there are no matches. + * * Contains wildcard expressions and there are only partial matches. + * + * If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when + * there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only + * partial matches. + * @server_default true + */ + allow_no_match?: boolean + /** Short version of the HTTP accept header. Valid values include JSON, YAML, for example. */ + format?: string + /** + * Comma-separated list of column names to display. + * @server_default bc,id,sc,s + */ + h?: CatDatafeedColumns + /** If `true`, the response includes help information. + * @server_default false + */ + help?: boolean + /** Comma-separated list of column names or column aliases used to sort the response. */ + s?: CatDatafeedColumns + /** + * The unit used to display time values. + */ + time?: TimeUnit + /** + * If `true`, the response includes column headings. + * @server_default false + */ + v?: boolean + } +} diff --git a/specification/cat/datafeeds/CatDatafeedsResponse.ts b/specification/cat/ml_datafeeds/CatDatafeedsResponse.ts similarity index 100% rename from specification/cat/datafeeds/CatDatafeedsResponse.ts rename to specification/cat/ml_datafeeds/CatDatafeedsResponse.ts diff --git a/specification/cat/datafeeds/types.ts b/specification/cat/ml_datafeeds/types.ts similarity index 100% rename from specification/cat/datafeeds/types.ts rename to specification/cat/ml_datafeeds/types.ts diff --git a/specification/cat/ml_jobs/CatJobsRequest.ts b/specification/cat/ml_jobs/CatJobsRequest.ts new file mode 100644 index 0000000000..8a18ba1061 --- /dev/null +++ b/specification/cat/ml_jobs/CatJobsRequest.ts @@ -0,0 +1,93 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { CatRequestBase, CatAnonalyDetectorColumns } from '@cat/_types/CatBase' +import { Bytes, Id } from '@_types/common' +import { TimeUnit } from '@_types/Time' + +/** + * Returns configuration and usage information for anomaly detection jobs. + * This API returns a maximum of 10,000 jobs. + * If the Elasticsearch security features are enabled, you must have `monitor_ml`, + * `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. + * + * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * console or command line. They are not intended for use by applications. For + * application consumption, use the get anomaly detection job statistics API. + * + * @rest_spec_name cat.ml_jobs + * @since 7.7.0 + * @stability stable + */ +export interface Request extends CatRequestBase { + path_parts: { + /** + * Identifier for the anomaly detection job. + */ + job_id?: Id + } + query_parameters: { + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ + allow_no_jobs?: boolean + /** + * Specifies what to do when the request: + * + * * Contains wildcard expressions and there are no jobs that match. + * * Contains the `_all` string or no identifiers and there are no matches. + * * Contains wildcard expressions and there are only partial matches. + * + * If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there + * are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial + * matches. + * @server_default true + */ + allow_no_match?: boolean + /** + * The unit used to display byte values. + */ + bytes?: Bytes + /** + * Short version of the HTTP accept header. Valid values include JSON, YAML, for example. + */ + format?: string + /** + * Comma-separated list of column names to display. + * @server_default buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state + */ + h?: CatAnonalyDetectorColumns + /** + * If true, the response includes help information. + * @server_default false + */ + help?: boolean + /** Comma-separated list of column names or column aliases used to sort the response. */ + s?: CatAnonalyDetectorColumns + /** + * The unit used to display time values. + */ + time?: TimeUnit + /** + * If `true`, the response includes column headings. + * @server_default false + */ + v?: boolean + } +} diff --git a/specification/cat/jobs/CatJobsResponse.ts b/specification/cat/ml_jobs/CatJobsResponse.ts similarity index 100% rename from specification/cat/jobs/CatJobsResponse.ts rename to specification/cat/ml_jobs/CatJobsResponse.ts diff --git a/specification/cat/jobs/types.ts b/specification/cat/ml_jobs/types.ts similarity index 100% rename from specification/cat/jobs/types.ts rename to specification/cat/ml_jobs/types.ts diff --git a/specification/cat/trained_models/CatTrainedModelsRequest.ts b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts similarity index 68% rename from specification/cat/trained_models/CatTrainedModelsRequest.ts rename to specification/cat/ml_trained_models/CatTrainedModelsRequest.ts index 3f06e8ddb8..aa678bc8e5 100644 --- a/specification/cat/trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -17,24 +17,31 @@ * under the License. */ -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatRequestBase, CatTrainedModelsColumns } from '@cat/_types/CatBase' import { Bytes, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Returns configuration and usage information about inference trained models. + * + * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * console or command line. They are not intended for use by applications. For + * application consumption, use the get trained models statistics API. + * * @rest_spec_name cat.ml_trained_models * @since 7.7.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { model_id?: Id } - query_parameters?: { + query_parameters: { allow_no_match?: boolean bytes?: Bytes + h?: CatTrainedModelsColumns + s?: CatTrainedModelsColumns from?: integer size?: integer } - body?: {} } diff --git a/specification/cat/trained_models/CatTrainedModelsResponse.ts b/specification/cat/ml_trained_models/CatTrainedModelsResponse.ts similarity index 100% rename from specification/cat/trained_models/CatTrainedModelsResponse.ts rename to specification/cat/ml_trained_models/CatTrainedModelsResponse.ts diff --git a/specification/cat/trained_models/types.ts b/specification/cat/ml_trained_models/types.ts similarity index 100% rename from specification/cat/trained_models/types.ts rename to specification/cat/ml_trained_models/types.ts diff --git a/specification/cat/node_attributes/CatNodeAttributesRequest.ts b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts similarity index 89% rename from specification/cat/node_attributes/CatNodeAttributesRequest.ts rename to specification/cat/nodeattrs/CatNodeAttributesRequest.ts index 90be510537..a4451eade3 100644 --- a/specification/cat/node_attributes/CatNodeAttributesRequest.ts +++ b/specification/cat/nodeattrs/CatNodeAttributesRequest.ts @@ -22,9 +22,6 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.nodeattrs * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends CatRequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends CatRequestBase {} diff --git a/specification/cat/node_attributes/CatNodeAttributesResponse.ts b/specification/cat/nodeattrs/CatNodeAttributesResponse.ts similarity index 100% rename from specification/cat/node_attributes/CatNodeAttributesResponse.ts rename to specification/cat/nodeattrs/CatNodeAttributesResponse.ts diff --git a/specification/cat/node_attributes/types.ts b/specification/cat/nodeattrs/types.ts similarity index 100% rename from specification/cat/node_attributes/types.ts rename to specification/cat/nodeattrs/types.ts diff --git a/specification/cat/nodes/CatNodesRequest.ts b/specification/cat/nodes/CatNodesRequest.ts index 423fac88c4..4caa9f6915 100644 --- a/specification/cat/nodes/CatNodesRequest.ts +++ b/specification/cat/nodes/CatNodesRequest.ts @@ -23,12 +23,11 @@ import { Bytes } from '@_types/common' /** * @rest_spec_name cat.nodes * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - query_parameters?: { + query_parameters: { bytes?: Bytes full_id?: boolean | string } - body?: {} } diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts index 8b19ad8cc2..57b81309a0 100644 --- a/specification/cat/pending_tasks/CatPendingTasksRequest.ts +++ b/specification/cat/pending_tasks/CatPendingTasksRequest.ts @@ -22,9 +22,6 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.pending_tasks * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends CatRequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends CatRequestBase {} diff --git a/specification/cat/plugins/CatPluginsRequest.ts b/specification/cat/plugins/CatPluginsRequest.ts index 4a6aacc5ac..c1f3bee2c0 100644 --- a/specification/cat/plugins/CatPluginsRequest.ts +++ b/specification/cat/plugins/CatPluginsRequest.ts @@ -22,9 +22,6 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.plugins * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends CatRequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends CatRequestBase {} diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts index 262a06cca7..e0e492b9b8 100644 --- a/specification/cat/recovery/CatRecoveryRequest.ts +++ b/specification/cat/recovery/CatRecoveryRequest.ts @@ -23,16 +23,15 @@ import { Bytes, Indices } from '@_types/common' /** * @rest_spec_name cat.recovery * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { active_only?: boolean bytes?: Bytes detailed?: boolean } - body?: {} } diff --git a/specification/cat/repositories/CatRepositoriesRequest.ts b/specification/cat/repositories/CatRepositoriesRequest.ts index f84f082d25..df5323b336 100644 --- a/specification/cat/repositories/CatRepositoriesRequest.ts +++ b/specification/cat/repositories/CatRepositoriesRequest.ts @@ -22,9 +22,6 @@ import { CatRequestBase } from '@cat/_types/CatBase' /** * @rest_spec_name cat.repositories * @since 2.1.0 - * @stability TODO + * @stability stable */ -export interface Request extends CatRequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends CatRequestBase {} diff --git a/specification/cat/segments/CatSegmentsRequest.ts b/specification/cat/segments/CatSegmentsRequest.ts index 9f6a743016..1bd17a21da 100644 --- a/specification/cat/segments/CatSegmentsRequest.ts +++ b/specification/cat/segments/CatSegmentsRequest.ts @@ -23,14 +23,13 @@ import { Bytes, Indices } from '@_types/common' /** * @rest_spec_name cat.segments * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { bytes?: Bytes } - body?: {} } diff --git a/specification/cat/shards/CatShardsRequest.ts b/specification/cat/shards/CatShardsRequest.ts index fe5c6829b5..3e5b109ba4 100644 --- a/specification/cat/shards/CatShardsRequest.ts +++ b/specification/cat/shards/CatShardsRequest.ts @@ -23,14 +23,13 @@ import { Bytes, Indices } from '@_types/common' /** * @rest_spec_name cat.shards * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { bytes?: Bytes } - body?: {} } diff --git a/specification/cat/shards/types.ts b/specification/cat/shards/types.ts index cd45212f0b..1c1e0a5968 100644 --- a/specification/cat/shards/types.ts +++ b/specification/cat/shards/types.ts @@ -42,16 +42,16 @@ export class ShardsRecord { * number of docs in shard * @aliases d,dc */ - 'docs'?: string + 'docs'?: string | null /** * store size of shard (how much disk it uses) * @aliases sto */ - 'store'?: string + 'store'?: string | null /** * ip of node where it lives */ - 'ip'?: string + 'ip'?: string | null /** * unique id of node where it lives */ @@ -60,7 +60,7 @@ export class ShardsRecord { * name of node where it lives * @aliases n */ - 'node'?: string + 'node'?: string | null /** * sync id */ diff --git a/specification/cat/snapshots/CatSnapshotsRequest.ts b/specification/cat/snapshots/CatSnapshotsRequest.ts index 66ff38d1fa..e6be9426ff 100644 --- a/specification/cat/snapshots/CatSnapshotsRequest.ts +++ b/specification/cat/snapshots/CatSnapshotsRequest.ts @@ -23,14 +23,13 @@ import { Names } from '@_types/common' /** * @rest_spec_name cat.snapshots * @since 2.1.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { repository?: Names } - query_parameters?: { + query_parameters: { ignore_unavailable?: boolean } - body?: {} } diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts index a61b1a16ca..22fb1f5a1a 100644 --- a/specification/cat/tasks/CatTasksRequest.ts +++ b/specification/cat/tasks/CatTasksRequest.ts @@ -23,14 +23,13 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name cat.tasks * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - query_parameters?: { + query_parameters: { actions?: string[] detailed?: boolean node_id?: string[] parent_task?: long } - body?: {} } diff --git a/specification/cat/templates/CatTemplatesRequest.ts b/specification/cat/templates/CatTemplatesRequest.ts index 353486a071..2c74d89072 100644 --- a/specification/cat/templates/CatTemplatesRequest.ts +++ b/specification/cat/templates/CatTemplatesRequest.ts @@ -23,12 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name cat.templates * @since 5.2.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { name?: Name } - query_parameters?: {} - body?: {} } diff --git a/specification/cat/templates/types.ts b/specification/cat/templates/types.ts index 436e8b5e27..42073ad2e3 100644 --- a/specification/cat/templates/types.ts +++ b/specification/cat/templates/types.ts @@ -39,7 +39,7 @@ export class TemplatesRecord { * version * @aliases v */ - 'version'?: VersionString + 'version'?: VersionString | null /** * component templates comprising index template * @aliases c diff --git a/specification/cat/thread_pool/CatThreadPoolRequest.ts b/specification/cat/thread_pool/CatThreadPoolRequest.ts index b149cb916a..99fa54b3fc 100644 --- a/specification/cat/thread_pool/CatThreadPoolRequest.ts +++ b/specification/cat/thread_pool/CatThreadPoolRequest.ts @@ -18,19 +18,19 @@ */ import { CatRequestBase } from '@cat/_types/CatBase' -import { Names, Size } from '@_types/common' +import { Names } from '@_types/common' +import { ThreadPoolSize } from '@cat/thread_pool/types' /** * @rest_spec_name cat.thread_pool * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { thread_pool_patterns?: Names } - query_parameters?: { - size?: Size | boolean + query_parameters: { + size?: ThreadPoolSize } - body?: {} } diff --git a/specification/cat/thread_pool/types.ts b/specification/cat/thread_pool/types.ts index b8968f3281..9c4e6dd339 100644 --- a/specification/cat/thread_pool/types.ts +++ b/specification/cat/thread_pool/types.ts @@ -104,20 +104,28 @@ export class ThreadPoolRecord { * core number of threads in a scaling thread pool * @aliases cr */ - 'core'?: string + 'core'?: string | null /** * maximum number of threads in a scaling thread pool * @aliases mx */ - 'max'?: string + 'max'?: string | null /** * number of threads in a fixed thread pool * @aliases sz */ - 'size'?: string + 'size'?: string | null /** * thread keep alive time * @aliases ka */ - 'keep_alive'?: string + 'keep_alive'?: string | null +} + +export enum ThreadPoolSize { + k = 1, + m = 2, + g = 3, + t = 4, + p = 5 } diff --git a/specification/cat/transforms/CatTransformsRequest.ts b/specification/cat/transforms/CatTransformsRequest.ts index 5d9dd304d0..f13c2c8497 100644 --- a/specification/cat/transforms/CatTransformsRequest.ts +++ b/specification/cat/transforms/CatTransformsRequest.ts @@ -17,23 +17,42 @@ * under the License. */ -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatRequestBase, CatTransformColumns } from '@cat/_types/CatBase' import { Id } from '@_types/common' import { integer } from '@_types/Numeric' +import { Time } from '@_types/Time' /** + * Returns configuration and usage information about transforms. + * + * IMPORTANT: cat APIs are only intended for human consumption using the Kibana + * console or command line. They are not intended for use by applications. For + * application consumption, use the get transform statistics API. + * * @rest_spec_name cat.transforms * @since 7.7.0 - * @stability TODO + * @stability stable */ export interface Request extends CatRequestBase { - path_parts?: { + path_parts: { transform_id?: Id } - query_parameters?: { + query_parameters: { allow_no_match?: boolean from?: integer + /** + * Comma-separated list of column names to display. + * @server_default create_time,id,state,type + */ + h?: CatTransformColumns + /** Comma-separated list of column names or column aliases used to sort the + * response. + */ + s?: CatTransformColumns + /** + * Unit used to display time values. + */ + time?: Time size?: integer } - body?: {} } diff --git a/specification/cat/transforms/types.ts b/specification/cat/transforms/types.ts index 58646993fe..83d50a717b 100644 --- a/specification/cat/transforms/types.ts +++ b/specification/cat/transforms/types.ts @@ -43,17 +43,17 @@ export class TransformsRecord { * progress of the checkpoint * @aliases cp, checkpointProgress */ - 'checkpoint_progress'?: string + 'checkpoint_progress'?: string | null /** * last time transform searched for updates * @aliases lst, lastSearchTime */ - 'last_search_time'?: string + 'last_search_time'?: string | null /** * changes last detected time * @aliases cldt */ - 'changes_last_detection_time'?: string + 'changes_last_detection_time'?: string | null /** * transform creation time * @aliases ct, createTime diff --git a/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts b/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts index 5838a610d6..f23ea48716 100644 --- a/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts +++ b/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name ccr.delete_auto_follow_pattern * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } } diff --git a/specification/ccr/create_follow_index/CreateFollowIndexRequest.ts b/specification/ccr/follow/CreateFollowIndexRequest.ts similarity index 95% rename from specification/ccr/create_follow_index/CreateFollowIndexRequest.ts rename to specification/ccr/follow/CreateFollowIndexRequest.ts index 2db916cfa0..e64e084812 100644 --- a/specification/ccr/create_follow_index/CreateFollowIndexRequest.ts +++ b/specification/ccr/follow/CreateFollowIndexRequest.ts @@ -25,16 +25,16 @@ import { Time } from '@_types/Time' /** * @rest_spec_name ccr.follow * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - query_parameters?: { + query_parameters: { wait_for_active_shards?: WaitForActiveShards } - body?: { + body: { leader_index?: IndexName max_outstanding_read_requests?: long max_outstanding_write_requests?: long diff --git a/specification/ccr/create_follow_index/CreateFollowIndexResponse.ts b/specification/ccr/follow/CreateFollowIndexResponse.ts similarity index 100% rename from specification/ccr/create_follow_index/CreateFollowIndexResponse.ts rename to specification/ccr/follow/CreateFollowIndexResponse.ts diff --git a/specification/ccr/follow_info/FollowInfoRequest.ts b/specification/ccr/follow_info/FollowInfoRequest.ts index 57bd30a35f..57462f9eca 100644 --- a/specification/ccr/follow_info/FollowInfoRequest.ts +++ b/specification/ccr/follow_info/FollowInfoRequest.ts @@ -23,10 +23,10 @@ import { Indices } from '@_types/common' /** * @rest_spec_name ccr.follow_info * @since 6.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } } diff --git a/specification/ccr/follow_index_stats/FollowIndexStatsRequest.ts b/specification/ccr/follow_stats/FollowIndexStatsRequest.ts similarity index 96% rename from specification/ccr/follow_index_stats/FollowIndexStatsRequest.ts rename to specification/ccr/follow_stats/FollowIndexStatsRequest.ts index 0c7bc10ca9..0a7cbd95c7 100644 --- a/specification/ccr/follow_index_stats/FollowIndexStatsRequest.ts +++ b/specification/ccr/follow_stats/FollowIndexStatsRequest.ts @@ -23,10 +23,10 @@ import { Indices } from '@_types/common' /** * @rest_spec_name ccr.follow_stats * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } } diff --git a/specification/ccr/follow_index_stats/FollowIndexStatsResponse.ts b/specification/ccr/follow_stats/FollowIndexStatsResponse.ts similarity index 100% rename from specification/ccr/follow_index_stats/FollowIndexStatsResponse.ts rename to specification/ccr/follow_stats/FollowIndexStatsResponse.ts diff --git a/specification/ccr/forget_follower_index/ForgetFollowerIndexRequest.ts b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts similarity index 96% rename from specification/ccr/forget_follower_index/ForgetFollowerIndexRequest.ts rename to specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts index adbe9efa4a..19b0779c87 100644 --- a/specification/ccr/forget_follower_index/ForgetFollowerIndexRequest.ts +++ b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts @@ -23,13 +23,13 @@ import { IndexName, Uuid } from '@_types/common' /** * @rest_spec_name ccr.forget_follower * @since 6.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - body?: { + body: { follower_cluster?: string follower_index?: IndexName follower_index_uuid?: Uuid diff --git a/specification/ccr/forget_follower_index/ForgetFollowerIndexResponse.ts b/specification/ccr/forget_follower/ForgetFollowerIndexResponse.ts similarity index 100% rename from specification/ccr/forget_follower_index/ForgetFollowerIndexResponse.ts rename to specification/ccr/forget_follower/ForgetFollowerIndexResponse.ts diff --git a/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts b/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts index 32a7604067..6f245c8ea8 100644 --- a/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts +++ b/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name ccr.get_auto_follow_pattern * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections. */ name?: Name } diff --git a/specification/ccr/get_auto_follow_pattern/types.ts b/specification/ccr/get_auto_follow_pattern/types.ts index d1733babf2..c4d9b381fa 100644 --- a/specification/ccr/get_auto_follow_pattern/types.ts +++ b/specification/ccr/get_auto_follow_pattern/types.ts @@ -27,8 +27,25 @@ export class AutoFollowPattern { export class AutoFollowPatternSummary { active: boolean + /** + * The remote cluster containing the leader indices to match against. + */ remote_cluster: string + /** + * The name of follower index. + */ follow_index_pattern?: IndexPattern + /** + * An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + */ leader_index_patterns: IndexPatterns + /** + * An array of simple index patterns that can be used to exclude indices from being auto-followed. + * @since 7.14.0 + */ + leader_index_exclusion_patterns: IndexPatterns + /** + * The maximum number of outstanding reads requests from the remote cluster. + */ max_outstanding_read_requests: integer } diff --git a/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts b/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts index fb0e335a67..1d9d308fb6 100644 --- a/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts +++ b/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name ccr.pause_auto_follow_pattern * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } } diff --git a/specification/ccr/pause_follow_index/PauseFollowIndexRequest.ts b/specification/ccr/pause_follow/PauseFollowIndexRequest.ts similarity index 96% rename from specification/ccr/pause_follow_index/PauseFollowIndexRequest.ts rename to specification/ccr/pause_follow/PauseFollowIndexRequest.ts index 45e57d58cd..c181ebe51d 100644 --- a/specification/ccr/pause_follow_index/PauseFollowIndexRequest.ts +++ b/specification/ccr/pause_follow/PauseFollowIndexRequest.ts @@ -23,10 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name ccr.pause_follow * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } } diff --git a/specification/ccr/unfollow_index/UnfollowIndexResponse.ts b/specification/ccr/pause_follow/PauseFollowIndexResponse.ts similarity index 100% rename from specification/ccr/unfollow_index/UnfollowIndexResponse.ts rename to specification/ccr/pause_follow/PauseFollowIndexResponse.ts diff --git a/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts b/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts index cb22729713..1c6798feec 100644 --- a/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts +++ b/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts @@ -27,37 +27,86 @@ import { Time } from '@_types/Time' /** * @rest_spec_name ccr.put_auto_follow_pattern * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - name: Name // param name in docs: auto_follow_pattern_name + path_parts: { + /** + * The name of the collection of auto-follow patterns. + */ + name: Name } - query_parameters?: {} - body?: { + body: { + /** + * The remote cluster containing the leader indices to match against. + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-remote-clusters.html + */ remote_cluster: string + /** + * The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices. + */ follow_index_pattern?: IndexPattern + /** + * An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. + */ leader_index_patterns?: IndexPatterns - /** @server_default 12 */ + /** + * An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. + */ + leader_index_exclusion_patterns?: IndexPatterns + /** + * The maximum number of outstanding reads requests from the remote cluster. + * @server_default 12 + */ max_outstanding_read_requests?: integer + /** + * Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). + */ settings?: Dictionary - /** @server_default 9 */ + /** + * The maximum number of outstanding reads requests from the remote cluster. + * @server_default 9 + */ max_outstanding_write_requests?: integer - /** @server_default 1m */ + /** + * The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. + * @server_default 1m + */ read_poll_timeout?: Time - /** @server_default 5120 */ + /** + * The maximum number of operations to pull per read from the remote cluster. + * @server_default 5120 + */ max_read_request_operation_count?: integer - /** @server_default 32mb */ + /** + * The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + * @server_default 32mb + */ max_read_request_size?: ByteSize - /** @server_default 500ms */ + /** + * The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. + * @server_default 500ms + */ max_retry_delay?: Time - /** @server_default 2147483647 */ + /** + * The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. + * @server_default 2147483647 + */ max_write_buffer_count?: integer - /** @server_default 512mb */ + /** + * The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. + * @server_default 512mb + */ max_write_buffer_size?: ByteSize - /** @server_default 5120 */ + /** + * The maximum number of operations per bulk write request executed on the follower. + * @server_default 5120 + */ max_write_request_operation_count?: integer - /** @server_default 9223372036854775807b */ + /** + * The maximum total bytes of operations per bulk write request executed on the follower. + * @server_default 9223372036854775807b + */ max_write_request_size?: ByteSize } } diff --git a/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts b/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts index e390ded9fb..f2a5f4d219 100644 --- a/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts +++ b/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name ccr.resume_auto_follow_pattern * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } } diff --git a/specification/ccr/resume_follow_index/ResumeFollowIndexRequest.ts b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts similarity index 96% rename from specification/ccr/resume_follow_index/ResumeFollowIndexRequest.ts rename to specification/ccr/resume_follow/ResumeFollowIndexRequest.ts index c3223e4e4b..404668c364 100644 --- a/specification/ccr/resume_follow_index/ResumeFollowIndexRequest.ts +++ b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts @@ -25,13 +25,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name ccr.resume_follow * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - body?: { + body: { max_outstanding_read_requests?: long max_outstanding_write_requests?: long max_read_request_operation_count?: long diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesBulkResponse.ts b/specification/ccr/resume_follow/ResumeFollowIndexResponse.ts similarity index 100% rename from specification/indices/update_aliases/IndicesUpdateAliasesBulkResponse.ts rename to specification/ccr/resume_follow/ResumeFollowIndexResponse.ts diff --git a/specification/ccr/stats/CcrStatsRequest.ts b/specification/ccr/stats/CcrStatsRequest.ts index 2249011867..6dbf44ff79 100644 --- a/specification/ccr/stats/CcrStatsRequest.ts +++ b/specification/ccr/stats/CcrStatsRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ccr.stats * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/ccr/unfollow_index/UnfollowIndexRequest.ts b/specification/ccr/unfollow/UnfollowIndexRequest.ts similarity index 96% rename from specification/ccr/unfollow_index/UnfollowIndexRequest.ts rename to specification/ccr/unfollow/UnfollowIndexRequest.ts index bbe5390d23..7a5386423d 100644 --- a/specification/ccr/unfollow_index/UnfollowIndexRequest.ts +++ b/specification/ccr/unfollow/UnfollowIndexRequest.ts @@ -23,10 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name ccr.unfollow * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } } diff --git a/specification/ml/validate_job/MlValidateJobResponse.ts b/specification/ccr/unfollow/UnfollowIndexResponse.ts similarity index 100% rename from specification/ml/validate_job/MlValidateJobResponse.ts rename to specification/ccr/unfollow/UnfollowIndexResponse.ts diff --git a/specification/cluster/_types/ClusterStateMetadata.ts b/specification/cluster/_types/ClusterStateMetadata.ts index 1d5d082b20..14512a1557 100644 --- a/specification/cluster/_types/ClusterStateMetadata.ts +++ b/specification/cluster/_types/ClusterStateMetadata.ts @@ -17,6 +17,7 @@ * under the License. */ +import { IndexState } from '@indices/_types/IndexState' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Id, IndexName, Name, Uuid } from '@_types/common' @@ -29,7 +30,7 @@ import { ClusterStateIngest } from './ClusterStateIngest' export class ClusterStateMetadata { cluster_uuid: Uuid cluster_uuid_committed: boolean - templates: ClusterStateMetadataTemplate + templates: Dictionary indices?: Dictionary 'index-graveyard': ClusterStateMetadataIndexGraveyard cluster_coordination: ClusterStateMetadataClusterCoordination @@ -55,8 +56,9 @@ export class TombstoneIndex { index_uuid: Uuid } -export class ClusterStateMetadataTemplate { - // TODO: check server code for validation +export class ClusterStateMetadataTemplate extends IndexState { + order: integer + version: integer } export class ClusterStateMetadataClusterCoordination { diff --git a/specification/cluster/_types/ClusterStatus.ts b/specification/cluster/_types/ClusterStatus.ts deleted file mode 100644 index 031ebc0245..0000000000 --- a/specification/cluster/_types/ClusterStatus.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -/** - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html - */ -export enum ClusterStatus { - /** All shards are assigned. */ - green = 0, - /** All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired. */ - yellow = 1, - /** One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned. */ - red = 2 -} diff --git a/specification/cluster/_types/ComponentTemplate.ts b/specification/cluster/_types/ComponentTemplate.ts index fad73a93f9..5cf9196ba8 100644 --- a/specification/cluster/_types/ComponentTemplate.ts +++ b/specification/cluster/_types/ComponentTemplate.ts @@ -39,7 +39,7 @@ export class ComponentTemplateSummary { /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html */ _meta?: Metadata version?: VersionNumber - settings: Dictionary + settings?: Dictionary mappings?: TypeMapping aliases?: Dictionary } diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts index afb6439c80..eeceac0175 100644 --- a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts +++ b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts @@ -24,10 +24,10 @@ import { integer } from '@_types/Numeric' /** * @rest_spec_name cluster.allocation_explain * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { /** * If true, returns information about disk usage and shard sizes. * @server_default false @@ -39,7 +39,7 @@ export interface Request extends RequestBase { */ include_yes_decisions?: boolean } - body?: { + body: { /** * Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. */ diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainResponse.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainResponse.ts index b2175d022d..050b80f0ce 100644 --- a/specification/cluster/allocation_explain/ClusterAllocationExplainResponse.ts +++ b/specification/cluster/allocation_explain/ClusterAllocationExplainResponse.ts @@ -54,5 +54,7 @@ export class Response { remaining_delay_in_millis?: long shard: integer unassigned_info?: UnassignedInformation + /** @since 7.14.0 */ + note?: string } } diff --git a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts index 148f021202..4bad9a9a08 100644 --- a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts +++ b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.delete_component_template * @since 7.8.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { name: Name } - query_parameters?: { + query_parameters: { /** @server_default 30s */ master_timeout?: Time /** @server_default 30s */ diff --git a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts index 038bf67c5e..e0e0c42b5e 100644 --- a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts +++ b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts @@ -22,10 +22,19 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name cluster.delete_voting_config_exclusions * @since 7.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - body?: { - stub: string + query_parameters: { + /** + * Specifies whether to wait for all excluded nodes to be removed from the + * cluster before clearing the voting configuration exclusions list. + * Defaults to true, meaning that all excluded nodes must be removed from + * the cluster before this API takes any action. If set to false then the + * voting configuration exclusions list is cleared even if some excluded + * nodes are still in the cluster. + * @server_default true + */ + wait_for_removal?: boolean } } diff --git a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts index 25b5bd6764..cf4f9c0d87 100644 --- a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts +++ b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Void } from '@spec_utils/VoidValue' export class Response { - body: { stub: integer } + body: Void } diff --git a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts index 5bf93db9a9..214a587624 100644 --- a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts +++ b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts @@ -18,20 +18,35 @@ */ import { RequestBase } from '@_types/Base' +import { Names } from '@_types/common' +import { Time } from '@_types/Time' /** * @rest_spec_name cluster.exists_component_template * @since 7.8.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string + path_parts: { + /** + * Comma-separated list of component template names used to limit the request. + * Wildcard (*) expressions are supported. + */ + name: Names } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an + * error. + * @server_default 30s + */ + master_timeout?: Time + /** + * If true, the request retrieves information from the local node only. + * Defaults to false, which means information is retrieved from the master node. + * @server_default false + */ + local?: boolean } } diff --git a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts index 25b5bd6764..cf4f9c0d87 100644 --- a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts +++ b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Void } from '@spec_utils/VoidValue' export class Response { - body: { stub: integer } + body: Void } diff --git a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts index 737caa8c93..e06cf5eeba 100644 --- a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts +++ b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.get_component_template * @since 7.8.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: Name } - query_parameters?: { + query_parameters: { /** @server_default false */ flat_settings?: boolean /** @server_default false */ diff --git a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts index 9b96b2e245..66341055e1 100644 --- a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts +++ b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts @@ -23,14 +23,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.get_settings * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { flat_settings?: boolean include_defaults?: boolean master_timeout?: Time timeout?: Time } - body?: {} } diff --git a/specification/cluster/health/ClusterHealthRequest.ts b/specification/cluster/health/ClusterHealthRequest.ts index 32b64050c1..fa232b5fba 100644 --- a/specification/cluster/health/ClusterHealthRequest.ts +++ b/specification/cluster/health/ClusterHealthRequest.ts @@ -20,29 +20,29 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, + HealthStatus, Indices, Level, WaitForActiveShards, - WaitForEvents, - WaitForStatus + WaitForEvents } from '@_types/common' import { Time } from '@_types/Time' /** * @rest_spec_name cluster.health * @since 1.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html#cluster-health-api-path-params */ - path_parts?: { + path_parts: { /** * Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *. */ index?: Indices } /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html#cluster-health-api-query-params */ - query_parameters?: { + query_parameters: { expand_wildcards?: ExpandWildcards /** * Can be one of cluster, indices or shards. Controls the details level of the health information returned. @@ -90,6 +90,6 @@ export interface Request extends RequestBase { /** * One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. */ - wait_for_status?: WaitForStatus + wait_for_status?: HealthStatus } } diff --git a/specification/cluster/health/ClusterHealthResponse.ts b/specification/cluster/health/ClusterHealthResponse.ts index 456be5df3f..b238502c88 100644 --- a/specification/cluster/health/ClusterHealthResponse.ts +++ b/specification/cluster/health/ClusterHealthResponse.ts @@ -18,7 +18,7 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { Health, IndexName } from '@_types/common' +import { HealthStatus, IndexName } from '@_types/common' import { integer, Percentage } from '@_types/Numeric' import { EpochMillis } from '@_types/Time' import { IndexHealthStats } from './types' @@ -49,7 +49,7 @@ export class Response { number_of_pending_tasks: integer /** The number of shards that are under relocation. */ relocating_shards: integer - status: Health + status: HealthStatus /** The time expressed in milliseconds since the earliest initiated task is waiting for being performed. */ task_max_waiting_in_queue_millis: EpochMillis /** If false the response returned within the period of time that is specified by the timeout parameter (30s by default) */ diff --git a/specification/cluster/health/types.ts b/specification/cluster/health/types.ts index c75f9e0fa7..d93ed4439e 100644 --- a/specification/cluster/health/types.ts +++ b/specification/cluster/health/types.ts @@ -18,7 +18,7 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { Health } from '@_types/common' +import { HealthStatus } from '@_types/common' import { integer } from '@_types/Numeric' export class IndexHealthStats { @@ -29,7 +29,7 @@ export class IndexHealthStats { number_of_shards: integer relocating_shards: integer shards?: Dictionary - status: Health + status: HealthStatus unassigned_shards: integer } @@ -38,6 +38,6 @@ export class ShardHealthStats { initializing_shards: integer primary_active: boolean relocating_shards: integer - status: Health + status: HealthStatus unassigned_shards: integer } diff --git a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts index bbd19f4883..ee9823457b 100644 --- a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts +++ b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts @@ -23,13 +23,12 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.pending_tasks * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { local?: boolean /** @server_default 30s */ master_timeout?: Time } - body?: {} } diff --git a/specification/cluster/pending_tasks/types.ts b/specification/cluster/pending_tasks/types.ts index ed147c3341..5a8b0b8d8e 100644 --- a/specification/cluster/pending_tasks/types.ts +++ b/specification/cluster/pending_tasks/types.ts @@ -20,6 +20,7 @@ import { integer } from '@_types/Numeric' export class PendingTask { + executing: boolean insert_order: integer priority: string source: string diff --git a/specification/cluster/put_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts similarity index 60% rename from specification/cluster/put_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts rename to specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts index 375c87a20b..cbdec31943 100644 --- a/specification/cluster/put_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts +++ b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts @@ -24,15 +24,27 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.post_voting_config_exclusions * @since 7.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { + /** + * A comma-separated list of the names of the nodes to exclude from the + * voting configuration. If specified, you may not also specify node_ids. + */ node_names?: Names + /** + * A comma-separated list of the persistent ids of the nodes to exclude + * from the voting configuration. If specified, you may not also specify node_names. + */ node_ids?: Ids - /** @server_default 30s */ + /** + * When adding a voting configuration exclusion, the API waits for the + * specified nodes to be excluded from the voting configuration before + * returning. If the timeout expires before the appropriate condition + * is satisfied, the request fails and returns an error. + * @server_default 30s + */ timeout?: Time - /** @server_default false */ - wait_for_removal?: boolean } } diff --git a/specification/cluster/put_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts similarity index 92% rename from specification/cluster/put_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts rename to specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts index 25b5bd6764..cf4f9c0d87 100644 --- a/specification/cluster/put_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts +++ b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Void } from '@spec_utils/VoidValue' export class Response { - body: { stub: integer } + body: Void } diff --git a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts index 31e1775849..cb362687ad 100644 --- a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts +++ b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts @@ -29,13 +29,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.put_component_template * @since 7.8.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { name: Name } - query_parameters?: { + query_parameters: { /** @server_default false */ create?: boolean /** @server_default 30s */ diff --git a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts index 6c6bae3759..37e27885cd 100644 --- a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts +++ b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts @@ -25,17 +25,17 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.put_settings * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { flat_settings?: boolean /** @server_default 30s */ master_timeout?: Time /** @server_default 30s */ timeout?: Time } - body?: { + body: { persistent?: Dictionary transient?: Dictionary } diff --git a/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts b/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts index de31c3081d..d732d69185 100644 --- a/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts +++ b/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts @@ -18,14 +18,14 @@ */ import { RequestBase } from '@_types/Base' +import { Void } from '@spec_utils/VoidValue' /** + * The cluster remote info API allows you to retrieve all of the configured + * remote cluster information. It returns connection and endpoint information + * keyed by the configured remote cluster alias. * @rest_spec_name cluster.remote_info * @since 6.1.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - body?: { - stub: string - } -} +export interface Request extends RequestBase {} diff --git a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts index 8c6a7f7276..3fb650f3f3 100644 --- a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts +++ b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts @@ -26,11 +26,26 @@ export class Response extends DictionaryResponseBase< ClusterRemoteInfo > {} -export class ClusterRemoteInfo { +/** @variants internal tag='mode' */ +export type ClusterRemoteInfo = ClusterRemoteSniffInfo | ClusterRemoteProxyInfo + +export class ClusterRemoteSniffInfo { + mode: 'sniff' connected: boolean - initial_connect_timeout: Time max_connections_per_cluster: integer num_nodes_connected: long + initial_connect_timeout: Time + skip_unavailable: boolean seeds: string[] +} + +export class ClusterRemoteProxyInfo { + mode: 'proxy' + connected: boolean + initial_connect_timeout: Time skip_unavailable: boolean + proxy_address: string + server_name: string + num_proxy_sockets_connected: integer + max_proxy_socket_connections: integer } diff --git a/specification/cluster/reroute/ClusterRerouteRequest.ts b/specification/cluster/reroute/ClusterRerouteRequest.ts index 678d2ecd2d..4370afe9d5 100644 --- a/specification/cluster/reroute/ClusterRerouteRequest.ts +++ b/specification/cluster/reroute/ClusterRerouteRequest.ts @@ -25,10 +25,10 @@ import { Command } from './types' /** * @rest_spec_name cluster.reroute * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { /** * If true, then the request simulates the operation only and returns the resulting state. * @server_default false diff --git a/specification/cluster/reroute/ClusterRerouteResponse.ts b/specification/cluster/reroute/ClusterRerouteResponse.ts index 41c3652d39..9e6a56bbf6 100644 --- a/specification/cluster/reroute/ClusterRerouteResponse.ts +++ b/specification/cluster/reroute/ClusterRerouteResponse.ts @@ -17,12 +17,17 @@ * under the License. */ -import { AcknowledgedResponseBase } from '@_types/Base' -import { RerouteExplanation, RerouteState } from './types' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { RerouteExplanation } from './types' -export class Response extends AcknowledgedResponseBase { +export class Response { body: { explanations?: RerouteExplanation[] - state: RerouteState + /** + * There aren't any guarantees on the output/structure of the raw cluster state. + * Here you will find the internal representation of the cluster, which can + * differ from the external representation. + */ + state: UserDefinedValue } } diff --git a/specification/cluster/reroute/types.ts b/specification/cluster/reroute/types.ts index 259bf5d8c7..79128864ef 100644 --- a/specification/cluster/reroute/types.ts +++ b/specification/cluster/reroute/types.ts @@ -17,21 +17,7 @@ * under the License. */ -import { ClusterStateMetadata } from '@cluster/_types/ClusterStateMetadata' -import { ClusterStateRoutingNodes } from '@cluster/_types/ClusterStateRoutingNodes' -import { - ClusterStateSnapshots, - ClusterStateDeletedSnapshots -} from '@cluster/_types/ClusterStateSnapshots' -import { Dictionary } from '@spec_utils/Dictionary' -import { - EmptyObject, - IndexName, - NodeName, - Uuid, - VersionNumber -} from '@_types/common' -import { NodeAttributes } from '@_types/Node' +import { IndexName, NodeName } from '@_types/common' import { integer } from '@_types/Numeric' /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html#cluster-reroute-api-request-body */ @@ -119,18 +105,3 @@ export class RerouteParameters { from_node?: NodeName to_node?: NodeName } - -export class RerouteState { - cluster_uuid: Uuid - state_uuid?: Uuid - master_node?: string - version?: VersionNumber - blocks?: EmptyObject // TODO: this is likely wrong too - nodes?: Dictionary - routing_table?: Dictionary // TODO: this is wrong, but the tests are not exhaustive enough - routing_nodes?: ClusterStateRoutingNodes - security_tokens?: Dictionary - snapshots?: ClusterStateSnapshots - snapshot_deletions?: ClusterStateDeletedSnapshots - metadata?: ClusterStateMetadata -} diff --git a/specification/cluster/state/ClusterStateRequest.ts b/specification/cluster/state/ClusterStateRequest.ts index ccf4b542e5..30677e22e1 100644 --- a/specification/cluster/state/ClusterStateRequest.ts +++ b/specification/cluster/state/ClusterStateRequest.ts @@ -29,14 +29,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.state * @since 1.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor, manage */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { metric?: Metrics index?: Indices } - query_parameters?: { + query_parameters: { /** @server_default true */ allow_no_indices?: boolean expand_wildcards?: ExpandWildcards diff --git a/specification/cluster/state/ClusterStateResponse.ts b/specification/cluster/state/ClusterStateResponse.ts index 7ddf77a837..d5f501f7b7 100644 --- a/specification/cluster/state/ClusterStateResponse.ts +++ b/specification/cluster/state/ClusterStateResponse.ts @@ -17,42 +17,13 @@ * under the License. */ -import { ClusterStateBlockIndex } from '@cluster/_types/ClusterStateBlocksIndex' -import { ClusterStateMetadata } from '@cluster/_types/ClusterStateMetadata' -import { ClusterStateRoutingNodes } from '@cluster/_types/ClusterStateRoutingNodes' -import { - ClusterStateDeletedSnapshots, - ClusterStateSnapshots -} from '@cluster/_types/ClusterStateSnapshots' -import { Dictionary } from '@spec_utils/Dictionary' -import { - EmptyObject, - IndexName, - Name, - NodeName, - Uuid, - VersionNumber -} from '@_types/common' -import { NodeAttributes } from '@_types/Node' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { - body: { - cluster_name: Name - cluster_uuid: Uuid - master_node?: string - state?: string[] - state_uuid?: Uuid - version?: VersionNumber - blocks?: ClusterStateBlocks - metadata?: ClusterStateMetadata - nodes?: Dictionary - routing_table?: Dictionary // TODO: this is wrong, but the tests are not exhaustive enough - routing_nodes?: ClusterStateRoutingNodes - snapshots?: ClusterStateSnapshots - snapshot_deletions?: ClusterStateDeletedSnapshots - } -} - -export class ClusterStateBlocks { - indices?: Dictionary> + /** + * There aren't any guarantees on the output/structure of the raw cluster state. + * Here you will find the internal representation of the cluster, which can + * differ from the external representation. + */ + body: UserDefinedValue } diff --git a/specification/cluster/stats/ClusterStatsRequest.ts b/specification/cluster/stats/ClusterStatsRequest.ts index f2d8fe3cce..237296f1bc 100644 --- a/specification/cluster/stats/ClusterStatsRequest.ts +++ b/specification/cluster/stats/ClusterStatsRequest.ts @@ -24,14 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name cluster.stats * @since 1.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. */ node_id?: NodeIds } - query_parameters?: { + query_parameters: { flat_settings?: boolean /** Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. */ timeout?: Time diff --git a/specification/cluster/stats/ClusterStatsResponse.ts b/specification/cluster/stats/ClusterStatsResponse.ts index cde088d642..56e78f5262 100644 --- a/specification/cluster/stats/ClusterStatsResponse.ts +++ b/specification/cluster/stats/ClusterStatsResponse.ts @@ -17,9 +17,8 @@ * under the License. */ -import { ClusterStatus } from '@cluster/_types/ClusterStatus' import { NodesResponseBase } from '@nodes/_types/NodesResponseBase' -import { Name, Uuid } from '@_types/common' +import { HealthStatus, Name, Uuid } from '@_types/common' import { long } from '@_types/Numeric' import { ClusterIndices, ClusterNodes } from './types' @@ -46,7 +45,7 @@ export class Response extends NodesResponseBase { /** * Health status of the cluster, based on the state of its primary and replica shards. */ - status: ClusterStatus + status: HealthStatus /** * Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed. * @doc_url https://en.wikipedia.org/wiki/Unix_time diff --git a/specification/cluster/stats/types.ts b/specification/cluster/stats/types.ts index edd01e7443..42c8cc808f 100644 --- a/specification/cluster/stats/types.ts +++ b/specification/cluster/stats/types.ts @@ -227,7 +227,7 @@ export class ClusterOperatingSystem { available_processors: integer mem: OperatingSystemMemoryInfo names: ClusterOperatingSystemName[] - pretty_names: ClusterOperatingSystemName[] + pretty_names: ClusterOperatingSystemPrettyName[] architectures?: ClusterOperatingSystemArchitecture[] } @@ -236,6 +236,11 @@ export class ClusterOperatingSystemName { name: Name } +export class ClusterOperatingSystemPrettyName { + count: integer + pretty_name: Name +} + export class ClusterProcess { cpu: ClusterProcessCpu open_file_descriptors: ClusterProcessOpenFileDescriptors diff --git a/specification/dangling_indices/index_delete/DeleteDanglingIndexRequest.ts b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts similarity index 81% rename from specification/dangling_indices/index_delete/DeleteDanglingIndexRequest.ts rename to specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts index 6a2c5a2a9b..b456ab4044 100644 --- a/specification/dangling_indices/index_delete/DeleteDanglingIndexRequest.ts +++ b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts @@ -18,20 +18,21 @@ */ import { RequestBase } from '@_types/Base' +import { Uuid } from '@_types/common' +import { Time } from '@_types/Time' /** * @rest_spec_name dangling_indices.delete_dangling_index * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string + path_parts: { + index_uuid: Uuid } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + query_parameters: { + accept_data_loss: boolean + master_timeout?: Time + timeout?: Time } } diff --git a/specification/rollup/create_rollup_job/CreateRollupJobResponse.ts b/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts similarity index 100% rename from specification/rollup/create_rollup_job/CreateRollupJobResponse.ts rename to specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts diff --git a/specification/dangling_indices/index_import/ImportDanglingIndexRequest.ts b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts similarity index 81% rename from specification/dangling_indices/index_import/ImportDanglingIndexRequest.ts rename to specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts index a68e2be040..6dc43fa7d3 100644 --- a/specification/dangling_indices/index_import/ImportDanglingIndexRequest.ts +++ b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts @@ -18,20 +18,21 @@ */ import { RequestBase } from '@_types/Base' +import { Uuid } from '@_types/common' +import { Time } from '@_types/Time' /** * @rest_spec_name dangling_indices.import_dangling_index * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string + path_parts: { + index_uuid: Uuid } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + query_parameters: { + accept_data_loss: boolean + master_timeout?: Time + timeout?: Time } } diff --git a/specification/dangling_indices/index_import/ImportDanglingIndexResponse.ts b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts similarity index 87% rename from specification/dangling_indices/index_import/ImportDanglingIndexResponse.ts rename to specification/dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts index 25b5bd6764..0059ab53e4 100644 --- a/specification/dangling_indices/index_import/ImportDanglingIndexResponse.ts +++ b/specification/dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts @@ -17,8 +17,6 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { AcknowledgedResponseBase } from '@_types/Base' -export class Response { - body: { stub: integer } -} +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/dangling_indices/indices_list/ListDanglingIndicesRequest.ts b/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts similarity index 83% rename from specification/dangling_indices/indices_list/ListDanglingIndicesRequest.ts rename to specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts index 95c4f88e66..4c36c1b23f 100644 --- a/specification/dangling_indices/indices_list/ListDanglingIndicesRequest.ts +++ b/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts @@ -22,16 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name dangling_indices.list_dangling_indices * @since 7.9.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string - } -} +export interface Request extends RequestBase {} diff --git a/specification/dangling_indices/indices_list/ListDanglingIndicesResponse.ts b/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts similarity index 76% rename from specification/dangling_indices/indices_list/ListDanglingIndicesResponse.ts rename to specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts index 25b5bd6764..18e9b26c4f 100644 --- a/specification/dangling_indices/indices_list/ListDanglingIndicesResponse.ts +++ b/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts @@ -17,8 +17,18 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Ids } from '@_types/common' +import { EpochMillis } from '@_types/Time' export class Response { - body: { stub: integer } + body: { + dangling_indices: DanglingIndex[] + } +} + +export class DanglingIndex { + index_name: string + index_uuid: string + creation_date_millis: EpochMillis + node_ids: Ids } diff --git a/specification/enrich/_types/Policy.ts b/specification/enrich/_types/Policy.ts index bd6170933b..aad7b99c37 100644 --- a/specification/enrich/_types/Policy.ts +++ b/specification/enrich/_types/Policy.ts @@ -18,14 +18,16 @@ */ import { Field, Fields, Indices, Name } from '@_types/common' +import { SingleKeyDictionary } from '@spec_utils/Dictionary' export class Summary { - config: Configuration + config: SingleKeyDictionary } -export class Configuration { - geo_match?: Policy - match: Policy +export enum PolicyType { + geo_match, + match, + range } export class Policy { @@ -34,4 +36,5 @@ export class Policy { match_field: Field query?: string name?: Name + elasticsearch_version?: string } diff --git a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts index b850e6e759..893257a5f3 100644 --- a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts +++ b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name enrich.delete_policy * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } } diff --git a/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts b/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts index c7ee0d3d6c..401295a6f0 100644 --- a/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts +++ b/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts @@ -23,14 +23,13 @@ import { Name } from '@_types/common' /** * @rest_spec_name enrich.execute_policy * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } - query_parameters?: { + query_parameters: { wait_for_completion?: boolean } - body?: {} } diff --git a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts index 29c6251d76..eac4a35e2a 100644 --- a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts +++ b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts @@ -23,10 +23,10 @@ import { Names } from '@_types/common' /** * @rest_spec_name enrich.get_policy * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: Names } } diff --git a/specification/enrich/put_policy/PutEnrichPolicyRequest.ts b/specification/enrich/put_policy/PutEnrichPolicyRequest.ts index 39a7719dfe..dbdfc69c7e 100644 --- a/specification/enrich/put_policy/PutEnrichPolicyRequest.ts +++ b/specification/enrich/put_policy/PutEnrichPolicyRequest.ts @@ -24,13 +24,13 @@ import { Name } from '@_types/common' /** * @rest_spec_name enrich.put_policy * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } - body?: { + body: { geo_match?: Policy match?: Policy } diff --git a/specification/enrich/stats/EnrichStatsRequest.ts b/specification/enrich/stats/EnrichStatsRequest.ts index eff159db86..423dd6c288 100644 --- a/specification/enrich/stats/EnrichStatsRequest.ts +++ b/specification/enrich/stats/EnrichStatsRequest.ts @@ -22,9 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name enrich.stats * @since 7.5.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends RequestBase {} diff --git a/specification/enrich/stats/EnrichStatsResponse.ts b/specification/enrich/stats/EnrichStatsResponse.ts index b2d3182cfb..2b84985bf0 100644 --- a/specification/enrich/stats/EnrichStatsResponse.ts +++ b/specification/enrich/stats/EnrichStatsResponse.ts @@ -17,11 +17,13 @@ * under the License. */ -import { ExecutingPolicy, CoordinatorStats } from './types' +import { ExecutingPolicy, CoordinatorStats, CacheStats } from './types' export class Response { body: { coordinator_stats: CoordinatorStats[] executing_policies: ExecutingPolicy[] + /** @since 7.16.0 */ + cache_stats?: CacheStats[] } } diff --git a/specification/enrich/stats/types.ts b/specification/enrich/stats/types.ts index e84a14c7df..e89d786459 100644 --- a/specification/enrich/stats/types.ts +++ b/specification/enrich/stats/types.ts @@ -17,7 +17,7 @@ * under the License. */ -import { Info } from '@task/_types/TaskInfo' +import { Info } from '@tasks/_types/TaskInfo' import { Id, Name } from '@_types/common' import { integer, long } from '@_types/Numeric' @@ -33,3 +33,11 @@ export class CoordinatorStats { remote_requests_current: integer remote_requests_total: long } + +export class CacheStats { + node_id: Id + count: integer + hits: integer + misses: integer + evictions: integer +} diff --git a/specification/eql/delete/EqlDeleteRequest.ts b/specification/eql/delete/EqlDeleteRequest.ts index 6c2b261f91..3572f7a252 100644 --- a/specification/eql/delete/EqlDeleteRequest.ts +++ b/specification/eql/delete/EqlDeleteRequest.ts @@ -23,7 +23,7 @@ import { Id } from '@_types/common' /** * @rest_spec_name eql.delete * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/eql/get/EqlGetRequest.ts b/specification/eql/get/EqlGetRequest.ts index c3535b92f9..3c49c3d7c0 100644 --- a/specification/eql/get/EqlGetRequest.ts +++ b/specification/eql/get/EqlGetRequest.ts @@ -24,7 +24,7 @@ import { Time } from '@_types/Time' /** * @rest_spec_name eql.get * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { @@ -33,7 +33,7 @@ export interface Request extends RequestBase { */ id: Id } - query_parameters?: { + query_parameters: { /** * Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request. */ diff --git a/specification/eql/get_status/EqlGetStatusRequest.ts b/specification/eql/get_status/EqlGetStatusRequest.ts index 628a973891..9dbbb92681 100644 --- a/specification/eql/get_status/EqlGetStatusRequest.ts +++ b/specification/eql/get_status/EqlGetStatusRequest.ts @@ -23,7 +23,7 @@ import { Id } from '@_types/common' /** * @rest_spec_name eql.get_status * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 861e4c57ce..3661694b6f 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -20,20 +20,20 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Field, IndexName } from '@_types/common' import { float, uint } from '@_types/Numeric' -import { QueryContainer } from '@_types/query_dsl/abstractions' +import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' import { Time } from '@_types/Time' -import { ResultPosition, SearchFieldFormatted } from './types' +import { ResultPosition } from './types' /** * @rest_spec_name eql.search * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { index: IndexName } - query_parameters?: { + query_parameters: { /** * @server_default true */ @@ -62,7 +62,7 @@ export interface Request extends RequestBase { */ wait_for_completion_timeout?: Time } - body?: { + body: { /** * EQL query you wish to run. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html @@ -99,11 +99,11 @@ export interface Request extends RequestBase { * For basic queries, the maximum number of matching events to return. Defaults to 10 * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax */ - size?: uint | float + size?: uint // doc says "integer of float" but it's really an int /** * Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. */ - fields?: Array + fields?: FieldAndFormat /** * @server_default tail */ diff --git a/specification/eql/search/types.ts b/specification/eql/search/types.ts index 6920330130..1a22b2c358 100644 --- a/specification/eql/search/types.ts +++ b/specification/eql/search/types.ts @@ -17,19 +17,6 @@ * under the License. */ -import { Field } from '@_types/common' - -export class SearchFieldFormatted { - /** - * Wildcard pattern. The request returns values for field names matching this pattern. - */ - field: Field - /** - * Format in which the values are returned. - */ - format?: string -} - /** * Set of matching events or sequences to return. */ diff --git a/specification/security/_types/ManageUserPrivileges.ts b/specification/features/_types/Feature.ts similarity index 92% rename from specification/security/_types/ManageUserPrivileges.ts rename to specification/features/_types/Feature.ts index 224f5fea10..72e74e0a87 100644 --- a/specification/security/_types/ManageUserPrivileges.ts +++ b/specification/features/_types/Feature.ts @@ -17,6 +17,7 @@ * under the License. */ -export class ManageUserPrivileges { - applications: string[] +export class Feature { + name: string + description: string } diff --git a/specification/features/get_features/GetFeaturesRequest.ts b/specification/features/get_features/GetFeaturesRequest.ts index 9a70c7d6c4..9b4b360825 100644 --- a/specification/features/get_features/GetFeaturesRequest.ts +++ b/specification/features/get_features/GetFeaturesRequest.ts @@ -22,16 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name features.get_features * @since 7.12.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string - } -} +export interface Request extends RequestBase {} diff --git a/specification/features/get_features/GetFeaturesResponse.ts b/specification/features/get_features/GetFeaturesResponse.ts index 25b5bd6764..6261948614 100644 --- a/specification/features/get_features/GetFeaturesResponse.ts +++ b/specification/features/get_features/GetFeaturesResponse.ts @@ -17,8 +17,10 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Feature } from '../_types/Feature' export class Response { - body: { stub: integer } + body: { + features: Feature[] + } } diff --git a/specification/features/reset_features/ResetFeaturesRequest.ts b/specification/features/reset_features/ResetFeaturesRequest.ts index 77536003c6..cad4c916dd 100644 --- a/specification/features/reset_features/ResetFeaturesRequest.ts +++ b/specification/features/reset_features/ResetFeaturesRequest.ts @@ -22,16 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name features.reset_features * @since 7.12.0 - * @stability TODO + * @stability experimental */ -export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string - } -} +export interface Request extends RequestBase {} diff --git a/specification/features/reset_features/ResetFeaturesResponse.ts b/specification/features/reset_features/ResetFeaturesResponse.ts index 25b5bd6764..6261948614 100644 --- a/specification/features/reset_features/ResetFeaturesResponse.ts +++ b/specification/features/reset_features/ResetFeaturesResponse.ts @@ -17,8 +17,10 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Feature } from '../_types/Feature' export class Response { - body: { stub: integer } + body: { + features: Feature[] + } } diff --git a/specification/fleet/_types/Checkpoints.ts b/specification/fleet/_types/Checkpoints.ts new file mode 100644 index 0000000000..968ce8866c --- /dev/null +++ b/specification/fleet/_types/Checkpoints.ts @@ -0,0 +1,22 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { long } from '@_types/Numeric' + +export type Checkpoint = long diff --git a/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts b/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts new file mode 100644 index 0000000000..edc1acfc66 --- /dev/null +++ b/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts @@ -0,0 +1,63 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { IndexName, IndexAlias } from '@_types/common' +import { Time } from '@_types/Time' +import { Checkpoint } from '../_types/Checkpoints' + +/** + * @rest_spec_name fleet.global_checkpoints + * @since 7.13.0 + * @stability stable + */ +export interface Request extends RequestBase { + path_parts: { + /** + * A single index or index alias that resolves to a single index. + */ + index: IndexName | IndexAlias + } + query_parameters: { + /** + * A boolean value which controls whether to wait (until the timeout) for the global checkpoints + * to advance past the provided `checkpoints`. + * @server_default false + */ + wait_for_advance?: boolean + /** + * A boolean value which controls whether to wait (until the timeout) for the target index to exist + * and all primary shards be active. Can only be true when `wait_for_advance` is true. + * @server_default false + */ + wait_for_index?: boolean + /** + * A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`, + * the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list + * will cause Elasticsearch to immediately return the current global checkpoints. + * @server_default [] + */ + checkpoints?: Checkpoint[] + /** + * Period to wait for a global checkpoints to advance past `checkpoints`. + * @server_default 30s + */ + timeout?: Time + } +} diff --git a/specification/fleet/global_checkpoints/GlobalCheckpointsResponse.ts b/specification/fleet/global_checkpoints/GlobalCheckpointsResponse.ts new file mode 100644 index 0000000000..1ae57e6536 --- /dev/null +++ b/specification/fleet/global_checkpoints/GlobalCheckpointsResponse.ts @@ -0,0 +1,27 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Checkpoint } from '../_types/Checkpoints' + +export class Response { + body: { + global_checkpoints: Checkpoint[] + timed_out: boolean + } +} diff --git a/specification/graph/explore/GraphExploreRequest.ts b/specification/graph/explore/GraphExploreRequest.ts index 695a93395b..ef9c7ddb3a 100644 --- a/specification/graph/explore/GraphExploreRequest.ts +++ b/specification/graph/explore/GraphExploreRequest.ts @@ -28,18 +28,18 @@ import { VertexDefinition } from '@graph/_types/Vertex' /** * @rest_spec_name graph.explore * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices type?: Types } - query_parameters?: { + query_parameters: { routing?: Routing timeout?: Time } - body?: { + body: { connections?: Hop controls?: ExploreControls query?: QueryContainer diff --git a/specification/ilm/_types/Phase.ts b/specification/ilm/_types/Phase.ts index 0a097fc7ce..24d181a582 100644 --- a/specification/ilm/_types/Phase.ts +++ b/specification/ilm/_types/Phase.ts @@ -18,10 +18,12 @@ */ import { Dictionary } from '@spec_utils/Dictionary' +import { integer } from '@_types/Numeric' import { Time } from '@_types/Time' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Phase { - actions: Dictionary | string[] + actions?: Actions min_age?: Time } @@ -32,4 +34,6 @@ export class Phases { warm?: Phase } -export class Action {} +// TODO. This is a variants container. +// See https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html#ilm-phase-actions +export type Actions = UserDefinedValue diff --git a/specification/ilm/_types/Policy.ts b/specification/ilm/_types/Policy.ts index 35cd64057a..c98d057860 100644 --- a/specification/ilm/_types/Policy.ts +++ b/specification/ilm/_types/Policy.ts @@ -17,10 +17,10 @@ * under the License. */ -import { Name } from '@_types/common' +import { Metadata, Name } from '@_types/common' import { Phases } from './Phase' export class Policy { phases: Phases - name?: Name + _meta?: Metadata } diff --git a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts index 4fbbf4642a..c8572ef329 100644 --- a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts +++ b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts @@ -18,16 +18,35 @@ */ import { RequestBase } from '@_types/Base' -import { Id, Name } from '@_types/common' +import { Name } from '@_types/common' +import { Time } from '@_types/Time' /** + * Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + * * @rest_spec_name ilm.delete_lifecycle * @since 6.6.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ilm */ export interface Request extends RequestBase { - path_parts?: { - policy?: Name - policy_id: Id + path_parts: { + /** + * Identifier for the policy. + * @codegen_name name + */ + policy: Name + } + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time } } diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts index b52ce9c3be..47936317c1 100644 --- a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts +++ b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts @@ -19,18 +19,41 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' +import { Time } from '@_types/Time' /** + * Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures. * @rest_spec_name ilm.explain_lifecycle * @since 6.6.0 - * @stability TODO + * @stability stable + * @index_privileges view_index_metadata,manage_ilm */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). + * To target all data streams and indices, use `*` or `_all`. + */ index: IndexName } - query_parameters?: { + query_parameters: { + /** + * Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. + */ only_errors?: boolean + /** + * Filters the returned indices to only indices that are managed by ILM. + */ only_managed?: boolean + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time } } diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleResponse.ts b/specification/ilm/explain_lifecycle/ExplainLifecycleResponse.ts index 41a501f4b6..1624702c53 100644 --- a/specification/ilm/explain_lifecycle/ExplainLifecycleResponse.ts +++ b/specification/ilm/explain_lifecycle/ExplainLifecycleResponse.ts @@ -19,10 +19,10 @@ import { Dictionary } from '@spec_utils/Dictionary' import { IndexName } from '@_types/common' -import { LifecycleExplain, LifecycleExplainProject } from './types' +import { LifecycleExplain } from './types' export class Response { body: { - indices: Dictionary | LifecycleExplainProject + indices: Dictionary } } diff --git a/specification/ilm/explain_lifecycle/types.ts b/specification/ilm/explain_lifecycle/types.ts index 33e4512241..235dbe8021 100644 --- a/specification/ilm/explain_lifecycle/types.ts +++ b/specification/ilm/explain_lifecycle/types.ts @@ -23,16 +23,17 @@ import { IndexName, Name, VersionNumber } from '@_types/common' import { integer } from '@_types/Numeric' import { EpochMillis, Time } from '@_types/Time' -export class LifecycleExplain { +export class LifecycleExplainManaged { action: Name action_time_millis: EpochMillis age: Time failed_step?: Name failed_step_retry_count?: integer index: IndexName + index_creation_date_millis?: EpochMillis is_auto_retryable_error?: boolean lifecycle_date_millis: EpochMillis - managed: boolean + managed: true phase: Name phase_time_millis: EpochMillis policy: Name @@ -40,19 +41,21 @@ export class LifecycleExplain { step_info?: Dictionary step_time_millis: EpochMillis phase_execution: LifecycleExplainPhaseExecution + time_since_index_creation?: Time } +export class LifecycleExplainUnmanaged { + index: IndexName + managed: false +} + +/** @variants internal tag='managed' */ +export type LifecycleExplain = + | LifecycleExplainManaged + | LifecycleExplainUnmanaged + export class LifecycleExplainPhaseExecution { policy: Name version: VersionNumber modified_date_in_millis: EpochMillis } - -export class LifecycleExplainProject { - project: LifecycleExplainProjectSummary -} - -export class LifecycleExplainProjectSummary { - index: IndexName - managed: boolean -} diff --git a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts index f30b25e96b..75b494face 100644 --- a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts +++ b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts @@ -18,16 +18,34 @@ */ import { RequestBase } from '@_types/Base' -import { Id, Name } from '@_types/common' +import { Name } from '@_types/common' +import { Time } from '@_types/Time' /** + * Retrieves a lifecycle policy. * @rest_spec_name ilm.get_lifecycle * @since 6.6.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ilm, read_ilm */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the policy. + * @codegen_name name + */ policy?: Name - policy_id?: Id + } + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time } } diff --git a/specification/ilm/get_status/GetIlmStatusRequest.ts b/specification/ilm/get_status/GetIlmStatusRequest.ts index 03ea60272e..78c4061d99 100644 --- a/specification/ilm/get_status/GetIlmStatusRequest.ts +++ b/specification/ilm/get_status/GetIlmStatusRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ilm.get_status * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/ml/post_data/MlPostDataRequest.ts b/specification/ilm/migrate_to_data_tiers/Request.ts similarity index 54% rename from specification/ml/post_data/MlPostDataRequest.ts rename to specification/ilm/migrate_to_data_tiers/Request.ts index 3c0919ddcb..cd833567c1 100644 --- a/specification/ml/post_data/MlPostDataRequest.ts +++ b/specification/ilm/migrate_to_data_tiers/Request.ts @@ -18,22 +18,27 @@ */ import { RequestBase } from '@_types/Base' -import { Id } from '@_types/common' -import { DateString } from '@_types/Time' -import { Input } from './types' /** - * @rest_spec_name ml.post_data - * @since 5.4.0 + * Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and + * attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + * Using node roles enables ILM to automatically move the indices between data tiers. + * + * @rest_spec_name ilm.migrate_to_data_tiers + * @since 7.14.0 * @stability stable */ export interface Request extends RequestBase { - path_parts: { - job_id: Id + query_parameters: { + /** + * If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. + * This provides a way to retrieve the indices and ILM policies that need to be migrated. + * @server_default false + */ + dry_run?: boolean } - query_parameters?: { - reset_end?: DateString - reset_start?: DateString + body: { + legacy_template_to_delete?: string + node_attribute?: string } - body?: Input } diff --git a/specification/security/_types/IndicesPrivileges.ts b/specification/ilm/migrate_to_data_tiers/Response.ts similarity index 73% rename from specification/security/_types/IndicesPrivileges.ts rename to specification/ilm/migrate_to_data_tiers/Response.ts index 288cf828b2..5fb556a568 100644 --- a/specification/security/_types/IndicesPrivileges.ts +++ b/specification/ilm/migrate_to_data_tiers/Response.ts @@ -17,14 +17,16 @@ * under the License. */ -import { FieldSecurity } from '@security/_types/FieldSecurity' import { Indices } from '@_types/common' -import { QueryContainer } from '@_types/query_dsl/abstractions' -export class IndicesPrivileges { - field_security?: FieldSecurity - names: Indices - privileges: string[] - query?: string | QueryContainer - allow_restricted_indices?: boolean +export class Response { + body: { + dry_run: boolean + removed_legacy_template: string + migrated_ilm_policies: string[] + migrated_indices: Indices + migrated_legacy_templates: string[] + migrated_composable_templates: string[] + migrated_component_templates: string[] + } } diff --git a/specification/ilm/move_to_step/MoveToStepRequest.ts b/specification/ilm/move_to_step/MoveToStepRequest.ts index 7e763df93e..c5a96d3d01 100644 --- a/specification/ilm/move_to_step/MoveToStepRequest.ts +++ b/specification/ilm/move_to_step/MoveToStepRequest.ts @@ -24,13 +24,13 @@ import { StepKey } from './types' /** * @rest_spec_name ilm.move_to_step * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - body?: { + body: { current_step?: StepKey next_step?: StepKey } diff --git a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts index 128a3476f0..b29341d99c 100644 --- a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts +++ b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts @@ -19,19 +19,38 @@ import { Policy } from '@ilm/_types/Policy' import { RequestBase } from '@_types/Base' -import { Id, Name } from '@_types/common' +import { Name } from '@_types/common' +import { Time } from '@_types/Time' /** + * Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. * @rest_spec_name ilm.put_lifecycle * @since 6.6.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ilm + * @index_privileges manage */ export interface Request extends RequestBase { - path_parts?: { - policy?: Name - policy_id?: Id + path_parts: { + /** + * Identifier for the policy. + * @codegen_name name + */ + policy: Name } - body?: { + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time + } + body: { policy?: Policy } } diff --git a/specification/ilm/remove_policy/RemovePolicyRequest.ts b/specification/ilm/remove_policy/RemovePolicyRequest.ts index 917984a4e6..97ffab74b5 100644 --- a/specification/ilm/remove_policy/RemovePolicyRequest.ts +++ b/specification/ilm/remove_policy/RemovePolicyRequest.ts @@ -23,10 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name ilm.remove_policy * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } } diff --git a/specification/ilm/retry/RetryIlmRequest.ts b/specification/ilm/retry/RetryIlmRequest.ts index 447a56bbae..21ebd0bd0d 100644 --- a/specification/ilm/retry/RetryIlmRequest.ts +++ b/specification/ilm/retry/RetryIlmRequest.ts @@ -23,10 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name ilm.retry * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } } diff --git a/specification/ilm/start/StartIlmRequest.ts b/specification/ilm/start/StartIlmRequest.ts index 322597d3dc..c8521f3eb0 100644 --- a/specification/ilm/start/StartIlmRequest.ts +++ b/specification/ilm/start/StartIlmRequest.ts @@ -18,15 +18,16 @@ */ import { RequestBase } from '@_types/Base' +import { Time } from '@_types/Time' /** * @rest_spec_name ilm.start * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { - stub: boolean + query_parameters: { + master_timeout?: Time + timeout?: Time } } diff --git a/specification/ilm/stop/StopIlmRequest.ts b/specification/ilm/stop/StopIlmRequest.ts index 1563a8fa33..c08652eb93 100644 --- a/specification/ilm/stop/StopIlmRequest.ts +++ b/specification/ilm/stop/StopIlmRequest.ts @@ -18,15 +18,16 @@ */ import { RequestBase } from '@_types/Base' +import { Time } from '@_types/Time' /** * @rest_spec_name ilm.stop * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { - stub: boolean + query_parameters: { + master_timeout?: Time + timeout?: Time } } diff --git a/specification/security/_types/RoleMappingRuleBase.ts b/specification/indices/_types/DataStream.ts similarity index 94% rename from specification/security/_types/RoleMappingRuleBase.ts rename to specification/indices/_types/DataStream.ts index 2ec93c7948..17387dcc68 100644 --- a/specification/security/_types/RoleMappingRuleBase.ts +++ b/specification/indices/_types/DataStream.ts @@ -17,4 +17,6 @@ * under the License. */ -export class RoleMappingRuleBase {} +export class DataStream { + hidden?: boolean +} diff --git a/specification/indices/_types/DataStreamStatus.ts b/specification/indices/_types/DataStreamStatus.ts index 481bdde02b..1f95ee5b23 100644 --- a/specification/indices/_types/DataStreamStatus.ts +++ b/specification/indices/_types/DataStreamStatus.ts @@ -22,15 +22,9 @@ */ export enum DataStreamHealthStatus { /** All shards are assigned. */ - GREEN = 0, - /** All shards are assigned. */ - green = 1, - /** All primary shards are assigned, but one or more replica shards are unassigned. */ - YELLOW = 2, + green, /** All primary shards are assigned, but one or more replica shards are unassigned. */ - yellow = 3, - /** One or more primary shards are unassigned, so some data is unavailable. */ - RED = 4, + yellow, /** One or more primary shards are unassigned, so some data is unavailable. */ - red = 5 + red } diff --git a/specification/indices/_types/IndexRouting.ts b/specification/indices/_types/IndexRouting.ts index 3c68a512c2..16f5e9235a 100644 --- a/specification/indices/_types/IndexRouting.ts +++ b/specification/indices/_types/IndexRouting.ts @@ -58,6 +58,7 @@ export class IndexRoutingAllocationInitialRecovery { _id?: Id } +// ES: DiskThresholdSettings export class IndexRoutingAllocationDisk { - threshold_enabled: boolean | string + threshold_enabled?: boolean | string } diff --git a/specification/indices/_types/IndexSegmentSort.ts b/specification/indices/_types/IndexSegmentSort.ts new file mode 100644 index 0000000000..6b96328f11 --- /dev/null +++ b/specification/indices/_types/IndexSegmentSort.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Fields } from '@_types/common' + +export class IndexSegmentSort { + field: Fields + order: SegmentSortOrder | SegmentSortOrder[] + mode?: SegmentSortMode | SegmentSortMode[] + missing?: SegmentSortMissing | SegmentSortMissing[] +} + +export enum SegmentSortOrder { + asc, + desc +} + +export enum SegmentSortMode { + min, + max +} + +export enum SegmentSortMissing { + /** @codegen_name last */ + '_last', + /** @codegen_name first */ + '_first' +} diff --git a/specification/indices/_types/IndexSettings.ts b/specification/indices/_types/IndexSettings.ts index c64d5e3075..0a7459e42d 100644 --- a/specification/indices/_types/IndexSettings.ts +++ b/specification/indices/_types/IndexSettings.ts @@ -19,22 +19,83 @@ import { IndexRouting } from '@indices/_types/IndexRouting' import { Dictionary } from '@spec_utils/Dictionary' +import { Analyzer } from '@_types/analysis/analyzers' +import { TokenFilter } from '@_types/analysis/token_filters' import { CharFilter } from '@_types/analysis/char_filters' -import { Name, PipelineName, Uuid, VersionString } from '@_types/common' -import { integer } from '@_types/Numeric' +import { Normalizer } from '@_types/analysis/normalizers' +import { + ByteSize, + Name, + PipelineName, + Uuid, + VersionString +} from '@_types/common' +import { integer, long } from '@_types/Numeric' import { DateString, Time } from '@_types/Time' +import { Tokenizer } from '@_types/analysis/tokenizers' +import { IndexSegmentSort } from './IndexSegmentSort' +import { + DFIIndependenceMeasure, + DFRAfterEffect, + DFRBasicModel, + IBDistribution, + IBLambda, + Normalization +} from '@_types/Similarity' +import { Script } from '@_types/Scripting' +import { Stringified } from '@spec_utils/Stringified' +import { AdditionalProperties } from '@spec_utils/behaviors' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' + +export class SoftDeletes { + /** + * Indicates whether soft deletes are enabled on the index. + * @server_default true + */ + enabled?: boolean + /** + * The maximum period to retain a shard history retention lease before it is considered expired. + * Shard history retention leases ensure that soft deletes are retained during merges on the Lucene + * index. If a soft delete is merged away before it can be replicated to a follower the following + * process will fail due to incomplete history on the leader. + */ + retention_lease?: RetentionLease +} + +export class RetentionLease { + period: Time +} /** - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/7.8/index-modules.html#index-modules-settings + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index-modules.html#index-modules-settings */ -export class IndexSettings { +export class IndexSettings + implements AdditionalProperties +{ + index?: IndexSettings /** - * server_default 1 + * @aliases index.mode + */ + mode?: string + /** + * @aliases index.routing_path + */ + routing_path?: string[] + /** + * @aliases index.soft_deletes + */ + soft_deletes?: SoftDeletes + /** + * @aliases index.sort + */ + sort?: IndexSegmentSort + /** + * @server_default 1 * @aliases index.number_of_shards */ number_of_shards?: integer | string // TODO: should be only int /** - * server_default 0 + * @server_default 0 * @aliases index.number_of_replicas */ number_of_replicas?: integer | string // TODO: should be only int @@ -53,10 +114,11 @@ export class IndexSettings { */ codec?: string /** - * server_default 1 + * @server_default 1 * @aliases index.routing_partition_size */ - routing_partition_size?: integer | string // TODO: should be int only + routing_partition_size?: integer + /** * @aliases index.soft_deletes.retention_lease.period * @server_default 12h @@ -68,7 +130,7 @@ export class IndexSettings { */ load_fixed_bitset_filters_eagerly?: boolean /** - * server_default false + * @server_default false * @aliases index.hidden */ hidden?: boolean | string // TODO should be bool only @@ -77,6 +139,10 @@ export class IndexSettings { * @server_default false */ auto_expand_replicas?: string + /** + * @aliases index.merge.scheduler.max_thread_count + */ + 'merge.scheduler.max_thread_count'?: integer /** * @aliases index.search.idle.after * @server_default 30s @@ -126,6 +192,16 @@ export class IndexSettings { * @aliases index.blocks */ blocks?: IndexSettingBlocks + /** @aliases index.blocks.read_only */ + 'blocks.read_only'?: boolean + /** @aliases index.blocks.read_only_allow_delete */ + 'blocks.read_only_allow_delete'?: boolean + /** @aliases index.blocks.read */ + 'blocks.read'?: boolean + /** @aliases index.blocks.write */ + 'blocks.write'?: boolean | string // TODO: should be bool only + /** @aliases index.blocks.metadata */ + 'blocks.metadata'?: boolean /** * @aliases index.max_refresh_listeners */ @@ -173,6 +249,10 @@ export class IndexSettings { * @aliases index.lifecycle */ lifecycle?: IndexSettingsLifecycle + /** + * @aliases index.lifecycle.name + */ + 'lifecycle.name'?: string /** * @aliases index.provided_name */ @@ -192,7 +272,7 @@ export class IndexSettings { /** * @aliases index.verified_before_close */ - verified_before_close?: boolean | string // TODO should be bool only + verified_before_close?: boolean /** * @aliases index.format */ @@ -201,14 +281,11 @@ export class IndexSettings { * @aliases index.max_slices_per_scroll */ max_slices_per_scroll?: integer - /** - * @aliases index.translog.durability - */ - 'translog.durability'?: string + translog?: Translog /** * @aliases index.query_string.lenient */ - 'query_string.lenient'?: boolean | string // TODO: should be bool only + 'query_string.lenient'?: boolean /** * @aliases index.priority */ @@ -216,36 +293,304 @@ export class IndexSettings { top_metrics_max_size?: integer + /** + * @aliases index.analysis + */ analysis?: IndexSettingsAnalysis + settings?: IndexSettings + /** + * Enable or disable dynamic mapping for an index. + */ + mapping?: MappingLimitSettings + 'indexing.slowlog'?: SlowlogSettings + /** + * Configure indexing back pressure limits. + */ + indexing_pressure?: IndexingPressure + /** + * The store module allows you to control how index data is stored and accessed on disk. + */ + store?: Storage } export class IndexSettingBlocks { - /** @aliases index.blocks.read_only */ read_only?: boolean - /** @aliases index.blocks.read_only_allow_delete */ read_only_allow_delete?: boolean - /** @aliases index.blocks.read */ read?: boolean - /** @aliases index.blocks.write */ write?: boolean | string // TODO: should be bool only - /** @aliases index.blocks.metadata */ metadata?: boolean } +/** + * @es_quirk This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false. + */ export enum IndexCheckOnStartup { - false = 0, - checksum = 1, - true = 2 + true, + false, + checksum } export class IndexVersioning { - created: VersionString + created?: VersionString } export class IndexSettingsLifecycle { + /** + * The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. + */ name: Name + /** + * Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. + * You can explicitly set it to skip rollover. + * @server_default false + */ + indexing_complete?: boolean + /** + * If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting + * if you create a new index that contains old data and want to use the original creation date to calculate the index + * age. Specified as a Unix epoch value in milliseconds. + * @server_default + */ + origination_date?: long + /** + * Set to true to parse the origination date from the index name. This origination date is used to calculate the index age + * for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is + * yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, + * for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + */ + parse_origination_date?: boolean + step?: IndexSettingsLifecycleStep + /** + * The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. + * When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more + * information about rolling indices, see Rollover. + * @server_default + */ + rollover_alias?: string +} + +export class IndexSettingsLifecycleStep { + /** + * Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). + * See Shard allocation for shrink. + */ + wait_time_threshold?: Time } export class IndexSettingsAnalysis { + analyzer?: Dictionary char_filter?: Dictionary + filter?: Dictionary + normalizer?: Dictionary + tokenizer?: Dictionary +} + +export class Translog { + /** + * How often the translog is fsynced to disk and committed, regardless of write operations. + * Values less than 100ms are not allowed. + * @server_default 5s + */ + sync_interval?: Time + /** + * Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. + * @server_default string + */ + durability?: TranslogDurability + /** + * The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not + * part of a Lucene commit point). Although these operations are available for reads, they will need + * to be replayed if the shard was stopped and had to be recovered. This setting controls the + * maximum total size of these operations, to prevent recoveries from taking too long. Once the + * maximum size has been reached a flush will happen, generating a new Lucene commit point. + * @server_default 512mb + */ + flush_threshold_size?: ByteSize + retention?: TranslogRetention +} + +export enum TranslogDurability { + /** + * (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes + * will already have been committed to disk. + * + * @aliases REQUEST + */ + request, + /** + * fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes + * since the last automatic commit will be discarded. + * + * @aliases ASYNC + */ + async +} + +export class TranslogRetention { + /** + * This controls the total size of translog files to keep for each shard. Keeping more translog files increases + * the chance of performing an operation based sync when recovering a replica. If the translog files are not + * sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be + * set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch + * versions 7.0.0 and later. + * @server_default 512mb + */ + size?: ByteSize + /** + * This controls the maximum duration for which translog files are kept by each shard. Keeping more + * translog files increases the chance of performing an operation based sync when recovering replicas. If + * the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting + * is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in + * indices created in Elasticsearch versions 7.0.0 and later. + * @server_default 12h + */ + age?: Time +} + +/** + * Mapping Limit Settings + * @doc_id mapping-settings-limit + */ +export class MappingLimitSettings { + coerce?: boolean + total_fields?: MappingLimitSettingsTotalFields + depth?: MappingLimitSettingsDepth + nested_fields?: MappingLimitSettingsNestedFields + nested_objects?: MappingLimitSettingsNestedObjects + field_name_length?: MappingLimitSettingsFieldNameLength + dimension_fields?: MappingLimitSettingsDimensionFields + ignore_malformed?: boolean +} + +export class MappingLimitSettingsTotalFields { + /** + * The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. + * The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance + * degradations and memory issues, especially in clusters with a high load or few resources. + * @server_default 1000 + */ + limit?: integer +} + +export class MappingLimitSettingsDepth { + /** + * The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined + * at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + * @server_default 20 + */ + limit?: integer +} + +export class MappingLimitSettingsNestedFields { + /** + * The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when + * arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this + * setting limits the number of unique nested types per index. + * @server_default 50 + */ + limit?: integer +} + +export class MappingLimitSettingsNestedObjects { + /** + * The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps + * to prevent out of memory errors when a document contains too many nested objects. + * @server_default 10000 + */ + limit?: integer +} + +export class MappingLimitSettingsFieldNameLength { + /** + * Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but + * might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + * default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). + */ + limit?: long +} + +export class MappingLimitSettingsDimensionFields { + /** + * [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will + * apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + */ + limit?: integer +} + +export class SlowlogSettings { + level?: string + source?: integer + reformat?: boolean + threshold?: SlowlogTresholds +} + +export class SlowlogTresholds { + query?: SlowlogTresholdLevels + fetch?: SlowlogTresholdLevels + /** + * The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`. + * Log and the thresholds are configured in the same way as the search slowlog. + * @doc_id index-modules-slowlog-slowlog + */ + index?: SlowlogTresholdLevels +} + +export class SlowlogTresholdLevels { + warn?: Time + info?: Time + debug?: Time + trace?: Time +} + +export class Storage { + type: StorageType + /** + * You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. + * This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + * setting is useful, for example, if you are in an environment where you can not control the ability to create a lot + * of memory maps so you need disable the ability to use memory-mapping. + */ + allow_mmap?: boolean +} + +export enum StorageType { + /** + * Default file system implementation. This will pick the best implementation depending on the operating environment, which + * is currently hybridfs on all supported systems but is subject to change. + * + * @aliases '' + */ + fs, + /** + * The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple + * threads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java + * implementation and disables some optimizations for heap memory usage. + */ + niofs, + /** + * The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into + * memory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size + * of the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space. + */ + mmapfs, + /** + * The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file + * based on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory + * mapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed + * plenty of virtual address space. + */ + hybridfs +} + +export class IndexingPressure { + memory: IndexingPressureMemory +} + +export class IndexingPressureMemory { + /** + * Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, + * the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, + * the node will reject new replica operations. Defaults to 10% of the heap. + */ + limit?: integer } diff --git a/specification/indices/_types/IndexState.ts b/specification/indices/_types/IndexState.ts index c1f02b5ae2..ca1d6d4f41 100644 --- a/specification/indices/_types/IndexState.ts +++ b/specification/indices/_types/IndexState.ts @@ -18,7 +18,7 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { IndexName } from '@_types/common' +import { DataStreamName, IndexName } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' import { Alias } from './Alias' import { IndexSettings } from './IndexSettings' @@ -26,9 +26,8 @@ import { IndexSettings } from './IndexSettings' export class IndexState { aliases?: Dictionary mappings?: TypeMapping - settings: IndexSettings | IndexStatePrefixedSettings -} - -export class IndexStatePrefixedSettings { - index: IndexSettings + settings?: IndexSettings + /** Default settings, included when the request's `include_default` is `true`. */ + defaults?: IndexSettings + data_stream?: DataStreamName } diff --git a/specification/indices/add_block/IndicesAddBlockRequest.ts b/specification/indices/add_block/IndicesAddBlockRequest.ts index 15af3b0ccc..b40e225124 100644 --- a/specification/indices/add_block/IndicesAddBlockRequest.ts +++ b/specification/indices/add_block/IndicesAddBlockRequest.ts @@ -24,21 +24,20 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.add_block * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName block: IndicesBlockOptions } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean // default: true expand_wildcards?: ExpandWildcards // default: open ignore_unavailable?: boolean // default: false master_timeout?: Time // default: 30s timeout?: Time // default: 30s } - body?: {} } export enum IndicesBlockOptions { diff --git a/specification/indices/analyze/IndicesAnalyzeRequest.ts b/specification/indices/analyze/IndicesAnalyzeRequest.ts index 150d047f11..f88dd6b344 100644 --- a/specification/indices/analyze/IndicesAnalyzeRequest.ts +++ b/specification/indices/analyze/IndicesAnalyzeRequest.ts @@ -27,22 +27,21 @@ import { TextToAnalyze } from './types' /** * @rest_spec_name indices.analyze * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: IndexName } - query_parameters?: {} - body?: { + body: { analyzer?: string attributes?: string[] - char_filter?: Array + char_filter?: Array explain?: boolean field?: Field - filter?: Array + filter?: Array normalizer?: string text?: TextToAnalyze - tokenizer?: string | Tokenizer + tokenizer?: Tokenizer } } diff --git a/specification/indices/analyze/types.ts b/specification/indices/analyze/types.ts index cf04f9a3d4..27b8f7f492 100644 --- a/specification/indices/analyze/types.ts +++ b/specification/indices/analyze/types.ts @@ -18,6 +18,8 @@ */ import { long } from '@_types/Numeric' +import { AdditionalProperties } from '@spec_utils/behaviors' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class AnalyzeDetail { analyzer?: AnalyzerDetail @@ -35,7 +37,7 @@ export class AnalyzerDetail { export class AnalyzeToken { end_offset: long position: long - position_length?: long + positionLength?: long start_offset: long token: string type: string @@ -46,7 +48,10 @@ export class CharFilterDetail { name: string } -export class ExplainAnalyzeToken { +// Additional properties are attributes that can be set by plugin-defined tokenizers +export class ExplainAnalyzeToken + implements AdditionalProperties +{ bytes: string end_offset: long keyword?: boolean diff --git a/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts b/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts index 1f6ab9e9f6..c7451b60d9 100644 --- a/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts +++ b/specification/indices/clear_cache/IndicesIndicesClearCacheRequest.ts @@ -23,13 +23,13 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common' /** * @rest_spec_name indices.clear_cache * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards fielddata?: boolean @@ -38,5 +38,4 @@ export interface Request extends RequestBase { query?: boolean request?: boolean } - body?: {} } diff --git a/specification/indices/clone/IndicesCloneRequest.ts b/specification/indices/clone/IndicesCloneRequest.ts index 53aa097b83..f60ac2ea07 100644 --- a/specification/indices/clone/IndicesCloneRequest.ts +++ b/specification/indices/clone/IndicesCloneRequest.ts @@ -27,19 +27,19 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.clone * @since 7.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName target: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: { + body: { aliases?: Dictionary settings?: Dictionary } diff --git a/specification/indices/close/CloseIndexRequest.ts b/specification/indices/close/CloseIndexRequest.ts index 9a4b36bf82..97c9d88528 100644 --- a/specification/indices/close/CloseIndexRequest.ts +++ b/specification/indices/close/CloseIndexRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.close * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -38,5 +38,4 @@ export interface Request extends RequestBase { timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: {} } diff --git a/specification/indices/create/IndicesCreateRequest.ts b/specification/indices/create/IndicesCreateRequest.ts index 4e9b4e6984..ae08cd25a9 100644 --- a/specification/indices/create/IndicesCreateRequest.ts +++ b/specification/indices/create/IndicesCreateRequest.ts @@ -18,31 +18,40 @@ */ import { Alias } from '@indices/_types/Alias' +import { IndexSettings } from '@indices/_types/IndexSettings' import { Dictionary } from '@spec_utils/Dictionary' -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { RequestBase } from '@_types/Base' -import { IndexName, WaitForActiveShards } from '@_types/common' +import { IndexName, Name, WaitForActiveShards } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' import { Time } from '@_types/Time' /** * @rest_spec_name indices.create * @since 0.0.0 - * @stability TODO + * @stability stable + * @index_privileges create_index, manage */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - query_parameters?: { + query_parameters: { include_type_name?: boolean master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: { - aliases?: Dictionary - mappings?: Dictionary | TypeMapping - settings?: Dictionary + body: { + /* Aliases for the index. */ + aliases?: Dictionary + /** + * Mapping for fields in the index. If specified, this mapping can include: + * - Field names + * - Field data types + * - Mapping parameters + */ + mappings?: TypeMapping + /* Configuration options for the index. */ + settings?: IndexSettings } } diff --git a/specification/indices/create/IndicesCreateResponse.ts b/specification/indices/create/IndicesCreateResponse.ts index 7ca919e7a5..67fe73fe11 100644 --- a/specification/indices/create/IndicesCreateResponse.ts +++ b/specification/indices/create/IndicesCreateResponse.ts @@ -17,12 +17,12 @@ * under the License. */ -import { AcknowledgedResponseBase } from '@_types/Base' import { IndexName } from '@_types/common' -export class Response extends AcknowledgedResponseBase { +export class Response { body: { index: IndexName shards_acknowledged: boolean + acknowledged: boolean } } diff --git a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts index 3f52a59d3a..3bf0cb2942 100644 --- a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts +++ b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts @@ -23,12 +23,10 @@ import { DataStreamName } from '@_types/common' /** * @rest_spec_name indices.create_data_stream * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: DataStreamName } - query_parameters?: {} - body?: {} } diff --git a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts index 379e02c9b8..5464be0e66 100644 --- a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts +++ b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts @@ -23,14 +23,13 @@ import { ExpandWildcards, IndexName } from '@_types/common' /** * @rest_spec_name indices.data_streams_stats * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: IndexName } - query_parameters?: { + query_parameters: { expand_wildcards?: ExpandWildcards // default: open } - body?: {} } diff --git a/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts b/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts index 6c0811ddcc..09731af121 100644 --- a/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts +++ b/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts @@ -18,7 +18,7 @@ */ import { ByteSize, Name } from '@_types/common' -import { integer } from '@_types/Numeric' +import { integer, long } from '@_types/Numeric' import { ShardStatistics } from '@_types/Stats' export class Response { @@ -37,5 +37,5 @@ export class DataStreamsStatsItem { data_stream: Name store_size?: ByteSize store_size_bytes: integer - maximum_timestamp: integer + maximum_timestamp: long } diff --git a/specification/indices/delete/IndicesDeleteRequest.ts b/specification/indices/delete/IndicesDeleteRequest.ts index 492db6b441..9ef3617750 100644 --- a/specification/indices/delete/IndicesDeleteRequest.ts +++ b/specification/indices/delete/IndicesDeleteRequest.ts @@ -24,18 +24,17 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.delete * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean master_timeout?: Time timeout?: Time } - body?: {} } diff --git a/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts b/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts index d3cc2ae06d..1ff663e5f9 100644 --- a/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts +++ b/specification/indices/delete_alias/IndicesDeleteAliasRequest.ts @@ -24,16 +24,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.delete_alias * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices name: Names } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: {} } diff --git a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts index 271b081c8d..276d5ed1bd 100644 --- a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts +++ b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts @@ -18,17 +18,18 @@ */ import { RequestBase } from '@_types/Base' -import { DataStreamName } from '@_types/common' +import { ExpandWildcards, DataStreamNames } from '@_types/common' /** * @rest_spec_name indices.delete_data_stream * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - name: DataStreamName + path_parts: { + name: DataStreamNames + } + query_parameters: { + expand_wildcards?: ExpandWildcards } - query_parameters?: {} - body?: {} } diff --git a/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts b/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts index ad80ba25f1..cb953ba8f8 100644 --- a/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts +++ b/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts @@ -18,15 +18,35 @@ */ import { RequestBase } from '@_types/Base' -import { Name } from '@_types/common' +import { Names } from '@_types/common' +import { Time } from '@_types/Time' /** + * The provided may contain multiple template names separated by a comma. If multiple template + * names are specified then there is no wildcard support and the provided names should match completely with + * existing templates. * @rest_spec_name indices.delete_index_template * @since 7.8.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_index_templates,manage */ export interface Request extends RequestBase { path_parts: { - name: Name + /** + * Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + */ + name: Names + } + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time } } diff --git a/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts b/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts index b3322a66a4..315f8b6141 100644 --- a/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts +++ b/specification/indices/delete_template/IndicesDeleteTemplateRequest.ts @@ -24,15 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.delete_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: {} } diff --git a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts new file mode 100644 index 0000000000..8603a3a81f --- /dev/null +++ b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts @@ -0,0 +1,77 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { ExpandWildcards, IndexName, Indices } from '@_types/common' +import { TimeUnit } from '@_types/Time' + +/** + * @rest_spec_name indices.disk_usage + * @since 7.15.0 + * @stability experimental + */ +export interface Request extends RequestBase { + path_parts: { + /** + * Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. + */ + index: IndexName + } + query_parameters?: { + /** + * If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + * @server_default true + */ + allow_no_indices?: boolean + /** + * Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. + * @server_default open + */ + expand_wildcards?: ExpandWildcards + /** + * If true, the API performs a flush before analysis. If false, the response may not include uncommitted data. + * @server_default true + */ + flush?: boolean + /** + * If true, missing or closed indices are not included in the response. + * @server_default false + */ + ignore_unavailable?: boolean + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: TimeUnit + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: TimeUnit + /** + * Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true. + * @server_default false + */ + run_expensive_tasks?: boolean + /** + * The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard. + */ + wait_for_active_shards?: string + } +} diff --git a/specification/autoscaling/policy_put/PutAutoscalingPolicyResponse.ts b/specification/indices/disk_usage/IndicesDiskUsageResponse.ts similarity index 90% rename from specification/autoscaling/policy_put/PutAutoscalingPolicyResponse.ts rename to specification/indices/disk_usage/IndicesDiskUsageResponse.ts index 25b5bd6764..f4ed729ed2 100644 --- a/specification/autoscaling/policy_put/PutAutoscalingPolicyResponse.ts +++ b/specification/indices/disk_usage/IndicesDiskUsageResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { - body: { stub: integer } + body: UserDefinedValue } diff --git a/specification/indices/exists/IndicesExistsRequest.ts b/specification/indices/exists/IndicesExistsRequest.ts index 33cd07ad96..a0840a69d7 100644 --- a/specification/indices/exists/IndicesExistsRequest.ts +++ b/specification/indices/exists/IndicesExistsRequest.ts @@ -23,13 +23,13 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.exists * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean @@ -37,5 +37,4 @@ export interface Request extends RequestBase { include_defaults?: boolean local?: boolean } - body?: {} } diff --git a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts index f43ff6c6b6..5bd0668f86 100644 --- a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts +++ b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts @@ -23,18 +23,17 @@ import { ExpandWildcards, Indices, Names } from '@_types/common' /** * @rest_spec_name indices.exists_alias * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Names index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean local?: boolean } - body?: {} } diff --git a/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts b/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts index ea3734310f..762c9511dc 100644 --- a/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts +++ b/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts @@ -24,14 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.exists_index_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { /** Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. */ name: Name } - query_parameters?: { + query_parameters: { /** * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s diff --git a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts index f5b235e2d6..2642b4a9dc 100644 --- a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts +++ b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts @@ -24,16 +24,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.exists_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Names } - query_parameters?: { + query_parameters: { flat_settings?: boolean local?: boolean master_timeout?: Time } - body?: {} } diff --git a/specification/indices/exists_type/IndicesExistsTypeRequest.ts b/specification/indices/exists_type/IndicesExistsTypeRequest.ts index 53de6a1620..7c22ad8812 100644 --- a/specification/indices/exists_type/IndicesExistsTypeRequest.ts +++ b/specification/indices/exists_type/IndicesExistsTypeRequest.ts @@ -23,18 +23,18 @@ import { ExpandWildcards, Indices, Types } from '@_types/common' /** * @rest_spec_name indices.exists_type * @since 0.0.0 - * @stability TODO + * @stability stable + * @deprecated 7.0.0 */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices type: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean local?: boolean } - body?: {} } diff --git a/specification/indices/flush/IndicesFlushRequest.ts b/specification/indices/flush/IndicesFlushRequest.ts index ee33fbb6df..0c1d7de1dc 100644 --- a/specification/indices/flush/IndicesFlushRequest.ts +++ b/specification/indices/flush/IndicesFlushRequest.ts @@ -23,18 +23,17 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.flush * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards force?: boolean ignore_unavailable?: boolean wait_if_ongoing?: boolean } - body?: {} } diff --git a/specification/indices/flush_synced/IndicesFlushSyncedRequest.ts b/specification/indices/flush_synced/IndicesFlushSyncedRequest.ts index 506a5b9425..3b146e6feb 100644 --- a/specification/indices/flush_synced/IndicesFlushSyncedRequest.ts +++ b/specification/indices/flush_synced/IndicesFlushSyncedRequest.ts @@ -23,7 +23,7 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.flush_synced * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts?: { @@ -34,5 +34,4 @@ export interface Request extends RequestBase { expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean } - body?: {} } diff --git a/specification/indices/forcemerge/IndicesForceMergeRequest.ts b/specification/indices/forcemerge/IndicesForceMergeRequest.ts index 90dab1bb8e..c96c000819 100644 --- a/specification/indices/forcemerge/IndicesForceMergeRequest.ts +++ b/specification/indices/forcemerge/IndicesForceMergeRequest.ts @@ -24,13 +24,13 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name indices.forcemerge * @since 2.1.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flush?: boolean @@ -38,5 +38,4 @@ export interface Request extends RequestBase { max_num_segments?: long only_expunge_deletes?: boolean } - body?: {} } diff --git a/specification/indices/freeze/IndicesFreezeRequest.ts b/specification/indices/freeze/IndicesFreezeRequest.ts index 24a0673536..be93357884 100644 --- a/specification/indices/freeze/IndicesFreezeRequest.ts +++ b/specification/indices/freeze/IndicesFreezeRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.freeze * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -38,5 +38,4 @@ export interface Request extends RequestBase { timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: {} } diff --git a/specification/indices/get/IndicesGetRequest.ts b/specification/indices/get/IndicesGetRequest.ts index 6e2b13c49c..c40b45b158 100644 --- a/specification/indices/get/IndicesGetRequest.ts +++ b/specification/indices/get/IndicesGetRequest.ts @@ -24,14 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.get * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. */ index: Indices } - query_parameters?: { + query_parameters: { /** @server_default true */ allow_no_indices?: boolean /** @@ -70,5 +70,4 @@ export interface Request extends RequestBase { */ master_timeout?: Time } - body?: {} } diff --git a/specification/indices/get_alias/IndicesGetAliasRequest.ts b/specification/indices/get_alias/IndicesGetAliasRequest.ts index a832083346..0d4256973e 100644 --- a/specification/indices/get_alias/IndicesGetAliasRequest.ts +++ b/specification/indices/get_alias/IndicesGetAliasRequest.ts @@ -23,18 +23,17 @@ import { ExpandWildcards, Indices, Names } from '@_types/common' /** * @rest_spec_name indices.get_alias * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: Names index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean local?: boolean } - body?: {} } diff --git a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts index 21264d1dfb..cde4fd6872 100644 --- a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts +++ b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts @@ -18,18 +18,18 @@ */ import { RequestBase } from '@_types/Base' -import { ExpandWildcards, IndexName } from '@_types/common' +import { ExpandWildcards, DataStreamNames } from '@_types/common' /** * @rest_spec_name indices.get_data_stream * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - name?: IndexName + path_parts: { + name?: DataStreamNames } - query_parameters?: { + query_parameters: { expand_wildcards?: ExpandWildcards } } diff --git a/specification/indices/get_data_stream/IndicesGetDataStreamResponse.ts b/specification/indices/get_data_stream/IndicesGetDataStreamResponse.ts index ea6a7fac5b..8620b92f49 100644 --- a/specification/indices/get_data_stream/IndicesGetDataStreamResponse.ts +++ b/specification/indices/get_data_stream/IndicesGetDataStreamResponse.ts @@ -17,10 +17,10 @@ * under the License. */ -import { DataStreamHealthStatus } from '@indices/_types/DataStreamStatus' import { DataStreamName, Field, + HealthStatus, IndexName, Metadata, Name, @@ -41,7 +41,7 @@ export class IndicesGetDataStreamItem { hidden: boolean /** @since 7.10.0 */ system?: boolean - status: DataStreamHealthStatus + status: HealthStatus ilm_policy?: Name /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html */ _meta?: Metadata diff --git a/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts b/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts index 04c0821a8b..7d0e2c6753 100644 --- a/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts +++ b/specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts @@ -23,15 +23,15 @@ import { ExpandWildcards, Fields, Indices, Types } from '@_types/common' /** * @rest_spec_name indices.get_field_mapping * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { fields: Fields index?: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -39,5 +39,4 @@ export interface Request extends RequestBase { include_type_name?: boolean local?: boolean } - body?: {} } diff --git a/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts b/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts index 57c9545776..cb58fd453a 100644 --- a/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts +++ b/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts @@ -24,21 +24,19 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.get_index_template * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. */ name?: Name } - query_parameters?: { + query_parameters: { /** * If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. * @server_default false */ local?: boolean - } - body?: { /** * If true, returns settings in flat format. * @server_default false diff --git a/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts b/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts index 1bcfd917d9..76bfa937fa 100644 --- a/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts +++ b/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts @@ -38,7 +38,7 @@ export class IndexTemplateItem { export class IndexTemplate { index_patterns: Name[] composed_of: Name[] - template: IndexTemplateSummary + template?: IndexTemplateSummary version?: VersionNumber priority?: long /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html */ diff --git a/specification/indices/get_mapping/IndicesGetMappingRequest.ts b/specification/indices/get_mapping/IndicesGetMappingRequest.ts index db3e464833..d623ee048c 100644 --- a/specification/indices/get_mapping/IndicesGetMappingRequest.ts +++ b/specification/indices/get_mapping/IndicesGetMappingRequest.ts @@ -24,14 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.get_mapping * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -39,5 +39,4 @@ export interface Request extends RequestBase { local?: boolean master_timeout?: Time } - body?: {} } diff --git a/specification/indices/get_settings/IndicesGetSettingsRequest.ts b/specification/indices/get_settings/IndicesGetSettingsRequest.ts index c0add2b007..16f2ac2724 100644 --- a/specification/indices/get_settings/IndicesGetSettingsRequest.ts +++ b/specification/indices/get_settings/IndicesGetSettingsRequest.ts @@ -24,14 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.get_settings * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices name?: Names } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean @@ -40,5 +40,4 @@ export interface Request extends RequestBase { local?: boolean master_timeout?: Time } - body?: {} } diff --git a/specification/indices/get_template/IndicesGetTemplateRequest.ts b/specification/indices/get_template/IndicesGetTemplateRequest.ts index d9350ccaef..ac20fd0ac0 100644 --- a/specification/indices/get_template/IndicesGetTemplateRequest.ts +++ b/specification/indices/get_template/IndicesGetTemplateRequest.ts @@ -24,17 +24,16 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.get_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: Names } - query_parameters?: { + query_parameters: { flat_settings?: boolean include_type_name?: boolean local?: boolean master_timeout?: Time } - body?: {} } diff --git a/specification/indices/get_upgrade/IndicesGetUpgradeRequest.ts b/specification/indices/get_upgrade/IndicesGetUpgradeRequest.ts index 0cf8c3e1ff..7b84f7c64a 100644 --- a/specification/indices/get_upgrade/IndicesGetUpgradeRequest.ts +++ b/specification/indices/get_upgrade/IndicesGetUpgradeRequest.ts @@ -18,15 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { IndexName } from '@_types/common' /** * @rest_spec_name indices.get_upgrade * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { - stub: string + index?: IndexName } - query_parameters?: {} } diff --git a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts index 9dd83f8436..e55f77de40 100644 --- a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts +++ b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts @@ -23,12 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name indices.migrate_to_data_stream * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: IndexName } - query_parameters?: {} - body?: {} } diff --git a/specification/indices/open/IndicesOpenRequest.ts b/specification/indices/open/IndicesOpenRequest.ts index 19b88ef07b..49371693d9 100644 --- a/specification/indices/open/IndicesOpenRequest.ts +++ b/specification/indices/open/IndicesOpenRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.open * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -38,5 +38,4 @@ export interface Request extends RequestBase { timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: {} } diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts index 298d9f1a7e..f8c0983fa0 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts @@ -23,12 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name indices.promote_data_stream * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: IndexName } - query_parameters?: {} - body?: {} } diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts index 25b5bd6764..f4ed729ed2 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { - body: { stub: integer } + body: UserDefinedValue } diff --git a/specification/indices/put_alias/IndicesPutAliasRequest.ts b/specification/indices/put_alias/IndicesPutAliasRequest.ts index b4cf7ece17..58e684f485 100644 --- a/specification/indices/put_alias/IndicesPutAliasRequest.ts +++ b/specification/indices/put_alias/IndicesPutAliasRequest.ts @@ -25,18 +25,18 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.put_alias * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices name: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: { + body: { filter?: QueryContainer index_routing?: Routing is_write_index?: boolean diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts index 9935d28f34..54c0ec2016 100644 --- a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts +++ b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts @@ -18,11 +18,11 @@ */ import { Alias } from '@indices/_types/Alias' +import { DataStream } from '@indices/_types/DataStream' import { IndexSettings } from '@indices/_types/IndexSettings' import { Dictionary } from '@spec_utils/Dictionary' import { RequestBase } from '@_types/Base' import { - EmptyObject, IndexName, Indices, Metadata, @@ -35,18 +35,18 @@ import { integer } from '@_types/Numeric' /** * @rest_spec_name indices.put_index_template * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { /** Index or template name */ name: Name } - body?: { + body: { index_patterns?: Indices composed_of?: Name[] template?: IndexTemplateMapping - data_stream?: EmptyObject + data_stream?: DataStream priority?: integer version?: VersionNumber /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html */ diff --git a/specification/indices/put_mapping/IndicesPutMappingRequest.ts b/specification/indices/put_mapping/IndicesPutMappingRequest.ts index 722b04628a..81605b69f7 100644 --- a/specification/indices/put_mapping/IndicesPutMappingRequest.ts +++ b/specification/indices/put_mapping/IndicesPutMappingRequest.ts @@ -26,11 +26,8 @@ import { DynamicTemplate } from '@_types/mapping/dynamic-template' import { - AllField, FieldNamesField, - IndexField, RoutingField, - SizeField, SourceField } from '@_types/mapping/meta-fields' import { Property } from '@_types/mapping/Property' @@ -40,14 +37,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.put_mapping * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - index?: Indices + path_parts: { + index: Indices type?: Type } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -56,22 +53,61 @@ export interface Request extends RequestBase { timeout?: Time write_index_only?: boolean } - body?: { - all_field?: AllField + body: { + /** + * Controls whether dynamic date detection is enabled. + */ date_detection?: boolean - dynamic?: boolean | DynamicMapping + /** + * Controls whether new fields are added dynamically. + */ + dynamic?: DynamicMapping + /** + * If date detection is enabled then new string fields are checked + * against 'dynamic_date_formats' and if the value matches then + * a new date field is added instead of string. + */ dynamic_date_formats?: string[] + /** + * Specify dynamic templates for the mapping. + */ dynamic_templates?: | Dictionary | Dictionary[] - field_names_field?: FieldNamesField - index_field?: IndexField - meta?: Dictionary + /** + * Control whether field names are enabled for the index. + */ + _field_names?: FieldNamesField + /** + * A mapping type can have custom meta data associated with it. These are + * not used at all by Elasticsearch, but can be used to store + * application-specific metadata. + */ + _meta?: Dictionary + /** + * Automatically map strings into numeric data types for all fields. + * @server_default false + */ numeric_detection?: boolean + /** + * Mapping for a field. For new fields, this mapping can include: + * + * - Field name + * - Field data type + * - Mapping parameters + */ properties?: Dictionary - routing_field?: RoutingField - size_field?: SizeField - source_field?: SourceField + /** + * Enable making a routing value required on indexed documents. + */ + _routing?: RoutingField + /** + * Control whether the _source field is enabled on the index. + */ + _source?: SourceField + /** + * Mapping of runtime fields for the index. + */ runtime?: RuntimeFields } } diff --git a/specification/indices/put_settings/IndicesPutSettingsRequest.ts b/specification/indices/put_settings/IndicesPutSettingsRequest.ts index 5b81f90cac..88d26dfd68 100644 --- a/specification/indices/put_settings/IndicesPutSettingsRequest.ts +++ b/specification/indices/put_settings/IndicesPutSettingsRequest.ts @@ -25,14 +25,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.put_settings * @since 0.0.0 - * - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards flat_settings?: boolean @@ -41,9 +40,6 @@ export interface Request extends RequestBase { preserve_existing?: boolean timeout?: Time } - body: IndexSettingsBody -} - -export class IndexSettingsBody extends IndexSettings { - settings?: IndexSettings + /** @codegen_name settings */ + body: IndexSettings } diff --git a/specification/indices/put_template/IndicesPutTemplateRequest.ts b/specification/indices/put_template/IndicesPutTemplateRequest.ts index 74e4c87771..f920aebdc6 100644 --- a/specification/indices/put_template/IndicesPutTemplateRequest.ts +++ b/specification/indices/put_template/IndicesPutTemplateRequest.ts @@ -29,25 +29,66 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.put_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } - query_parameters?: { + query_parameters: { + /** + * If true, this request cannot replace or update existing index templates. + * @server_default false + */ create?: boolean flat_settings?: boolean include_type_name?: boolean + /** + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ master_timeout?: Time timeout?: Time + /** + * Order in which Elasticsearch applies this template if index + * matches multiple templates. + * + * Templates with lower 'order' values are merged first. Templates with higher + * 'order' values are merged later, overriding templates with lower values. + */ + order?: integer } - body?: { + body: { + /** + * Aliases for the index. + */ aliases?: Dictionary + /** + * Array of wildcard expressions used to match the names + * of indices during creation. + */ index_patterns?: string | string[] + /** + * Mapping for fields in the index. + */ mappings?: TypeMapping + /** + * Order in which Elasticsearch applies this template if index + * matches multiple templates. + * + * Templates with lower 'order' values are merged first. Templates with higher + * 'order' values are merged later, overriding templates with lower values. + */ order?: integer + /** + * Configuration options for the index. + */ settings?: Dictionary + /** + * Version number used to manage index templates externally. This number + * is not automatically generated by Elasticsearch. + */ version?: VersionNumber } } diff --git a/specification/indices/recovery/IndicesRecoveryRequest.ts b/specification/indices/recovery/IndicesRecoveryRequest.ts index ae9eb45785..9e0f312bac 100644 --- a/specification/indices/recovery/IndicesRecoveryRequest.ts +++ b/specification/indices/recovery/IndicesRecoveryRequest.ts @@ -23,15 +23,14 @@ import { Indices } from '@_types/common' /** * @rest_spec_name indices.recovery * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { active_only?: boolean detailed?: boolean } - body?: {} } diff --git a/specification/indices/recovery/types.ts b/specification/indices/recovery/types.ts index cfbac724e4..2388eb86a1 100644 --- a/specification/indices/recovery/types.ts +++ b/specification/indices/recovery/types.ts @@ -34,6 +34,8 @@ export class RecoveryBytes { percent: Percentage recovered?: ByteSize recovered_in_bytes: ByteSize + recovered_from_snapshot?: ByteSize + recovered_from_snapshot_in_bytes?: ByteSize reused?: ByteSize reused_in_bytes: ByteSize total?: ByteSize @@ -116,7 +118,7 @@ export class ShardRecovery { start_time?: DateString start_time_in_millis: EpochMillis stop_time?: DateString - stop_time_in_millis: EpochMillis + stop_time_in_millis?: EpochMillis target: RecoveryOrigin total_time?: DateString total_time_in_millis: EpochMillis diff --git a/specification/indices/refresh/IndicesRefreshRequest.ts b/specification/indices/refresh/IndicesRefreshRequest.ts index c397a001cf..666bf76410 100644 --- a/specification/indices/refresh/IndicesRefreshRequest.ts +++ b/specification/indices/refresh/IndicesRefreshRequest.ts @@ -23,16 +23,15 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.refresh * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean } - body?: {} } diff --git a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts index 13f327149a..c8502ea1c2 100644 --- a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts +++ b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts @@ -23,16 +23,15 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.reload_search_analyzers * @since 7.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean } - body?: {} } diff --git a/specification/indices/resolve_index/ResolveIndexRequest.ts b/specification/indices/resolve_index/ResolveIndexRequest.ts index 1c985e9294..0d6776494e 100644 --- a/specification/indices/resolve_index/ResolveIndexRequest.ts +++ b/specification/indices/resolve_index/ResolveIndexRequest.ts @@ -23,14 +23,13 @@ import { ExpandWildcards, Names } from '@_types/common' /** * @rest_spec_name indices.resolve_index * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Names } - query_parameters?: { + query_parameters: { expand_wildcards?: ExpandWildcards } - body?: {} } diff --git a/specification/indices/rollover/IndicesRolloverRequest.ts b/specification/indices/rollover/IndicesRolloverRequest.ts index c0670cfd36..d6b98c7e21 100644 --- a/specification/indices/rollover/IndicesRolloverRequest.ts +++ b/specification/indices/rollover/IndicesRolloverRequest.ts @@ -24,29 +24,30 @@ import { RequestBase } from '@_types/Base' import { IndexAlias, IndexName, WaitForActiveShards } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' import { Time } from '@_types/Time' -import { RolloverConditions } from './types' +import { IndexRolloverMapping, RolloverConditions } from './types' /** * @rest_spec_name indices.rollover * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { alias: IndexAlias new_index?: IndexName } - query_parameters?: { + query_parameters: { dry_run?: boolean include_type_name?: boolean master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: { + body: { aliases?: Dictionary conditions?: RolloverConditions - mappings?: Dictionary | TypeMapping + // Mappings is a dictionary if include_type_name is true, which is deprecated in 7.0 and removed in 8.0 + mappings?: IndexRolloverMapping settings?: Dictionary } } diff --git a/specification/indices/rollover/types.ts b/specification/indices/rollover/types.ts index 34b01a6e94..03273ece34 100644 --- a/specification/indices/rollover/types.ts +++ b/specification/indices/rollover/types.ts @@ -20,10 +20,22 @@ import { ByteSize } from '@_types/common' import { long } from '@_types/Numeric' import { Time } from '@_types/Time' +import { TypeMapping } from '@_types/mapping/TypeMapping' +import { Dictionary } from '@spec_utils/Dictionary' export class RolloverConditions { max_age?: Time max_docs?: long - max_size?: string + max_size?: ByteSize + min_size?: ByteSize + max_size_bytes?: ByteSize max_primary_shard_size?: ByteSize + min_primary_shard_size?: ByteSize + max_primary_shard_docs?: long + min_primary_shard_docs?: long } + +/** + * @codegen_names single, by_type + */ +export type IndexRolloverMapping = TypeMapping | Dictionary diff --git a/specification/indices/segments/IndicesSegmentsRequest.ts b/specification/indices/segments/IndicesSegmentsRequest.ts index 997c2ee439..dc3af5af41 100644 --- a/specification/indices/segments/IndicesSegmentsRequest.ts +++ b/specification/indices/segments/IndicesSegmentsRequest.ts @@ -23,17 +23,16 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name indices.segments * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean verbose?: boolean } - body?: {} } diff --git a/specification/indices/shard_stores/IndicesShardStoresRequest.ts b/specification/indices/shard_stores/IndicesShardStoresRequest.ts index e04e0b7eb1..5c008de280 100644 --- a/specification/indices/shard_stores/IndicesShardStoresRequest.ts +++ b/specification/indices/shard_stores/IndicesShardStoresRequest.ts @@ -19,21 +19,41 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices } from '@_types/common' +import { ShardStoreStatus } from './types' /** * @rest_spec_name indices.shard_stores * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * List of data streams, indices, and aliases used to limit the request. + */ index?: Indices } - query_parameters?: { + query_parameters: { + /** + * If false, the request returns an error if any wildcard expression, index alias, or _all + * value targets only missing or closed indices. This behavior applies even if the request + * targets other open indices. + */ allow_no_indices?: boolean + /** + * Type of index that wildcard patterns can match. If the request can target data streams, + * this argument determines whether wildcard expressions match hidden data streams. + * @server_default open + */ expand_wildcards?: ExpandWildcards + /** + * If true, missing or closed indices are not included in the response. + * @server_default false + */ ignore_unavailable?: boolean - status?: string | string[] + /** + * List of shard health statuses used to limit the request. + */ + status?: ShardStoreStatus | ShardStoreStatus[] } - body?: {} } diff --git a/specification/indices/shard_stores/types.ts b/specification/indices/shard_stores/types.ts index 8350cddbfa..ebcb64d167 100644 --- a/specification/indices/shard_stores/types.ts +++ b/specification/indices/shard_stores/types.ts @@ -51,3 +51,14 @@ export class ShardStoreException { export class ShardStoreWrapper { stores: ShardStore[] } + +export enum ShardStoreStatus { + /** The primary shard and all replica shards are assigned. */ + green = 0, + /** One or more replica shards are unassigned. */ + yellow = 1, + /** The primary shard is unassigned. */ + red = 2, + /** Return all shards, regardless of health status. */ + all = 3 +} diff --git a/specification/indices/shrink/IndicesShrinkRequest.ts b/specification/indices/shrink/IndicesShrinkRequest.ts index d44a8159e0..1925e1bf08 100644 --- a/specification/indices/shrink/IndicesShrinkRequest.ts +++ b/specification/indices/shrink/IndicesShrinkRequest.ts @@ -27,19 +27,19 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.shrink * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName target: IndexName } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: { + body: { aliases?: Dictionary settings?: Dictionary } diff --git a/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts b/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts index 02c2bd5c56..8237705894 100644 --- a/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts +++ b/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts @@ -17,26 +17,55 @@ * under the License. */ -import { OverlappingIndexTemplate } from '@indices/_types/OverlappingIndexTemplate' -import { TemplateMapping } from '@indices/_types/TemplateMapping' +import { DataStream } from '@indices/_types/DataStream' import { RequestBase } from '@_types/Base' -import { IndexName, Name } from '@_types/common' +import { + IndexName, + Indices, + Metadata, + Name, + VersionNumber +} from '@_types/common' +import { Time } from '@_types/Time' +import { integer } from '@_types/Numeric' +import { IndexTemplateMapping } from '../put_index_template/IndicesPutIndexTemplateRequest' /** * @rest_spec_name indices.simulate_index_template * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Index or template name to simulate */ - name?: Name + name: Name } - body?: { - index_patterns?: IndexName[] + query_parameters: { + /** + * If `true`, the template passed in the body is only used if no existing + * templates match the same index patterns. If `false`, the simulation uses + * the template with the highest priority. Note that the template is not + * permanently added or updated in either case; it is only used for the + * simulation. + * @server_default false + * */ + create?: boolean + /** + * Period to wait for a connection to the master node. If no response is received + * before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + } + body: { + allow_auto_create?: boolean + index_patterns?: Indices composed_of?: Name[] - /** Any overlapping templates that would have matched, but have lower priority */ - overlapping?: OverlappingIndexTemplate[] - template?: TemplateMapping + template?: IndexTemplateMapping + data_stream?: DataStream + priority?: integer + version?: VersionNumber + /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html */ + _meta?: Metadata } } diff --git a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts index b65cff8bbd..a668d8181b 100644 --- a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts +++ b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts @@ -25,14 +25,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.simulate_template * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body. */ name?: Name } - query_parameters?: { + query_parameters: { /** * If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. * @server_default false @@ -44,5 +44,6 @@ export interface Request extends RequestBase { */ master_timeout?: Time } + /** @codegen_name template */ body?: IndexTemplate } diff --git a/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts b/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts index 38561dcbd2..26e47096b8 100644 --- a/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts +++ b/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts @@ -17,8 +17,26 @@ * under the License. */ +import { Alias } from '@indices/_types/Alias' +import { Dictionary } from '@spec_utils/Dictionary' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { IndexName, Name } from '@_types/common' +import { TypeMapping } from '@_types/mapping/TypeMapping' + export class Response { body: { - stub: string + template: Template } } + +export class Template { + aliases: Dictionary + mappings: TypeMapping + settings: Dictionary + overlapping: Overlapping[] +} + +export class Overlapping { + name: Name + index_patterns: string[] +} diff --git a/specification/indices/split/IndicesSplitRequest.ts b/specification/indices/split/IndicesSplitRequest.ts index 8fe4da2716..1d339cd23c 100644 --- a/specification/indices/split/IndicesSplitRequest.ts +++ b/specification/indices/split/IndicesSplitRequest.ts @@ -27,19 +27,19 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.split * @since 6.1.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName target: IndexName } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time wait_for_active_shards?: WaitForActiveShards } - body?: { + body: { aliases?: Dictionary settings?: Dictionary } diff --git a/specification/indices/stats/IndicesStatsRequest.ts b/specification/indices/stats/IndicesStatsRequest.ts index b17708f390..cb920af499 100644 --- a/specification/indices/stats/IndicesStatsRequest.ts +++ b/specification/indices/stats/IndicesStatsRequest.ts @@ -30,14 +30,14 @@ import { /** * @rest_spec_name indices.stats * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { metric?: Metrics index?: Indices } - query_parameters?: { + query_parameters: { completion_fields?: Fields expand_wildcards?: ExpandWildcards fielddata_fields?: Fields @@ -49,5 +49,4 @@ export interface Request extends RequestBase { level?: Level types?: Types } - body?: {} } diff --git a/specification/indices/stats/types.ts b/specification/indices/stats/types.ts index 0e3c052c9d..3a8e4ae39b 100644 --- a/specification/indices/stats/types.ts +++ b/specification/indices/stats/types.ts @@ -53,6 +53,8 @@ export class IndexStats { get?: GetStats /** Contains statistics about indexing operations for the node. */ indexing?: IndexingStats + /** Contains statistics about indices operations for the node. */ + indices?: IndicesStats /** Contains statistics about merge operations for the node. */ merges?: MergesStats /** Contains statistics about the query cache across all shards assigned to the node. */ @@ -74,12 +76,14 @@ export class IndexStats { /** Contains statistics about index warming operations for the node. */ warmer?: WarmerStats bulk?: BulkStats + /** @since 7.15.0 */ + shard_stats?: ShardsTotalStats } export class IndicesStats { - primaries: IndexStats + primaries?: IndexStats shards?: Dictionary - total: IndexStats + total?: IndexStats uuid?: Uuid } @@ -153,27 +157,35 @@ export class ShardSequenceNumber { max_seq_no: SequenceNumber } +export class ShardsTotalStats { + total_count: long +} + export class ShardStats { - commit: ShardCommit - completion: CompletionStats - docs: DocStats - fielddata: FielddataStats - flush: FlushStats - get: GetStats - indexing: IndexingStats - merges: MergesStats - shard_path: ShardPath - query_cache: ShardQueryCache - recovery: RecoveryStats - refresh: RefreshStats - request_cache: RequestCacheStats - retention_leases: ShardRetentionLeases - routing: ShardRouting - search: SearchStats - segments: SegmentsStats - seq_no: ShardSequenceNumber - store: StoreStats - translog: TranslogStats - warmer: WarmerStats + commit?: ShardCommit + completion?: CompletionStats + docs?: DocStats + fielddata?: FielddataStats + flush?: FlushStats + get?: GetStats + indexing?: IndexingStats + merges?: MergesStats + shard_path?: ShardPath + query_cache?: ShardQueryCache + recovery?: RecoveryStats + refresh?: RefreshStats + request_cache?: RequestCacheStats + retention_leases?: ShardRetentionLeases + routing?: ShardRouting + search?: SearchStats + segments?: SegmentsStats + seq_no?: ShardSequenceNumber + store?: StoreStats + translog?: TranslogStats + warmer?: WarmerStats bulk?: BulkStats + /** @since 7.15.0 */ + shards?: ShardsTotalStats + shard_stats?: ShardsTotalStats + indices?: IndicesStats } diff --git a/specification/indices/unfreeze/IndicesUnfreezeRequest.ts b/specification/indices/unfreeze/IndicesUnfreezeRequest.ts index 216a16880d..c76c1efd0c 100644 --- a/specification/indices/unfreeze/IndicesUnfreezeRequest.ts +++ b/specification/indices/unfreeze/IndicesUnfreezeRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name indices.unfreeze * @since 6.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: IndexName } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_unavailable?: boolean @@ -38,5 +38,4 @@ export interface Request extends RequestBase { timeout?: Time wait_for_active_shards?: string } - body?: {} } diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesBulkRequest.ts b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts similarity index 88% rename from specification/indices/update_aliases/IndicesUpdateAliasesBulkRequest.ts rename to specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts index eaedd84689..1ed567d262 100644 --- a/specification/indices/update_aliases/IndicesUpdateAliasesBulkRequest.ts +++ b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts @@ -19,20 +19,19 @@ import { RequestBase } from '@_types/Base' import { Time } from '@_types/Time' +import { Action } from './types' /** * @rest_spec_name indices.update_aliases * @since 1.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: { - actions?: IndicesUpdateAliasBulk[] + body: { + actions?: Action[] } } - -export class IndicesUpdateAliasBulk {} diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesResponse.ts b/specification/indices/update_aliases/IndicesUpdateAliasesResponse.ts new file mode 100644 index 0000000000..0059ab53e4 --- /dev/null +++ b/specification/indices/update_aliases/IndicesUpdateAliasesResponse.ts @@ -0,0 +1,22 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/indices/update_aliases/types.ts b/specification/indices/update_aliases/types.ts new file mode 100644 index 0000000000..6f1c3ca8f6 --- /dev/null +++ b/specification/indices/update_aliases/types.ts @@ -0,0 +1,56 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Routing, IndexName, IndexAlias, Indices } from '@_types/common' +import { QueryContainer } from '@_types/query_dsl/abstractions' + +/** @variants container */ +export class Action { + add?: AddAction + remove?: RemoveAction + remove_index?: RemoveIndexAction +} + +export class AddAction { + alias?: IndexAlias + aliases?: IndexAlias | IndexAlias[] + filter?: QueryContainer + index?: IndexName + indices?: Indices + index_routing?: Routing + /** @server_default false */ + is_hidden?: boolean + is_write_index?: boolean + routing?: Routing + search_routing?: Routing +} + +export class RemoveAction { + alias?: IndexAlias + aliases?: IndexAlias | IndexAlias[] + index?: IndexName + indices?: Indices + /** @server_default false */ + must_exist?: boolean +} + +export class RemoveIndexAction { + index?: IndexName + indices?: Indices +} diff --git a/specification/indices/upgrade/IndicesUpgradeRequest.ts b/specification/indices/upgrade/IndicesUpgradeRequest.ts index 83f1dabadb..794d82afac 100644 --- a/specification/indices/upgrade/IndicesUpgradeRequest.ts +++ b/specification/indices/upgrade/IndicesUpgradeRequest.ts @@ -18,21 +18,22 @@ */ import { RequestBase } from '@_types/Base' -import { integer } from '@_types/Numeric' +import { ExpandWildcards, IndexName } from '@_types/common' /** * @rest_spec_name indices.upgrade * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_b: integer + path_parts: { + index?: IndexName } query_parameters?: { - stub_a: integer - } - body?: { - stub_c: integer + allow_no_indices?: boolean + expand_wildcards?: ExpandWildcards + ignore_unavailable?: boolean + wait_for_completion?: boolean + only_ancient_segments?: boolean } } diff --git a/specification/indices/upgrade/IndicesUpgradeResponse.ts b/specification/indices/upgrade/IndicesUpgradeResponse.ts index 25b5bd6764..0059ab53e4 100644 --- a/specification/indices/upgrade/IndicesUpgradeResponse.ts +++ b/specification/indices/upgrade/IndicesUpgradeResponse.ts @@ -17,8 +17,6 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { AcknowledgedResponseBase } from '@_types/Base' -export class Response { - body: { stub: integer } -} +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/indices/validate_query/IndicesValidateQueryRequest.ts b/specification/indices/validate_query/IndicesValidateQueryRequest.ts index d2d119f5a0..4c83b5a32f 100644 --- a/specification/indices/validate_query/IndicesValidateQueryRequest.ts +++ b/specification/indices/validate_query/IndicesValidateQueryRequest.ts @@ -18,40 +18,35 @@ */ import { RequestBase } from '@_types/Base' -import { - DefaultOperator, - ExpandWildcards, - Indices, - Types -} from '@_types/common' +import { ExpandWildcards, Indices, Types } from '@_types/common' import { QueryContainer } from '@_types/query_dsl/abstractions' +import { Operator } from '@_types/query_dsl/Operator' /** * @rest_spec_name indices.validate_query * @since 1.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices type?: Types } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean all_shards?: boolean analyzer?: string analyze_wildcard?: boolean - default_operator?: DefaultOperator + default_operator?: Operator df?: string expand_wildcards?: ExpandWildcards explain?: boolean ignore_unavailable?: boolean lenient?: boolean - query_on_query_string?: string rewrite?: boolean q?: string } - body?: { + body: { query?: QueryContainer } } diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index 79e549b681..66a2bb12fb 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -17,16 +17,16 @@ * under the License. */ -import { SortOrder } from '@global/search/_types/sort' +import { SortOrder } from '@_types/sort' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Fields, Id, Name } from '@_types/common' import { GeoShapeRelation } from '@_types/Geo' import { double, integer, long } from '@_types/Numeric' -import { Script } from '@_types/Scripting' /** * @variants container + * @non_exhaustive */ export class ProcessorContainer { attachment?: AttachmentProcessor @@ -49,7 +49,7 @@ export class ProcessorContainer { lowercase?: LowercaseProcessor remove?: RemoveProcessor rename?: RenameProcessor - script?: Script + script?: ScriptProcessor set?: SetProcessor sort?: SortProcessor split?: SplitProcessor @@ -66,6 +66,7 @@ export class ProcessorContainer { } export class ProcessorBase { + description?: string if?: string ignore_failure?: boolean on_failure?: ProcessorContainer[] @@ -98,24 +99,25 @@ export class AttachmentProcessor extends ProcessorBase { indexed_chars_field?: Field properties?: string[] target_field?: Field + remove_binary?: boolean resource_name?: string } export class GeoIpProcessor extends ProcessorBase { - database_file: string + database_file?: string field: Field - first_only: boolean - ignore_missing: boolean - properties: string[] - target_field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field } export class UserAgentProcessor extends ProcessorBase { field: Field - ignore_missing: boolean - options: UserAgentProperty[] - regex_file: string - target_field: Field + ignore_missing?: boolean + options?: UserAgentProperty[] + regex_file?: string + target_field?: Field } export class BytesProcessor extends ProcessorBase { @@ -127,9 +129,9 @@ export class BytesProcessor extends ProcessorBase { export class CircleProcessor extends ProcessorBase { error_distance: double field: Field - ignore_missing: boolean + ignore_missing?: boolean shape_type: ShapeType - target_field: Field + target_field?: Field } export enum ConvertType { @@ -145,46 +147,33 @@ export enum ConvertType { export class ConvertProcessor extends ProcessorBase { field: Field ignore_missing?: boolean - target_field: Field + target_field?: Field type: ConvertType } export class CsvProcessor extends ProcessorBase { - empty_value: UserDefinedValue - description?: string + empty_value?: UserDefinedValue field: Field ignore_missing?: boolean quote?: string separator?: string target_fields: Fields - trim: boolean -} - -export enum DateRounding { - /** @identifier Second */ - s = 0, - /** @identifier Minute */ - m = 1, - /** @identifier Hour */ - h = 2, - /** @identifier Day */ - d = 3, - /** @identifier Week */ - w = 4, - /** @identifier Month */ - M = 5, - /** @identifier Year */ - y = 6 + trim?: boolean } export class DateIndexNameProcessor extends ProcessorBase { date_formats: string[] - date_rounding: string | DateRounding + /** + * How to round the date when formatting the date into the index name. Valid values are: + * `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second). + * Supports template snippets. + */ + date_rounding: string field: Field - index_name_format: string - index_name_prefix: string - locale: string - timezone: string + index_name_format?: string + index_name_prefix?: string + locale?: string + timezone?: string } export class DateProcessor extends ProcessorBase { @@ -196,9 +185,9 @@ export class DateProcessor extends ProcessorBase { } export class DissectProcessor extends ProcessorBase { - append_separator: string + append_separator?: string field: Field - ignore_missing: boolean + ignore_missing?: boolean pattern: string } @@ -232,7 +221,7 @@ export class ForeachProcessor extends ProcessorBase { export class GrokProcessor extends ProcessorBase { field: Field ignore_missing?: boolean - pattern_definitions: Dictionary + pattern_definitions?: Dictionary patterns: string[] trace_match?: boolean } @@ -247,7 +236,7 @@ export class GsubProcessor extends ProcessorBase { export class InferenceProcessor extends ProcessorBase { model_id: Id - target_field: Field + target_field?: Field field_map?: Dictionary inference_config?: InferenceConfig } @@ -267,9 +256,18 @@ export class JoinProcessor extends ProcessorBase { } export class JsonProcessor extends ProcessorBase { - add_to_root: boolean + add_to_root?: boolean + add_to_root_conflict_strategy?: JsonProcessorConflictStrategy + allow_duplicate_keys?: boolean field: Field - target_field: Field + target_field?: Field +} + +export enum JsonProcessorConflictStrategy { + /** Root fields that conflict with fields from the parsed JSON will be overridden. */ + replace, + /** Conflicting fields will be merged. */ + merge } export class KeyValueProcessor extends ProcessorBase { @@ -294,6 +292,7 @@ export class LowercaseProcessor extends ProcessorBase { export class PipelineProcessor extends ProcessorBase { name: Name + ignore_missing_pipeline?: boolean } export class RemoveProcessor extends ProcessorBase { @@ -311,13 +310,16 @@ export class ScriptProcessor extends ProcessorBase { id?: Id lang?: string params?: Dictionary - source: string + source?: string } export class SetProcessor extends ProcessorBase { + copy_from?: Field field: Field + ignore_empty_value?: boolean + media_type?: string override?: boolean - value: UserDefinedValue + value?: UserDefinedValue } export class SetSecurityUserProcessor extends ProcessorBase { @@ -332,8 +334,8 @@ export enum ShapeType { export class SortProcessor extends ProcessorBase { field: Field - order: SortOrder - target_field: Field + order?: SortOrder + target_field?: Field } export class SplitProcessor extends ProcessorBase { diff --git a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts index 82cef774b3..d6de8ef91d 100644 --- a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts +++ b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name ingest.delete_pipeline * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { id: Id } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } diff --git a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts index 2f9f6aa738..8246117a7e 100644 --- a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts +++ b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ingest.geo_ip_stats * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/ingest/get_pipeline/GetPipelineRequest.ts b/specification/ingest/get_pipeline/GetPipelineRequest.ts index 0cede87021..87f6b9728d 100644 --- a/specification/ingest/get_pipeline/GetPipelineRequest.ts +++ b/specification/ingest/get_pipeline/GetPipelineRequest.ts @@ -27,10 +27,10 @@ import { Time } from '@_types/Time' * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id?: Id } - query_parameters?: { + query_parameters: { /** @server_default 30s */ master_timeout?: Time /** @server_default false */ diff --git a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts index d3afe0e7b5..54e0ea2da1 100644 --- a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts +++ b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ingest.processor_grok * @since 6.1.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/ingest/put_pipeline/PutPipelineRequest.ts b/specification/ingest/put_pipeline/PutPipelineRequest.ts index 9592557f4e..c2e08b67a7 100644 --- a/specification/ingest/put_pipeline/PutPipelineRequest.ts +++ b/specification/ingest/put_pipeline/PutPipelineRequest.ts @@ -19,25 +19,35 @@ import { ProcessorContainer } from '@ingest/_types/Processors' import { RequestBase } from '@_types/Base' -import { Id, VersionNumber } from '@_types/common' +import { Id, VersionNumber, Metadata } from '@_types/common' import { Time } from '@_types/Time' /** * @rest_spec_name ingest.put_pipeline * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { id: Id } - query_parameters?: { - /** @server_default 30s */ + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ master_timeout?: Time /** @server_default 30s */ timeout?: Time } - body?: { + body: { + /** + * Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. + */ + _meta?: Metadata + /** + * Description of the ingest pipeline. + */ description?: string on_failure?: ProcessorContainer[] processors?: ProcessorContainer[] diff --git a/specification/ingest/simulate_pipeline/SimulatePipelineRequest.ts b/specification/ingest/simulate/SimulatePipelineRequest.ts similarity index 94% rename from specification/ingest/simulate_pipeline/SimulatePipelineRequest.ts rename to specification/ingest/simulate/SimulatePipelineRequest.ts index 14d3e5a223..7be2fc877f 100644 --- a/specification/ingest/simulate_pipeline/SimulatePipelineRequest.ts +++ b/specification/ingest/simulate/SimulatePipelineRequest.ts @@ -25,16 +25,16 @@ import { Document } from './types' /** * @rest_spec_name ingest.simulate * @since 5.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id?: Id } - query_parameters?: { + query_parameters: { verbose?: boolean } - body?: { + body: { docs?: Document[] pipeline?: Pipeline } diff --git a/specification/ingest/simulate_pipeline/SimulatePipelineResponse.ts b/specification/ingest/simulate/SimulatePipelineResponse.ts similarity index 100% rename from specification/ingest/simulate_pipeline/SimulatePipelineResponse.ts rename to specification/ingest/simulate/SimulatePipelineResponse.ts diff --git a/specification/ingest/simulate_pipeline/types.ts b/specification/ingest/simulate/types.ts similarity index 77% rename from specification/ingest/simulate_pipeline/types.ts rename to specification/ingest/simulate/types.ts index 11a997b768..ec0727f0a3 100644 --- a/specification/ingest/simulate_pipeline/types.ts +++ b/specification/ingest/simulate/types.ts @@ -20,8 +20,17 @@ import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { ActionStatusOptions } from '@watcher/_types/Action' -import { Id, IndexName, Name, Type } from '@_types/common' +import { + Id, + IndexName, + Name, + Type, + VersionNumber, + VersionType +} from '@_types/common' import { DateString } from '@_types/Time' +import { AdditionalProperties } from '@spec_utils/behaviors' +import { Stringified } from '@spec_utils/Stringified' export class Ingest { timestamp: DateString @@ -42,12 +51,18 @@ export class Document { _source: UserDefinedValue } -export class DocumentSimulation { +/** + * The simulated document, with optional metadata. + */ +export class DocumentSimulation + implements AdditionalProperties +{ _id: Id _index: IndexName _ingest: Ingest - _parent?: string _routing?: string _source: Dictionary _type?: Type + _version?: Stringified + _version_type?: VersionType } diff --git a/specification/license/delete/DeleteLicenseRequest.ts b/specification/license/delete/DeleteLicenseRequest.ts index 1dffcc9b0f..00eded2616 100644 --- a/specification/license/delete/DeleteLicenseRequest.ts +++ b/specification/license/delete/DeleteLicenseRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.delete * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/license/get/GetLicenseRequest.ts b/specification/license/get/GetLicenseRequest.ts index b7eca3302f..2c5365d53d 100644 --- a/specification/license/get/GetLicenseRequest.ts +++ b/specification/license/get/GetLicenseRequest.ts @@ -22,10 +22,10 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.get * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { accept_enterprise?: boolean local?: boolean } diff --git a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts index 8a80cb5738..4fdd826fe7 100644 --- a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts +++ b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.get_basic_status * @since 6.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts index bc0eed2632..a2f64b4150 100644 --- a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts +++ b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.get_trial_status * @since 6.1.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/license/post/PostLicenseRequest.ts b/specification/license/post/PostLicenseRequest.ts index 0775f680c5..9a391d08ec 100644 --- a/specification/license/post/PostLicenseRequest.ts +++ b/specification/license/post/PostLicenseRequest.ts @@ -23,13 +23,13 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.post * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { acknowledge?: boolean } - body?: { + body: { license?: License licenses?: Array } diff --git a/specification/license/post_start_basic/StartBasicLicenseRequest.ts b/specification/license/post_start_basic/StartBasicLicenseRequest.ts index 727f96f1c7..1f0538336b 100644 --- a/specification/license/post_start_basic/StartBasicLicenseRequest.ts +++ b/specification/license/post_start_basic/StartBasicLicenseRequest.ts @@ -22,10 +22,10 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.post_start_basic * @since 6.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { acknowledge?: boolean } } diff --git a/specification/license/post_start_trial/StartTrialLicenseRequest.ts b/specification/license/post_start_trial/StartTrialLicenseRequest.ts index 3751af9a7b..7a41c458e6 100644 --- a/specification/license/post_start_trial/StartTrialLicenseRequest.ts +++ b/specification/license/post_start_trial/StartTrialLicenseRequest.ts @@ -22,10 +22,10 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name license.post_start_trial * @since 6.1.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { acknowledge?: boolean type_query_string?: string } diff --git a/specification/license/post_start_trial/StartTrialLicenseResponse.ts b/specification/license/post_start_trial/StartTrialLicenseResponse.ts index 6e8f0b15be..61d0ffbe26 100644 --- a/specification/license/post_start_trial/StartTrialLicenseResponse.ts +++ b/specification/license/post_start_trial/StartTrialLicenseResponse.ts @@ -23,7 +23,6 @@ import { AcknowledgedResponseBase } from '@_types/Base' export class Response extends AcknowledgedResponseBase { body: { error_message?: string - acknowledged: boolean trial_was_started: boolean type: LicenseType } diff --git a/specification/logstash/_types/Pipeline.ts b/specification/logstash/_types/Pipeline.ts new file mode 100644 index 0000000000..16d7ada32d --- /dev/null +++ b/specification/logstash/_types/Pipeline.ts @@ -0,0 +1,44 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { integer } from '@_types/Numeric' +import { Timestamp } from '@_types/Time' + +export class PipelineMetadata { + type: string + version: string +} + +export class PipelineSettings { + 'pipeline.workers': integer + 'pipeline.batch.size': integer + 'pipeline.batch.delay': integer + 'queue.type': string + 'queue.max_bytes.number': integer + 'queue.max_bytes.units': string + 'queue.checkpoint.writes': integer +} +export class Pipeline { + description: string + last_modified: Timestamp + pipeline_metadata: PipelineMetadata + username: string + pipeline: string + pipeline_settings: PipelineSettings +} diff --git a/specification/logstash/pipeline_delete/LogstashDeletePipelineRequest.ts b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts similarity index 87% rename from specification/logstash/pipeline_delete/LogstashDeletePipelineRequest.ts rename to specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts index af7ee887b2..7c73e03ec5 100644 --- a/specification/logstash/pipeline_delete/LogstashDeletePipelineRequest.ts +++ b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts @@ -18,20 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' /** * @rest_spec_name logstash.delete_pipeline * @since 7.12.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + path_parts: { + id: Id } } diff --git a/specification/logstash/pipeline_delete/LogstashDeletePipelineResponse.ts b/specification/logstash/delete_pipeline/LogstashDeletePipelineResponse.ts similarity index 92% rename from specification/logstash/pipeline_delete/LogstashDeletePipelineResponse.ts rename to specification/logstash/delete_pipeline/LogstashDeletePipelineResponse.ts index 25b5bd6764..cf4f9c0d87 100644 --- a/specification/logstash/pipeline_delete/LogstashDeletePipelineResponse.ts +++ b/specification/logstash/delete_pipeline/LogstashDeletePipelineResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Void } from '@spec_utils/VoidValue' export class Response { - body: { stub: integer } + body: Void } diff --git a/specification/logstash/pipeline_get/LogstashGetPipelineRequest.ts b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts similarity index 87% rename from specification/logstash/pipeline_get/LogstashGetPipelineRequest.ts rename to specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts index ab32de8e96..f6e51d557d 100644 --- a/specification/logstash/pipeline_get/LogstashGetPipelineRequest.ts +++ b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts @@ -18,20 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { Ids } from '@_types/common' /** * @rest_spec_name logstash.get_pipeline * @since 7.12.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + path_parts: { + id: Ids } } diff --git a/specification/logstash/pipeline_get/LogstashGetPipelineResponse.ts b/specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts similarity index 82% rename from specification/logstash/pipeline_get/LogstashGetPipelineResponse.ts rename to specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts index 25b5bd6764..31565a44f7 100644 --- a/specification/logstash/pipeline_get/LogstashGetPipelineResponse.ts +++ b/specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts @@ -17,8 +17,10 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Pipeline } from '@logstash/_types/Pipeline' +import { Dictionary } from '@spec_utils/Dictionary' +import { Id } from '@_types/common' export class Response { - body: { stub: integer } + body: Dictionary } diff --git a/specification/logstash/pipeline_put/LogstashPutPipelineRequest.ts b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts similarity index 83% rename from specification/logstash/pipeline_put/LogstashPutPipelineRequest.ts rename to specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts index eb88891418..82fda102ff 100644 --- a/specification/logstash/pipeline_put/LogstashPutPipelineRequest.ts +++ b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts @@ -18,20 +18,18 @@ */ import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { Pipeline } from '@logstash/_types/Pipeline' /** * @rest_spec_name logstash.put_pipeline * @since 7.12.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + path_parts: { + id: Id } + /** @codegen_name pipeline */ + body: Pipeline } diff --git a/specification/logstash/pipeline_put/LogstashPutPipelineResponse.ts b/specification/logstash/put_pipeline/LogstashPutPipelineResponse.ts similarity index 92% rename from specification/logstash/pipeline_put/LogstashPutPipelineResponse.ts rename to specification/logstash/put_pipeline/LogstashPutPipelineResponse.ts index 25b5bd6764..cf4f9c0d87 100644 --- a/specification/logstash/pipeline_put/LogstashPutPipelineResponse.ts +++ b/specification/logstash/put_pipeline/LogstashPutPipelineResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { Void } from '@spec_utils/VoidValue' export class Response { - body: { stub: integer } + body: Void } diff --git a/specification/migration/deprecation_info/DeprecationInfoRequest.ts b/specification/migration/deprecations/DeprecationInfoRequest.ts similarity index 96% rename from specification/migration/deprecation_info/DeprecationInfoRequest.ts rename to specification/migration/deprecations/DeprecationInfoRequest.ts index 1cd054fafe..8d6e282ba9 100644 --- a/specification/migration/deprecation_info/DeprecationInfoRequest.ts +++ b/specification/migration/deprecations/DeprecationInfoRequest.ts @@ -23,10 +23,10 @@ import { IndexName } from '@_types/common' /** * @rest_spec_name migration.deprecations * @since 6.1.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. */ index?: IndexName } diff --git a/specification/migration/deprecation_info/DeprecationInfoResponse.ts b/specification/migration/deprecations/DeprecationInfoResponse.ts similarity index 100% rename from specification/migration/deprecation_info/DeprecationInfoResponse.ts rename to specification/migration/deprecations/DeprecationInfoResponse.ts diff --git a/specification/migration/deprecation_info/types.ts b/specification/migration/deprecations/types.ts similarity index 100% rename from specification/migration/deprecation_info/types.ts rename to specification/migration/deprecations/types.ts diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts new file mode 100644 index 0000000000..a29ded9737 --- /dev/null +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts @@ -0,0 +1,28 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' + +/** + * @rest_spec_name migration.get_feature_upgrade_status + * @since 7.16.0 + * @stability stable + * @index_privileges manage + */ +export interface Request extends RequestBase {} diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts new file mode 100644 index 0000000000..ae8310f4f8 --- /dev/null +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts @@ -0,0 +1,48 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { IndexName, Indices, VersionString } from '@_types/common' +import { ErrorCause } from '@_types/Errors' + +export class Response { + body: { + features: MigrationFeature[] + migration_status: MigrationStatus + } +} + +export enum MigrationStatus { + NO_MIGRATION_NEEDED, + MIGRATION_NEEDED, + IN_PROGRESS, + ERROR +} + +export class MigrationFeature { + feature_name: string + minimum_index_version: VersionString + migration_status: MigrationStatus + indices: MigrationFeatureIndexInfo[] +} + +export class MigrationFeatureIndexInfo { + index: IndexName + version: VersionString + failure_cause?: ErrorCause +} diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts new file mode 100644 index 0000000000..3fb2ffea44 --- /dev/null +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts @@ -0,0 +1,28 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' + +/** + * @rest_spec_name migration.post_feature_upgrade + * @since 7.16.0 + * @stability stable + * @index_privileges manage + */ +export interface Request extends RequestBase {} diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts b/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts new file mode 100644 index 0000000000..4007fd899b --- /dev/null +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts @@ -0,0 +1,29 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export class Response { + body: { + accepted: boolean + features: MigrationFeature[] + } +} + +export class MigrationFeature { + feature_name: string +} diff --git a/specification/ml/_types/Analysis.ts b/specification/ml/_types/Analysis.ts index b7620b4793..2dd6bfe226 100644 --- a/specification/ml/_types/Analysis.ts +++ b/specification/ml/_types/Analysis.ts @@ -20,10 +20,11 @@ import { Field } from '@_types/common' import { long } from '@_types/Numeric' import { Time, TimeSpan } from '@_types/Time' -import { Detector } from './Detector' +import { Detector, DetectorRead } from './Detector' import { CharFilter } from '@_types/analysis/char_filters' -import { Tokenizer } from '@_types/analysis/tokenizers' +import { Tokenizer, TokenizerDefinition } from '@_types/analysis/tokenizers' import { TokenFilter } from '@_types/analysis/token_filters' +import { OverloadOf } from '@spec_utils/behaviors' export class AnalysisConfig { /** @@ -34,7 +35,7 @@ export class AnalysisConfig { /** * If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string it must refer to a built-in analyzer or one added by another plugin. */ - categorization_analyzer?: CategorizationAnalyzer | string + categorization_analyzer?: CategorizationAnalyzer /** * If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. */ @@ -51,6 +52,10 @@ export class AnalysisConfig { * A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. */ influencers?: Field[] + /** + * Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. Typically, set to `30d` or longer. If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit. + */ + model_prune_window?: Time /** * The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is only applicable when you send data by using the post data API. * @server_default 0 @@ -70,6 +75,20 @@ export class AnalysisConfig { summary_count_field_name?: Field } +export class AnalysisConfigRead implements OverloadOf { + bucket_span: TimeSpan + categorization_analyzer?: CategorizationAnalyzer + categorization_field_name?: Field + categorization_filters?: string[] + detectors: DetectorRead[] + influencers: Field[] + model_prune_window?: Time + latency?: Time + multivariate_by_fields?: boolean + per_partition_categorization?: PerPartitionCategorization + summary_count_field_name?: Field +} + export class PerPartitionCategorization { /** * To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails. @@ -101,17 +120,20 @@ export class AnalysisMemoryLimit { model_memory_limit: string } -export class CategorizationAnalyzer { - char_filter?: Array +/** @codegen_names name, definition */ +export type CategorizationAnalyzer = string | CategorizationAnalyzerDefinition + +export class CategorizationAnalyzerDefinition { /** * One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. */ - filter?: Array + char_filter?: Array /** * One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. */ - tokenizer?: string | Tokenizer + filter?: Array /** * The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your `categorization_analyzer`. */ + tokenizer?: Tokenizer } diff --git a/specification/ml/_types/Bucket.ts b/specification/ml/_types/Bucket.ts index 5a58c524e7..328267e08b 100644 --- a/specification/ml/_types/Bucket.ts +++ b/specification/ml/_types/Bucket.ts @@ -22,41 +22,93 @@ import { double, long } from '@_types/Numeric' import { Time } from '@_types/Time' export class BucketSummary { + /** + * The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited + * score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as + * new data is analyzed. + */ anomaly_score: double bucket_influencers: BucketInfluencer[] + /** + * The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + */ bucket_span: Time + /** + * The number of input data records processed in this bucket. + */ event_count: long + /** + * The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the + * time the bucket was processed. + */ initial_anomaly_score: double + /** + * If true, this is an interim result. In other words, the results are calculated based on partial input data. + */ is_interim: boolean + /** + * Identifier for the anomaly detection job. + */ job_id: Id - partition_scores?: PartitionScore[] + /** + * The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results. + */ processing_time_ms: double + /** + * Internal. This value is always set to bucket. + */ result_type: string + /** + * The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the + * timestamp of the bucket are included in the results for the bucket. + */ timestamp: Time } export class BucketInfluencer { - /** The length of the bucket in seconds. This value matches the bucket_span that is specified in the job. */ + /** + * A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as + * newer data is analyzed. + */ + anomaly_score: double + /** + * The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + */ bucket_span: long - /** A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors. Unlike initial_influencer_score, this value will be updated by a re-normalization process as new data is analyzed. */ - influencer_score: double - /** The field name of the influencer. */ + /** + * The field name of the influencer. + */ influencer_field_name: Field - /** The entity that influenced, contributed to, or was to blame for the anomaly. */ - influencer_field_value: string - /** A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed. */ - initial_influencer_score: double - /** If true, this is an interim result. In other words, the results are calculated based on partial input data. */ + /** + * The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the + * time the bucket was processed. */ + initial_anomaly_score: double + /** + * If true, this is an interim result. In other words, the results are calculated based on partial input data. + */ is_interim: boolean - /** Identifier for the anomaly detection job. */ + /** + * Identifier for the anomaly detection job. + */ job_id: Id - /** The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so the influencer_score is provided as a human-readable and friendly interpretation of this. */ + /** + * The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision + * of over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of + * this. + */ probability: double - /** Internal. This value is always set to influencer. */ + /** + * Internal. + */ + raw_anomaly_score: double + /** + * Internal. This value is always set to `bucket_influencer`. + */ result_type: string - /** The start time of the bucket for which these results were calculated. */ + /** + * The start time of the bucket for which these results were calculated. + */ timestamp: Time - foo?: string // TODO ??? - the tests carry this prop but :shrug: } export class OverallBucket { @@ -77,11 +129,3 @@ export class OverallBucketJob { job_id: Id max_anomaly_score: double } - -export class PartitionScore { - initial_record_score: double - partition_field_name: Field - partition_field_value: string - probability: double - record_score: double -} diff --git a/specification/ml/_types/CalendarEvent.ts b/specification/ml/_types/CalendarEvent.ts index 906e8ce6dd..2bf57e8594 100644 --- a/specification/ml/_types/CalendarEvent.ts +++ b/specification/ml/_types/CalendarEvent.ts @@ -21,6 +21,7 @@ import { Id } from '@_types/common' import { EpochMillis } from '@_types/Time' export class CalendarEvent { + /** A string that uniquely identifies a calendar. */ calendar_id?: Id event_id?: Id /** A description of the scheduled event. */ diff --git a/specification/ml/_types/Datafeed.ts b/specification/ml/_types/Datafeed.ts index 8494aaadc5..4ed3d4d076 100644 --- a/specification/ml/_types/Datafeed.ts +++ b/specification/ml/_types/Datafeed.ts @@ -19,7 +19,7 @@ import { Dictionary } from '@spec_utils/Dictionary' import { AggregationContainer } from '@_types/aggregations/AggregationContainer' -import { ExpandWildcards, Id, Indices } from '@_types/common' +import { ExpandWildcards, Id, Indices, IndicesOptions } from '@_types/common' import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { double, integer, long } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' @@ -28,8 +28,8 @@ import { Time, Timestamp } from '@_types/Time' import { DiscoveryNode } from './DiscoveryNode' export class Datafeed { + /** @aliases aggs */ aggregations?: Dictionary - aggs?: Dictionary chunking_config?: ChunkingConfig datafeed_id: Id frequency?: Timestamp @@ -43,14 +43,16 @@ export class Datafeed { scroll_size?: integer delayed_data_check_config: DelayedDataCheckConfig runtime_mappings?: RuntimeFields - indices_options?: DatafeedIndicesOptions + indices_options?: IndicesOptions } + export class DatafeedConfig { /** * If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. + * + * @aliases aggs */ aggregations?: Dictionary - aggs?: Dictionary /** * Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. */ @@ -66,15 +68,15 @@ export class DatafeedConfig { * The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. */ frequency?: Timestamp - indexes?: Indices + indexes?: string[] /** * An array of index names. Wildcards are supported. */ - indices?: Indices + indices: string[] /** * Specifies index expansion options that are used during search. */ - indices_options?: DatafeedIndicesOptions + indices_options?: IndicesOptions job_id?: Id /** * If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. @@ -83,7 +85,7 @@ export class DatafeedConfig { /** * The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. */ - query?: QueryContainer + query: QueryContainer /** * The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. */ @@ -114,11 +116,12 @@ export class DelayedDataCheckConfig { enabled: boolean // default: true } +// Identical to WatcherState, but kept separate as they're different enums in ES export enum DatafeedState { - started = 0, - stopped = 1, - starting = 2, - stopping = 3 + started, + stopped, + starting, + stopping } export class DatafeedStats { @@ -145,9 +148,9 @@ export class DatafeedRunningState { } export enum ChunkingMode { - auto = 0, - manual = 1, - off = 2 + auto, + manual, + off } export class ChunkingConfig { @@ -157,13 +160,7 @@ export class ChunkingConfig { mode: ChunkingMode /** * The time span that each search will be querying. This setting is only applicable when the `mode` is set to `manual`. - * @server_default 3h */ + * @server_default 3h + */ time_span?: Time } - -export class DatafeedIndicesOptions { - allow_no_indices?: boolean - expand_wildcards?: ExpandWildcards - ignore_unavailable?: boolean - ignore_throttled?: boolean -} diff --git a/specification/ml/_types/DataframeAnalytics.ts b/specification/ml/_types/DataframeAnalytics.ts index 6a4e4d8e54..de0d4853fe 100644 --- a/specification/ml/_types/DataframeAnalytics.ts +++ b/specification/ml/_types/DataframeAnalytics.ts @@ -36,16 +36,19 @@ import { DateString } from '@_types/Time' import { DataframeState } from './Dataframe' export class DataframeAnalyticsSource { - /** Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. */ + /** Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.*/ index: Indices /** * The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html */ query?: QueryContainer - /** Specify includes and/or excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. */ - _source?: DataframeAnalysisAnalyzedFields + /** + * Definitions of runtime fields that will become part of the mapping of the destination index. + */ runtime_mappings?: RuntimeFields + /** Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. */ + _source?: DataframeAnalysisAnalyzedFields } export class DataframeAnalyticsFieldSelection { @@ -73,74 +76,166 @@ export class DataframeAnalyticsMemoryEstimation { export class DataframeAnalyticsDestination { /** Defines the destination index to store the results of the data frame analytics job. */ index: IndexName - /** Defines the name of the field in which to store the results of the analysis. Defaults to ml. */ + /** Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. */ results_field?: Field } /** @variants container */ export class DataframeAnalysisContainer { /** - * The configuration information necessary to perform outlier detection + * The configuration information necessary to perform classification. + * @doc_url https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html + */ + classification?: DataframeAnalysisClassification + /** + * The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters. * @doc_url https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html */ outlier_detection?: DataframeAnalysisOutlierDetection /** - * The configuration information necessary to perform regression. + * The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters. * @doc_url https://www.elastic.co/guide/en/machine-learning/current/dfa-regression.html */ regression?: DataframeAnalysisRegression - /** - * The configuration information necessary to perform classification. - * @doc_url https://www.elastic.co/guide/en/machine-learning/current/dfa-classification.html - */ - classification?: DataframeAnalysisClassification } export class DataframeAnalysisOutlierDetection { - n_neighbors?: integer - method?: string - feature_influence_threshold?: double + /** + * Specifies whether the feature influence calculation is enabled. + * @server_default true + */ compute_feature_influence?: boolean + /** + * The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. + * @server_default 0.1 + */ + feature_influence_threshold?: double + /** + * The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. + * @server_default ensemble + */ + method?: string + /** + * Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. + */ + n_neighbors?: integer + /** + * The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. + */ outlier_fraction?: double + /** + * If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`. + * @server_default true + */ standardization_enabled?: boolean } export class DataframeAnalysis { - dependent_variable: string - prediction_field_name?: Field + /** + * Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. + */ alpha?: double - lambda?: double - gamma?: double + /** + * Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. + * For classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field. + * For regression analysis, the data type of the field must be numeric. + */ + dependent_variable: string + /** + * Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. + */ + downsample_factor?: double + /** + * Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. + * @server_default true + */ + early_stopping_enabled?: boolean + /** + * Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. + */ eta?: double + /** + * Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. + */ eta_growth_rate_per_tree?: double + /** + * Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. + */ feature_bag_fraction?: double - /** @aliases maximum_number_trees */ - max_trees?: integer - soft_tree_depth_limit?: integer - soft_tree_depth_tolerance?: double - downsample_factor?: double + /** + * Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. + */ + feature_processors?: DataframeAnalysisFeatureProcessor[] + /** + * Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + */ + gamma?: double + /** + * Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. + */ + lambda?: double + /** + * Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. + */ max_optimization_rounds_per_hyperparameter?: integer - early_stopping_enabled?: boolean + /** + * Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. + * @aliases maximum_number_trees + */ + max_trees?: integer + /** + * Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. + * @server_default 0 + */ num_top_feature_importance_values?: integer - feature_processors?: DataframeAnalysisFeatureProcessor[] + /** + * Defines the name of the prediction field in the results. Defaults to `_prediction`. + */ + prediction_field_name?: Field + /** + * Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). + */ randomize_seed?: double + /** + * Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. + */ + soft_tree_depth_limit?: integer + /** + * Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. + */ + soft_tree_depth_tolerance?: double + /** + * Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. + * @server_default 100 + */ training_percent?: Percentage } export class DataframeAnalysisRegression extends DataframeAnalysis { + /** + * The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). + * @server_default mse + */ loss_function?: string + /** + * A positive number that is used as a parameter to the `loss_function`. + */ loss_function_parameter?: double } export class DataframeAnalysisClassification extends DataframeAnalysis { + /* + * Defines the objective to optimize when assigning class labels: `maximize_accuracy` or `maximize_minimum_recall`. When maximizing accuracy, class labels are chosen to maximize the number of correct predictions. When maximizing minimum recall, labels are chosen to maximize the minimum recall for any class. Defaults to `maximize_minimum_recall`.*/ class_assignment_objective?: string + /** + * Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. + * @server_default 2 + */ num_top_classes?: integer } -export type DataframeAnalysisAnalyzedFields = - | string[] - | DataframeAnalysisAnalyzedFieldsIncludeExclude -export class DataframeAnalysisAnalyzedFieldsIncludeExclude { +/** @shortcut_property includes */ +export class DataframeAnalysisAnalyzedFields { /** An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. */ includes: string[] /** An array of strings that defines the fields that will be included in the analysis. */ diff --git a/specification/ml/_types/Detector.ts b/specification/ml/_types/Detector.ts index 6f47507d57..83c00d8938 100644 --- a/specification/ml/_types/Detector.ts +++ b/specification/ml/_types/Detector.ts @@ -17,6 +17,7 @@ * under the License. */ +import { OverloadOf } from '@spec_utils/behaviors' import { Field } from '@_types/common' import { integer } from '@_types/Numeric' import { DetectionRule } from './Rule' @@ -49,7 +50,7 @@ export class Detector { /** * The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. */ - function?: string + function: string /** * The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. */ @@ -63,7 +64,19 @@ export class Detector { * @server_default false */ use_null?: boolean - description?: string +} + +export class DetectorRead implements OverloadOf { + by_field_name?: Field + custom_rules?: DetectionRule[] + detector_description?: string + detector_index?: integer + exclude_frequent?: ExcludeFrequent + field_name?: Field + function: string + over_field_name?: Field + partition_field_name?: Field + use_null?: boolean } export enum ExcludeFrequent { diff --git a/specification/ml/_types/Filter.ts b/specification/ml/_types/Filter.ts index 6ade63dfbb..c2b65eb904 100644 --- a/specification/ml/_types/Filter.ts +++ b/specification/ml/_types/Filter.ts @@ -20,8 +20,11 @@ import { Id } from '@_types/common' export class Filter { + /** A description of the filter. */ description?: string + /** A string that uniquely identifies a filter. */ filter_id: Id + /** An array of strings which is the filter item list. */ items: string[] } @@ -38,6 +41,6 @@ export class FilterRef { } export enum FilterType { - include = 0, - exclude = 1 + include, + exclude } diff --git a/specification/ml/_types/Include.ts b/specification/ml/_types/Include.ts new file mode 100644 index 0000000000..e4f3605bf2 --- /dev/null +++ b/specification/ml/_types/Include.ts @@ -0,0 +1,42 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export enum Include { + /** + * Includes the model definition. + */ + definition, + /** + * Includes the baseline for feature importance values. + */ + feature_importance_baseline, + /** + * Includes the information about hyperparameters used to train the model. + * This information consists of the value, the absolute and relative + * importance of the hyperparameter as well as an indicator of whether it was + * specified by the user or tuned during hyperparameter optimization. + */ + hyperparameters, + /** + * Includes the total feature importance for the training data set. The + * baseline and total feature importance values are returned in the metadata + * field in the response body. + */ + total_feature_importance +} diff --git a/specification/ml/_types/Influencer.ts b/specification/ml/_types/Influencer.ts new file mode 100644 index 0000000000..6a9fd67f53 --- /dev/null +++ b/specification/ml/_types/Influencer.ts @@ -0,0 +1,76 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { double, integer, long } from '@_types/Numeric' +import { Field, Id } from '@_types/common' +import { Time } from '@_types/Time' + +export class Influencer { + /** + * The length of the bucket in seconds. This value matches the bucket span that is specified in the job. + */ + bucket_span: long + /** + * A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated + * across detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new + * data is analyzed. + */ + influencer_score: double + /** + * The field name of the influencer. + */ + influencer_field_name: Field + /** + * The entity that influenced, contributed to, or was to blame for the anomaly. + */ + influencer_field_value: string + /** + * A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. + * This is the initial value that was calculated at the time the bucket was processed. + */ + initial_influencer_score: double + /** + * If true, this is an interim result. In other words, the results are calculated based on partial input data. + */ + is_interim: boolean + /** + * Identifier for the anomaly detection job. + */ + job_id: Id + /** + * The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high + * precision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly + * interpretation of this value. + */ + probability: double + /** + * Internal. This value is always set to `influencer`. + */ + result_type: string + /** + * The start time of the bucket for which these results were calculated. + */ + timestamp: Time + /** + * Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s + * analyzing `user_name` as an influencer, a field `user_name` is added to the result document. This + * information enables you to filter the anomaly results more easily. + */ + foo?: string // TODO ??? - the tests carry this prop but :shrug: +} diff --git a/specification/ml/_types/Job.ts b/specification/ml/_types/Job.ts index 77170c85aa..ea6801126a 100644 --- a/specification/ml/_types/Job.ts +++ b/specification/ml/_types/Job.ts @@ -67,7 +67,6 @@ export class Job { renormalization_window_days?: long results_index_name: IndexName results_retention_days?: long - system_annotations_retention_days?: long } export class JobConfig { @@ -88,7 +87,6 @@ export class JobConfig { renormalization_window_days?: long results_index_name?: IndexName results_retention_days?: long - system_annotations_retention_days?: long } export class JobStats { assignment_explanation?: string @@ -137,6 +135,7 @@ export class DataCounts { latest_record_timestamp?: long latest_sparse_bucket_timestamp?: long latest_bucket_timestamp?: long + log_time?: long missing_field_count: long out_of_order_timestamp_count: long processed_field_count: long diff --git a/specification/ml/_types/Model.ts b/specification/ml/_types/Model.ts index 4fb1411cfc..bb2f888ce0 100644 --- a/specification/ml/_types/Model.ts +++ b/specification/ml/_types/Model.ts @@ -17,9 +17,10 @@ * under the License. */ -import { Id, VersionString } from '@_types/common' +import { ByteSize, Id, VersionString } from '@_types/common' import { integer, long } from '@_types/Numeric' import { Time } from '@_types/Time' +import { DiscoveryNode } from '@ml/_types/DiscoveryNode' export class ModelSnapshot { /** An optional description of the job. */ @@ -41,7 +42,15 @@ export class ModelSnapshot { /** A numerical character string that uniquely identifies the model snapshot. */ snapshot_id: Id /** The creation timestamp for the snapshot. */ - timestamp: integer + timestamp: long +} + +export class ModelSnapshotUpgrade { + job_id: Id + snapshot_id: Id + state: SnapshotUpgradeState + node: DiscoveryNode + assignment_explanation: string } export class ModelSizeStats { @@ -49,10 +58,10 @@ export class ModelSizeStats { job_id: Id log_time: Time memory_status: MemoryStatus - model_bytes: long - model_bytes_exceeded?: long - model_bytes_memory_limit?: long - peak_model_bytes?: long + model_bytes: ByteSize + model_bytes_exceeded?: ByteSize + model_bytes_memory_limit?: ByteSize + peak_model_bytes?: ByteSize assignment_memory_basis?: string result_type: string total_by_field_count: long @@ -69,12 +78,19 @@ export class ModelSizeStats { } export enum CategorizationStatus { - ok = 0, - warn = 1 + ok, + warn } export enum MemoryStatus { - ok = 0, - soft_limit = 1, - hard_limit = 2 + ok, + soft_limit, + hard_limit +} + +export enum SnapshotUpgradeState { + loading_old_state, + saving_new_state, + stopped, + failed } diff --git a/specification/ml/_types/ModelPlot.ts b/specification/ml/_types/ModelPlot.ts index 0a2193d814..bcbba87093 100644 --- a/specification/ml/_types/ModelPlot.ts +++ b/specification/ml/_types/ModelPlot.ts @@ -17,11 +17,16 @@ * under the License. */ +import { OverloadOf } from '@spec_utils/behaviors' import { Field } from '@_types/common' +/** + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html#ml-apimodelplotconfig + */ export class ModelPlotConfig { /** * If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. + * @since 7.9.0 * @server_default true */ annotations_enabled?: boolean @@ -32,26 +37,14 @@ export class ModelPlotConfig { enabled?: boolean /** * Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. + * @since 7.9.0 + * @stability experimental */ terms?: Field } -/** - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html#ml-apimodelplotconfig - */ -export class ModelPlotConfigEnabled { - /** - * If true, enables calculation and storage of the model bounds for each entity that is being analyzed. - */ - enabled: boolean - /** - * @since 7.9.0 - * @server_default true - */ +export class ModelPlotConfigEnabled implements OverloadOf { annotations_enabled?: boolean - /** - * stability: experimental - * @since 7.9.0 - */ - terms?: string + enabled: boolean + terms?: Field } diff --git a/specification/ml/_types/Page.ts b/specification/ml/_types/Page.ts index 671564adcf..757dc55adb 100644 --- a/specification/ml/_types/Page.ts +++ b/specification/ml/_types/Page.ts @@ -20,6 +20,14 @@ import { integer } from '@_types/Numeric' export class Page { + /** + * Skips the specified number of items. + * @server_default 0 + */ from?: integer + /** + * Specifies the maximum number of items to obtain. + * @server_default 10000 + */ size?: integer } diff --git a/specification/ml/_types/Rule.ts b/specification/ml/_types/Rule.ts index 93493d6918..4bce66fe1c 100644 --- a/specification/ml/_types/Rule.ts +++ b/specification/ml/_types/Rule.ts @@ -25,6 +25,7 @@ import { FilterRef } from './Filter' export class DetectionRule { /** * The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. + * @server_default ['skip_result'] */ actions?: RuleAction[] /** diff --git a/specification/ml/_types/Settings.ts b/specification/ml/_types/Settings.ts index ca2acd4b31..fb6e91c259 100644 --- a/specification/ml/_types/Settings.ts +++ b/specification/ml/_types/Settings.ts @@ -17,14 +17,11 @@ * under the License. */ -import { Dictionary } from '@spec_utils/Dictionary' -import { UrlConfig } from '@xpack/usage/types' -import { AdditionalProperties } from '@spec_utils/behaviors' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -export class CustomSettings - implements AdditionalProperties { - custom_urls?: UrlConfig[] - created_by?: string - job_tags?: Dictionary -} +/** + * Custom metadata about the job + */ +// Can be anything, see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html +// Some settings are illustrated in https://www.elastic.co/guide/en/machine-learning/7.15/ml-configuring-url.html +export type CustomSettings = UserDefinedValue diff --git a/specification/ml/_types/TrainedModel.ts b/specification/ml/_types/TrainedModel.ts index 7afaf3c55f..c16984cb6b 100644 --- a/specification/ml/_types/TrainedModel.ts +++ b/specification/ml/_types/TrainedModel.ts @@ -69,7 +69,7 @@ export class TrainedModelConfig { /** Any field map described in the inference configuration takes precedence. */ default_field_map?: Dictionary /** The free-text description of the trained model. */ - description: string + description?: string /** The estimated heap usage in bytes to keep the trained model in memory. */ estimated_heap_memory_usage_bytes?: integer /** The estimated number of operations to use the trained model. */ diff --git a/specification/ml/close_job/MlCloseJobRequest.ts b/specification/ml/close_job/MlCloseJobRequest.ts index 40f8c8ade2..8a6db3ea99 100644 --- a/specification/ml/close_job/MlCloseJobRequest.ts +++ b/specification/ml/close_job/MlCloseJobRequest.ts @@ -22,18 +22,59 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Closes one or more anomaly detection jobs. + * A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + * When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + * If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + * When a datafeed that has a specified end date stops, it automatically closes its associated job. * @rest_spec_name ml.close_job * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier. + */ job_id: Id } - query_parameters?: { + query_parameters: { + /** + * Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches. + * If `false`, the request returns a 404 status code when there are no matches or only partial matches. + * @server_default true + */ + allow_no_match?: boolean + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ allow_no_jobs?: boolean + /** + * Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots. + * If you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future. + * @server_default false + */ force?: boolean - /** @server_default 30s */ + /** + * Controls the time to wait until a job has closed. + * @server_default 30m */ + timeout?: Time + } + body: { + /** + * Refer to the description for the `allow_no_match` query parameter. + * @server_default true + */ + allow_no_match?: boolean + /** + * Refer to the descriptiion for the `force` query parameter. + * @server_default false + */ + force?: boolean + /** + * Refer to the description for the `timeout` query parameter. + * @server_default 30m */ timeout?: Time } } diff --git a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts index 6a32de9d17..b683a421a4 100644 --- a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts +++ b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts @@ -21,12 +21,15 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Removes all scheduled events from a calendar, then deletes it. * @rest_spec_name ml.delete_calendar * @since 6.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** A string that uniquely identifies a calendar. */ calendar_id: Id } } diff --git a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts index 971d4d2ea1..49d4cd3b30 100644 --- a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts +++ b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts @@ -21,12 +21,13 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes scheduled events from a calendar. * @rest_spec_name ml.delete_calendar_event * @since 6.2.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { calendar_id: Id event_id: Id } diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts index 950fb3be0c..6fde3683fd 100644 --- a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts +++ b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts @@ -21,13 +21,17 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes anomaly detection jobs from a calendar. * @rest_spec_name ml.delete_calendar_job * @since 6.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** A string that uniquely identifies a calendar. */ calendar_id: Id + /** An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. */ job_id: Id } } diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts b/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts index b5a108d308..d26147bb40 100644 --- a/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts +++ b/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts @@ -21,8 +21,11 @@ import { Id, Ids } from '@_types/common' export class Response { body: { + /** A string that uniquely identifies a calendar. */ calendar_id: Id + /** A description of the calendar. */ description?: string + /** A list of anomaly detection job identifiers or group names. */ job_ids: Ids } } diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts index dc51002d26..dd0a077d22 100644 --- a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts +++ b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts @@ -22,18 +22,29 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Deletes a data frame analytics job. * @rest_spec_name ml.delete_data_frame_analytics * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the data frame analytics job. + */ id: Id } - query_parameters?: { - /** @server_default false */ + query_parameters: { + /** + * If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + * @server_default false + */ force?: boolean - /** @server_default 1m */ + /** + * The time to wait for the job to be deleted. + * @server_default 1m + */ timeout?: Time } } diff --git a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts index dd76e9d88a..4e6c696619 100644 --- a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts +++ b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts @@ -21,15 +21,27 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes an existing datafeed. * @rest_spec_name ml.delete_datafeed * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * A numerical character string that uniquely identifies the datafeed. This + * identifier can contain lowercase alphanumeric characters (a-z and 0-9), + * hyphens, and underscores. It must start and end with alphanumeric + * characters. + */ datafeed_id: Id } - query_parameters?: { + query_parameters: { + /** + * Use to forcefully delete a started datafeed; this method is quicker than + * stopping and deleting the datafeed. + */ force?: boolean } } diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts index 28f1b5ddfd..0f7bc24485 100644 --- a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts +++ b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts @@ -18,27 +18,55 @@ */ import { RequestBase } from '@_types/Base' -import { Name } from '@_types/common' +import { Id } from '@_types/common' import { float } from '@_types/Numeric' import { Time } from '@_types/Time' /** + * Deletes expired and unused machine learning data. + * Deletes all job results, model snapshots and forecast data that have exceeded + * their retention days period. Machine learning state documents that are not + * associated with any job are also deleted. + * You can limit the request to a single or set of anomaly detection jobs by + * using a job identifier, a group name, a comma-separated list of jobs, or a + * wildcard expression. You can delete expired data for all anomaly detection + * jobs by using _all, by specifying * as the , or by omitting the + * . * @rest_spec_name ml.delete_expired_data * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { - name?: Name + path_parts: { + /** + * Identifier for an anomaly detection job. It can be a job identifier, a + * group name, or a wildcard expression. + */ + job_id?: Id } - query_parameters?: { + query_parameters: { + /** + * The desired requests per second for the deletion processes. The default + * behavior is no throttling. + */ requests_per_second?: float - /** @server_default 8h */ + /** + * How long can the underlying delete processes run until they are canceled. + * @server_default 8h + */ timeout?: Time } - body?: { + body: { + /** + * The desired requests per second for the deletion processes. The default + * behavior is no throttling. + */ requests_per_second?: float - /** @server_default 8h */ + /** + * How long can the underlying delete processes run until they are canceled. + * @server_default 8h + */ timeout?: Time } } diff --git a/specification/ml/delete_filter/MlDeleteFilterRequest.ts b/specification/ml/delete_filter/MlDeleteFilterRequest.ts index d624937dee..df113a325b 100644 --- a/specification/ml/delete_filter/MlDeleteFilterRequest.ts +++ b/specification/ml/delete_filter/MlDeleteFilterRequest.ts @@ -21,12 +21,19 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes a filter. + * If an anomaly detection job references the filter, you cannot delete the + * filter. You must update or delete the job before you can delete the filter. * @rest_spec_name ml.delete_filter * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * A string that uniquely identifies a filter. + */ filter_id: Id } } diff --git a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts index fd00201f32..64fb8203ff 100644 --- a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts +++ b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts @@ -22,17 +22,44 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Deletes forecasts from a machine learning job. + * By default, forecasts are retained for 14 days. You can specify a + * different retention period with the `expires_in` parameter in the forecast + * jobs API. The delete forecast API enables you to delete one or more + * forecasts before they expire. * @rest_spec_name ml.delete_forecast * @since 6.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id + /** + * A comma-separated list of forecast identifiers. If you do not specify + * this optional parameter or if you specify `_all` or `*` the API deletes + * all forecasts from the job. + */ forecast_id?: Id } - query_parameters?: { + query_parameters: { + /** + * Specifies whether an error occurs when there are no forecasts. In + * particular, if this parameter is set to `false` and there are no + * forecasts associated with the job, attempts to delete all forecasts + * return an error. + * @server_default true + */ allow_no_forecasts?: boolean + /** + * Specifies the period of time to wait for the completion of the delete + * operation. When this period of time elapses, the API fails and returns an + * error. + * @server_default 30s + */ timeout?: Time } } diff --git a/specification/ml/delete_job/MlDeleteJobRequest.ts b/specification/ml/delete_job/MlDeleteJobRequest.ts index 1e53832740..ad305dfc37 100644 --- a/specification/ml/delete_job/MlDeleteJobRequest.ts +++ b/specification/ml/delete_job/MlDeleteJobRequest.ts @@ -21,16 +21,37 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes an anomaly detection job. + * + * All job configuration, model state and results are deleted. + * It is not currently possible to delete multiple jobs using wildcards or a + * comma separated list. If you delete a job that has a datafeed, the request + * first tries to delete the datafeed. This behavior is equivalent to calling + * the delete datafeed API with the same timeout and force parameters as the + * delete job request. * @rest_spec_name ml.delete_job * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id } - query_parameters?: { + query_parameters: { + /** + * Use to forcefully delete an opened job; this method is quicker than + * closing and deleting the job. + */ force?: boolean + /** + * Specifies whether the request should return immediately or wait until the + * job deletion completes. + * @server_default true + */ wait_for_completion?: boolean } } diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts index 30d2e8e741..5ef84f2138 100644 --- a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts +++ b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts @@ -21,13 +21,24 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes an existing model snapshot. + * You cannot delete the active model snapshot. To delete that snapshot, first + * revert to a different one. To identify the active model snapshot, refer to + * the `model_snapshot_id` in the results from the get jobs API. * @rest_spec_name ml.delete_model_snapshot * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id + /** + * Identifier for the model snapshot. + */ snapshot_id: Id } } diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts index 0a2775973c..b219d682fa 100644 --- a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts +++ b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts @@ -21,12 +21,18 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Deletes an existing trained inference model that is currently not referenced + * by an ingest pipeline. * @rest_spec_name ml.delete_trained_model * @since 7.10.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * The unique identifier of the trained model. + */ model_id: Id } } diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts index 22a189b3c7..e6df475bd8 100644 --- a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts +++ b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts @@ -21,13 +21,24 @@ import { RequestBase } from '@_types/Base' import { Id, Name } from '@_types/common' /** + * Deletes a trained model alias. + * This API deletes an existing model alias that refers to a trained model. If + * the model alias is missing or refers to a model other than the one identified + * by the `model_id`, this API returns an error. * @rest_spec_name ml.delete_trained_model_alias * @since 7.13.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * The model alias to delete. + */ model_alias: Name + /** + * The trained model ID to which the model alias refers. + */ model_id: Id } } diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts index 995de489d2..9eefaa5551 100644 --- a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts +++ b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts @@ -24,14 +24,38 @@ import { Field } from '@_types/common' import { long } from '@_types/Numeric' /** + * Makes an estimation of the memory usage for an anomaly detection job model. + * It is based on analysis configuration details for the job and cardinality + * estimates for the fields it references. * @rest_spec_name ml.estimate_model_memory * @since 7.7.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - body?: { + body: { + /** + * For a list of the properties that you can specify in the + * `analysis_config` component of the body of this API. + */ analysis_config?: AnalysisConfig + /** + * Estimates of the highest cardinality in a single bucket that is observed + * for influencer fields over the time period that the job analyzes data. + * To produce a good answer, values must be provided for all influencer + * fields. Providing values for fields that are not listed as `influencers` + * has no effect on the estimation. + */ max_bucket_cardinality?: Dictionary + /** + * Estimates of the cardinality that is observed for fields over the whole + * time period that the job analyzes data. To produce a good answer, values + * must be provided for fields referenced in the `by_field_name`, + * `over_field_name` and `partition_field_name` of any detectors. Providing + * values for other fields has no effect on the estimation. It can be + * omitted from the request if no detectors have a `by_field_name`, + * `over_field_name` or `partition_field_name`. + */ overall_cardinality?: Dictionary } } diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts index 88d3cd22b7..0436c6ec62 100644 --- a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts +++ b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts @@ -23,9 +23,15 @@ import { IndexName } from '@_types/common' import { QueryContainer } from '@_types/query_dsl/abstractions' /** + * Evaluates the data frame analytics for an annotated index. + * The API packages together commonly used evaluation metrics for various types + * of machine learning features. This has been designed for use on indexes + * created by data frame analytics. Evaluation requires both a ground truth + * field and an analytics result field to be present. * @rest_spec_name ml.evaluate_data_frame * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { body: { diff --git a/specification/ml/evaluate_data_frame/types.ts b/specification/ml/evaluate_data_frame/types.ts index 0459b42321..1fc221b24d 100644 --- a/specification/ml/evaluate_data_frame/types.ts +++ b/specification/ml/evaluate_data_frame/types.ts @@ -96,22 +96,22 @@ export class ConfusionMatrixPrediction { export class ConfusionMatrixThreshold { /** * True Positive - * @identifier true_positive + * @codegen_name true_positive */ tp: integer /** * False Positive - * @identifier false_positive + * @codegen_name false_positive */ fp: integer /** * True Negative - * @identifier true_negative + * @codegen_name true_negative */ tn: integer /** * False Negative - * @identifier false_negative + * @codegen_name false_negative */ fn: integer } diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts index f49d0f3d63..f64af20b72 100644 --- a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts +++ b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts @@ -28,35 +28,77 @@ import { ByteSize, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Explains a data frame analytics config. + * This API provides explanations for a data frame analytics config that either + * exists already or one that has not been created yet. The following + * explanations are provided: + * * which fields are included or not in the analysis and why, + * * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + * If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. * @rest_spec_name ml.explain_data_frame_analytics * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. */ + /** + * Identifier for the data frame analytics job. This identifier can contain + * lowercase alphanumeric characters (a-z and 0-9), hyphens, and + * underscores. It must start and end with alphanumeric characters. + */ id?: Id } - body?: { - /** The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified. */ + body: { + /** + * The configuration of how to source the analysis data. It requires an + * index. Optionally, query and _source may be specified. + */ source?: DataframeAnalyticsSource - /** The destination configuration, consisting of index and optionally results_field (ml by default). */ + /** + * The destination configuration, consisting of index and optionally + * results_field (ml by default). + */ dest?: DataframeAnalyticsDestination - /** The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression. */ - analysis: DataframeAnalysisContainer - /** A description of the job. */ + /** + * The analysis configuration, which contains the information necessary to + * perform one of the following types of analysis: classification, outlier + * detection, or regression. + */ + analysis?: DataframeAnalysisContainer + /** + * A description of the job. + */ description?: string /** - * The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting. + * The approximate maximum amount of memory resources that are permitted for + * analytical processing. The default value for data frame analytics jobs is + * 1gb. If your elasticsearch.yml file contains an + * xpack.ml.max_model_memory_limit setting, an error occurs when you try to + * create data frame analytics jobs that have model_memory_limit values + * greater than that setting. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html */ model_memory_limit?: string - /** The maximum number of threads to be used by the analysis. The default value is 1. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. */ + /** + * The maximum number of threads to be used by the analysis. The default + * value is 1. Using more threads may decrease the time necessary to + * complete the analysis at the cost of using more CPU. Note that the + * process may use additional threads for operational functionality other + * than the analysis itself. + */ max_num_threads?: integer - /** Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis. */ + /** + * Specify includes and/or excludes patterns to select which fields will be + * included in the analysis. The patterns specified in excludes are applied + * last, therefore excludes takes precedence. In other words, if the same + * field is specified in both includes and excludes, then the field will not + * be included in the analysis. + */ analyzed_fields?: DataframeAnalysisAnalyzedFields /** - * Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. + * Specifies whether this job can start when there is insufficient machine + * learning node capacity for it to be immediately assigned to a node. * @server_default false * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings */ diff --git a/specification/ml/flush_job/MlFlushJobRequest.ts b/specification/ml/flush_job/MlFlushJobRequest.ts index 12b5b530ca..bb2b4babc0 100644 --- a/specification/ml/flush_job/MlFlushJobRequest.ts +++ b/specification/ml/flush_job/MlFlushJobRequest.ts @@ -22,21 +22,54 @@ import { Id } from '@_types/common' import { DateString } from '@_types/Time' /** + * Forces any buffered data to be processed by the job. + * The flush jobs API is only applicable when sending data for analysis using + * the post data API. Depending on the content of the buffer, then it might + * additionally calculate new results. Both flush and close operations are + * similar, however the flush is more efficient if you are expecting to send + * more data for analysis. When flushing, the job remains open and is available + * to continue analyzing data. A close operation additionally prunes and + * persists the model state to disk and the job must be opened again before + * analyzing further data. * @rest_spec_name ml.flush_job * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id } - query_parameters?: { + query_parameters: { + /** + * Specifies to skip to a particular time value. Results are not generated + * and the model is not updated for data from the specified time interval. + */ skip_time?: string } - body?: { + body: { + /** + * Specifies to advance to a particular time value. Results are generated + * and the model is updated for data from the specified time interval. + */ advance_time?: DateString + /** + * If true, calculates the interim results for the most recent bucket or all + * buckets within the latency period. + */ calc_interim?: boolean + /** + * When used in conjunction with `calc_interim`, specifies the range of + * buckets on which to calculate interim results. + */ end?: DateString + /** + * When used in conjunction with calc_interim, specifies the range of + * buckets on which to calculate interim results. + */ start?: DateString } } diff --git a/specification/ml/forecast/MlForecastJobRequest.ts b/specification/ml/forecast/MlForecastJobRequest.ts new file mode 100644 index 0000000000..417a1c3f65 --- /dev/null +++ b/specification/ml/forecast/MlForecastJobRequest.ts @@ -0,0 +1,67 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { Time } from '@_types/Time' + +/** + * Predicts the future behavior of a time series by using its historical + * behavior. + * You can create a forecast job based on an anomaly detection job to + * extrapolate future behavior. You can delete a forecast by using the Delete + * forecast API. + * @rest_spec_name ml.forecast + * @since 6.1.0 + * @stability stable + * @cluster_privileges manage_ml + */ +export interface Request extends RequestBase { + path_parts: { + /** + * Identifier for the anomaly detection job. + */ + job_id: Id + } + body: { + /** + * A period of time that indicates how far into the future to forecast. For + * example, `30d` corresponds to 30 days. The forecast starts at the last + * record that was processed. + * @server_default 1d + */ + duration?: Time + /** + * The period of time that forecast results are retained. After a forecast + * expires, the results are deleted. If set to a value of 0, the forecast is + * never automatically deleted. + * @server_default 14d + */ + expires_in?: Time + /** + * The maximum memory the forecast can use. If the forecast needs to use + * more than the provided amount, it will spool to disk. Default is 20mb, + * maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s + * configured memory limit, it is automatically reduced to below that + * amount. + * @server_default 20mb + */ + max_model_memory?: string + } +} diff --git a/specification/ml/forecast_job/MlForecastJobResponse.ts b/specification/ml/forecast/MlForecastJobResponse.ts similarity index 100% rename from specification/ml/forecast_job/MlForecastJobResponse.ts rename to specification/ml/forecast/MlForecastJobResponse.ts diff --git a/specification/ml/get_anomaly_records/MlGetAnomalyRecordsRequest.ts b/specification/ml/get_anomaly_records/MlGetAnomalyRecordsRequest.ts deleted file mode 100644 index a60b4c5d76..0000000000 --- a/specification/ml/get_anomaly_records/MlGetAnomalyRecordsRequest.ts +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { Page } from '@ml/_types/Page' -import { RequestBase } from '@_types/Base' -import { Field, Id } from '@_types/common' -import { double, integer } from '@_types/Numeric' -import { DateString } from '@_types/Time' - -/** - * @rest_spec_name ml.get_records - * @since 5.4.0 - * @stability TODO - */ -export interface Request extends RequestBase { - path_parts?: { - job_id: Id - } - query_parameters?: { - /** @server_default false */ - exclude_interim?: boolean - from?: integer - size?: integer - start?: DateString - end?: DateString - } - body?: { - /** @server_default false */ - desc?: boolean - /** @server_default false */ - exclude_interim?: boolean - page?: Page - record_score?: double - sort?: Field - start?: DateString - end?: DateString - } -} diff --git a/specification/ml/get_buckets/MlGetBucketsRequest.ts b/specification/ml/get_buckets/MlGetBucketsRequest.ts index 92c9dd83c7..d2bfa3115d 100644 --- a/specification/ml/get_buckets/MlGetBucketsRequest.ts +++ b/specification/ml/get_buckets/MlGetBucketsRequest.ts @@ -24,37 +24,110 @@ import { double, integer } from '@_types/Numeric' import { DateString, Timestamp } from '@_types/Time' /** + * Retrieves anomaly detection job results for one or more buckets. + * The API presents a chronological view of the records, grouped by bucket. * @rest_spec_name ml.get_buckets * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id + /** + * The timestamp of a single bucket result. If you do not specify this + * parameter, the API returns information about all buckets. + */ timestamp?: Timestamp } - query_parameters?: { + query_parameters: { + /** + * Returns buckets with anomaly scores greater or equal than this value. + * @server_default 0.0 + */ + anomaly_score?: double + /** + * If `true`, the buckets are sorted in descending order. + * @server_default false + */ + desc?: boolean + /** + * Returns buckets with timestamps earlier than this time. `-1` means it is + * unset and results are not limited to specific timestamps. + * @server_default -1 + */ + end?: DateString + /** + * If `true`, the output excludes interim results. + * @server_default false + */ + exclude_interim?: boolean + /** + * If true, the output includes anomaly records. + * @server_default false + */ + expand?: boolean + /** + * Skips the specified number of buckets. + * @server_default 0 + */ from?: integer + /** + * Specifies the maximum number of buckets to obtain. + * @server_default 100 + */ size?: integer - /** @server_default false */ - exclude_interim?: boolean + /** + * Specifies the sort field for the requested buckets. + * @server_default timestamp + */ sort?: Field - /** @server_default false */ - desc?: boolean + /** + * Returns buckets with timestamps after this time. `-1` means it is unset + * and results are not limited to specific timestamps. + * @server_default -1 + */ start?: DateString - end?: DateString } - body?: { + body: { + /** + * Refer to the description for the `anomaly_score` query parameter. + * @server_default 0.0 + */ anomaly_score?: double - /** @server_default false */ + /** + * Refer to the description for the `desc` query parameter. + * @server_default false + */ desc?: boolean - /** @server_default false */ + /** + * Refer to the description for the `end` query parameter. + * @server_default -1 + */ + end?: DateString + /** + * Refer to the description for the `exclude_interim` query parameter. + * @server_default false + */ exclude_interim?: boolean - /** @server_default false */ + /** + * Refer to the description for the `expand` query parameter. + * @server_default false + */ expand?: boolean page?: Page + /** + * Refer to the desription for the `sort` query parameter. + * @server_default timestamp + */ sort?: Field + /** + * Refer to the description for the `start` query parameter. + * @server_default -1 + */ start?: DateString - end?: DateString } } diff --git a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts index 60441d97e9..654b098951 100644 --- a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts +++ b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts @@ -23,27 +23,31 @@ import { integer } from '@_types/Numeric' import { DateString } from '@_types/Time' /** + * Retrieves information about the scheduled events in calendars. * @rest_spec_name ml.get_calendar_events * @since 6.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { + /** A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.*/ calendar_id: Id } - query_parameters?: { - job_id?: Id // undocumented - // these params below should all be in the request body, but the tests are failing - // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html#ml-get-calendar-event-request-body + query_parameters: { + /** Specifies to get events with timestamps earlier than this time. */ end?: DateString + /** Skips the specified number of events. + * @server_default 0 + */ from?: integer - start?: string + /** Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. */ + job_id?: Id + /** Specifies the maximum number of events to obtain. + * @server_default 100 + */ size?: integer - } - body?: { - end?: DateString - from?: integer + /** Specifies to get events with timestamps after this time. */ start?: string - size?: integer } } diff --git a/specification/ml/get_calendars/MlGetCalendarsRequest.ts b/specification/ml/get_calendars/MlGetCalendarsRequest.ts index 18a32d581e..df5b5ab564 100644 --- a/specification/ml/get_calendars/MlGetCalendarsRequest.ts +++ b/specification/ml/get_calendars/MlGetCalendarsRequest.ts @@ -23,22 +23,29 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves configuration information for calendars. * @rest_spec_name ml.get_calendars * @since 6.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { - /** A string that uniquely identifies a calendar. */ + path_parts: { + /** A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.*/ calendar_id?: Id } - query_parameters?: { - /** Skips the specified number of calendars. */ + query_parameters: { + /** Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + * @server_default 0 + */ from?: integer - /** Specifies the maximum number of calendars to obtain. */ + /** Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. + * @server_default 10000 + */ size?: integer } - body?: { + body: { + /** This object is supported only when you omit the calendar identifier. */ page?: Page } } diff --git a/specification/ml/get_calendars/types.ts b/specification/ml/get_calendars/types.ts index 7c1dc3d096..61717e801f 100644 --- a/specification/ml/get_calendars/types.ts +++ b/specification/ml/get_calendars/types.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' export class Calendar { /** A string that uniquely identifies a calendar. */ calendar_id: Id + /** A description of the calendar. */ description?: string /** An array of anomaly detection job identifiers. */ job_ids: Id[] diff --git a/specification/ml/get_categories/MlGetCategoriesRequest.ts b/specification/ml/get_categories/MlGetCategoriesRequest.ts index f692a0bf8e..055e56695d 100644 --- a/specification/ml/get_categories/MlGetCategoriesRequest.ts +++ b/specification/ml/get_categories/MlGetCategoriesRequest.ts @@ -23,24 +23,44 @@ import { CategoryId, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves anomaly detection job results for one or more categories. * @rest_spec_name ml.get_categories * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the anomaly detection job. */ + /** + * Identifier for the anomaly detection job. + */ job_id: Id - /** Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition. */ + /** + * Identifier for the category, which is unique in the job. If you specify + * neither the category ID nor the partition_field_value, the API returns + * information about all categories. If you specify only the + * partition_field_value, it returns information about all categories for + * the specified partition. + */ category_id?: CategoryId } - query_parameters?: { + query_parameters: { + /** + * Skips the specified number of categories. + * @server_default 0 + */ from?: integer - size?: integer - /** Only return categories for the specified partition. */ + /** + * Only return categories for the specified partition. + */ partition_field_value?: string + /** + * Specifies the maximum number of categories to obtain. + * @server_default 100 + */ + size?: integer } - body?: { + body: { page?: Page } } diff --git a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts index 05b48c33f9..a922a22388 100644 --- a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts +++ b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts @@ -22,17 +22,37 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves configuration information for data frame analytics jobs. + * You can get information for multiple data frame analytics jobs in a single + * API request by using a comma-separated list of data frame analytics jobs or a + * wildcard expression. * @rest_spec_name ml.get_data_frame_analytics * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { - /** Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs. */ + path_parts: { + /** + * Identifier for the data frame analytics job. If you do not specify this + * option, the API returns information for the first hundred data frame + * analytics jobs. + */ id?: Id } - query_parameters?: { + query_parameters: { /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no data frame analytics + * jobs that match. + * 2. Contains the `_all` string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value returns an empty data_frame_analytics array when there + * are no matches and the subset of results when there are partial matches. + * If this parameter is `false`, the request returns a 404 status code when + * there are no matches or only partial matches. * @server_default true */ allow_no_match?: boolean @@ -47,7 +67,9 @@ export interface Request extends RequestBase { */ size?: integer /** - * Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. + * Indicates if certain fields should be removed from the configuration on + * retrieval. This allows the configuration to be in an acceptable format to + * be retrieved and then added to another cluster. * @server_default false */ exclude_generated?: boolean diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts index 41cd6bdae2..1ffc1eb347 100644 --- a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts +++ b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts @@ -22,17 +22,34 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves usage information for data frame analytics jobs. * @rest_spec_name ml.get_data_frame_analytics_stats * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { - /** Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs. */ + path_parts: { + /** + * Identifier for the data frame analytics job. If you do not specify this + * option, the API returns information for the first hundred data frame + * analytics jobs. + */ id?: Id } - query_parameters?: { + query_parameters: { /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no data frame analytics + * jobs that match. + * 2. Contains the `_all` string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value returns an empty data_frame_analytics array when there + * are no matches and the subset of results when there are partial matches. + * If this parameter is `false`, the request returns a 404 status code when + * there are no matches or only partial matches. * @server_default true */ allow_no_match?: boolean diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts index 2003ad8886..d2f5714884 100644 --- a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts +++ b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts @@ -21,15 +21,44 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** + * Retrieves usage information for datafeeds. + * You can get statistics for multiple datafeeds in a single API request by + * using a comma-separated list of datafeeds or a wildcard expression. You can + * get statistics for all datafeeds by using `_all`, by specifying `*` as the + * ``, or by omitting the ``. If the datafeed is stopped, the + * only information you receive is the `datafeed_id` and the `state`. + * This API returns a maximum of 10,000 datafeeds. * @rest_spec_name ml.get_datafeed_stats * @since 5.5.0 * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the datafeed. It can be a datafeed identifier or a + * wildcard expression. If you do not specify one of these options, the API + * returns information about all datafeeds. + */ datafeed_id?: Ids } - query_parameters?: { + query_parameters: { + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ allow_no_datafeeds?: boolean + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no datafeeds that match. + * 2. Contains the `_all` string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value is `true`, which returns an empty `datafeeds` array + * when there are no matches and the subset of results when there are + * partial matches. If this parameter is `false`, the request returns a + * `404` status code when there are no matches or only partial matches. + */ + allow_no_match?: boolean } } diff --git a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts index 72073c6768..3d8b50aaa3 100644 --- a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts +++ b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts @@ -21,16 +21,50 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** + * Retrieves configuration information for datafeeds. + * You can get information for multiple datafeeds in a single API request by + * using a comma-separated list of datafeeds or a wildcard expression. You can + * get information for all datafeeds by using `_all`, by specifying `*` as the + * ``, or by omitting the ``. + * This API returns a maximum of 10,000 datafeeds. * @rest_spec_name ml.get_datafeeds * @since 5.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the datafeed. It can be a datafeed identifier or a + * wildcard expression. If you do not specify one of these options, the API + * returns information about all datafeeds. + */ datafeed_id?: Ids } - query_parameters?: { + query_parameters: { + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ allow_no_datafeeds?: boolean + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no datafeeds that match. + * 2. Contains the `_all` string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value is `true`, which returns an empty `datafeeds` array + * when there are no matches and the subset of results when there are + * partial matches. If this parameter is `false`, the request returns a + * `404` status code when there are no matches or only partial matches. + */ + allow_no_match?: boolean + /** + * Indicates if certain fields should be removed from the configuration on + * retrieval. This allows the configuration to be in an acceptable format to + * be retrieved and then added to another cluster. + * @server_default false + */ exclude_generated?: boolean } } diff --git a/specification/ml/get_filters/MlGetFiltersRequest.ts b/specification/ml/get_filters/MlGetFiltersRequest.ts index 9d6e8d8205..eea4a4a326 100644 --- a/specification/ml/get_filters/MlGetFiltersRequest.ts +++ b/specification/ml/get_filters/MlGetFiltersRequest.ts @@ -18,20 +18,34 @@ */ import { RequestBase } from '@_types/Base' -import { Id } from '@_types/common' +import { Ids } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves filters. + * You can get a single filter or all filters. * @rest_spec_name ml.get_filters * @since 5.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { - filter_id?: Id + path_parts: { + /** + * A string that uniquely identifies a filter. + */ + filter_id?: Ids } - query_parameters?: { + query_parameters: { + /** + * Skips the specified number of filters. + * @server_default 0 + */ from?: integer + /** + * Specifies the maximum number of filters to obtain. + * @server_default 100 + */ size?: integer } } diff --git a/specification/ml/get_influencers/MlGetInfluencersRequest.ts b/specification/ml/get_influencers/MlGetInfluencersRequest.ts index 9f504603e7..79786245d3 100644 --- a/specification/ml/get_influencers/MlGetInfluencersRequest.ts +++ b/specification/ml/get_influencers/MlGetInfluencersRequest.ts @@ -24,37 +24,70 @@ import { double, integer } from '@_types/Numeric' import { DateString } from '@_types/Time' /** + * Retrieves anomaly detection job results for one or more influencers. + * Influencers are the entities that have contributed to, or are to blame for, + * the anomalies. Influencer results are available only if an + * `influencer_field_name` is specified in the job configuration. * @rest_spec_name ml.get_influencers * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the anomaly detection job. */ + /** + * Identifier for the anomaly detection job. + */ job_id: Id } - query_parameters?: { + query_parameters: { /** * If true, the results are sorted in descending order. * @server_default false */ desc?: boolean - /** Returns influencers with timestamps earlier than this time. */ + /** + * Returns influencers with timestamps earlier than this time. + * The default value means it is unset and results are not limited to + * specific timestamps. + * @server_default -1 + */ end?: DateString - /** If true, the output excludes interim results. By default, interim results are included. */ + /** + * If true, the output excludes interim results. By default, interim results + * are included. + * @server_default false + */ exclude_interim?: boolean - /** Returns influencers with anomaly scores greater than or equal to this value. */ + /** + * Returns influencers with anomaly scores greater than or equal to this + * value. + * @server_default 0.0 + */ influencer_score?: double - /** Skips the specified number of influencers. */ + /** + * Skips the specified number of influencers. + * @server_default 0 + */ from?: integer - /** Specifies the maximum number of influencers to obtain. */ + /** + * Specifies the maximum number of influencers to obtain. + * @server_default 100 + */ size?: integer - /** Specifies the sort field for the requested influencers. By default, the influencers are sorted by the influencer_score value. */ + /** + * Specifies the sort field for the requested influencers. By default, the + * influencers are sorted by the `influencer_score` value. + */ sort?: Field - /** Returns influencers with timestamps after this time. */ + /** + * Returns influencers with timestamps after this time. The default value + * means it is unset and results are not limited to specific timestamps. + * @server_default -1 + */ start?: DateString } - body?: { + body: { page?: Page } } diff --git a/specification/ml/get_influencers/MlGetInfluencersResponse.ts b/specification/ml/get_influencers/MlGetInfluencersResponse.ts index 0e3f0106e4..ef6ec79907 100644 --- a/specification/ml/get_influencers/MlGetInfluencersResponse.ts +++ b/specification/ml/get_influencers/MlGetInfluencersResponse.ts @@ -17,13 +17,13 @@ * under the License. */ -import { BucketInfluencer } from '@ml/_types/Bucket' +import { Influencer } from '@ml/_types/Influencer' import { long } from '@_types/Numeric' export class Response { body: { count: long /** Array of influencer objects */ - influencers: BucketInfluencer[] + influencers: Influencer[] } } diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts index 17dc9d823f..ba518dd90f 100644 --- a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts +++ b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts @@ -21,15 +21,37 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Retrieves usage information for anomaly detection jobs. * @rest_spec_name ml.get_job_stats * @since 5.5.0 * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the anomaly detection job. It can be a job identifier, a + * group name, a comma-separated list of jobs, or a wildcard expression. If + * you do not specify one of these options, the API returns information for + * all anomaly detection jobs. + */ job_id?: Id } - query_parameters?: { + query_parameters: { + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no jobs that match. + * 2. Contains the _all string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value is `true`, which returns an empty `jobs` array when + * there are no matches and the subset of results when there are partial + * matches. If this parameter is `false`, the request returns a `404` status + * code when there are no matches or only partial matches. + * @server_default true + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ allow_no_jobs?: boolean } } diff --git a/specification/ml/get_jobs/MlGetJobsRequest.ts b/specification/ml/get_jobs/MlGetJobsRequest.ts index 1deace2812..d910ed91bc 100644 --- a/specification/ml/get_jobs/MlGetJobsRequest.ts +++ b/specification/ml/get_jobs/MlGetJobsRequest.ts @@ -21,20 +21,50 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** + * Retrieves configuration information for anomaly detection jobs. + * You can get information for multiple anomaly detection jobs in a single API + * request by using a group name, a comma-separated list of jobs, or a wildcard + * expression. You can get information for all anomaly detection jobs by using + * `_all`, by specifying `*` as the ``, or by omitting the ``. * @rest_spec_name ml.get_jobs * @since 5.5.0 * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the anomaly detection job. It can be a job identifier, a + * group name, or a wildcard expression. If you do not specify one of these + * options, the API returns information for all anomaly detection jobs. + */ job_id?: Ids } - query_parameters?: { - /** @server_default true */ + query_parameters: { + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no jobs that match. + * 2. Contains the _all string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value is `true`, which returns an empty `jobs` array when + * there are no matches and the subset of results when there are partial + * matches. If this parameter is `false`, the request returns a `404` status + * code when there are no matches or only partial matches. + * @server_default true + */ allow_no_match?: boolean - /** @server_default true */ + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ allow_no_jobs?: boolean - /** @server_default false */ + /** + * Indicates if certain fields should be removed from the configuration on + * retrieval. This allows the configuration to be in an acceptable format to + * be retrieved and then added to another cluster. + * @server_default false + */ exclude_generated?: boolean } } diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts new file mode 100644 index 0000000000..c614fd456a --- /dev/null +++ b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts @@ -0,0 +1,57 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Retrieves usage information for anomaly detection job model snapshot upgrades. + * @rest_spec_name ml.get_model_snapshot_upgrade_stats + * @since 7.16.0 + * @stability stable + * @cluster_privileges monitor_ml + */ +export interface Request extends RequestBase { + path_parts: { + /** + * Identifier for the anomaly detection job. + */ + job_id: Id + /** + * A numerical character string that uniquely identifies the model snapshot. You can get information for multiple + * snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, + * by specifying `*` as the snapshot ID, or by omitting the snapshot ID. + */ + snapshot_id?: Id + } + query_parameters: { + /** + * Specifies what to do when the request: + * + * - Contains wildcard expressions and there are no jobs that match. + * - Contains the _all string or no identifiers and there are no matches. + * - Contains wildcard expressions and there are only partial matches. + * + * The default value is true, which returns an empty jobs array when there are no matches and the subset of results + * when there are partial matches. If this parameter is false, the request returns a 404 status code when there are + * no matches or only partial matches. + */ + allow_no_match?: boolean + } +} diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsResponse.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsResponse.ts new file mode 100644 index 0000000000..145c96b75b --- /dev/null +++ b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsResponse.ts @@ -0,0 +1,28 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { long } from '@_types/Numeric' +import { ModelSnapshotUpgrade } from '@ml/_types/Model' + +export class Response { + body: { + count: long + model_snapshot_upgrades: ModelSnapshotUpgrade[] + } +} diff --git a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts index 8955cc500e..43261ff57e 100644 --- a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts +++ b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts @@ -17,39 +17,80 @@ * under the License. */ +import { Page } from '@ml/_types/Page' import { RequestBase } from '@_types/Base' import { Field, Id } from '@_types/common' import { integer } from '@_types/Numeric' import { Time } from '@_types/Time' /** + * Retrieves information about model snapshots. * @rest_spec_name ml.get_model_snapshots * @since 5.4.0 * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the anomaly detection job. */ + /** + * Identifier for the anomaly detection job. + */ job_id: Id - /** A numerical character string that uniquely identifies the model snapshot. */ + /** + * A numerical character string that uniquely identifies the model snapshot. You can get information for multiple + * snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, + * by specifying `*` as the snapshot ID, or by omitting the snapshot ID. + */ snapshot_id?: Id } - query_parameters?: { - /** If true, the results are sorted in descending order. */ + query_parameters: { + /** + * If true, the results are sorted in descending order. + * @server_default false + */ desc?: boolean - /** Returns snapshots with timestamps earlier than this time. */ + /** + * Returns snapshots with timestamps earlier than this time. + */ end?: Time - /** Skips the specified number of snapshots. */ + /** + * Skips the specified number of snapshots. + * @server_default 0 + */ from?: integer - /** Specifies the maximum number of snapshots to obtain. */ + /** + * Specifies the maximum number of snapshots to obtain. + * @server_default 100 + */ size?: integer - /** Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp. */ + /** + * Specifies the sort field for the requested snapshots. By default, the + * snapshots are sorted by their timestamp. + */ sort?: Field - /** Returns snapshots with timestamps after this time. */ + /** + * Returns snapshots with timestamps after this time. + */ start?: Time } - body?: { - start?: Time + body: { + /** + * Refer to the description for the `desc` query parameter. + * @server_default false + */ + desc?: boolean + /** + * Refer to the description for the `end` query parameter. + */ end?: Time + page?: Page + /** + * Refer to the description for the `sort` query parameter. + */ + sort?: Field + /** + * Refer to the description for the `start` query parameter. + */ + start?: Time } } diff --git a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts index 30868add35..28f333ea7c 100644 --- a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts +++ b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts @@ -23,34 +23,125 @@ import { double, integer } from '@_types/Numeric' import { Time } from '@_types/Time' /** + * Retrieves overall bucket results that summarize the bucket results of + * multiple anomaly detection jobs. + * + * The `overall_score` is calculated by combining the scores of all the + * buckets within the overall bucket span. First, the maximum + * `anomaly_score` per anomaly detection job in the overall bucket is + * calculated. Then the `top_n` of those scores are averaged to result in + * the `overall_score`. This means that you can fine-tune the + * `overall_score` so that it is more or less sensitive to the number of + * jobs that detect an anomaly at the same time. For example, if you set + * `top_n` to `1`, the `overall_score` is the maximum bucket score in the + * overall bucket. Alternatively, if you set `top_n` to the number of jobs, + * the `overall_score` is high only when all jobs detect anomalies in that + * overall bucket. If you set the `bucket_span` parameter (to a value + * greater than its default), the `overall_score` is the maximum + * `overall_score` of the overall buckets that have a span equal to the + * jobs' largest bucket span. * @rest_spec_name ml.get_overall_buckets * @since 6.1.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. */ + /** + * Identifier for the anomaly detection job. It can be a job identifier, a + * group name, a comma-separated list of jobs or groups, or a wildcard + * expression. + * + * You can summarize the bucket results for all anomaly detection jobs by + * using `_all` or by specifying `*` as the ``. + */ job_id: Id } - query_parameters?: { - /** The span of the overall buckets. Must be greater or equal to the largest bucket span of the specified anomaly detection jobs, which is the default value. */ + query_parameters: { + /** + * The span of the overall buckets. Must be greater or equal to the largest + * bucket span of the specified anomaly detection jobs, which is the default + * value. + * + * By default, an overall bucket has a span equal to the largest bucket span + * of the specified anomaly detection jobs. To override that behavior, use + * the optional `bucket_span` parameter. + */ bucket_span?: Time - /** Returns overall buckets with overall scores greater than or equal to this value. */ + /** + * Returns overall buckets with overall scores greater than or equal to this + * value. + */ overall_score?: double | string /** - * The number of top anomaly detection job bucket scores to be used in the overall_score calculation. + * The number of top anomaly detection job bucket scores to be used in the + * `overall_score` calculation. * @server_default 1 */ top_n?: integer - /** Returns overall buckets with timestamps earlier than this time. */ + /** + * Returns overall buckets with timestamps earlier than this time. + */ end?: Time - /** Returns overall buckets with timestamps after this time. */ + /** + * Returns overall buckets with timestamps after this time. + */ start?: Time - /** If true, the output excludes interim results. By default, interim results are included. */ + /** + * If `true`, the output excludes interim results. + * @server_default false + */ exclude_interim?: boolean + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no jobs that match. + * 2. Contains the `_all` string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * If `true`, the request returns an empty `jobs` array when there are no + * matches and the subset of results when there are partial matches. If this + * parameter is `false`, the request returns a `404` status code when there + * are no matches or only partial matches. + * @server_default true + */ allow_no_match?: boolean } - body?: { + body: { + /** + * @deprecated 7.10.0 + */ allow_no_jobs?: boolean + /** + * Refer to the description for the `allow_no_match` query parameter. + * @server_default true + */ + allow_no_match?: boolean + /** + * Refer to the description for the `bucket_span` query parameter. + */ + bucket_span?: Time + /** + * Refer to the description for the `end` query parameter. + */ + end?: Time + /** + * Refer to the description for the `exclude_interim` query parameter. + * @server_default false + */ + exclude_interim?: boolean + /** + * Refer to the description for the `overall_score` query parameter. + */ + overall_score?: double | string + /** + * Refer to the description for the `start` query parameter. + */ + start?: Time + /** + * Refer to the description for the `top_n` query parameter. + * @server_default 1 + */ + top_n?: integer } } diff --git a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts new file mode 100644 index 0000000000..8f84a1d5d7 --- /dev/null +++ b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts @@ -0,0 +1,127 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Page } from '@ml/_types/Page' +import { RequestBase } from '@_types/Base' +import { Field, Id } from '@_types/common' +import { double, integer } from '@_types/Numeric' +import { DateString } from '@_types/Time' + +/** + * Retrieves anomaly records for an anomaly detection job. + * Records contain the detailed analytical results. They describe the anomalous + * activity that has been identified in the input data based on the detector + * configuration. + * There can be many anomaly records depending on the characteristics and size + * of the input data. In practice, there are often too many to be able to + * manually process them. The machine learning features therefore perform a + * sophisticated aggregation of the anomaly records into buckets. + * The number of record results depends on the number of anomalies found in each + * bucket, which relates to the number of time series being modeled and the + * number of detectors. + * @rest_spec_name ml.get_records + * @since 5.4.0 + * @stability stable + * @cluster_privileges monitor_ml + */ +export interface Request extends RequestBase { + path_parts: { + /** + * Identifier for the anomaly detection job. + */ + job_id: Id + } + query_parameters: { + /** + * If true, the results are sorted in descending order. + * @server_default false + */ + desc?: boolean + /** + * Returns records with timestamps earlier than this time. The default value + * means results are not limited to specific timestamps. + * @server_default -1 + */ + end?: DateString + /** + * If `true`, the output excludes interim results. + * @server_default false + */ + exclude_interim?: boolean + /** + * Skips the specified number of records. + * @server_default 0 + */ + from?: integer + /** + * Returns records with anomaly scores greater or equal than this value. + * @server_default 0.0 + */ + record_score?: double + /** + * Specifies the maximum number of records to obtain. + * @server_default 100 + */ + size?: integer + /** + * Specifies the sort field for the requested records. + * @server_default record_score + */ + sort?: Field + /** + * Returns records with timestamps after this time. The default value means + * results are not limited to specific timestamps. + * @server_default -1 + */ + start?: DateString + } + body: { + /** + * Refer to the description for the `desc` query parameter. + * @server_default false + */ + desc?: boolean + /** + * Refer to the description for the `end` query parameter. + * @server_default -1 + */ + end?: DateString + /** + * Refer to the description for the `exclude_interim` query parameter. + * @server_default false + */ + exclude_interim?: boolean + page?: Page + /** + * Refer to the description for the `record_score` query parameter. + * @server_default 0.0 + */ + record_score?: double + /** + * Refer to the description for the `sort` query parameter. + * @server_default record_score + */ + sort?: Field + /** + * Refer to the description for the `start` query parameter. + * @server_default -1 + */ + start?: DateString + } +} diff --git a/specification/ml/get_anomaly_records/MlGetAnomalyRecordsResponse.ts b/specification/ml/get_records/MlGetAnomalyRecordsResponse.ts similarity index 100% rename from specification/ml/get_anomaly_records/MlGetAnomalyRecordsResponse.ts rename to specification/ml/get_records/MlGetAnomalyRecordsResponse.ts diff --git a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts index 45ae257f53..f0c4e72861 100644 --- a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts +++ b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts @@ -20,51 +20,67 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' import { integer } from '@_types/Numeric' +import { Include } from '@ml/_types/Include' /** + * Retrieves configuration information for a trained model. * @rest_spec_name ml.get_trained_models * @since 7.10.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { - /** The unique identifier of the trained model. */ + path_parts: { + /** + * The unique identifier of the trained model. + */ model_id?: Id } - query_parameters?: { + query_parameters: { /** * Specifies what to do when the request: + * * - Contains wildcard expressions and there are no models that match. * - Contains the _all string or no identifiers and there are no matches. * - Contains wildcard expressions and there are only partial matches. + * + * If true, it returns an empty array when there are no matches and the + * subset of results when there are partial matches. + * @server_default true */ allow_no_match?: boolean /** - * Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false). + * Specifies whether the included model definition should be returned as a + * JSON map (true) or in a custom compressed format (false). * @server_default true */ decompress_definition?: boolean /** - * Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. + * Indicates if certain fields should be removed from the configuration on + * retrieval. This allows the configuration to be in an acceptable format to + * be retrieved and then added to another cluster. * @server_default false */ exclude_generated?: boolean /** * Skips the specified number of models. - * @server_default false + * @server_default 0 */ from?: integer /** - * A comma delimited string of optional fields to include in the response body. + * A comma delimited string of optional fields to include in the response + * body. */ - include?: string + include?: Include /** * Specifies the maximum number of models to obtain. * @server_default 100 */ size?: integer /** - * A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned. + * A comma delimited string of tags. A trained model can have many tags, or + * none. When supplied, only trained models that contain all the supplied + * tags are returned. */ tags?: string } diff --git a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts index f07720ffe8..8d3aa2a062 100644 --- a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts +++ b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts @@ -22,26 +22,38 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves usage information for trained models. + * You can get usage information for multiple trained models in a single API + * request by using a comma-separated list of model IDs or a wildcard + * expression. * @rest_spec_name ml.get_trained_models_stats * @since 7.10.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { - /** The unique identifier of the trained model. */ + path_parts: { + /** + * The unique identifier of the trained model or a model alias. + */ model_id?: Id } - query_parameters?: { + query_parameters: { /** * Specifies what to do when the request: + * * - Contains wildcard expressions and there are no models that match. * - Contains the _all string or no identifiers and there are no matches. * - Contains wildcard expressions and there are only partial matches. + * + * If true, it returns an empty array when there are no matches and the + * subset of results when there are partial matches. + * @server_default true */ allow_no_match?: boolean /** * Skips the specified number of models. - * @server_default false + * @server_default 0 */ from?: integer /** diff --git a/specification/ml/info/MlInfoRequest.ts b/specification/ml/info/MlInfoRequest.ts index 4edb2554d4..46eaf6d619 100644 --- a/specification/ml/info/MlInfoRequest.ts +++ b/specification/ml/info/MlInfoRequest.ts @@ -20,8 +20,16 @@ import { RequestBase } from '@_types/Base' /** + * Returns defaults and limits used by machine learning. + * This endpoint is designed to be used by a user interface that needs to fully + * understand machine learning configurations where some options are not + * specified, meaning that the defaults should be used. This endpoint may be + * used to find out what those defaults are. It also provides information about + * the maximum size of machine learning jobs that could run in the current + * cluster configuration. * @rest_spec_name ml.info * @since 6.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase {} diff --git a/specification/ml/open_job/MlOpenJobRequest.ts b/specification/ml/open_job/MlOpenJobRequest.ts index 869b9f3847..e3aa2a37db 100644 --- a/specification/ml/open_job/MlOpenJobRequest.ts +++ b/specification/ml/open_job/MlOpenJobRequest.ts @@ -22,15 +22,38 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Opens one or more anomaly detection jobs. + * An anomaly detection job must be opened in order for it to be ready to + * receive and analyze data. It can be opened and closed multiple times + * throughout its lifecycle. + * When you open a new job, it starts with an empty model. + * When you open an existing job, the most recent model state is automatically + * loaded. The job is ready to resume its analysis from where it left off, once + * new data is received. * @rest_spec_name ml.open_job * @since 5.4.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id } - body?: { + query_parameters: { + /** + * Controls the time to wait until a job has opened. + * @server_default 30m + */ + timeout?: Time + } + body: { + /** + * Refer to the description for the `timeout` query parameter. + * @server_default 30m + */ timeout?: Time } } diff --git a/specification/ml/open_job/MlOpenJobResponse.ts b/specification/ml/open_job/MlOpenJobResponse.ts index f4bc48f369..0d9950e1ef 100644 --- a/specification/ml/open_job/MlOpenJobResponse.ts +++ b/specification/ml/open_job/MlOpenJobResponse.ts @@ -17,11 +17,6 @@ * under the License. */ -import { Id } from '@_types/common' - export class Response { - body: { - opened: boolean - node: Id - } + body: { opened: boolean } } diff --git a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts index 2913f11d27..82bdb7430a 100644 --- a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts +++ b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts @@ -22,17 +22,19 @@ import { Id } from '@_types/common' import { CalendarEvent } from '../_types/CalendarEvent' /** + * Adds scheduled events to a calendar. * @rest_spec_name ml.post_calendar_events * @since 6.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** A string that uniquely identifies a calendar. */ - calendar_id?: Id + calendar_id: Id } body: { - /** A list of one of more scheduled events. The event’s start and end times may be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. */ + /** A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. */ events: CalendarEvent[] } } diff --git a/specification/ml/post_data/MlPostJobDataRequest.ts b/specification/ml/post_data/MlPostJobDataRequest.ts new file mode 100644 index 0000000000..30dc7adb86 --- /dev/null +++ b/specification/ml/post_data/MlPostJobDataRequest.ts @@ -0,0 +1,54 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { DateString } from '@_types/Time' + +/** + * @rest_spec_name ml.post_data + * @since 5.4.0 + * @stability stable + */ +export interface Request extends RequestBase { + path_parts: { + job_id: Id + } + query_parameters: { + reset_end?: DateString + reset_start?: DateString + } + /** + * A sequence of one or more JSON documents containing the data to be analyzed. + * Multiple JSON documents can be sent, either adjacent with no separator in between them or whitespace separated. + * Newline delimited JSON (NDJSON) is a possible whitespace separated format, and for this the `Content-Type header` should be set to `application/x-ndjson`. + * + * The following documents will not be processed: + * + * * Documents not in chronological order and outside the latency window + * * Records with an invalid timestamp + * + * Upload sizes are limited to the Elasticsearch HTTP receive buffer size (default 100 Mb). + * If your data is larger, split it into multiple chunks and upload each one separately in sequential time order. + * When running in real time, it is generally recommended that you perform many small uploads, + * rather than queueing data to upload larger files. + * @codegen_name data + * */ + body: Array +} diff --git a/specification/ml/post_data/MlPostDataResponse.ts b/specification/ml/post_data/MlPostJobDataResponse.ts similarity index 94% rename from specification/ml/post_data/MlPostDataResponse.ts rename to specification/ml/post_data/MlPostJobDataResponse.ts index c927415aaa..55a530ff43 100644 --- a/specification/ml/post_data/MlPostDataResponse.ts +++ b/specification/ml/post_data/MlPostJobDataResponse.ts @@ -23,7 +23,7 @@ import { integer, long } from '@_types/Numeric' export class Response { body: { bucket_count: long - earliest_record_timestamp?: integer + earliest_record_timestamp: long empty_bucket_count: long input_bytes: long input_field_count: long @@ -31,7 +31,7 @@ export class Response { invalid_date_count: long job_id: Id last_data_time: integer - latest_record_timestamp?: integer + latest_record_timestamp: long missing_field_count: long out_of_order_timestamp_count: long processed_field_count: long diff --git a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts index a162f081b5..cf2b55801f 100644 --- a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts +++ b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts @@ -22,18 +22,24 @@ import { Id } from '@_types/common' import { DataframePreviewConfig } from './types' /** + * Previews the extracted features used by a data frame analytics config. * @rest_spec_name ml.preview_data_frame_analytics * @since 7.13.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_ml */ export interface Request extends RequestBase { - path_parts?: { - /** Identifier for the data frame analytics job. */ + path_parts: { + /** + * Identifier for the data frame analytics job. + */ id?: Id } - body?: { + body: { /** - * A data frame analytics config as described in Create data frame analytics jobs. Note that id and dest don’t need to be provided in the context of this API. + * A data frame analytics config as described in Create data frame analytics + * jobs. Note that id and dest don’t need to be provided in the context of + * this API. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html */ config?: DataframePreviewConfig diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts index 9f50c3aeae..56e2980a9b 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts @@ -31,7 +31,7 @@ export interface Request extends RequestBase { path_parts: { datafeed_id?: Id } - body?: { + body: { job_config?: JobConfig datafeed_config?: DatafeedConfig } diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts index 87d7400ddb..a8f45f553f 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts @@ -18,5 +18,7 @@ */ export class Response { - body: Array + body: { + data: TDocument[] + } } diff --git a/specification/ml/put_calendar/MlPutCalendarRequest.ts b/specification/ml/put_calendar/MlPutCalendarRequest.ts index c08aae41b4..89b51dd37d 100644 --- a/specification/ml/put_calendar/MlPutCalendarRequest.ts +++ b/specification/ml/put_calendar/MlPutCalendarRequest.ts @@ -18,19 +18,26 @@ */ import { RequestBase } from '@_types/Base' -import { Id, Ids } from '@_types/common' +import { Id } from '@_types/common' /** + * Creates a calendar. * @rest_spec_name ml.put_calendar * @since 6.2.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** A string that uniquely identifies a calendar. */ calendar_id: Id } - body?: { - job_ids?: Ids + body: { + /** + * An array of anomaly detection job identifiers. + */ + job_ids?: Id[] + /** A description of the calendar. */ description?: string } } diff --git a/specification/ml/put_calendar/MlPutCalendarResponse.ts b/specification/ml/put_calendar/MlPutCalendarResponse.ts index b5a108d308..29e8458dbf 100644 --- a/specification/ml/put_calendar/MlPutCalendarResponse.ts +++ b/specification/ml/put_calendar/MlPutCalendarResponse.ts @@ -21,8 +21,11 @@ import { Id, Ids } from '@_types/common' export class Response { body: { + /** A string that uniquely identifies a calendar. */ calendar_id: Id - description?: string + /** A description of the calendar. */ + description: string + /** A list of anomaly detection job identifiers or group names. */ job_ids: Ids } } diff --git a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts index 4d9122a98d..b9c0acd24a 100644 --- a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts +++ b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Adds an anomaly detection job to a calendar. * @rest_spec_name ml.put_calendar_job * @since 6.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ml/put_calendar_job/MlPutCalendarJobResponse.ts b/specification/ml/put_calendar_job/MlPutCalendarJobResponse.ts index b5a108d308..d26147bb40 100644 --- a/specification/ml/put_calendar_job/MlPutCalendarJobResponse.ts +++ b/specification/ml/put_calendar_job/MlPutCalendarJobResponse.ts @@ -21,8 +21,11 @@ import { Id, Ids } from '@_types/common' export class Response { body: { + /** A string that uniquely identifies a calendar. */ calendar_id: Id + /** A description of the calendar. */ description?: string + /** A list of anomaly detection job identifiers or group names. */ job_ids: Ids } } diff --git a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts index bcb7d83f0c..8f31ad3569 100644 --- a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts +++ b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts @@ -28,38 +28,103 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Instantiates a data frame analytics job. + * This API creates a data frame analytics job that performs an analysis on the + * source indices and stores the outcome in a destination index. * @rest_spec_name ml.put_data_frame_analytics * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml + * @index_privileges create_index, index, manage, read, view_index_metadata */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. */ + /** + * Identifier for the data frame analytics job. This identifier can contain + * lowercase alphanumeric characters (a-z and 0-9), hyphens, and + * underscores. It must start and end with alphanumeric characters. + */ id: Id } - body?: { - /** The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified. */ - source?: DataframeAnalyticsSource - /** The destination configuration, consisting of index and optionally results_field (ml by default). */ - dest: DataframeAnalyticsDestination - /** The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression. */ + body: { + /** + * Specifies whether this job can start when there is insufficient machine + * learning node capacity for it to be immediately assigned to a node. If + * set to false and a machine learning node with capacity to run the job + * cannot be immediately found, the API returns an error. If set to true, + * the API does not return an error; the job waits in the `starting` state + * until sufficient machine learning node capacity is available. This + * behavior is also affected by the cluster-wide + * `xpack.ml.max_lazy_ml_nodes` setting. + * @server_default false + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings + */ + allow_lazy_start?: boolean + /** + * The analysis configuration, which contains the information necessary to + * perform one of the following types of analysis: classification, outlier + * detection, or regression. + */ analysis: DataframeAnalysisContainer - /** A description of the job. */ + /** + * Specifies `includes` and/or `excludes` patterns to select which fields + * will be included in the analysis. The patterns specified in `excludes` + * are applied last, therefore `excludes` takes precedence. In other words, + * if the same field is specified in both `includes` and `excludes`, then + * the field will not be included in the analysis. If `analyzed_fields` is + * not set, only the relevant fields will be included. For example, all the + * numeric fields for outlier detection. + * The supported fields vary for each type of analysis. Outlier detection + * requires numeric or `boolean` data to analyze. The algorithms don’t + * support missing values therefore fields that have data types other than + * numeric or boolean are ignored. Documents where included fields contain + * missing values, null values, or an array are also ignored. Therefore the + * `dest` index may contain documents that don’t have an outlier score. + * Regression supports fields that are numeric, `boolean`, `text`, + * `keyword`, and `ip` data types. It is also tolerant of missing values. + * Fields that are supported are included in the analysis, other fields are + * ignored. Documents where included fields contain an array with two or + * more values are also ignored. Documents in the `dest` index that don’t + * contain a results field are not included in the regression analysis. + * Classification supports fields that are numeric, `boolean`, `text`, + * `keyword`, and `ip` data types. It is also tolerant of missing values. + * Fields that are supported are included in the analysis, other fields are + * ignored. Documents where included fields contain an array with two or + * more values are also ignored. Documents in the `dest` index that don’t + * contain a results field are not included in the classification analysis. + * Classification analysis can be improved by mapping ordinal variable + * values to a single number. For example, in case of age ranges, you can + * model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. + */ + analyzed_fields?: DataframeAnalysisAnalyzedFields + /** + * A description of the job. + */ description?: string /** - * The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html + * The destination configuration. + */ + dest: DataframeAnalyticsDestination + /** + * The maximum number of threads to be used by the analysis. Using more + * threads may decrease the time necessary to complete the analysis at the + * cost of using more CPU. Note that the process may use additional threads + * for operational functionality other than the analysis itself. + * @server_default 1 */ - model_memory_limit?: string - /** The maximum number of threads to be used by the analysis. The default value is 1. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. */ max_num_threads?: integer - /** Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis. */ - analyzed_fields?: DataframeAnalysisAnalyzedFields /** - * Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. - * @server_default false - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings + * The approximate maximum amount of memory resources that are permitted for + * analytical processing. If your `elasticsearch.yml` file contains an + * `xpack.ml.max_model_memory_limit` setting, an error occurs when you try + * to create data frame analytics jobs that have `model_memory_limit` values + * greater than that setting. + * @server_default 1gb */ - allow_lazy_start?: boolean + model_memory_limit?: string + /** + * The configuration of how to source the analysis data. + */ + source: DataframeAnalyticsSource } } diff --git a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts index a76c050bc3..b46f194dc2 100644 --- a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts +++ b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts @@ -17,15 +17,11 @@ * under the License. */ -import { - ChunkingConfig, - DatafeedIndicesOptions, - DelayedDataCheckConfig -} from '@ml/_types/Datafeed' +import { ChunkingConfig, DelayedDataCheckConfig } from '@ml/_types/Datafeed' import { Dictionary } from '@spec_utils/Dictionary' import { AggregationContainer } from '@_types/aggregations/AggregationContainer' import { RequestBase } from '@_types/Base' -import { ExpandWildcards, Id, Indices } from '@_types/common' +import { ExpandWildcards, Id, Indices, IndicesOptions } from '@_types/common' import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { integer } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' @@ -41,21 +37,20 @@ export interface Request extends RequestBase { path_parts: { datafeed_id: Id } - query_parameters?: { + query_parameters: { allow_no_indices?: boolean expand_wildcards?: ExpandWildcards ignore_throttled?: boolean ignore_unavailable?: boolean } - body?: { - aggs?: Dictionary + body: { aggregations?: Dictionary chunking_config?: ChunkingConfig delayed_data_check_config?: DelayedDataCheckConfig frequency?: Time - indices?: Indices - indexes?: Indices - indices_options?: DatafeedIndicesOptions + /** @aliases indexes */ + indices?: string[] + indices_options?: IndicesOptions job_id?: Id max_empty_searches?: integer query?: QueryContainer diff --git a/specification/ml/put_datafeed/MlPutDatafeedResponse.ts b/specification/ml/put_datafeed/MlPutDatafeedResponse.ts index 39418a9f93..2f1108315b 100644 --- a/specification/ml/put_datafeed/MlPutDatafeedResponse.ts +++ b/specification/ml/put_datafeed/MlPutDatafeedResponse.ts @@ -17,14 +17,10 @@ * under the License. */ -import { - ChunkingConfig, - DatafeedIndicesOptions, - DelayedDataCheckConfig -} from '@ml/_types/Datafeed' +import { ChunkingConfig, DelayedDataCheckConfig } from '@ml/_types/Datafeed' import { Dictionary } from '@spec_utils/Dictionary' import { AggregationContainer } from '@_types/aggregations/AggregationContainer' -import { Id, Indices } from '@_types/common' +import { Id, Indices, IndicesOptions } from '@_types/common' import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { integer } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' @@ -33,15 +29,15 @@ import { Time } from '@_types/Time' export class Response { body: { - aggregations?: Dictionary + aggregations: Dictionary chunking_config: ChunkingConfig delayed_data_check_config?: DelayedDataCheckConfig datafeed_id: Id - frequency?: Time + frequency: Time indices: string[] job_id: Id - indices_options?: DatafeedIndicesOptions - max_empty_searches?: integer + indices_options?: IndicesOptions + max_empty_searches: integer query: QueryContainer query_delay: Time runtime_mappings?: RuntimeFields diff --git a/specification/ml/put_filter/MlPutFilterRequest.ts b/specification/ml/put_filter/MlPutFilterRequest.ts index 525bd52a6a..a7727ebed6 100644 --- a/specification/ml/put_filter/MlPutFilterRequest.ts +++ b/specification/ml/put_filter/MlPutFilterRequest.ts @@ -26,10 +26,10 @@ import { Id } from '@_types/common' * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { filter_id: Id } - body?: { + body: { description?: string items?: string[] } diff --git a/specification/ml/put_filter/MlPutFilterResponse.ts b/specification/ml/put_filter/MlPutFilterResponse.ts index 8a4de41536..5e83d98944 100644 --- a/specification/ml/put_filter/MlPutFilterResponse.ts +++ b/specification/ml/put_filter/MlPutFilterResponse.ts @@ -21,7 +21,7 @@ import { Id } from '@_types/common' export class Response { body: { - description?: string + description: string filter_id: Id items: string[] } diff --git a/specification/ml/put_job/MlPutJobRequest.ts b/specification/ml/put_job/MlPutJobRequest.ts index be2d8d211c..f0ea356367 100644 --- a/specification/ml/put_job/MlPutJobRequest.ts +++ b/specification/ml/put_job/MlPutJobRequest.ts @@ -30,7 +30,7 @@ import { DatafeedConfig } from '@ml/_types/Datafeed' /** * @rest_spec_name ml.put_job * @since 5.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { @@ -39,7 +39,7 @@ export interface Request extends RequestBase { */ job_id: Id } - body?: { + body: { /** * Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. * @server_default false @@ -104,9 +104,5 @@ export interface Request extends RequestBase { * Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. */ results_retention_days?: long - /** - * Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically. - */ - system_annotations_retention_days?: long } } diff --git a/specification/ml/put_job/MlPutJobResponse.ts b/specification/ml/put_job/MlPutJobResponse.ts index 6a0615b89a..310deb37b7 100644 --- a/specification/ml/put_job/MlPutJobResponse.ts +++ b/specification/ml/put_job/MlPutJobResponse.ts @@ -17,7 +17,7 @@ * under the License. */ -import { AnalysisConfig, AnalysisLimits } from '@ml/_types/Analysis' +import { AnalysisConfigRead, AnalysisLimits } from '@ml/_types/Analysis' import { DataDescription } from '@ml/_types/Job' import { ModelPlotConfig } from '@ml/_types/ModelPlot' import { CustomSettings } from '@ml/_types/Settings' @@ -29,7 +29,7 @@ import { Datafeed } from '@ml/_types/Datafeed' export class Response { body: { allow_lazy_open: boolean - analysis_config: AnalysisConfig + analysis_config: AnalysisConfigRead analysis_limits: AnalysisLimits background_persist_interval?: Time create_time: DateString @@ -48,6 +48,5 @@ export class Response { renormalization_window_days?: long results_index_name: string results_retention_days?: long - system_annotations_retention_days?: long } } diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 140ac3ec19..ee51410ce7 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -17,21 +17,59 @@ * under the License. */ +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { InferenceConfigContainer } from '@_types/aggregations/pipeline' import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { Definition, Input } from './types' /** + * Enables you to supply a trained model that is not created by data frame analytics. * @rest_spec_name ml.put_trained_model * @since 7.10.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { - stub: string + /** + * The unique identifier of the trained model. + */ + model_id: Id } - query_parameters?: { - stub?: string - } - body?: { - stub?: string + body: { + /** + * The compressed (GZipped and Base64 encoded) inference definition of the + * model. If compressed_definition is specified, then definition cannot be + * specified. + */ + compressed_definition?: string + /** + * The inference definition for the model. If definition is specified, then + * compressed_definition cannot be specified. + */ + definition?: Definition + /** + * A human-readable description of the inference trained model. + */ + description?: string + /** + * The default configuration for inference. This can be either a regression + * or classification configuration. It must match the underlying + * definition.trained_model's target_type. + */ + inference_config: InferenceConfigContainer + /** + * The input field names for the model definition. + */ + input: Input + /** + * An object map that contains metadata about the model. + */ + metadata?: UserDefinedValue + /** + * An array of tags to organize the model. + */ + tags?: string[] } } diff --git a/specification/ml/put_trained_model/MlPutTrainedModelResponse.ts b/specification/ml/put_trained_model/MlPutTrainedModelResponse.ts index be8dc1fd43..268552dbb1 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelResponse.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelResponse.ts @@ -17,6 +17,8 @@ * under the License. */ +import { TrainedModelConfig } from '@ml/_types/TrainedModel' + export class Response { - body: { stub: boolean } + body: TrainedModelConfig } diff --git a/specification/ml/put_trained_model/types.ts b/specification/ml/put_trained_model/types.ts new file mode 100644 index 0000000000..fded4436be --- /dev/null +++ b/specification/ml/put_trained_model/types.ts @@ -0,0 +1,110 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Dictionary } from '@spec_utils/Dictionary' +import { Names } from '@_types/common' +import { double, integer } from '@_types/Numeric' + +export class Definition { + /** Collection of preprocessors */ + preprocessors?: Preprocessor[] + /** The definition of the trained model. */ + trained_model: TrainedModel +} + +/** @variants container */ +export class Preprocessor { + frequency_encoding?: FrequencyEncodingPreprocessor + one_hot_encoding?: OneHotEncodingPreprocessor + target_mean_encoding?: TargetMeanEncodingPreprocessor +} + +export class FrequencyEncodingPreprocessor { + field: string + feature_name: string + frequency_map: Dictionary +} + +export class OneHotEncodingPreprocessor { + field: string + hot_map: Dictionary +} + +export class TargetMeanEncodingPreprocessor { + field: string + feature_name: string + target_map: Dictionary + default_value: double +} + +export class Input { + field_names: Names +} + +export class TrainedModel { + /** The definition for a binary decision tree. */ + tree?: TrainedModelTree + /** + * The definition of a node in a tree. + * There are two major types of nodes: leaf nodes and not-leaf nodes. + * - Leaf nodes only need node_index and leaf_value defined. + * - All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. + * */ + tree_node?: TrainedModelTreeNode + /** The definition for an ensemble model */ + ensemble?: Ensemble +} + +export class TrainedModelTree { + classification_labels?: string[] + feature_names: string[] + target_type?: string + tree_structure: TrainedModelTreeNode[] +} + +export class TrainedModelTreeNode { + decision_type?: string + default_left?: boolean + leaf_value?: double + left_child?: integer + node_index: integer + right_child?: integer + split_feature?: integer + split_gain?: integer + threshold?: double +} + +export class Ensemble { + aggregate_output?: AggregateOutput + classification_labels?: string[] + feature_names?: string[] + target_type?: string + trained_models: TrainedModel[] +} + +export class AggregateOutput { + logistic_regression?: Weights + weighted_sum?: Weights + weighted_mode?: Weights + exponent?: Weights +} + +export class Weights { + weights: double +} diff --git a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts index 762242a31c..84a063b349 100644 --- a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts +++ b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts @@ -18,23 +18,46 @@ */ import { RequestBase } from '@_types/Base' -import { Id } from '@_types/common' +import { Id, Name } from '@_types/common' /** + * Creates or updates a trained model alias. A trained model alias is a logical + * name used to reference a single trained model. + * You can use aliases instead of trained model identifiers to make it easier to + * reference your models. For example, you can use aliases in inference + * aggregations and processors. + * An alias must be unique and refer to only a single trained model. However, + * you can have multiple aliases for each trained model. + * If you use this API to update an alias such that it references a different + * trained model ID and the model uses a different type of data frame analytics, + * an error occurs. For example, this situation occurs if you have a trained + * model for regression analysis and a trained model for classification + * analysis; you cannot reassign an alias from one type of trained model to + * another. + * If you use this API to update an alias and there are very few input fields in + * common between the old and new trained models for the model alias, the API + * returns a warning. * @rest_spec_name ml.put_trained_model_alias * @since 7.13.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { - /** The alias to create or update. This value cannot end in numbers. */ - model_alias: string - /** The identifier for the trained model that the alias refers to. */ + /** + * The alias to create or update. This value cannot end in numbers. + */ + model_alias: Name + /** + * The identifier for the trained model that the alias refers to. + */ model_id: Id } - query_parameters?: { + query_parameters: { /** - * Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error. + * Specifies whether the alias gets reassigned to the specified trained + * model if it is already assigned to a different model. If the alias is + * already assigned and this parameter is false, the API returns an error. * @server_default false */ reassign?: boolean diff --git a/specification/ml/reset_job/MlResetJobRequest.ts b/specification/ml/reset_job/MlResetJobRequest.ts index 52ef5f07d3..59aabf8c0b 100644 --- a/specification/ml/reset_job/MlResetJobRequest.ts +++ b/specification/ml/reset_job/MlResetJobRequest.ts @@ -21,18 +21,27 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Resets an anomaly detection job. + * All model state and results are deleted. The job is ready to start over as if + * it had just been created. + * It is not currently possible to reset multiple jobs using wildcards or a + * comma separated list. * @rest_spec_name ml.reset_job * @since 7.14.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { - /** The ID of the job to reset. */ + /** + * The ID of the job to reset. + */ job_id: Id } - query_parameters?: { + query_parameters: { /** - * Should this request wait until the operation has completed before returning. + * Should this request wait until the operation has completed before + * returning. * @server_default true */ wait_for_completion?: boolean diff --git a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts index 5f58dc4680..d5c918f94a 100644 --- a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts +++ b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts @@ -21,19 +21,42 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Reverts to a specific snapshot. + * The machine learning features react quickly to anomalous input, learning new + * behaviors in data. Highly anomalous input increases the variance in the + * models whilst the system learns whether this is a new step-change in behavior + * or a one-off event. In the case where this anomalous input is known to be a + * one-off, then it might be appropriate to reset the model state to a time + * before this event. For example, you might consider reverting to a saved + * snapshot after Black Friday or a critical system failure. * @rest_spec_name ml.revert_model_snapshot * @since 5.4.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id + /** + * You can specify `empty` as the . Reverting to the empty + * snapshot means the anomaly detection job starts learning a new model from + * scratch when it is started. + */ snapshot_id: Id } - query_parameters?: { - delete_intervening_results?: boolean - } - body?: { + body: { + /** + * If true, deletes the results in the time period between the latest + * results and the time of the reverted snapshot. It also resets the model + * to accept records for this time period. If you choose not to delete + * intervening results when reverting a snapshot, the job will not accept + * input data that is older than the current time. If you want to resend + * data, then delete the intervening results. + * @server_default false + */ delete_intervening_results?: boolean } } diff --git a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts index 5e93ba59e0..97a5aa8e73 100644 --- a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts +++ b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts @@ -21,13 +21,36 @@ import { RequestBase } from '@_types/Base' import { Time } from '@_types/Time' /** + * Sets a cluster wide upgrade_mode setting that prepares machine learning + * indices for an upgrade. + * When upgrading your cluster, in some circumstances you must restart your + * nodes and reindex your machine learning indices. In those circumstances, + * there must be no machine learning jobs running. You can close the machine + * learning jobs, do the upgrade, then open all the jobs again. Alternatively, + * you can use this API to temporarily halt tasks associated with the jobs and + * datafeeds and prevent new jobs from opening. You can also use this API + * during upgrades that do not require you to reindex your machine learning + * indices, though stopping jobs is not a requirement in that case. + * You can see the current value for the upgrade_mode setting by using the get + * machine learning info API. * @rest_spec_name ml.set_upgrade_mode * @since 6.7.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { + /** + * When `true`, it enables `upgrade_mode` which temporarily halts all job + * and datafeed tasks and prohibits new job and datafeed tasks from + * starting. + * @server_default false + */ enabled?: boolean + /** + * The time to wait for the request to be completed. + * @server_default 30s + */ timeout?: Time } } diff --git a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts index aa29d89082..97a020d27b 100644 --- a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts +++ b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts @@ -22,17 +22,37 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Starts a data frame analytics job. + * A data frame analytics job can be started and stopped multiple times + * throughout its lifecycle. + * If the destination index does not exist, it is created automatically the + * first time you start the data frame analytics job. The + * `index.number_of_shards` and `index.number_of_replicas` settings for the + * destination index are copied from the source index. If there are multiple + * source indices, the destination index copies the highest setting values. The + * mappings for the destination index are also copied from the source indices. + * If there are any mapping conflicts, the job fails to start. + * If the destination index exists, it is used as is. You can therefore set up + * the destination index in advance with custom settings and mappings. * @rest_spec_name ml.start_data_frame_analytics - * @since 5.4.0 + * @since 7.3.0 * @stability stable + * @cluster_privileges manage_ml + * @index_privileges create_index, index, manage, read, view_index_metadata */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the data frame analytics job. This identifier can contain + * lowercase alphanumeric characters (a-z and 0-9), hyphens, and + * underscores. It must start and end with alphanumeric characters. + */ id: Id } - query_parameters?: { + query_parameters: { /** - * Controls the amount of time to wait until the data frame analytics job starts. + * Controls the amount of time to wait until the data frame analytics job + * starts. * @server_default 20s */ timeout?: Time diff --git a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts index 38cbc5e93d..c540749a29 100644 --- a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts +++ b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts @@ -24,16 +24,16 @@ import { Time } from '@_types/Time' /** * @rest_spec_name ml.start_datafeed * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { datafeed_id: Id } - query_parameters?: { + query_parameters: { start?: Time // default "" } - body?: { + body: { end?: Time // default "" start?: Time // default "" /** @server_default 20s */ diff --git a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts index d053aa225f..23947ddd7f 100644 --- a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts +++ b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts @@ -22,17 +22,38 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Stops one or more data frame analytics jobs. + * A data frame analytics job can be started and stopped multiple times + * throughout its lifecycle. * @rest_spec_name ml.stop_data_frame_analytics * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. */ + /** + * Identifier for the data frame analytics job. This identifier can contain + * lowercase alphanumeric characters (a-z and 0-9), hyphens, and + * underscores. It must start and end with alphanumeric characters. + */ id: Id } - query_parameters?: { - /** @server_default true */ + query_parameters: { + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no data frame analytics + * jobs that match. + * 2. Contains the _all string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * The default value is true, which returns an empty data_frame_analytics + * array when there are no matches and the subset of results when there are + * partial matches. If this parameter is false, the request returns a 404 + * status code when there are no matches or only partial matches. + * @server_default true + */ allow_no_match?: boolean /** * If true, the data frame analytics job is stopped forcefully. @@ -40,7 +61,8 @@ export interface Request extends RequestBase { */ force?: boolean /** - * Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds. + * Controls the amount of time to wait until the data frame analytics job + * stops. Defaults to 20 seconds. * @server_default 20s */ timeout?: Time diff --git a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts index d6b60d3d6a..94d1d1a10f 100644 --- a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts +++ b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts @@ -24,19 +24,23 @@ import { Time } from '@_types/Time' /** * @rest_spec_name ml.stop_datafeed * @since 5.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { datafeed_id: Id } - query_parameters?: { + query_parameters: { + /** + * @deprecated 7.10.0 Use `allow_no_match` instead. + */ + allow_no_datafeeds?: boolean /** @server_default true */ allow_no_match?: boolean /** @server_default false */ force?: boolean } - body?: { + body: { /** @server_default false */ force?: boolean /** @server_default 20s */ diff --git a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts index 9d115fb93e..1e95055c08 100644 --- a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts +++ b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts @@ -22,27 +22,48 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Updates an existing data frame analytics job. * @rest_spec_name ml.update_data_frame_analytics * @since 7.3.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml + * @index_privileges read, create_index, manage, index, view_index_metadata */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. */ + /** + * Identifier for the data frame analytics job. This identifier can contain + * lowercase alphanumeric characters (a-z and 0-9), hyphens, and + * underscores. It must start and end with alphanumeric characters. + */ id: Id } - body?: { - /** A description of the job. */ + body: { + /** + * A description of the job. + */ description?: string /** - * The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting. + * The approximate maximum amount of memory resources that are permitted for + * analytical processing. The default value for data frame analytics jobs is + * 1gb. If your elasticsearch.yml file contains an + * `xpack.ml.max_model_memory_limit` setting, an error occurs when you try + * to create data frame analytics jobs that have model_memory_limit values + * greater than that setting. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html */ model_memory_limit?: string - /** The maximum number of threads to be used by the analysis. The default value is 1. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. */ + /** + * The maximum number of threads to be used by the analysis. Using more + * threads may decrease the time necessary to complete the analysis at the + * cost of using more CPU. Note that the process may use additional threads + * for operational functionality other than the analysis itself. + * @server_default 1 + * */ max_num_threads?: integer /** - * Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. + * Specifies whether this job can start when there is insufficient machine + * learning node capacity for it to be immediately assigned to a node. * @server_default false * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html#advanced-ml-settings */ diff --git a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts new file mode 100644 index 0000000000..6adce1da69 --- /dev/null +++ b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts @@ -0,0 +1,161 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { ExpandWildcards, Id, IndicesOptions } from '@_types/common' +import { Dictionary } from '@spec_utils/Dictionary' +import { AggregationContainer } from '@_types/aggregations/AggregationContainer' +import { ChunkingConfig, DelayedDataCheckConfig } from '@ml/_types/Datafeed' +import { Time } from '@_types/Time' +import { integer } from '@_types/Numeric' +import { QueryContainer } from '@_types/query_dsl/abstractions' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' +import { ScriptField } from '@_types/Scripting' + +/** + * Updates the properties of a datafeed. + * You must stop and start the datafeed for the changes to be applied. + * When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + * the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + * those credentials are used instead. + * @rest_spec_name ml.update_datafeed + * @since 6.4.0 + * @stability stable + * @cluster_privileges manage_ml + */ +export interface Request extends RequestBase { + path_parts: { + /** + * A numerical character string that uniquely identifies the datafeed. + * This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + * It must start and end with alphanumeric characters. + */ + datafeed_id: Id + } + query_parameters: { + /** + * If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + * `_all` string or when no indices are specified. + * @server_default true + */ + allow_no_indices?: boolean + /** + * Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + * whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + * + * * `all`: Match any data stream or index, including hidden ones. + * * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + * * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. + * * `none`: Wildcard patterns are not accepted. + * * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. + * @server_default open + */ + expand_wildcards?: ExpandWildcards + /** + * If `true`, concrete, expanded or aliased indices are ignored when frozen. + * @server_default true + * @deprecated 7.16.0 + */ + ignore_throttled?: boolean + /** + * If `true`, unavailable indices (missing or closed) are ignored. + * @server_default false + */ + ignore_unavailable?: boolean + } + body: { + /** + * If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only + * with low cardinality data. + */ + aggregations?: Dictionary + /** + * Datafeeds might search over long time periods, for several months or years. This search is split into time + * chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of + * these time chunks are calculated; it is an advanced configuration option. + */ + chunking_config?: ChunkingConfig + /** + * Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally + * search over indices that have already been read in an effort to determine whether any data has subsequently been + * added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and + * the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time + * datafeeds. + */ + delayed_data_check_config?: DelayedDataCheckConfig + /** + * The interval at which scheduled queries are made while the datafeed runs in real time. The default value is + * either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket + * span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are + * written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value + * must be divisible by the interval of the date histogram aggregation. + */ + frequency?: Time + /** + * An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine + * learning nodes must have the `remote_cluster_client` role. + * @aliases indexes + * */ + indices?: string[] + /** + * Specifies index expansion options that are used during search. + */ + indices_options?: IndicesOptions + /** + * If a real-time datafeed has never seen any data (including during any initial training period), it automatically + * stops and closes the associated job after this many real-time searches return no documents. In other words, + * it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no + * end time that sees no data remains started until it is explicitly stopped. By default, it is not set. + */ + max_empty_searches?: integer + /** + * The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an + * Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this + * object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also + * changed. Therefore, the time required to learn might be long and the understandability of the results is + * unpredictable. If you want to make significant changes to the source data, it is recommended that you + * clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one + * when you are satisfied with the results of the job. + * @server_default {"match_all": {"boost": 1}} + */ + query?: QueryContainer + /** + * The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might + * not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default + * value is randomly selected between `60s` and `120s`. This randomness improves the query performance + * when there are multiple jobs running on the same node. + */ + query_delay?: Time + /** + * Specifies runtime fields for the datafeed search. + */ + runtime_mappings?: RuntimeFields + /** + * Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. + * The detector configuration objects in a job can contain functions that use these script fields. + */ + script_fields?: Dictionary + /** + * The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. + * The maximum value is the value of `index.max_result_window`. + * @server_default 1000 + */ + scroll_size?: integer + } +} diff --git a/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts b/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts new file mode 100644 index 0000000000..3efcbf0be7 --- /dev/null +++ b/specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts @@ -0,0 +1,47 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { ChunkingConfig, DelayedDataCheckConfig } from '@ml/_types/Datafeed' +import { Dictionary } from '@spec_utils/Dictionary' +import { AggregationContainer } from '@_types/aggregations/AggregationContainer' +import { Id, IndicesOptions } from '@_types/common' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' +import { integer } from '@_types/Numeric' +import { QueryContainer } from '@_types/query_dsl/abstractions' +import { ScriptField } from '@_types/Scripting' +import { Time } from '@_types/Time' + +export class Response { + body: { + aggregations: Dictionary + chunking_config: ChunkingConfig + delayed_data_check_config?: DelayedDataCheckConfig + datafeed_id: Id + frequency: Time + indices: string[] + job_id: Id + indices_options?: IndicesOptions + max_empty_searches: integer + query: QueryContainer + query_delay: Time + runtime_mappings?: RuntimeFields + script_fields?: Dictionary + scroll_size: integer + } +} diff --git a/specification/ml/update_filter/MlUpdateFilterRequest.ts b/specification/ml/update_filter/MlUpdateFilterRequest.ts index ffc3ddce92..002c5332b2 100644 --- a/specification/ml/update_filter/MlUpdateFilterRequest.ts +++ b/specification/ml/update_filter/MlUpdateFilterRequest.ts @@ -23,13 +23,13 @@ import { Id } from '@_types/common' /** * @rest_spec_name ml.update_filter * @since 6.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { filter_id: Id } - body?: { + body: { add_items?: string[] description?: string remove_items?: string[] diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts index b52dc672bd..4053564a81 100644 --- a/specification/ml/update_job/MlUpdateJobRequest.ts +++ b/specification/ml/update_job/MlUpdateJobRequest.ts @@ -31,50 +31,94 @@ import { long } from '@_types/Numeric' import { Time } from '@_types/Time' /** + * Updates certain properties of an anomaly detection job. * @rest_spec_name ml.update_job * @since 5.5.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the job */ + /** + * Identifier for the job. + */ job_id: Id } - body?: { + body: { + /** + * Advanced configuration option. Specifies whether this job can open when + * there is insufficient machine learning node capacity for it to be + * immediately assigned to a node. If `false` and a machine learning node + * with capacity to run the job cannot immediately be found, the open + * anomaly detection jobs API returns an error. However, this is also + * subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this + * option is set to `true`, the open anomaly detection jobs API does not + * return an error and the job waits in the opening state until sufficient + * machine learning node capacity is available. + * @server_default false + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-settings.html#advanced-ml-settings + */ allow_lazy_open?: boolean analysis_limits?: AnalysisMemoryLimit /** - * Advanced configuration option. The time between each periodic persistence of the model. See Job resources. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html + * Advanced configuration option. The time between each periodic persistence + * of the model. + * The default value is a randomized value between 3 to 4 hours, which + * avoids all jobs persisting at exactly the same time. The smallest allowed + * value is 1 hour. + * For very large models (several GB), persistence could take 10-20 minutes, + * so do not set the value too low. + * If the job is open when you make the update, you must stop the datafeed, + * close the job, then reopen the job and restart the datafeed for the + * changes to take effect. */ background_persist_interval?: Time /** - * Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results. - * @doc_url https://www.elastic.co/guide/en/machine-learning/7.12/ml-configuring-url.html + * Advanced configuration option. Contains custom meta data about the job. + * For example, it can contain custom URL information as shown in Adding + * custom URLs to machine learning results. + * @doc_id ml.customUrls */ custom_settings?: Dictionary categorization_filters?: string[] /** - * A description of the job. See Job resources. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html + * A description of the job. */ description?: string model_plot_config?: ModelPlotConfig /** + * Advanced configuration option, which affects the automatic removal of old + * model snapshots for this job. It specifies a period of time (in days) + * after which only the first snapshot per day is retained. This period is + * relative to the timestamp of the most recent snapshot for this job. Valid + * values range from 0 to `model_snapshot_retention_days`. For jobs created + * before version 7.8.0, the default value matches + * `model_snapshot_retention_days`. * @server_default 1 + * @doc_url https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html#ml-ad-model-snapshots */ daily_model_snapshot_retention_after_days?: long /** - * Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. + * Advanced configuration option, which affects the automatic removal of old + * model snapshots for this job. It specifies the maximum period of time (in + * days) that snapshots are retained. This period is relative to the + * timestamp of the most recent snapshot for this job. * @server_default 10 + * @doc_url https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html#ml-ad-model-snapshots */ model_snapshot_retention_days?: long /** - * Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. + * Advanced configuration option. The period over which adjustments to the + * score are applied, as new data is seen. */ renormalization_window_days?: long /** - * Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. + * Advanced configuration option. The period of time (in days) that results + * are retained. Age is calculated relative to the timestamp of the latest + * bucket result. If this property has a non-null value, once per day at + * 00:30 (server time), results that are the specified number of days older + * than the latest bucket result are deleted from Elasticsearch. The default + * value is null, which means all results are retained. */ results_retention_days?: long /** @@ -89,9 +133,5 @@ export interface Request extends RequestBase { * Settings related to how categorization interacts with partition fields. */ per_partition_categorization?: PerPartitionCategorization - /** - * Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically. - */ - system_annotations_retention_days?: long } } diff --git a/specification/ml/update_job/MlUpdateJobResponse.ts b/specification/ml/update_job/MlUpdateJobResponse.ts index 4dd6d0caf3..a16440c0b4 100644 --- a/specification/ml/update_job/MlUpdateJobResponse.ts +++ b/specification/ml/update_job/MlUpdateJobResponse.ts @@ -17,23 +17,24 @@ * under the License. */ -import { AnalysisConfig, AnalysisLimits } from '@ml/_types/Analysis' +import { AnalysisConfigRead, AnalysisLimits } from '@ml/_types/Analysis' +import { Datafeed } from '@ml/_types/Datafeed' import { DataDescription } from '@ml/_types/Job' import { ModelPlotConfig } from '@ml/_types/ModelPlot' -import { CustomSettings } from '@ml/_types/Settings' -import { Id } from '@_types/common' +import { Dictionary } from '@spec_utils/Dictionary' +import { Id, IndexName, VersionString } from '@_types/common' import { long } from '@_types/Numeric' -import { DateString, Time } from '@_types/Time' -import { Datafeed } from '@ml/_types/Datafeed' +import { Time, EpochMillis } from '@_types/Time' export class Response { body: { allow_lazy_open: boolean - analysis_config: AnalysisConfig + analysis_config: AnalysisConfigRead analysis_limits: AnalysisLimits background_persist_interval?: Time - create_time: Time - custom_settings?: CustomSettings + create_time: EpochMillis + finished_time?: EpochMillis + custom_settings?: Dictionary daily_model_snapshot_retention_after_days: long data_description: DataDescription datafeed_config?: Datafeed @@ -41,13 +42,12 @@ export class Response { groups?: string[] job_id: Id job_type: string - job_version: string - finished_time?: Time + job_version: VersionString model_plot_config?: ModelPlotConfig model_snapshot_id?: Id model_snapshot_retention_days: long renormalization_window_days?: long - results_index_name: string + results_index_name: IndexName results_retention_days?: long } } diff --git a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts index f939551948..d9d56c2f85 100644 --- a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts +++ b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts @@ -21,17 +21,34 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Updates certain properties of a snapshot. * @rest_spec_name ml.update_model_snapshot * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { + /** + * Identifier for the anomaly detection job. + */ job_id: Id + /** + * Identifier for the model snapshot. + */ snapshot_id: Id } - body?: { + body: { + /** + * A description of the model snapshot. + */ description?: string + /** + * If `true`, this snapshot will not be deleted during automatic cleanup of + * snapshots older than `model_snapshot_retention_days`. However, this + * snapshot will be deleted when the job is deleted. + * @server_default false + */ retain?: boolean } } diff --git a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts index 1445b05f27..c9933d301c 100644 --- a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts +++ b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts @@ -22,26 +22,41 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Upgrades an anomaly detection model snapshot to the latest major version. + * Over time, older snapshot formats are deprecated and removed. Anomaly + * detection jobs support only snapshots that are from the current or previous + * major version. + * This API provides a means to upgrade a snapshot to the current major version. + * This aids in preparing the cluster for an upgrade to the next major version. + * Only one snapshot per anomaly detection job can be upgraded at a time and the + * upgraded snapshot cannot be the current snapshot of the anomaly detection + * job. * @rest_spec_name ml.upgrade_job_snapshot * @since 5.4.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { - /** Identifier for the anomaly detection job. */ + /** + * Identifier for the anomaly detection job. + */ job_id: Id - /** A numerical character string that uniquely identifies the model snapshot. */ + /** + * A numerical character string that uniquely identifies the model snapshot. + */ snapshot_id: Id } - query_parameters?: { + query_parameters: { /** - * When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node. + * When true, the API won’t respond until the upgrade is complete. + * Otherwise, it responds as soon as the upgrade task is assigned to a node. * @server_default false */ wait_for_completion?: boolean /** * Controls the time to wait for the request to complete. - * @server_default 30s + * @server_default 30m */ timeout?: Time } diff --git a/specification/ml/validate_job/MlValidateJobRequest.ts b/specification/ml/validate/MlValidateJobRequest.ts similarity index 96% rename from specification/ml/validate_job/MlValidateJobRequest.ts rename to specification/ml/validate/MlValidateJobRequest.ts index bcb64dd277..c764c9fcd5 100644 --- a/specification/ml/validate_job/MlValidateJobRequest.ts +++ b/specification/ml/validate/MlValidateJobRequest.ts @@ -27,10 +27,11 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name ml.validate * @since 6.3.0 - * @stability TODO + * @stability stable + * @visibility private */ export interface Request extends RequestBase { - body?: { + body: { job_id?: Id analysis_config?: AnalysisConfig analysis_limits?: AnalysisLimits diff --git a/specification/ml/validate/MlValidateJobResponse.ts b/specification/ml/validate/MlValidateJobResponse.ts new file mode 100644 index 0000000000..0059ab53e4 --- /dev/null +++ b/specification/ml/validate/MlValidateJobResponse.ts @@ -0,0 +1,22 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/ml/validate_detector/MlValidateDetectorRequest.ts b/specification/ml/validate_detector/MlValidateDetectorRequest.ts index 3ecf9ff93e..4fa67111c2 100644 --- a/specification/ml/validate_detector/MlValidateDetectorRequest.ts +++ b/specification/ml/validate_detector/MlValidateDetectorRequest.ts @@ -23,9 +23,10 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ml.validate_detector * @since 5.4.0 - * - * @stability TODO + * @visibility private + * @stability stable */ export interface Request extends RequestBase { + /** @codegen_name detector */ body?: Detector } diff --git a/specification/monitoring/bulk/BulkMonitoringRequest.ts b/specification/monitoring/bulk/BulkMonitoringRequest.ts index 45d7872e1b..c8f7c83836 100644 --- a/specification/monitoring/bulk/BulkMonitoringRequest.ts +++ b/specification/monitoring/bulk/BulkMonitoringRequest.ts @@ -18,20 +18,43 @@ */ import { RequestBase } from '@_types/Base' +import { TimeSpan } from '@_types/Time' +import { OperationContainer, UpdateAction } from '@global/bulk/types' /** * @rest_spec_name monitoring.bulk * @since 6.3.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - path_parts?: { - stub_a: string +export interface Request extends RequestBase { + path_parts: { + /** + * @deprecated 7.0.0 + */ + type?: string } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + + query_parameters: { + /** + * Identifier of the monitored system + */ + system_id: string + + /** + * + */ + system_api_version: string + + /** + * Collection interval (e.g., '10s' or '10000ms') of the payload + */ + interval: TimeSpan } + + /** @codegen_name operations */ + // BulkMonitoringRequest accepts a body request that has the same format as the BulkRequest + // See BulkRequest for additional notes. + body?: Array< + OperationContainer | UpdateAction | TDocument + > } diff --git a/specification/monitoring/bulk/BulkMonitoringResponse.ts b/specification/monitoring/bulk/BulkMonitoringResponse.ts index 25b5bd6764..f9a663c5ab 100644 --- a/specification/monitoring/bulk/BulkMonitoringResponse.ts +++ b/specification/monitoring/bulk/BulkMonitoringResponse.ts @@ -17,8 +17,16 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { long } from '@_types/Numeric' +import { ErrorCause } from '@_types/Errors' export class Response { - body: { stub: integer } + body: { + error?: ErrorCause + /** True if there is was an error */ + errors: boolean + /** Was collection disabled? */ + ignored: boolean + took: long + } } diff --git a/specification/nodes/reload_secure_settings/types.ts b/specification/nodes/_types/NodeReloadResult.ts similarity index 78% rename from specification/nodes/reload_secure_settings/types.ts rename to specification/nodes/_types/NodeReloadResult.ts index e3370db675..e5b912b08d 100644 --- a/specification/nodes/reload_secure_settings/types.ts +++ b/specification/nodes/_types/NodeReloadResult.ts @@ -18,14 +18,13 @@ */ import { Name } from '@_types/common' +import { ErrorCause } from '@_types/Errors' +import { Stats } from '@nodes/_types/Stats' -export class NodeReloadException { +export class NodeReloadError { name: Name - reload_exception?: NodeReloadExceptionCausedBy + reload_exception?: ErrorCause } -export class NodeReloadExceptionCausedBy { - type: string - reason: string - caused_by?: NodeReloadExceptionCausedBy -} +/** @codegen_names stats, error */ +export type NodeReloadResult = Stats | NodeReloadError diff --git a/specification/nodes/_types/NodesResponseBase.ts b/specification/nodes/_types/NodesResponseBase.ts index 6df87d26fd..b43033ee17 100644 --- a/specification/nodes/_types/NodesResponseBase.ts +++ b/specification/nodes/_types/NodesResponseBase.ts @@ -23,7 +23,7 @@ export class NodesResponseBase { /** * Contains statistics about the number of nodes selected by the request’s node filters. * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes - * @identifier node_stats + * @codegen_name node_stats */ - _nodes: NodeStatistics + _nodes?: NodeStatistics } diff --git a/specification/nodes/_types/RepositoryMeteringInformation.ts b/specification/nodes/_types/RepositoryMeteringInformation.ts new file mode 100644 index 0000000000..bb15eb96ce --- /dev/null +++ b/specification/nodes/_types/RepositoryMeteringInformation.ts @@ -0,0 +1,103 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Id, Name, VersionNumber } from '@_types/common' +import { long } from '@_types/Numeric' +import { EpochMillis } from '@_types/Time' + +export class RepositoryMeteringInformation { + /** + * Repository name. + */ + repository_name: Name + /** + * Repository type. + */ + repository_type: string + /** + * Represents an unique location within the repository. + */ + repository_location: RepositoryLocation + /** + * An identifier that changes every time the repository is updated. + */ + repository_ephemeral_id: Id + /** + * Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch. + */ + repository_started_at: EpochMillis + /** + * Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch. + */ + repository_stopped_at?: EpochMillis + /** + * A flag that tells whether or not this object has been archived. When a repository is closed or updated the + * repository metering information is archived and kept for a certain period of time. This allows retrieving the + * repository metering information of previous repository instantiations. + */ + archived: boolean + /** + * The cluster state version when this object was archived, this field can be used as a logical timestamp to delete + * all the archived metrics up to an observed version. This field is only present for archived repository metering + * information objects. The main purpose of this field is to avoid possible race conditions during repository metering + * information deletions, i.e. deleting archived repositories metering information that we haven’t observed yet. + */ + cluster_version?: VersionNumber + /** + * An object with the number of request performed against the repository grouped by request type. + */ + request_counts: RequestCounts +} + +export class RepositoryLocation { + base_path: string + /** Container name (Azure) */ + container?: string + /** Bucket name (GCP, S3) */ + bucket?: string +} + +export class RequestCounts { + /** Number of Get Blob Properties requests (Azure) */ + GetBlobProperties?: long + /** Number of Get Blob requests (Azure) */ + GetBlob?: long + /** Number of List Blobs requests (Azure) */ + ListBlobs?: long + /** Number of Put Blob requests (Azure) */ + PutBlob?: long + /** Number of Put Block (Azure) */ + PutBlock?: long + /** Number of Put Block List requests */ + PutBlockList?: long + /** Number of get object requests (GCP, S3) */ + GetObject?: long + /** Number of list objects requests (GCP, S3) */ + ListObjects?: long + /** + * Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads + * can perform multiple http requests to insert a single object but they are considered as a single request + * since they are billed as an individual operation. (GCP) + */ + InsertObject?: long + /** Number of PutObject requests (S3) */ + PutObject?: long + /** Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3) */ + PutMultipartObject?: long +} diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index ff4dd75374..8ebe0b1c25 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -17,74 +17,199 @@ * under the License. */ -import { IndexStats } from '@indices/stats/types' +import { IndexStats, IndicesStats, ShardStats } from '@indices/stats/types' import { Dictionary } from '@spec_utils/Dictionary' import { Field, Name } from '@_types/common' import { Host, Ip, TransportAddress } from '@_types/Networking' import { NodeRoles } from '@_types/Node' import { double, float, integer, long } from '@_types/Numeric' +// The node stats response can be filtered both by `metric` and `filter_path`, +// every property needs to be optional to be compliant with the API behavior. export class Stats { - adaptive_selection: Dictionary - breakers: Dictionary - fs: FileSystem - host: Host - http: Http - indices: IndexStats - ingest: Ingest - ip: Ip | Ip[] - jvm: Jvm - name: Name - os: OperatingSystem - process: Process - roles: NodeRoles - script: Scripting - thread_pool: Dictionary - timestamp: long - transport: Transport - transport_address: TransportAddress - attributes: Dictionary + adaptive_selection?: Dictionary + breakers?: Dictionary + fs?: FileSystem + host?: Host + http?: Http + ingest?: Ingest + ip?: Ip | Ip[] + jvm?: Jvm + name?: Name + os?: OperatingSystem + process?: Process + roles?: NodeRoles + script?: Scripting + script_cache?: Dictionary + thread_pool?: Dictionary + timestamp?: long + transport?: Transport + transport_address?: TransportAddress + attributes?: Dictionary + discovery?: Discovery + indexing_pressure?: IndexingPressure + indices?: ShardStats +} + +export class IndexingPressure { + memory?: IndexingPressureMemory +} + +export class IndexingPressureMemory { + limit_in_bytes?: long + current?: PressureMemory + total?: PressureMemory +} + +export interface PressureMemory { + combined_coordinating_and_primary_in_bytes?: long + coordinating_in_bytes?: long + primary_in_bytes?: long + replica_in_bytes?: long + all_in_bytes?: long + coordinating_rejections?: long + primary_rejections?: long + replica_rejections?: long +} + +export class Discovery { + cluster_state_queue?: ClusterStateQueue + published_cluster_states?: PublishedClusterStates + cluster_state_update?: Dictionary + serialized_cluster_states?: SerializedClusterState + cluster_applier_stats?: ClusterAppliedStats +} + +export class ClusterAppliedStats { + recordings?: Recording[] +} + +export class Recording { + name?: string + cumulative_execution_count?: long + cumulative_execution_time?: string + cumulative_execution_time_millis?: long +} + +export class SerializedClusterState { + full_states?: SerializedClusterStateDetail + diffs?: SerializedClusterStateDetail +} + +export class SerializedClusterStateDetail { + count?: long + uncompressed_size?: string + uncompressed_size_in_bytes?: long + compressed_size?: string + compressed_size_in_bytes?: long +} + +export class ClusterStateQueue { + total?: long + pending?: long + committed?: long +} + +export class PublishedClusterStates { + full_states?: long + incompatible_diffs?: long + compatible_diffs?: long +} + +export class ClusterStateUpdate { + count?: long + computation_time?: string + computation_time_millis?: long + publication_time?: string + publication_time_millis?: long + context_construction_time?: string + context_construction_time_millis?: long + commit_time?: string + commit_time_millis?: long + completion_time?: string + completion_time_millis?: long + master_apply_time?: string + master_apply_time_millis?: long + notification_time?: string + notification_time_millis?: long } export class Ingest { - pipelines: Dictionary - total: IngestTotal + pipelines?: Dictionary + total?: IngestTotal } export class IngestTotal { - count: long - current: long - failed: long - processors: KeyedProcessor[] - time_in_millis: long + count?: long + current?: long + failed?: long + processors?: Dictionary[] + time_in_millis?: long } export class KeyedProcessor { - statistics: Process - type: string + stats?: Processor + type?: string +} + +export class Processor { + count?: long + current?: long + failed?: long + time_in_millis?: long } export class AdaptiveSelection { - avg_queue_size: long - avg_response_time: long - avg_response_time_ns: long - avg_service_time: string - avg_service_time_ns: long - outgoing_searches: long - rank: string + avg_queue_size?: long + avg_response_time?: long + avg_response_time_ns?: long + avg_service_time?: string + avg_service_time_ns?: long + outgoing_searches?: long + rank?: string } export class Breaker { - estimated_size: string - estimated_size_in_bytes: long - limit_size: string - limit_size_in_bytes: long - overhead: float - tripped: float + estimated_size?: string + estimated_size_in_bytes?: long + limit_size?: string + limit_size_in_bytes?: long + overhead?: float + tripped?: float +} + +export class Cgroup { + cpuacct?: CpuAcct + cpu?: CgroupCpu + memory?: CgroupMemory +} + +export class CpuAcct { + control_group?: string + usage_nanos?: long +} + +export class CgroupCpu { + control_group?: string + cfs_period_micros?: integer + cfs_quota_micros?: integer + stat?: CgroupCpuStat +} + +export class CgroupCpuStat { + number_of_elapsed_periods?: long + number_of_times_throttled?: long + time_throttled_nanos?: long +} + +export class CgroupMemory { + control_group?: string + limit_in_bytes?: string + usage_in_bytes?: string } export class Cpu { - percent: integer + percent?: integer sys?: string sys_in_millis?: long total?: string @@ -95,138 +220,210 @@ export class Cpu { } export class DataPathStats { - available: string - available_in_bytes: long - disk_queue: string - disk_reads: long - disk_read_size: string - disk_read_size_in_bytes: long - disk_writes: long - disk_write_size: string - disk_write_size_in_bytes: long - free: string - free_in_bytes: long - mount: string - path: string - total: string - total_in_bytes: long - type: string + available?: string + available_in_bytes?: long + disk_queue?: string + disk_reads?: long + disk_read_size?: string + disk_read_size_in_bytes?: long + disk_writes?: long + disk_write_size?: string + disk_write_size_in_bytes?: long + free?: string + free_in_bytes?: long + mount?: string + path?: string + total?: string + total_in_bytes?: long + type?: string } export class MemoryStats { + adjusted_total_in_bytes?: long resident?: string resident_in_bytes?: long share?: string share_in_bytes?: long total_virtual?: string total_virtual_in_bytes?: long - total_in_bytes: long - free_in_bytes: long - used_in_bytes: long + total_in_bytes?: long + free_in_bytes?: long + used_in_bytes?: long } export class ExtendedMemoryStats extends MemoryStats { - free_percent: integer - used_percent: integer - total_in_bytes: integer - free_in_bytes: integer - used_in_bytes: integer + free_percent?: integer + used_percent?: integer } export class Http { - current_open: integer - total_opened: long + current_open?: integer + total_opened?: long + clients?: Client[] +} + +export class Client { + id?: long + agent?: string + local_address?: string + remote_address?: string + last_uri?: string + opened_time_millis?: long + closed_time_millis?: long + last_request_time_millis?: long + request_count?: long + request_size_bytes?: long + x_opaque_id?: string } export class FileSystem { - data: DataPathStats[] - timestamp: long - total: FileSystemTotal + data?: DataPathStats[] + timestamp?: long + total?: FileSystemTotal + io_stats?: IoStats +} + +export class IoStats { + devices?: IoStatDevice[] + total?: IoStatDevice +} + +export class IoStatDevice { + device_name?: string + operations?: long + read_kilobytes?: long + read_operations?: long + write_kilobytes?: long + write_operations?: long } export class FileSystemTotal { - available: string - available_in_bytes: long - free: string - free_in_bytes: long - total: string - total_in_bytes: long + available?: string + available_in_bytes?: long + free?: string + free_in_bytes?: long + total?: string + total_in_bytes?: long } export class NodeBufferPool { - count: long - total_capacity: string - total_capacity_in_bytes: long - used: string - used_in_bytes: long + count?: long + total_capacity?: string + total_capacity_in_bytes?: long + used?: string + used_in_bytes?: long } export class Jvm { - buffer_pools: Dictionary - classes: JvmClasses - gc: GarbageCollector - mem: MemoryStats - threads: JvmThreads - timestamp: long - uptime: string - uptime_in_millis: long + buffer_pools?: Dictionary + classes?: JvmClasses + gc?: GarbageCollector + mem?: JvmMemoryStats + threads?: JvmThreads + timestamp?: long + uptime?: string + uptime_in_millis?: long +} + +export class JvmMemoryStats { + heap_used_in_bytes?: long + heap_used_percent?: long + heap_committed_in_bytes?: long + heap_max_in_bytes?: long + non_heap_used_in_bytes?: long + non_heap_committed_in_bytes?: long + pools?: Dictionary +} + +export class Pool { + used_in_bytes?: long + max_in_bytes?: long + peak_used_in_bytes?: long + peak_max_in_bytes?: long } export class JvmThreads { - count: long - peak_count: long + count?: long + peak_count?: long } export class JvmClasses { - current_loaded_count: long - total_loaded_count: long - total_unloaded_count: long + current_loaded_count?: long + total_loaded_count?: long + total_unloaded_count?: long } export class GarbageCollector { - collectors: Dictionary + collectors?: Dictionary } export class GarbageCollectorTotal { - collection_count: long - collection_time: string - collection_time_in_millis: long + collection_count?: long + collection_time?: string + collection_time_in_millis?: long } export class OperatingSystem { - cpu: Cpu - mem: ExtendedMemoryStats - swap: MemoryStats - timestamp: long + cpu?: Cpu + mem?: ExtendedMemoryStats + swap?: MemoryStats + cgroup?: Cgroup + timestamp?: long } export class Process { - cpu: Cpu - mem: MemoryStats - open_file_descriptors: integer - timestamp: long + cpu?: Cpu + mem?: MemoryStats + open_file_descriptors?: integer + max_file_descriptors?: integer + timestamp?: long } export class Scripting { - cache_evictions: long - compilations: long + cache_evictions?: long + compilations?: long + compilation_limit_triggered?: long + contexts?: Context[] +} + +export class Context { + context?: string + compilations?: long + cache_evictions?: long + compilation_limit_triggered?: long } export class ThreadCount { - active: long - completed: long - largest: long - queue: long - rejected: long - threads: long + active?: long + completed?: long + largest?: long + queue?: long + rejected?: long + threads?: long +} + +export class ScriptCache { + cache_evictions?: long + compilation_limit_triggered?: long + compilations?: long + context?: string } export class Transport { - rx_count: long - rx_size: string - rx_size_in_bytes: long - server_open: integer - tx_count: long - tx_size: string - tx_size_in_bytes: long + inbound_handling_time_histogram?: TransportHistogram[] + outbound_handling_time_histogram?: TransportHistogram[] + rx_count?: long + rx_size?: string + rx_size_in_bytes?: long + server_open?: integer + tx_count?: long + tx_size?: string + tx_size_in_bytes?: long + total_outbound_connections?: long +} + +export class TransportHistogram { + count?: long + lt_millis?: long + ge_millis?: long } diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts new file mode 100644 index 0000000000..a81751d025 --- /dev/null +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { NodeIds } from '@_types/common' +import { long } from '@_types/Numeric' + +/** + * You can use this API to clear the archived repositories metering information in the cluster. + * @rest_spec_name nodes.clear_repositories_metering_archive + * @since 7.16.0 + * @stability experimental + * @cluster_privileges monitor, manage + */ +export interface Request extends RequestBase { + path_parts: { + /** + * Comma-separated list of node IDs or names used to limit returned information. + * All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). + */ + node_id: NodeIds + /** + * Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive. + */ + max_archive_version: long + } +} diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts new file mode 100644 index 0000000000..203cc23fb3 --- /dev/null +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts @@ -0,0 +1,37 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { NodesResponseBase } from '@nodes/_types/NodesResponseBase' +import { RepositoryMeteringInformation } from '@nodes/_types/RepositoryMeteringInformation' +import { Dictionary } from '@spec_utils/Dictionary' +import { Name } from '@_types/common' +import { NodeStatistics } from '@_types/Node' + +export class Response extends NodesResponseBase { + body: { + /** + * Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). + */ + cluster_name: Name + /** + * Contains repositories metering information for the nodes selected by the request. + */ + nodes: Dictionary + } +} diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts new file mode 100644 index 0000000000..072735156c --- /dev/null +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -0,0 +1,41 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { NodeIds } from '@_types/common' + +/** + * You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. + * This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the + * information needed to compute aggregations over a period of time. Additionally, the information exposed by this + * API is volatile, meaning that it won’t be present after node restarts. + * @rest_spec_name nodes.get_repositories_metering_info + * @since 7.16.0 + * @stability experimental + * @cluster_privileges monitor, manage + */ +export interface Request extends RequestBase { + path_parts: { + /** + * Comma-separated list of node IDs or names used to limit returned information. + * All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). + */ + node_id: NodeIds + } +} diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts new file mode 100644 index 0000000000..203cc23fb3 --- /dev/null +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts @@ -0,0 +1,37 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { NodesResponseBase } from '@nodes/_types/NodesResponseBase' +import { RepositoryMeteringInformation } from '@nodes/_types/RepositoryMeteringInformation' +import { Dictionary } from '@spec_utils/Dictionary' +import { Name } from '@_types/common' +import { NodeStatistics } from '@_types/Node' + +export class Response extends NodesResponseBase { + body: { + /** + * Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). + */ + cluster_name: Name + /** + * Contains repositories metering information for the nodes selected by the request. + */ + nodes: Dictionary + } +} diff --git a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts index 6d60c0841f..09a63660f9 100644 --- a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts +++ b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts @@ -23,20 +23,59 @@ import { long } from '@_types/Numeric' import { Time } from '@_types/Time' /** + * This API yields a breakdown of the hot threads on each selected node in the cluster. + * The output is plain text with a breakdown of each node’s top hot threads. * @rest_spec_name nodes.hot_threads * @since 0.0.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor,manage */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * List of node IDs or names used to limit returned information. + */ node_id?: NodeIds } - query_parameters?: { + query_parameters: { + /** + * If true, known idle threads (e.g. waiting in a socket select, or to get + * a task from an empty queue) are filtered out. + * @server_default true + */ ignore_idle_threads?: boolean + /** + * The interval to do the second sampling of threads. + * @server_default 500ms + */ interval?: Time + /** + * Number of samples of thread stacktrace. + * @server_default 10 + */ snapshots?: long + /** + * Period to wait for a connection to the master node. If no response + * is received before the timeout expires, the request fails and + * returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Specifies the number of hot threads to provide information for. + * @server_default 3 + */ threads?: long - thread_type?: ThreadType + /** + * Period to wait for a response. If no response is received + * before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ timeout?: Time + /** + * The type to sample. + * @server_default cpu + */ + type?: ThreadType } } diff --git a/specification/nodes/info/NodesInfoRequest.ts b/specification/nodes/info/NodesInfoRequest.ts index 6248763e99..7a3aeaa8db 100644 --- a/specification/nodes/info/NodesInfoRequest.ts +++ b/specification/nodes/info/NodesInfoRequest.ts @@ -24,16 +24,16 @@ import { Time } from '@_types/Time' /** * @rest_spec_name nodes.info * @since 1.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Comma-separated list of node IDs or names used to limit returned information. */ node_id?: NodeIds /** Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. */ metric?: Metrics } - query_parameters?: { + query_parameters: { /** * If true, returns settings in flat format. * @server_default false diff --git a/specification/nodes/info/types.ts b/specification/nodes/info/types.ts index 66b2dd7591..a5b0379c87 100644 --- a/specification/nodes/info/types.ts +++ b/specification/nodes/info/types.ts @@ -25,6 +25,9 @@ import { Host, Ip, TransportAddress } from '@_types/Networking' import { integer, long } from '@_types/Numeric' import { PluginStats } from '@_types/Stats' import { NodeRoles } from '@_types/Node' +import { Duration, DurationValue, EpochTime, UnitMillis } from '@_types/Time' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { AdditionalProperties } from '@spec_utils/behaviors' export class NodeInfo { attributes: Dictionary @@ -67,7 +70,7 @@ export class NodeInfo { export class NodeInfoSettings { cluster: NodeInfoSettingsCluster node: NodeInfoSettingsNode - path: NodeInfoPath + path?: NodeInfoPath repositories?: NodeInfoRepositories discovery?: NodeInfoDiscover action?: NodeInfoAction @@ -79,13 +82,65 @@ export class NodeInfoSettings { xpack?: NodeInfoXpack script?: NodeInfoScript search?: NodeInfoSearch + ingest?: NodeInfoSettingsIngest +} + +export class NodeInfoSettingsIngest { + attachment?: NodeInfoIngestInfo + append?: NodeInfoIngestInfo + csv?: NodeInfoIngestInfo + convert?: NodeInfoIngestInfo + date?: NodeInfoIngestInfo + date_index_name?: NodeInfoIngestInfo + dot_expander?: NodeInfoIngestInfo + enrich?: NodeInfoIngestInfo + fail?: NodeInfoIngestInfo + foreach?: NodeInfoIngestInfo + json?: NodeInfoIngestInfo + user_agent?: NodeInfoIngestInfo + kv?: NodeInfoIngestInfo + geoip?: NodeInfoIngestInfo + grok?: NodeInfoIngestInfo + gsub?: NodeInfoIngestInfo + join?: NodeInfoIngestInfo + lowercase?: NodeInfoIngestInfo + remove?: NodeInfoIngestInfo + rename?: NodeInfoIngestInfo + script?: NodeInfoIngestInfo + set?: NodeInfoIngestInfo + sort?: NodeInfoIngestInfo + split?: NodeInfoIngestInfo + trim?: NodeInfoIngestInfo + uppercase?: NodeInfoIngestInfo + urldecode?: NodeInfoIngestInfo + bytes?: NodeInfoIngestInfo + dissect?: NodeInfoIngestInfo + set_security_user?: NodeInfoIngestInfo + pipeline?: NodeInfoIngestInfo + drop?: NodeInfoIngestInfo + circle?: NodeInfoIngestInfo + inference?: NodeInfoIngestInfo +} + +export class NodeInfoIngestInfo { + downloader: NodeInfoIngestDownloader +} + +export class NodeInfoIngestDownloader { + enabled: string } export class NodeInfoSettingsCluster { name: Name routing?: IndexRouting election: NodeInfoSettingsClusterElection - initial_master_nodes?: string + initial_master_nodes?: string[] + /** @since 7.16.0 */ + deprecation_indexing?: DeprecationIndexing +} + +export class DeprecationIndexing { + enabled: boolean | string } export class NodeInfoSettingsClusterElection { @@ -99,9 +154,9 @@ export class NodeInfoSettingsNode { } export class NodeInfoPath { - logs: string - home: string - repo: string[] + logs?: string + home?: string + repo?: string[] data?: string[] } @@ -113,8 +168,12 @@ export class NodeInfoRepositoriesUrl { allowed_urls: string } -export class NodeInfoDiscover { - seed_hosts: string +export class NodeInfoDiscover + implements AdditionalProperties +{ + seed_hosts?: string[] + type?: string + seed_providers?: string[] } export class NodeInfoAction { @@ -126,12 +185,13 @@ export class NodeInfoClient { } export class NodeInfoSettingsHttp { - type: string | NodeInfoSettingsHttpType + type: NodeInfoSettingsHttpType 'type.default'?: string // TODO this clashes with NodeInfoSettingsHttpType compression?: boolean | string port?: integer | string } +/** @shortcut_property default */ export class NodeInfoSettingsHttpType { default: string } @@ -141,11 +201,12 @@ export class NodeInfoBootstrap { } export class NodeInfoSettingsTransport { - type: string | NodeInfoSettingsTransportType + type: NodeInfoSettingsTransportType 'type.default'?: string // TODO this clashes with NodeInfoSettingsTransportType features?: NodeInfoSettingsTransportFeatures } +/** @shortcut_property default */ export class NodeInfoSettingsTransportType { default: string } @@ -179,7 +240,7 @@ export class NodeInfoXpack { export class NodeInfoXpackSecurity { http: NodeInfoXpackSecuritySsl enabled: string - transport: NodeInfoXpackSecuritySsl + transport?: NodeInfoXpackSecuritySsl authc?: NodeInfoXpackSecurityAuthc } diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts index b373e0dc0f..823900782e 100644 --- a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts +++ b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts @@ -24,16 +24,16 @@ import { Time } from '@_types/Time' /** * @rest_spec_name nodes.reload_secure_settings * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { node_id?: NodeIds } - query_parameters?: { + query_parameters: { timeout?: Time } - body?: { + body: { secure_settings_password?: Password } } diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsResponse.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsResponse.ts index 67d95b3eb4..2cbd38f814 100644 --- a/specification/nodes/reload_secure_settings/ReloadSecureSettingsResponse.ts +++ b/specification/nodes/reload_secure_settings/ReloadSecureSettingsResponse.ts @@ -17,15 +17,14 @@ * under the License. */ -import { Stats } from '@nodes/_types/Stats' import { NodesResponseBase } from '@nodes/_types/NodesResponseBase' import { Dictionary } from '@spec_utils/Dictionary' import { Name } from '@_types/common' -import { NodeReloadException } from './types' +import { NodeReloadResult } from '../_types/NodeReloadResult' export class Response extends NodesResponseBase { body: { cluster_name: Name - nodes: Dictionary + nodes: Dictionary } } diff --git a/specification/nodes/stats/NodesStatsRequest.ts b/specification/nodes/stats/NodesStatsRequest.ts index 208648a233..2d78d13b67 100644 --- a/specification/nodes/stats/NodesStatsRequest.ts +++ b/specification/nodes/stats/NodesStatsRequest.ts @@ -24,10 +24,10 @@ import { Time } from '@_types/Time' /** * @rest_spec_name nodes.stats * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** Comma-separated list of node IDs or names used to limit returned information. */ node_id?: NodeIds /*+ Limits the information returned to the specific metrics. */ @@ -35,7 +35,7 @@ export interface Request extends RequestBase { /** Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.*/ index_metric?: Metrics } - query_parameters?: { + query_parameters: { /** Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. */ completion_fields?: Fields /** Comma-separated list or wildcard expressions of fields to include in fielddata statistics. */ diff --git a/specification/nodes/stats/NodesStatsResponse.ts b/specification/nodes/stats/NodesStatsResponse.ts index 4a22d9d98f..c5e8e2d6bc 100644 --- a/specification/nodes/stats/NodesStatsResponse.ts +++ b/specification/nodes/stats/NodesStatsResponse.ts @@ -24,7 +24,7 @@ import { Stats } from '../_types/Stats' export class Response extends NodesResponseBase { body: { - cluster_name: Name + cluster_name?: Name nodes: Dictionary } } diff --git a/specification/nodes/usage/NodesUsageRequest.ts b/specification/nodes/usage/NodesUsageRequest.ts index 3aed35de3f..a077b29a82 100644 --- a/specification/nodes/usage/NodesUsageRequest.ts +++ b/specification/nodes/usage/NodesUsageRequest.ts @@ -24,14 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name nodes.usage * @since 6.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { node_id?: NodeIds metric?: Metrics } - query_parameters?: { + query_parameters: { timeout?: Time } } diff --git a/specification/rollup/delete_rollup_job/DeleteRollupJobRequest.ts b/specification/rollup/delete_job/DeleteRollupJobRequest.ts similarity index 95% rename from specification/rollup/delete_rollup_job/DeleteRollupJobRequest.ts rename to specification/rollup/delete_job/DeleteRollupJobRequest.ts index 445f58f8e6..70cf2dc51b 100644 --- a/specification/rollup/delete_rollup_job/DeleteRollupJobRequest.ts +++ b/specification/rollup/delete_job/DeleteRollupJobRequest.ts @@ -23,10 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name rollup.delete_job * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } } diff --git a/specification/rollup/delete_rollup_job/DeleteRollupJobResponse.ts b/specification/rollup/delete_job/DeleteRollupJobResponse.ts similarity index 93% rename from specification/rollup/delete_rollup_job/DeleteRollupJobResponse.ts rename to specification/rollup/delete_job/DeleteRollupJobResponse.ts index b37e224624..b1d937e88d 100644 --- a/specification/rollup/delete_rollup_job/DeleteRollupJobResponse.ts +++ b/specification/rollup/delete_job/DeleteRollupJobResponse.ts @@ -17,7 +17,7 @@ * under the License. */ -import { TaskFailure } from '@rollup/delete_rollup_job/types' +import { TaskFailure } from './types' import { AcknowledgedResponseBase } from '@_types/Base' export class Response extends AcknowledgedResponseBase { diff --git a/specification/rollup/delete_rollup_job/types.ts b/specification/rollup/delete_job/types.ts similarity index 100% rename from specification/rollup/delete_rollup_job/types.ts rename to specification/rollup/delete_job/types.ts diff --git a/specification/rollup/get_rollup_job/GetRollupJobRequest.ts b/specification/rollup/get_jobs/GetRollupJobRequest.ts similarity index 95% rename from specification/rollup/get_rollup_job/GetRollupJobRequest.ts rename to specification/rollup/get_jobs/GetRollupJobRequest.ts index a1043b5d5b..26271944f3 100644 --- a/specification/rollup/get_rollup_job/GetRollupJobRequest.ts +++ b/specification/rollup/get_jobs/GetRollupJobRequest.ts @@ -23,10 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name rollup.get_jobs * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id?: Id } } diff --git a/specification/rollup/get_rollup_job/GetRollupJobResponse.ts b/specification/rollup/get_jobs/GetRollupJobResponse.ts similarity index 100% rename from specification/rollup/get_rollup_job/GetRollupJobResponse.ts rename to specification/rollup/get_jobs/GetRollupJobResponse.ts diff --git a/specification/rollup/get_rollup_job/types.ts b/specification/rollup/get_jobs/types.ts similarity index 100% rename from specification/rollup/get_rollup_job/types.ts rename to specification/rollup/get_jobs/types.ts diff --git a/specification/rollup/get_rollup_capabilities/GetRollupCapabilitiesRequest.ts b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts similarity index 95% rename from specification/rollup/get_rollup_capabilities/GetRollupCapabilitiesRequest.ts rename to specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts index b0b55168ac..762b45bec1 100644 --- a/specification/rollup/get_rollup_capabilities/GetRollupCapabilitiesRequest.ts +++ b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts @@ -23,10 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name rollup.get_rollup_caps * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id?: Id } } diff --git a/specification/rollup/get_rollup_capabilities/GetRollupCapabilitiesResponse.ts b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts similarity index 100% rename from specification/rollup/get_rollup_capabilities/GetRollupCapabilitiesResponse.ts rename to specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts diff --git a/specification/rollup/get_rollup_capabilities/types.ts b/specification/rollup/get_rollup_caps/types.ts similarity index 100% rename from specification/rollup/get_rollup_capabilities/types.ts rename to specification/rollup/get_rollup_caps/types.ts diff --git a/specification/rollup/get_rollup_index_capabilities/GetRollupIndexCapabilitiesRequest.ts b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts similarity index 95% rename from specification/rollup/get_rollup_index_capabilities/GetRollupIndexCapabilitiesRequest.ts rename to specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts index ce7b399cbc..4d8cbdb15f 100644 --- a/specification/rollup/get_rollup_index_capabilities/GetRollupIndexCapabilitiesRequest.ts +++ b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts @@ -23,10 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name rollup.get_rollup_index_caps * @since 6.4.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Id } } diff --git a/specification/rollup/get_rollup_index_capabilities/GetRollupIndexCapabilitiesResponse.ts b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts similarity index 100% rename from specification/rollup/get_rollup_index_capabilities/GetRollupIndexCapabilitiesResponse.ts rename to specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts diff --git a/specification/rollup/get_rollup_index_capabilities/types.ts b/specification/rollup/get_rollup_index_caps/types.ts similarity index 100% rename from specification/rollup/get_rollup_index_capabilities/types.ts rename to specification/rollup/get_rollup_index_caps/types.ts diff --git a/specification/rollup/create_rollup_job/CreateRollupJobRequest.ts b/specification/rollup/put_job/CreateRollupJobRequest.ts similarity index 96% rename from specification/rollup/create_rollup_job/CreateRollupJobRequest.ts rename to specification/rollup/put_job/CreateRollupJobRequest.ts index 9d9062233b..63c2660906 100644 --- a/specification/rollup/create_rollup_job/CreateRollupJobRequest.ts +++ b/specification/rollup/put_job/CreateRollupJobRequest.ts @@ -26,13 +26,13 @@ import { long } from '@_types/Numeric' /** * @rest_spec_name rollup.put_job * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } - body?: { + body: { cron?: string groups?: Groupings index_pattern?: string diff --git a/specification/rollup/put_job/CreateRollupJobResponse.ts b/specification/rollup/put_job/CreateRollupJobResponse.ts new file mode 100644 index 0000000000..0059ab53e4 --- /dev/null +++ b/specification/rollup/put_job/CreateRollupJobResponse.ts @@ -0,0 +1,22 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/rollup/rollup/RollupRequest.ts b/specification/rollup/rollup/RollupRequest.ts index aff69f3029..64d5b8e5fc 100644 --- a/specification/rollup/rollup/RollupRequest.ts +++ b/specification/rollup/rollup/RollupRequest.ts @@ -17,22 +17,20 @@ * under the License. */ +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { RequestBase } from '@_types/Base' -import { integer } from '@_types/Numeric' +import { IndexName } from '@_types/common' /** * @rest_spec_name rollup.rollup * @since 7.13.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { - stubb: integer - } - query_parameters?: { - stuba: integer - } - body?: { - stub: integer + path_parts: { + index: IndexName + rollup_index: IndexName } + /** @codegen_name config */ + body?: UserDefinedValue // TODO: This API is experimental and no docs exist describing it. Requires reverse engineering if made stable } diff --git a/specification/rollup/rollup/RollupResponse.ts b/specification/rollup/rollup/RollupResponse.ts index 25b5bd6764..9e71df5410 100644 --- a/specification/rollup/rollup/RollupResponse.ts +++ b/specification/rollup/rollup/RollupResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { - body: { stub: integer } + body: UserDefinedValue // TODO: This API is experimental and no docs exist describing it. Requires reverse engineering if made stable } diff --git a/specification/rollup/rollup_search/RollupSearchRequest.ts b/specification/rollup/rollup_search/RollupSearchRequest.ts index d590bd7395..4bdecdb4f7 100644 --- a/specification/rollup/rollup_search/RollupSearchRequest.ts +++ b/specification/rollup/rollup_search/RollupSearchRequest.ts @@ -27,20 +27,22 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' /** * @rest_spec_name rollup.rollup_search * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index: Indices type?: Type } - query_parameters?: { + query_parameters: { rest_total_hits_as_int?: boolean typed_keys?: boolean } - body?: { - aggs?: Dictionary + body: { + /** @aliases aggs */ + aggregations?: Dictionary query?: QueryContainer + /** Must be zero if set, as rollups work on pre-aggregated data */ size?: integer } } diff --git a/specification/rollup/start_rollup_job/StartRollupJobRequest.ts b/specification/rollup/start_job/StartRollupJobRequest.ts similarity index 95% rename from specification/rollup/start_rollup_job/StartRollupJobRequest.ts rename to specification/rollup/start_job/StartRollupJobRequest.ts index 33823e384e..a34febf46f 100644 --- a/specification/rollup/start_rollup_job/StartRollupJobRequest.ts +++ b/specification/rollup/start_job/StartRollupJobRequest.ts @@ -23,10 +23,10 @@ import { Id } from '@_types/common' /** * @rest_spec_name rollup.start_job * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } } diff --git a/specification/rollup/start_rollup_job/StartRollupJobResponse.ts b/specification/rollup/start_job/StartRollupJobResponse.ts similarity index 100% rename from specification/rollup/start_rollup_job/StartRollupJobResponse.ts rename to specification/rollup/start_job/StartRollupJobResponse.ts diff --git a/specification/rollup/stop_rollup_job/StopRollupJobRequest.ts b/specification/rollup/stop_job/StopRollupJobRequest.ts similarity index 94% rename from specification/rollup/stop_rollup_job/StopRollupJobRequest.ts rename to specification/rollup/stop_job/StopRollupJobRequest.ts index e13a63206f..51defff65e 100644 --- a/specification/rollup/stop_rollup_job/StopRollupJobRequest.ts +++ b/specification/rollup/stop_job/StopRollupJobRequest.ts @@ -24,13 +24,13 @@ import { Time } from '@_types/Time' /** * @rest_spec_name rollup.stop_job * @since 6.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } - query_parameters?: { + query_parameters: { timeout?: Time wait_for_completion?: boolean } diff --git a/specification/rollup/stop_rollup_job/StopRollupJobResponse.ts b/specification/rollup/stop_job/StopRollupJobResponse.ts similarity index 100% rename from specification/rollup/stop_rollup_job/StopRollupJobResponse.ts rename to specification/rollup/stop_job/StopRollupJobResponse.ts diff --git a/specification/searchable_snapshots/_types/stats.ts b/specification/searchable_snapshots/_types/stats.ts new file mode 100644 index 0000000000..e720fdfef6 --- /dev/null +++ b/specification/searchable_snapshots/_types/stats.ts @@ -0,0 +1,24 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export enum StatsLevel { + cluster = 0, + indices = 1, + shards = 2 +} diff --git a/specification/ml/forecast_job/MlForecastJobRequest.ts b/specification/searchable_snapshots/cache_stats/Request.ts similarity index 82% rename from specification/ml/forecast_job/MlForecastJobRequest.ts rename to specification/searchable_snapshots/cache_stats/Request.ts index 68db039b0b..a0bd5ab74d 100644 --- a/specification/ml/forecast_job/MlForecastJobRequest.ts +++ b/specification/searchable_snapshots/cache_stats/Request.ts @@ -18,20 +18,19 @@ */ import { RequestBase } from '@_types/Base' -import { Id } from '@_types/common' +import { NodeIds } from '@_types/common' import { Time } from '@_types/Time' /** - * @rest_spec_name ml.forecast - * @since 6.1.0 - * @stability TODO + * @rest_spec_name searchable_snapshots.cache_stats + * @since 7.13.0 + * @stability experimental */ export interface Request extends RequestBase { path_parts: { - job_id: Id + node_id?: NodeIds } - body?: { - duration?: Time - expires_in?: Time + query_parameters: { + master_timeout?: Time } } diff --git a/specification/searchable_snapshots/cache_stats/Response.ts b/specification/searchable_snapshots/cache_stats/Response.ts new file mode 100644 index 0000000000..387b713784 --- /dev/null +++ b/specification/searchable_snapshots/cache_stats/Response.ts @@ -0,0 +1,43 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Dictionary } from '@spec_utils/Dictionary' +import { long, integer } from '@_types/Numeric' +import { ByteSize } from '@_types/common' + +export class Response { + body: { + nodes: Dictionary + } +} + +export class Node { + shared_cache: Shared +} + +export class Shared { + reads: long + bytes_read_in_bytes: ByteSize + writes: long + bytes_written_in_bytes: ByteSize + evictions: long + num_regions: integer + size_in_bytes: ByteSize + region_size_in_bytes: ByteSize +} diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts index b854c24146..a1db34c91b 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts @@ -23,13 +23,13 @@ import { ExpandWildcards, Indices } from '@_types/common' /** * @rest_spec_name searchable_snapshots.clear_cache * @since 7.10.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { index?: Indices } - query_parameters?: { + query_parameters: { expand_wildcards?: ExpandWildcards allow_no_indices?: boolean ignore_unavailable?: boolean diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts index 25b5bd6764..f4ed729ed2 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts @@ -17,8 +17,8 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { - body: { stub: integer } + body: UserDefinedValue } diff --git a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts index bedca58cf6..6243a6047e 100644 --- a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts +++ b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts @@ -26,14 +26,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name searchable_snapshots.mount * @since 7.10.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { repository: Name snapshot: Name } - query_parameters?: { + query_parameters: { /** @server_default 30s */ master_timeout?: Time /** @server_default false */ @@ -41,7 +41,7 @@ export interface Request extends RequestBase { /** @server_default full_copy */ storage?: string } - body?: { + body: { index: IndexName renamed_index?: IndexName index_settings?: Dictionary diff --git a/specification/searchable_snapshots/repository_stats/SearchableSnapshotsRepositoryStatsRequest.ts b/specification/searchable_snapshots/repository_stats/SearchableSnapshotsRepositoryStatsRequest.ts deleted file mode 100644 index c02ea7e12b..0000000000 --- a/specification/searchable_snapshots/repository_stats/SearchableSnapshotsRepositoryStatsRequest.ts +++ /dev/null @@ -1,38 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { RequestBase } from '@_types/Base' -import { integer } from '@_types/Numeric' - -/** - * @rest_spec_name searchable_snapshots.repository_stats - * @since 7.10.0 - * @stability TODO - */ -export interface Request extends RequestBase { - path_parts?: { - stub_a: integer - } - query_parameters?: { - stub_b: integer - } - body?: { - stub_c: integer - } -} diff --git a/specification/searchable_snapshots/repository_stats/SearchableSnapshotsRepositoryStatsResponse.ts b/specification/searchable_snapshots/repository_stats/SearchableSnapshotsRepositoryStatsResponse.ts deleted file mode 100644 index 25b5bd6764..0000000000 --- a/specification/searchable_snapshots/repository_stats/SearchableSnapshotsRepositoryStatsResponse.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { integer } from '@_types/Numeric' - -export class Response { - body: { stub: integer } -} diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts index 8e52171468..06edcd9c12 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts @@ -17,22 +17,20 @@ * under the License. */ +import { StatsLevel } from '../_types/stats' import { RequestBase } from '@_types/Base' -import { integer } from '@_types/Numeric' +import { Indices } from '@_types/common' /** * @rest_spec_name searchable_snapshots.stats * @since 7.10.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: integer + path_parts: { + index?: Indices } - query_parameters?: { - stub_b: integer - } - body?: { - stub_c: integer + query_parameters: { + level?: StatsLevel } } diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsResponse.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsResponse.ts index 25b5bd6764..65b2855273 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsResponse.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsResponse.ts @@ -17,8 +17,11 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { - body: { stub: integer } + body: { + stats: UserDefinedValue // TODO: complete this definition + total: UserDefinedValue // TODO: complete this definition + } } diff --git a/specification/security/_types/ApplicationGlobalUserPrivileges.ts b/specification/security/_types/ApplicationGlobalUserPrivileges.ts deleted file mode 100644 index 0864be1d4e..0000000000 --- a/specification/security/_types/ApplicationGlobalUserPrivileges.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { ManageUserPrivileges } from './ManageUserPrivileges' - -export class ApplicationGlobalUserPrivileges { - manage: ManageUserPrivileges -} diff --git a/specification/security/_types/ApplicationPrivileges.ts b/specification/security/_types/ApplicationPrivileges.ts deleted file mode 100644 index 1aa214087c..0000000000 --- a/specification/security/_types/ApplicationPrivileges.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -export class ApplicationPrivileges { - application: string - privileges: string[] - resources: string[] -} diff --git a/specification/security/_types/FieldSecurity.ts b/specification/security/_types/FieldSecurity.ts index a81afc62a6..b65e4f0635 100644 --- a/specification/security/_types/FieldSecurity.ts +++ b/specification/security/_types/FieldSecurity.ts @@ -21,5 +21,5 @@ import { Fields } from '@_types/common' export class FieldSecurity { except?: Fields - grant: Fields + grant?: Fields } diff --git a/specification/security/_types/GlobalPrivileges.ts b/specification/security/_types/GlobalPrivileges.ts deleted file mode 100644 index d78d629ea7..0000000000 --- a/specification/security/_types/GlobalPrivileges.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { ApplicationGlobalUserPrivileges } from './ApplicationGlobalUserPrivileges' - -export class GlobalPrivileges { - application: ApplicationGlobalUserPrivileges -} diff --git a/specification/security/_types/Privileges.ts b/specification/security/_types/Privileges.ts new file mode 100644 index 0000000000..3ab5c3348b --- /dev/null +++ b/specification/security/_types/Privileges.ts @@ -0,0 +1,198 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Dictionary } from '@spec_utils/Dictionary' +import { Indices } from '@_types/common' +import { QueryContainer } from '@_types/query_dsl/abstractions' +import { FieldSecurity } from './FieldSecurity' +import { ScriptLanguage, ScriptBase, StoredScriptId } from '@_types/Scripting' + +export class ApplicationPrivileges { + /** + * The name of the application to which this entry applies. + */ + application: string + /** + * A list of strings, where each element is the name of an application privilege or action. + */ + privileges: string[] + /** + * A list resources to which the privileges are applied. + */ + resources: string[] +} + +/** @non_exhaustive */ +export enum ClusterPrivilege { + all, + cancel_task, + create_snapshot, + grant_api_key, + manage, + manage_api_key, + manage_ccr, + manage_enrich, + manage_ilm, + manage_index_templates, + manage_ingest_pipelines, + manage_logstash_pipelines, + manage_ml, + manage_oidc, + manage_own_api_key, + manage_pipeline, + manage_rollup, + manage_saml, + manage_security, + manage_service_account, + manage_slm, + manage_token, + manage_transform, + manage_watcher, + monitor, + monitor_ml, + monitor_rollup, + monitor_snapshot, + monitor_text_structure, + monitor_transform, + monitor_watcher, + read_ccr, + read_ilm, + read_pipeline, + read_slm, + transport_client +} + +export class IndicesPrivileges { + /** + * The document fields that the owners of the role have read access to. + * @doc_id field-and-document-access-control + */ + field_security?: FieldSecurity | FieldSecurity[] + /** + * A list of indices (or index name patterns) to which the permissions in this entry apply. + */ + names: Indices + /** + * The index level privileges that owners of the role have on the specified indices. + */ + privileges: IndexPrivilege[] + /** + * A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. + */ + query?: IndicesPrivilegesQuery + /** + * Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. + * @server_default false + */ + allow_restricted_indices?: boolean +} + +export class UserIndicesPrivileges { + /** + * The document fields that the owners of the role have read access to. + * @doc_id field-and-document-access-control + */ + field_security?: FieldSecurity[] + /** + * A list of indices (or index name patterns) to which the permissions in this entry apply. + */ + names: Indices + /** + * The index level privileges that owners of the role have on the specified indices. + */ + privileges: IndexPrivilege[] + /** + * Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role. + */ + query?: IndicesPrivilegesQuery[] + /** + * Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. + */ + allow_restricted_indices: boolean +} + +/** + * While creating or updating a role you can provide either a JSON structure or a string to the API. + * However, the response provided by Elasticsearch will only be string with a json-as-text content. + * + * Since this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts. + * + * @codegen_names json_text, query, template + */ +export type IndicesPrivilegesQuery = string | QueryContainer | RoleTemplateQuery + +export class RoleTemplateQuery { + /** + * When you create a role, you can specify a query that defines the document level security permissions. You can optionally + * use Mustache templates in the role query to insert the username of the current authenticated user into the role. + * Like other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based + * templates and define custom parameters. You access the details for the current authenticated user through the _user parameter. + * + * @doc_id templating-role-query + */ + template?: RoleTemplateScript +} + +/** @shortcut_property source */ +export class RoleTemplateInlineScript extends ScriptBase { + lang?: ScriptLanguage + options?: Dictionary + source: RoleTemplateInlineQuery +} + +/** @codegen_names query_string, query_object */ +export type RoleTemplateInlineQuery = string | QueryContainer + +/** @codegen_names inline, stored */ +export type RoleTemplateScript = RoleTemplateInlineScript | StoredScriptId + +/** @non_exhaustive */ +export enum IndexPrivilege { + none, + all, + auto_configure, + create, + create_doc, + create_index, + delete, + delete_index, + index, + maintenance, + manage, + manage_follow_index, + manage_ilm, + manage_leader_index, + monitor, + read, + read_cross_cluster, + view_index_metadata, + write +} + +export class GlobalPrivilege { + application: ApplicationGlobalUserPrivileges +} + +export class ApplicationGlobalUserPrivileges { + manage: ManageUserPrivileges +} + +export class ManageUserPrivileges { + applications: string[] +} diff --git a/specification/security/_types/RoleMapping.ts b/specification/security/_types/RoleMapping.ts index 6bff67c30d..9f505418a9 100644 --- a/specification/security/_types/RoleMapping.ts +++ b/specification/security/_types/RoleMapping.ts @@ -18,11 +18,14 @@ */ import { Metadata } from '@_types/common' -import { RoleMappingRuleBase } from './RoleMappingRuleBase' +import { RoleMappingRule } from './RoleMappingRule' +import { RoleTemplate } from './RoleTemplate' +// ES: ExpressionRoleMapping export class RoleMapping { enabled: boolean metadata: Metadata roles: string[] - rules: RoleMappingRuleBase + rules: RoleMappingRule + role_templates?: RoleTemplate[] } diff --git a/specification/cat/data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/security/_types/RoleMappingRule.ts similarity index 55% rename from specification/cat/data_frame_analytics/CatDataFrameAnalyticsRequest.ts rename to specification/security/_types/RoleMappingRule.ts index d7e2f0a5ec..85b52882a8 100644 --- a/specification/cat/data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/security/_types/RoleMappingRule.ts @@ -17,21 +17,28 @@ * under the License. */ -import { CatRequestBase } from '@cat/_types/CatBase' -import { Bytes, Id } from '@_types/common' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { Name, Names } from '@_types/common' /** - * @rest_spec_name cat.ml_data_frame_analytics - * @since 7.7.0 - * @stability TODO + * @variants container */ -export interface Request extends CatRequestBase { - path_parts?: { - id?: Id - } - query_parameters?: { - allow_no_match?: boolean - bytes?: Bytes - } - body?: {} +export class RoleMappingRule { + any?: RoleMappingRule[] + all?: RoleMappingRule[] + // `field` should have been defined as SingleKeyDictionary + // However, this was initially defined as a container with a limited number of variants, + // and was later made non_exhaustive to limit breaking changes. + field?: FieldRule + except?: RoleMappingRule +} + +/** + * @variants container + * @non_exhaustive + */ +export class FieldRule { + username?: Names + dn?: Names + groups?: Names } diff --git a/specification/security/_types/RoleTemplate.ts b/specification/security/_types/RoleTemplate.ts new file mode 100644 index 0000000000..2065b84377 --- /dev/null +++ b/specification/security/_types/RoleTemplate.ts @@ -0,0 +1,31 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Script } from '@_types/Scripting' + +export enum TemplateFormat { + string = 0, + json = 1 +} + +// ES: TemplateRoleName +export class RoleTemplate { + format?: TemplateFormat + template: Script +} diff --git a/specification/ml/find_file_structure/MlFindFileStructureResponse.ts b/specification/security/_types/TransientMetadataConfig.ts similarity index 93% rename from specification/ml/find_file_structure/MlFindFileStructureResponse.ts rename to specification/security/_types/TransientMetadataConfig.ts index 9a10e1bcf3..1ceffef545 100644 --- a/specification/ml/find_file_structure/MlFindFileStructureResponse.ts +++ b/specification/security/_types/TransientMetadataConfig.ts @@ -17,6 +17,6 @@ * under the License. */ -export class Response { - body: { stub: string } +export class TransientMetadataConfig { + enabled: boolean } diff --git a/specification/security/authenticate/SecurityAuthenticateRequest.ts b/specification/security/authenticate/SecurityAuthenticateRequest.ts index 4718005e1c..b3e75997da 100644 --- a/specification/security/authenticate/SecurityAuthenticateRequest.ts +++ b/specification/security/authenticate/SecurityAuthenticateRequest.ts @@ -23,6 +23,6 @@ import { RequestBase } from '@_types/Base' * Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user. * @rest_spec_name security.authenticate * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/security/authenticate/SecurityAuthenticateResponse.ts b/specification/security/authenticate/SecurityAuthenticateResponse.ts index 6c0bac4bd5..d6f182204c 100644 --- a/specification/security/authenticate/SecurityAuthenticateResponse.ts +++ b/specification/security/authenticate/SecurityAuthenticateResponse.ts @@ -19,13 +19,14 @@ import { RealmInfo } from '@security/_types/RealmInfo' import { Metadata, Name, Username } from '@_types/common' -import { Token } from './types' +import { ApiKey, Token } from './types' export class Response { body: { + api_key?: ApiKey authentication_realm: RealmInfo - email?: string - full_name?: Name + email?: string | null + full_name?: Name | null lookup_realm: RealmInfo metadata: Metadata roles: string[] diff --git a/specification/security/authenticate/types.ts b/specification/security/authenticate/types.ts index fe22bd7b68..fa821d54be 100644 --- a/specification/security/authenticate/types.ts +++ b/specification/security/authenticate/types.ts @@ -21,4 +21,11 @@ import { Name } from '@_types/common' export class Token { name: Name + /** @since 7.14.0 */ + type?: string +} + +export class ApiKey { + id: string + name: Name } diff --git a/specification/security/change_password/SecurityChangePasswordRequest.ts b/specification/security/change_password/SecurityChangePasswordRequest.ts index 63f6d2bba5..a8887a67c4 100644 --- a/specification/security/change_password/SecurityChangePasswordRequest.ts +++ b/specification/security/change_password/SecurityChangePasswordRequest.ts @@ -23,16 +23,30 @@ import { Password, Refresh, Username } from '@_types/common' /** * @rest_spec_name security.change_password * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * The user whose password you want to change. If you do not specify this + * parameter, the password is changed for the current user. + */ username?: Username } - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: { + body: { + /** + * The new password value. Passwords must be at least 6 characters long. + */ password?: Password + /** + * A hash of the new password value. This must be produced using the same + * hashing algorithm as has been configured for password storage. For more details, + * see the explanation of the `xpack.security.authc.password_hashing.algorithm` + * setting. + */ + password_hash?: string } } diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts index 56b4347483..110193ccd6 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts @@ -23,10 +23,10 @@ import { Ids } from '@_types/common' /** * @rest_spec_name security.clear_api_key_cache * @since 7.10.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - ids?: Ids + path_parts: { + ids: Ids } } diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts index 0cab1706b7..77e61eaf2f 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts @@ -24,7 +24,7 @@ import { NodeStatistics } from '@_types/Node' export class Response { body: { - /** @identifier node_stats */ + /** @codegen_name node_stats */ _nodes: NodeStatistics cluster_name: Name nodes: Dictionary diff --git a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts index e20594aee1..45a55a07eb 100644 --- a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts +++ b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name security.clear_cached_privileges * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { application: Name } } diff --git a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts index 0cab1706b7..77e61eaf2f 100644 --- a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts +++ b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts @@ -24,7 +24,7 @@ import { NodeStatistics } from '@_types/Node' export class Response { body: { - /** @identifier node_stats */ + /** @codegen_name node_stats */ _nodes: NodeStatistics cluster_name: Name nodes: Dictionary diff --git a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts index 3bce18d8da..6529418a19 100644 --- a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts +++ b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts @@ -23,14 +23,13 @@ import { Names } from '@_types/common' /** * @rest_spec_name security.clear_cached_realms * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { realms: Names } - query_parameters?: { + query_parameters: { usernames?: string[] } - body?: {} } diff --git a/specification/security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts b/specification/security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts index 0cab1706b7..77e61eaf2f 100644 --- a/specification/security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts +++ b/specification/security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts @@ -24,7 +24,7 @@ import { NodeStatistics } from '@_types/Node' export class Response { body: { - /** @identifier node_stats */ + /** @codegen_name node_stats */ _nodes: NodeStatistics cluster_name: Name nodes: Dictionary diff --git a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts index a7c30faa49..024e194735 100644 --- a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts +++ b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts @@ -23,7 +23,7 @@ import { Names } from '@_types/common' /** * @rest_spec_name security.clear_cached_roles * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/clear_cached_roles/ClearCachedRolesResponse.ts b/specification/security/clear_cached_roles/ClearCachedRolesResponse.ts index 0cab1706b7..77e61eaf2f 100644 --- a/specification/security/clear_cached_roles/ClearCachedRolesResponse.ts +++ b/specification/security/clear_cached_roles/ClearCachedRolesResponse.ts @@ -24,7 +24,7 @@ import { NodeStatistics } from '@_types/Node' export class Response { body: { - /** @identifier node_stats */ + /** @codegen_name node_stats */ _nodes: NodeStatistics cluster_name: Name nodes: Dictionary diff --git a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts index 58172ba976..555b038048 100644 --- a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts +++ b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts @@ -23,7 +23,7 @@ import { Names, Namespace, Service } from '@_types/common' /** * @rest_spec_name security.clear_cached_service_tokens * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts index 0cab1706b7..77e61eaf2f 100644 --- a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts +++ b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts @@ -24,7 +24,7 @@ import { NodeStatistics } from '@_types/Node' export class Response { body: { - /** @identifier node_stats */ + /** @codegen_name node_stats */ _nodes: NodeStatistics cluster_name: Name nodes: Dictionary diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index 0e62da026d..3ad5f2cbb1 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -26,13 +26,13 @@ import { RoleDescriptor } from './types' /** * @rest_spec_name security.create_api_key * @since 6.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: { + body: { /** Expiration time for the API key. By default, API keys never expire. */ expiration?: Time /** Specifies the name for this API key. */ diff --git a/specification/security/create_api_key/SecurityCreateApiKeyResponse.ts b/specification/security/create_api_key/SecurityCreateApiKeyResponse.ts index 1f489443f7..a4cdb2b1e5 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyResponse.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyResponse.ts @@ -21,5 +21,29 @@ import { Id, Name } from '@_types/common' import { long } from '@_types/Numeric' export class Response { - body: { api_key: string; expiration?: long; id: Id; name: Name } + body: { + /** + * Generated API key. + */ + api_key: string + /** + * Expiration in milliseconds for the API key. + */ + expiration?: long + /** + * Unique ID for this API key. + */ + id: Id + /** + * Specifies the name for this API key. + */ + name: Name + /** + * API key credentials which is the base64-encoding of + * the UTF-8 representation of `id` and `api_key` joined + * by a colon (`:`). + * @since 7.16.0 + */ + encoded: string + } } diff --git a/specification/security/create_api_key/types.ts b/specification/security/create_api_key/types.ts index 995ef5237c..26680309e4 100644 --- a/specification/security/create_api_key/types.ts +++ b/specification/security/create_api_key/types.ts @@ -17,16 +17,28 @@ * under the License. */ -import { ApplicationPrivileges } from '@security/_types/ApplicationPrivileges' -import { Indices } from '@_types/common' +import { + IndexPrivilege, + ApplicationPrivileges, + IndicesPrivileges, + GlobalPrivilege +} from '@security/_types/Privileges' +import { Indices, Metadata } from '@_types/common' +import { TransientMetadataConfig } from '@security/_types/TransientMetadataConfig' +// FIXME: should be merged with get_service_accounts/RoleDescriptor export class RoleDescriptor { cluster: string[] - index: IndexPrivileges[] + /** @aliases index */ + indices: IndicesPrivileges[] + global?: GlobalPrivilege[] | GlobalPrivilege applications?: ApplicationPrivileges[] + metadata?: Metadata + run_as?: string[] + transient_metadata?: TransientMetadataConfig } export class IndexPrivileges { names: Indices - privileges: string[] + privileges: IndexPrivilege[] } diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index 9bbea28b2f..e31849ba49 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -23,7 +23,7 @@ import { Name, Namespace, Service } from '@_types/common' /** * @rest_spec_name security.create_service_token * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts index 1e5bc67dff..78542d2084 100644 --- a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts +++ b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts @@ -23,14 +23,14 @@ import { Name, Refresh } from '@_types/common' /** * @rest_spec_name security.delete_privileges * @since 6.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { application: Name name: Name } - query_parameters?: { + query_parameters: { refresh?: Refresh } } diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index 08ec1e882e..2c3c65f4b3 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -23,13 +23,13 @@ import { Name, Refresh } from '@_types/common' /** * @rest_spec_name security.delete_role * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { name: Name } - query_parameters?: { + query_parameters: { refresh?: Refresh } } diff --git a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts index 96a4124d99..424c385b33 100644 --- a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts +++ b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts @@ -23,14 +23,13 @@ import { Name, Refresh } from '@_types/common' /** * @rest_spec_name security.delete_role_mapping * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: {} } diff --git a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts index 7b93ca32d9..668355fb5f 100644 --- a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts +++ b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts @@ -23,16 +23,15 @@ import { Name, Namespace, Refresh, Service } from '@_types/common' /** * @rest_spec_name security.delete_service_token * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { namespace: Namespace service: Service name: Name } - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: {} } diff --git a/specification/security/delete_user/SecurityDeleteUserRequest.ts b/specification/security/delete_user/SecurityDeleteUserRequest.ts index 8c0a8200d1..a5fbc97a0c 100644 --- a/specification/security/delete_user/SecurityDeleteUserRequest.ts +++ b/specification/security/delete_user/SecurityDeleteUserRequest.ts @@ -23,13 +23,13 @@ import { Refresh, Username } from '@_types/common' /** * @rest_spec_name security.delete_user * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { username: Username } - query_parameters?: { + query_parameters: { refresh?: Refresh } } diff --git a/specification/security/disable_user/SecurityDisableUserRequest.ts b/specification/security/disable_user/SecurityDisableUserRequest.ts index c6900e192c..2c5dae4e8d 100644 --- a/specification/security/disable_user/SecurityDisableUserRequest.ts +++ b/specification/security/disable_user/SecurityDisableUserRequest.ts @@ -23,13 +23,13 @@ import { Refresh, Username } from '@_types/common' /** * @rest_spec_name security.disable_user * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { username: Username } - query_parameters?: { + query_parameters: { refresh?: Refresh } } diff --git a/specification/security/enable_user/SecurityEnableUserRequest.ts b/specification/security/enable_user/SecurityEnableUserRequest.ts index 3c7c90a798..564401a7c3 100644 --- a/specification/security/enable_user/SecurityEnableUserRequest.ts +++ b/specification/security/enable_user/SecurityEnableUserRequest.ts @@ -23,13 +23,13 @@ import { Refresh, Username } from '@_types/common' /** * @rest_spec_name security.enable_user * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { username: Username } - query_parameters?: { + query_parameters: { refresh?: Refresh } } diff --git a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts index 3b3e3d41d7..69bc84e548 100644 --- a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts +++ b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts @@ -23,10 +23,10 @@ import { Id, Name, Username } from '@_types/common' /** * @rest_spec_name security.get_api_key * @since 6.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { id?: Id name?: Name owner?: boolean diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index f2adcda671..793e406401 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name security.get_builtin_privileges * @since 7.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts b/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts index c818dd8008..4d605a5157 100644 --- a/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts +++ b/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name security.get_privileges * @since 6.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { application?: Name name?: Name } diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 577059c122..60ac6ae854 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name security.get_role * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: Name } } diff --git a/specification/security/get_role/types.ts b/specification/security/get_role/types.ts index baf1cd204c..8239b94f5a 100644 --- a/specification/security/get_role/types.ts +++ b/specification/security/get_role/types.ts @@ -17,9 +17,12 @@ * under the License. */ -import { ApplicationPrivileges } from '@security/_types/ApplicationPrivileges' -import { IndicesPrivileges } from '@security/_types/IndicesPrivileges' +import { + IndicesPrivileges, + ApplicationPrivileges +} from '@security/_types/Privileges' import { Metadata } from '@_types/common' +import { RoleTemplate } from '@security/_types/RoleTemplate' export class Role { cluster: string[] @@ -34,36 +37,3 @@ export class Role { export class TransientMetadata { enabled: boolean } - -export enum TemplateFormat { - string = 0, - json = 1 -} - -export class InlineRoleTemplate { - template: InlineRoleTemplateSource - format?: TemplateFormat -} - -export class InlineRoleTemplateSource { - source: string -} - -export class StoredRoleTemplate { - template: StoredRoleTemplateId - format?: TemplateFormat -} - -export class StoredRoleTemplateId { - id: string -} - -export class InvalidRoleTemplate { - template: string - format?: TemplateFormat -} - -export type RoleTemplate = - | InlineRoleTemplate - | StoredRoleTemplate - | InvalidRoleTemplate diff --git a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts index d00448aab7..2025bcd7f1 100644 --- a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts +++ b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name security.get_role_mapping * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name?: Name } } diff --git a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts index 0a37f006ed..c4311fb070 100644 --- a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts +++ b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts @@ -23,10 +23,10 @@ import { Namespace, Service } from '@_types/common' /** * @rest_spec_name security.get_service_accounts * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { namespace?: Namespace service?: Service } diff --git a/specification/security/get_service_accounts/types.ts b/specification/security/get_service_accounts/types.ts index 812ad437fc..6152fa5d81 100644 --- a/specification/security/get_service_accounts/types.ts +++ b/specification/security/get_service_accounts/types.ts @@ -17,9 +17,11 @@ * under the License. */ -import { ApplicationPrivileges } from '@security/_types/ApplicationPrivileges' -import { GlobalPrivileges } from '@security/_types/GlobalPrivileges' -import { IndicesPrivileges } from '@security/_types/IndicesPrivileges' +import { + IndicesPrivileges, + GlobalPrivilege, + ApplicationPrivileges +} from '@security/_types/Privileges' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Metadata } from '@_types/common' @@ -30,8 +32,9 @@ export class RoleDescriptorWrapper { export class RoleDescriptor { cluster: string[] + /** @aliases index */ indices: IndicesPrivileges[] - global?: GlobalPrivileges[] + global?: GlobalPrivilege[] applications?: ApplicationPrivileges[] metadata?: Metadata run_as?: string[] diff --git a/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts b/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts index 16d5cd4256..c6223f8c89 100644 --- a/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts +++ b/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts @@ -23,7 +23,7 @@ import { Namespace, Service } from '@_types/common' /** * @rest_spec_name security.get_service_credentials * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_token/GetUserAccessTokenRequest.ts b/specification/security/get_token/GetUserAccessTokenRequest.ts index 4ce37f2276..2554058e5f 100644 --- a/specification/security/get_token/GetUserAccessTokenRequest.ts +++ b/specification/security/get_token/GetUserAccessTokenRequest.ts @@ -25,11 +25,10 @@ import { AccessTokenGrantType } from './types' /** * @rest_spec_name security.get_token * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { + body: { grant_type?: AccessTokenGrantType scope?: string password?: Password diff --git a/specification/security/get_token/GetUserAccessTokenResponse.ts b/specification/security/get_token/GetUserAccessTokenResponse.ts index f68eb3c8c8..3f848098e0 100644 --- a/specification/security/get_token/GetUserAccessTokenResponse.ts +++ b/specification/security/get_token/GetUserAccessTokenResponse.ts @@ -26,7 +26,7 @@ export class Response { expires_in: long scope?: string type: string - refresh_token: string + refresh_token?: string kerberos_authentication_response_token?: string authentication: AuthenticatedUser } diff --git a/specification/security/get_user/SecurityGetUserRequest.ts b/specification/security/get_user/SecurityGetUserRequest.ts index be10fc256f..c01331f06c 100644 --- a/specification/security/get_user/SecurityGetUserRequest.ts +++ b/specification/security/get_user/SecurityGetUserRequest.ts @@ -23,10 +23,10 @@ import { Username } from '@_types/common' /** * @rest_spec_name security.get_user * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { /** An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. */ username?: Username | Username[] } diff --git a/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts b/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts index c526ffa031..9401e301dc 100644 --- a/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts +++ b/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name security.get_user_privileges * @since 6.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { /** The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. */ application?: Name /** The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. */ diff --git a/specification/security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts b/specification/security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts index 188362a5f4..6d0b6cbebd 100644 --- a/specification/security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts +++ b/specification/security/get_user_privileges/SecurityGetUserPrivilegesResponse.ts @@ -17,16 +17,19 @@ * under the License. */ -import { ApplicationPrivileges } from '@security/_types/ApplicationPrivileges' -import { GlobalPrivileges } from '@security/_types/GlobalPrivileges' -import { IndicesPrivileges } from '@security/_types/IndicesPrivileges' +import { + IndicesPrivileges, + GlobalPrivilege, + ApplicationPrivileges, + UserIndicesPrivileges +} from '@security/_types/Privileges' export class Response { body: { applications: ApplicationPrivileges[] cluster: string[] - global: GlobalPrivileges[] - indices: IndicesPrivileges[] + global: GlobalPrivilege[] + indices: UserIndicesPrivileges[] run_as: string[] } } diff --git a/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts b/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts index afd47cc1d8..594340dbe3 100644 --- a/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts +++ b/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts @@ -24,10 +24,10 @@ import { ApiKey, ApiKeyGrantType } from './types' /** * @rest_spec_name security.grant_api_key * @since 7.9.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - body?: { + body: { api_key: ApiKey grant_type: ApiKeyGrantType access_token?: string diff --git a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts index 4362d460f7..d63960ab82 100644 --- a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts +++ b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts @@ -17,6 +17,7 @@ * under the License. */ +import { ClusterPrivilege } from '@security/_types/Privileges' import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' import { ApplicationPrivilegesCheck, IndexPrivilegesCheck } from './types' @@ -24,16 +25,15 @@ import { ApplicationPrivilegesCheck, IndexPrivilegesCheck } from './types' /** * @rest_spec_name security.has_privileges * @since 6.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { user?: Name } - query_parameters?: {} - body?: { + body: { application?: ApplicationPrivilegesCheck[] - cluster?: string[] + cluster?: ClusterPrivilege[] index?: IndexPrivilegesCheck[] } } diff --git a/specification/security/has_privileges/types.ts b/specification/security/has_privileges/types.ts index 59294411b2..9404f71d21 100644 --- a/specification/security/has_privileges/types.ts +++ b/specification/security/has_privileges/types.ts @@ -17,8 +17,9 @@ * under the License. */ +import { IndexPrivilege } from '@security/_types/Privileges' import { Dictionary } from '@spec_utils/Dictionary' -import { Name } from '@_types/common' +import { Indices, Name } from '@_types/common' export class ApplicationPrivilegesCheck { application: string @@ -27,8 +28,8 @@ export class ApplicationPrivilegesCheck { } export class IndexPrivilegesCheck { - names: string[] - privileges: string[] + names: Indices + privileges: IndexPrivilege[] } export type ApplicationsPrivileges = Dictionary diff --git a/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts b/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts index ac86640bbf..cf0eadd5e3 100644 --- a/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts +++ b/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts @@ -23,11 +23,10 @@ import { Id, Name, Username } from '@_types/common' /** * @rest_spec_name security.invalidate_api_key * @since 6.7.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { + body: { id?: Id ids?: Id[] name?: Name diff --git a/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts b/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts index d114dba0ff..b5957e751d 100644 --- a/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts +++ b/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts @@ -23,10 +23,10 @@ import { Name, Username } from '@_types/common' /** * @rest_spec_name security.invalidate_token * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - body?: { + body: { token?: string refresh_token?: string realm_name?: Name diff --git a/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts b/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts index 7942c7e319..a5ecf3a616 100644 --- a/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts +++ b/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts @@ -26,11 +26,12 @@ import { Actions } from './types' * @rest_spec_name security.put_privileges * @since 6.4.0 * - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { refresh?: Refresh } + /** @codegen_name privileges */ body?: Dictionary> } diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index 9e985dff6a..e8b14e5b56 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -18,8 +18,11 @@ */ import { TransientMetadata } from '@security/get_role/types' -import { ApplicationPrivileges } from '@security/_types/ApplicationPrivileges' -import { IndicesPrivileges } from '@security/_types/IndicesPrivileges' +import { + IndicesPrivileges, + ClusterPrivilege, + ApplicationPrivileges +} from '@security/_types/Privileges' import { Dictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { RequestBase } from '@_types/Base' @@ -28,22 +31,44 @@ import { Metadata, Name, Refresh } from '@_types/common' /** * @rest_spec_name security.put_role * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { name: Name } - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: { + body: { + /** + * A list of application privilege entries. + */ applications?: ApplicationPrivileges[] - cluster?: string[] + /** + * A list of cluster privileges. These privileges define the cluster-level actions for users with this role. + */ + cluster?: ClusterPrivilege[] + /** + * An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. + */ global?: Dictionary + /** + * A list of indices permissions entries. + */ indices?: IndicesPrivileges[] + /** + * Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use. + */ metadata?: Metadata + /** + * A list of users that the owners of this role can impersonate. + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html + */ run_as?: string[] + /** + * Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API. + */ transient_metadata?: TransientMetadata } } diff --git a/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts b/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts index 17c37389bd..d0121ac8d7 100644 --- a/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts +++ b/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts @@ -17,27 +17,29 @@ * under the License. */ -import { RoleMappingRuleBase } from '@security/_types/RoleMappingRuleBase' +import { RoleMappingRule } from '@security/_types/RoleMappingRule' import { RequestBase } from '@_types/Base' import { Metadata, Name, Refresh } from '@_types/common' +import { RoleTemplate } from '@security/_types/RoleTemplate' /** * @rest_spec_name security.put_role_mapping * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { name: Name } - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: { + body: { enabled?: boolean metadata?: Metadata roles?: string[] - rules?: RoleMappingRuleBase + role_templates?: RoleTemplate[] + rules?: RoleMappingRule run_as?: string[] } } diff --git a/specification/security/put_user/SecurityPutUserRequest.ts b/specification/security/put_user/SecurityPutUserRequest.ts index 90b228398e..82de511792 100644 --- a/specification/security/put_user/SecurityPutUserRequest.ts +++ b/specification/security/put_user/SecurityPutUserRequest.ts @@ -23,16 +23,16 @@ import { Metadata, Password, Refresh, Username } from '@_types/common' /** * @rest_spec_name security.put_user * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { username: Username } - query_parameters?: { + query_parameters: { refresh?: Refresh } - body?: { + body: { username?: Username email?: string | null full_name?: string | null diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index dccc1c6ef8..a287f3481b 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -18,14 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { NodeId } from '@_types/common' /** * @rest_spec_name shutdown.delete_node * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - body: { - stub: string + path_parts: { + node_id: NodeId } } diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeResponse.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeResponse.ts index be8dc1fd43..0059ab53e4 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeResponse.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeResponse.ts @@ -17,6 +17,6 @@ * under the License. */ -export class Response { - body: { stub: boolean } -} +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index ecf451dd1c..456a98b527 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -18,14 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { NodeIds } from '@_types/common' /** * @rest_spec_name shutdown.get_node * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - body: { - stub: string + path_parts: { + node_id?: NodeIds } } diff --git a/specification/shutdown/get_node/ShutdownGetNodeResponse.ts b/specification/shutdown/get_node/ShutdownGetNodeResponse.ts index be8dc1fd43..e91481d929 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeResponse.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeResponse.ts @@ -17,6 +17,46 @@ * under the License. */ +import { NodeId } from '@_types/common' +import { EpochMillis, Timestamp } from '@_types/Time' + export class Response { - body: { stub: boolean } + body: { + nodes: NodeShutdownStatus[] + } +} + +export class NodeShutdownStatus { + node_id: NodeId + type: ShutdownType + reason: string + shutdown_startedmillis: EpochMillis + status: ShutdownStatus + shard_migration: ShardMigrationStatus + persistent_tasks: PersistentTaskStatus + plugins: PluginsStatus +} + +export enum ShutdownType { + remove, + restart +} + +export enum ShutdownStatus { + not_started, + in_progress, + stalled, + complete +} + +export class ShardMigrationStatus { + status: ShutdownStatus +} + +export class PersistentTaskStatus { + status: ShutdownStatus +} + +export class PluginsStatus { + status: ShutdownStatus } diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index d4f593eed3..8f03aba020 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -18,14 +18,15 @@ */ import { RequestBase } from '@_types/Base' +import { NodeId } from '@_types/common' /** * @rest_spec_name shutdown.put_node * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - body: { - stub: string + path_parts: { + node_id: NodeId } } diff --git a/specification/shutdown/put_node/ShutdownPutNodeResponse.ts b/specification/shutdown/put_node/ShutdownPutNodeResponse.ts index be8dc1fd43..0059ab53e4 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeResponse.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeResponse.ts @@ -17,6 +17,6 @@ * under the License. */ -export class Response { - body: { stub: boolean } -} +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response extends AcknowledgedResponseBase {} diff --git a/specification/slm/_types/SnapshotLifecycle.ts b/specification/slm/_types/SnapshotLifecycle.ts index 23661d0998..f6cd3ff099 100644 --- a/specification/slm/_types/SnapshotLifecycle.ts +++ b/specification/slm/_types/SnapshotLifecycle.ts @@ -18,7 +18,14 @@ */ import { CronExpression } from '@watcher/_types/Schedule' -import { Id, Indices, Name, Uuid, VersionNumber } from '@_types/common' +import { + Id, + Indices, + Metadata, + Name, + Uuid, + VersionNumber +} from '@_types/common' import { integer, long } from '@_types/Numeric' import { DateString, EpochMillis, Time } from '@_types/Time' @@ -61,23 +68,58 @@ export class Statistics { } export class Policy { - config: Configuration + config?: Configuration name: Name repository: string - retention: Retention + retention?: Retention schedule: CronExpression } export class Retention { + /** + * Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. + */ expire_after: Time + /** + * Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. + */ max_count: integer + /** + * Minimum number of snapshots to retain, even if the snapshots have expired. + */ min_count: integer } export class Configuration { + /** + * If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. + * @server_default false + */ ignore_unavailable?: boolean + /** + * A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. + * By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. + */ + indices?: Indices + /** + * If true, the current global state is included in the snapshot. + * @server_default true + */ include_global_state?: boolean - indices: Indices + /** + * A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. + * Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. + */ + feature_states?: string[] + /** + * Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. + */ + metadata?: Metadata + /** + * If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. + * @server_default false + */ + partial?: boolean } export class InProgress { diff --git a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts index 4ce618042b..239f0f4e55 100644 --- a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts +++ b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name slm.delete_lifecycle * @since 7.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { policy_id: Name } } diff --git a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts index 8b20ce6a2b..eb846dec6f 100644 --- a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts +++ b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts @@ -23,10 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name slm.execute_lifecycle * @since 7.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { policy_id: Name } } diff --git a/specification/slm/execute_retention/ExecuteRetentionRequest.ts b/specification/slm/execute_retention/ExecuteRetentionRequest.ts index 3755910f74..e1d1a20d15 100644 --- a/specification/slm/execute_retention/ExecuteRetentionRequest.ts +++ b/specification/slm/execute_retention/ExecuteRetentionRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.execute_retention * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts index 0c3fc52e57..d5a34d9eac 100644 --- a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts +++ b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts @@ -23,10 +23,10 @@ import { Names } from '@_types/common' /** * @rest_spec_name slm.get_lifecycle * @since 7.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { policy_id?: Names } } diff --git a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts index 43715f3093..aad98e5267 100644 --- a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts +++ b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.get_stats * @since 7.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts index 7639e64c0d..ac115ed534 100644 --- a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts +++ b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.get_status * @since 7.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts index 5ead6a10e8..0123ccf54a 100644 --- a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts +++ b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts @@ -21,21 +21,52 @@ import { Configuration, Retention } from '@slm/_types/SnapshotLifecycle' import { CronExpression } from '@watcher/_types/Schedule' import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' +import { Time } from '@_types/Time' /** * @rest_spec_name slm.put_lifecycle * @since 7.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * ID for the snapshot lifecycle policy you want to create or update. + */ policy_id: Name } - body?: { + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Time + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time + } + body: { + /** + * Configuration for each snapshot created by the policy. + */ config?: Configuration + /** + * Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. + */ name?: Name + /** + * Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. + */ repository?: string + /** + * Retention rules used to retain and delete snapshots created by the policy. + */ retention?: Retention + /** + * Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. + */ schedule?: CronExpression } } diff --git a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts index 2fb66a3035..130caeede4 100644 --- a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.start * @since 7.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts index 735a2d5436..37a49c17ab 100644 --- a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts @@ -22,6 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name slm.stop * @since 7.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase {} diff --git a/specification/snapshot/_types/SnapshotInfo.ts b/specification/snapshot/_types/SnapshotInfo.ts index 3fe8bd9528..c728991f7f 100644 --- a/specification/snapshot/_types/SnapshotInfo.ts +++ b/specification/snapshot/_types/SnapshotInfo.ts @@ -45,6 +45,8 @@ export class SnapshotInfo { index_details?: Dictionary metadata?: Metadata reason?: string + /** @since 7.14.0 */ + repository?: Name snapshot: Name shards?: ShardStatistics start_time?: Time @@ -55,3 +57,16 @@ export class SnapshotInfo { version_id?: VersionNumber feature_states?: InfoFeatureState[] } + +export enum SnapshotSort { + start_time, + duration, + name, + index_count, + /** @since 7.16.0 */ + repository, + /** @since 7.16.0 */ + shard_count, + /** @since 7.16.0 */ + failed_shard_count +} diff --git a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts index 09e23c1dbe..29bee6bb61 100644 --- a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts +++ b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts @@ -22,17 +22,28 @@ import { Name } from '@_types/common' import { Time } from '@_types/Time' /** + * Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. * @rest_spec_name snapshot.cleanup_repository * @since 7.4.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Snapshot repository to clean up. + * @codegen_name name */ repository: Name } - query_parameters?: { + query_parameters: { + /** + * Period to wait for a connection to the master node. + * @server_default 30s + */ master_timeout?: Time + /** + * Period to wait for a response. + * @server_default 30s + */ timeout?: Time } - body?: {} } diff --git a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts index 198b50771f..5e215730a7 100644 --- a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts +++ b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts @@ -20,10 +20,15 @@ import { long } from '@_types/Numeric' export class Response { - body: { results: CleanupRepositoryResults } + body: { + /** Statistics for cleanup operations. */ + results: CleanupRepositoryResults + } } export class CleanupRepositoryResults { + /** Number of binary large objects (blobs) removed during cleanup. */ deleted_blobs: long + /** Number of bytes freed by cleanup operations. */ deleted_bytes: long } diff --git a/specification/snapshot/clone/SnapshotCloneRequest.ts b/specification/snapshot/clone/SnapshotCloneRequest.ts index 0891c9fa19..bd5fe5e56e 100644 --- a/specification/snapshot/clone/SnapshotCloneRequest.ts +++ b/specification/snapshot/clone/SnapshotCloneRequest.ts @@ -24,19 +24,19 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.clone * @since 7.10.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { repository: Name snapshot: Name target_snapshot: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: { + body: { indices: string } } diff --git a/specification/snapshot/create/SnapshotCreateRequest.ts b/specification/snapshot/create/SnapshotCreateRequest.ts index ca2a6378af..fc2f3ec558 100644 --- a/specification/snapshot/create/SnapshotCreateRequest.ts +++ b/specification/snapshot/create/SnapshotCreateRequest.ts @@ -24,22 +24,58 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.create * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Repository for the snapshot. + */ repository: Name + /** + * Name of the snapshot. Must be unique in the repository. + */ snapshot: Name } - query_parameters?: { + query_parameters: { + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ master_timeout?: Time + /** + * If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + * @server_default false + */ wait_for_completion?: boolean } - body?: { + body: { + /** + * If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + * @server_default false + */ ignore_unavailable?: boolean + /** + * If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + * @server_default true + */ include_global_state?: boolean + /** + * Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default. + */ indices?: Indices + /** + * Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + */ + feature_states?: string[] + /** + * Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch. + */ metadata?: Metadata + /** + * If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + * @server_default false + */ partial?: boolean } } diff --git a/specification/snapshot/create/SnapshotCreateResponse.ts b/specification/snapshot/create/SnapshotCreateResponse.ts index 236ec20c93..ddc3395ed7 100644 --- a/specification/snapshot/create/SnapshotCreateResponse.ts +++ b/specification/snapshot/create/SnapshotCreateResponse.ts @@ -20,5 +20,15 @@ import { SnapshotInfo } from '@snapshot/_types/SnapshotInfo' export class Response { - body: { accepted?: boolean; snapshot?: SnapshotInfo } + body: { + /** + * Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false` + * @since 7.15.0 + */ + accepted?: boolean + /** + * Snapshot information. Present when the request had `wait_for_completion` set to `true` + */ + snapshot?: SnapshotInfo + } } diff --git a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts index 9731979976..3687e13810 100644 --- a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts +++ b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts @@ -29,18 +29,19 @@ import { Time } from '@_types/Time' * @rest_spec_name snapshot.create_repository * @since 0.0.0 * - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** @codegen_name name */ repository: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time verify?: boolean } - body?: { + body: { repository?: Repository type: string settings: RepositorySettings diff --git a/specification/snapshot/delete/SnapshotDeleteRequest.ts b/specification/snapshot/delete/SnapshotDeleteRequest.ts index 972b5ee75e..cf506a538d 100644 --- a/specification/snapshot/delete/SnapshotDeleteRequest.ts +++ b/specification/snapshot/delete/SnapshotDeleteRequest.ts @@ -24,15 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.delete * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { repository: Name snapshot: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time } - body?: {} } diff --git a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts index efa866f891..9fa6287167 100644 --- a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts +++ b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts @@ -24,13 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.delete_repository * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** @codegen_name name */ repository: Names } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } diff --git a/specification/snapshot/get/SnapshotGetRequest.ts b/specification/snapshot/get/SnapshotGetRequest.ts index b235576d94..7b8a550b86 100644 --- a/specification/snapshot/get/SnapshotGetRequest.ts +++ b/specification/snapshot/get/SnapshotGetRequest.ts @@ -20,23 +20,90 @@ import { RequestBase } from '@_types/Base' import { Name, Names } from '@_types/common' import { Time } from '@_types/Time' +import { SnapshotSort } from '@snapshot/_types/SnapshotInfo' +import { integer } from '@_types/Numeric' +import { SortOrder } from '@_types/sort' /** * @rest_spec_name snapshot.get * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { + /** + * Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. + */ repository: Name + /** + * Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*). + * - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. + * - To get information about any snapshots that are currently running, use _current. + */ snapshot: Names } - query_parameters?: { + query_parameters: { + /** + * If false, the request returns an error for any snapshots that are unavailable. + * @server_default false + */ ignore_unavailable?: boolean + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ master_timeout?: Time + /** + * If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + * @server_default true + */ verbose?: boolean - /** @since 7.13.0 */ + /** + * If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted. + * @since 7.13.0 + * @server_default false + */ index_details?: boolean human?: boolean + include_repository?: boolean + /** + * Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp. + * @since 7.14.0 + * @server_default start_time + */ + sort?: SnapshotSort + /** + * Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit. + * @since 7.14.0 + * @server_default 0 + */ + size?: integer + /** + * Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order. + * @since 7.14.0 + * @server_default asc + */ + order?: SortOrder + /** + * Offset identifier to start pagination from as returned by the next field in the response body. + * @since 7.14.0 + */ + after?: string + /** + * Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + * @since 7.15.0 + * @server_default 0 + */ + offset?: integer + /** + * Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count. + * @since 7.16.0 + */ + from_sort_value?: string + /** + * Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy. + * @since 7.16.0 + */ + slm_policy_filter?: Name } } diff --git a/specification/snapshot/get/SnapshotGetResponse.ts b/specification/snapshot/get/SnapshotGetResponse.ts index d817eab4a6..e389430266 100644 --- a/specification/snapshot/get/SnapshotGetResponse.ts +++ b/specification/snapshot/get/SnapshotGetResponse.ts @@ -20,11 +20,22 @@ import { SnapshotInfo } from '@snapshot/_types/SnapshotInfo' import { Name } from '@_types/common' import { ErrorCause } from '@_types/Errors' +import { integer } from '@_types/Numeric' export class Response { body: { responses?: SnapshotResponseItem[] snapshots?: SnapshotInfo[] + /** + * The total number of snapshots that match the request when ignoring size limit or after query parameter. + * @since 7.15.0 + */ + total: integer + /** + * The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. + * @since 7.15.0 + */ + remaining: integer } } diff --git a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts index 2a328a80fb..055ca91fa0 100644 --- a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts +++ b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts @@ -24,15 +24,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.get_repository * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** @codegen_name name */ repository?: Names } - query_parameters?: { + query_parameters: { local?: boolean master_timeout?: Time } - body?: {} } diff --git a/specification/snapshot/restore/SnapshotRestoreRequest.ts b/specification/snapshot/restore/SnapshotRestoreRequest.ts index e0f038888e..242ea513f2 100644 --- a/specification/snapshot/restore/SnapshotRestoreRequest.ts +++ b/specification/snapshot/restore/SnapshotRestoreRequest.ts @@ -25,18 +25,19 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.restore * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { repository: Name snapshot: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time wait_for_completion?: boolean } - body?: { + body: { + feature_states?: string[] ignore_index_settings?: string[] ignore_unavailable?: boolean include_aliases?: boolean diff --git a/specification/snapshot/status/SnapshotStatusRequest.ts b/specification/snapshot/status/SnapshotStatusRequest.ts index 19d6a13d68..d8c4cf3101 100644 --- a/specification/snapshot/status/SnapshotStatusRequest.ts +++ b/specification/snapshot/status/SnapshotStatusRequest.ts @@ -24,16 +24,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.status * @since 7.8.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { repository?: Name snapshot?: Names } - query_parameters?: { + query_parameters: { ignore_unavailable?: boolean // default: false master_timeout?: Time } - body?: {} } diff --git a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts index fd792e2ac9..ac3b5aaa77 100644 --- a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts +++ b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts @@ -24,15 +24,15 @@ import { Time } from '@_types/Time' /** * @rest_spec_name snapshot.verify_repository * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** @codegen_name name */ repository: Name } - query_parameters?: { + query_parameters: { master_timeout?: Time timeout?: Time } - body?: {} } diff --git a/specification/sql/clear_cursor/ClearSqlCursorRequest.ts b/specification/sql/clear_cursor/ClearSqlCursorRequest.ts index 5c33606d28..3c7e652549 100644 --- a/specification/sql/clear_cursor/ClearSqlCursorRequest.ts +++ b/specification/sql/clear_cursor/ClearSqlCursorRequest.ts @@ -22,7 +22,7 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name sql.clear_cursor * @since 6.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { body: { diff --git a/specification/sql/query/QuerySqlRequest.ts b/specification/sql/query/QuerySqlRequest.ts index c82df62408..6e322076ee 100644 --- a/specification/sql/query/QuerySqlRequest.ts +++ b/specification/sql/query/QuerySqlRequest.ts @@ -17,7 +17,10 @@ * under the License. */ +import { Dictionary } from '@spec_utils/Dictionary' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { RequestBase } from '@_types/Base' +import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { integer } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' import { Time } from '@_types/Time' @@ -25,16 +28,20 @@ import { Time } from '@_types/Time' /** * @rest_spec_name sql.query * @since 6.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { /** * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html#sql-rest-format */ format?: string } - body?: { + body: { + /** + * Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. + */ + catalog?: string columnar?: boolean cursor?: string /** @@ -72,5 +79,33 @@ export interface Request extends RequestBase { * @server_default false */ field_multi_value_leniency?: boolean + /** + * Defines one or more runtime fields in the search request. These fields take + * precedence over mapped fields with the same name. + */ + runtime_mappings?: RuntimeFields + /** + * Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async. + */ + wait_for_completion_timeout?: Time + /** + * Values for parameters in the query. + */ + params?: Dictionary + /** + * Retention period for an async or saved synchronous search. + * @server_default 5d + */ + keep_alive?: Time + /** + * If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout. + * @server_default false + */ + keep_on_completion?: boolean + /** + * If true, the search can run on frozen indices. Defaults to false. + * @server_default false + */ + index_using_frozen?: boolean } } diff --git a/specification/sql/translate/TranslateSqlRequest.ts b/specification/sql/translate/TranslateSqlRequest.ts index f69e14334f..4b46918c32 100644 --- a/specification/sql/translate/TranslateSqlRequest.ts +++ b/specification/sql/translate/TranslateSqlRequest.ts @@ -24,11 +24,10 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' /** * @rest_spec_name sql.translate * @since 6.3.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: {} - body?: { + body: { fetch_size?: integer filter?: QueryContainer query: string diff --git a/specification/sql/translate/TranslateSqlResponse.ts b/specification/sql/translate/TranslateSqlResponse.ts index b0c5223340..24f376c555 100644 --- a/specification/sql/translate/TranslateSqlResponse.ts +++ b/specification/sql/translate/TranslateSqlResponse.ts @@ -17,17 +17,22 @@ * under the License. */ -import { Sort } from '@global/search/_types/sort' -import { SourceFilter } from '@global/search/_types/SourceFilter' +import { Sort } from '@_types/sort' +import { SourceConfig } from '@global/search/_types/SourceFilter' import { Dictionary } from '@spec_utils/Dictionary' import { Field, Fields } from '@_types/common' import { long } from '@_types/Numeric' +import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions' +import { AggregationContainer } from '@_types/aggregations/AggregationContainer' export class Response { + // This is a subset of SearchRequest's body (same data structure in the ES code) body: { - size: long - _source: boolean | Fields | SourceFilter - fields: Array> - sort: Sort + aggregations?: Dictionary + size?: long + _source?: SourceConfig + fields?: Array + query?: QueryContainer + sort?: Sort } } diff --git a/specification/ssl/get_certificates/GetCertificatesRequest.ts b/specification/ssl/certificates/GetCertificatesRequest.ts similarity index 89% rename from specification/ssl/get_certificates/GetCertificatesRequest.ts rename to specification/ssl/certificates/GetCertificatesRequest.ts index b95a1d4f27..0a5ddb9eb7 100644 --- a/specification/ssl/get_certificates/GetCertificatesRequest.ts +++ b/specification/ssl/certificates/GetCertificatesRequest.ts @@ -22,9 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name ssl.certificates * @since 6.2.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends RequestBase {} diff --git a/specification/ssl/get_certificates/GetCertificatesResponse.ts b/specification/ssl/certificates/GetCertificatesResponse.ts similarity index 100% rename from specification/ssl/get_certificates/GetCertificatesResponse.ts rename to specification/ssl/certificates/GetCertificatesResponse.ts diff --git a/specification/ssl/get_certificates/types.ts b/specification/ssl/certificates/types.ts similarity index 96% rename from specification/ssl/get_certificates/types.ts rename to specification/ssl/certificates/types.ts index bfd825a250..40458d47ac 100644 --- a/specification/ssl/get_certificates/types.ts +++ b/specification/ssl/certificates/types.ts @@ -20,10 +20,11 @@ import { DateString } from '@_types/Time' export class CertificateInformation { - alias?: string + alias: string | null expiry: DateString format: string has_private_key: boolean + issuer?: string path: string serial_number: string subject_dn: string diff --git a/specification/task/_types/TaskStatus.ts b/specification/task/_types/TaskStatus.ts deleted file mode 100644 index 7cfb072bc3..0000000000 --- a/specification/task/_types/TaskStatus.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { float, long } from '@_types/Numeric' -import { Retries } from '@_types/Retries' -import { Time } from '@_types/Time' - -export class Status { - batches: long - canceled?: string - created: long - deleted: long - noops: long - failures?: string[] - requests_per_second: float - retries: Retries - throttled?: Time - throttled_millis: long - throttled_until?: Time - throttled_until_millis: long - timed_out?: boolean - took?: long - total: long - updated: long - version_conflicts: long -} diff --git a/specification/tasks/_types/GroupBy.ts b/specification/tasks/_types/GroupBy.ts new file mode 100644 index 0000000000..c05ce54ee3 --- /dev/null +++ b/specification/tasks/_types/GroupBy.ts @@ -0,0 +1,24 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export enum GroupBy { + nodes = 0, + parents = 1, + none = 2 +} diff --git a/specification/task/_types/TaskExecutingNode.ts b/specification/tasks/_types/TaskExecutingNode.ts similarity index 100% rename from specification/task/_types/TaskExecutingNode.ts rename to specification/tasks/_types/TaskExecutingNode.ts diff --git a/specification/task/_types/TaskInfo.ts b/specification/tasks/_types/TaskInfo.ts similarity index 87% rename from specification/task/_types/TaskInfo.ts rename to specification/tasks/_types/TaskInfo.ts index e3cfeebf38..20013cefdb 100644 --- a/specification/task/_types/TaskInfo.ts +++ b/specification/tasks/_types/TaskInfo.ts @@ -17,12 +17,14 @@ * under the License. */ -import { Status } from '@task/_types/TaskStatus' +import { Status } from '@tasks/_types/TaskStatus' import { HttpHeaders, Id } from '@_types/common' import { long } from '@_types/Numeric' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Info { action: string + cancelled?: boolean cancellable: boolean children?: Info[] description?: string @@ -31,7 +33,7 @@ export class Info { node: string running_time_in_nanos: long start_time_in_millis: long - status?: Status + status?: UserDefinedValue type: string parent_task_id?: Id } diff --git a/specification/task/_types/TaskState.ts b/specification/tasks/_types/TaskState.ts similarity index 92% rename from specification/task/_types/TaskState.ts rename to specification/tasks/_types/TaskState.ts index 196f76562f..363d3b2518 100644 --- a/specification/task/_types/TaskState.ts +++ b/specification/tasks/_types/TaskState.ts @@ -19,7 +19,7 @@ import { HttpHeaders, TaskId } from '@_types/common' import { long } from '@_types/Numeric' -import { Status } from './TaskStatus' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class State { action: string @@ -31,6 +31,6 @@ export class State { parent_task_id?: TaskId running_time_in_nanos: long start_time_in_millis: long - status?: Status + status?: UserDefinedValue type: string } diff --git a/specification/task/cancel/CancelTasksRequest.ts b/specification/tasks/cancel/CancelTasksRequest.ts similarity index 94% rename from specification/task/cancel/CancelTasksRequest.ts rename to specification/tasks/cancel/CancelTasksRequest.ts index 8c254462b4..a7ea3e561b 100644 --- a/specification/task/cancel/CancelTasksRequest.ts +++ b/specification/tasks/cancel/CancelTasksRequest.ts @@ -23,17 +23,16 @@ import { TaskId } from '@_types/common' /** * @rest_spec_name tasks.cancel * @since 2.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { task_id?: TaskId } - query_parameters?: { + query_parameters: { actions?: string | string[] nodes?: string[] parent_task_id?: string wait_for_completion?: boolean } - body?: {} } diff --git a/specification/task/cancel/CancelTasksResponse.ts b/specification/tasks/cancel/CancelTasksResponse.ts similarity index 93% rename from specification/task/cancel/CancelTasksResponse.ts rename to specification/tasks/cancel/CancelTasksResponse.ts index 8240aa4072..b361e7801b 100644 --- a/specification/task/cancel/CancelTasksResponse.ts +++ b/specification/tasks/cancel/CancelTasksResponse.ts @@ -18,7 +18,7 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { TaskExecutingNode } from '@task/_types/TaskExecutingNode' +import { TaskExecutingNode } from '@tasks/_types/TaskExecutingNode' import { ErrorCause } from '@_types/Errors' export class Response { diff --git a/specification/task/get/GetTaskRequest.ts b/specification/tasks/get/GetTaskRequest.ts similarity index 93% rename from specification/task/get/GetTaskRequest.ts rename to specification/tasks/get/GetTaskRequest.ts index f259509092..189af16d9d 100644 --- a/specification/task/get/GetTaskRequest.ts +++ b/specification/tasks/get/GetTaskRequest.ts @@ -24,15 +24,14 @@ import { Time } from '@_types/Time' /** * @rest_spec_name tasks.get * @since 5.0.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { task_id: Id } - query_parameters?: { + query_parameters: { timeout?: Time wait_for_completion?: boolean } - body?: {} } diff --git a/specification/task/get/GetTaskResponse.ts b/specification/tasks/get/GetTaskResponse.ts similarity index 91% rename from specification/task/get/GetTaskResponse.ts rename to specification/tasks/get/GetTaskResponse.ts index 2bcfca9067..804d8dc2e4 100644 --- a/specification/task/get/GetTaskResponse.ts +++ b/specification/tasks/get/GetTaskResponse.ts @@ -17,15 +17,15 @@ * under the License. */ -import { Status } from '@task/_types/TaskStatus' import { ErrorCause } from '@_types/Errors' import { Info } from '../_types/TaskInfo' +import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { body: { completed: boolean task: Info - response?: Status + response?: UserDefinedValue error?: ErrorCause } } diff --git a/specification/task/list/ListTasksRequest.ts b/specification/tasks/list/ListTasksRequest.ts similarity index 89% rename from specification/task/list/ListTasksRequest.ts rename to specification/tasks/list/ListTasksRequest.ts index 981f33fb64..488e3ad0ef 100644 --- a/specification/task/list/ListTasksRequest.ts +++ b/specification/tasks/list/ListTasksRequest.ts @@ -18,16 +18,17 @@ */ import { RequestBase } from '@_types/Base' -import { GroupBy, Id } from '@_types/common' +import { Id } from '@_types/common' import { Time } from '@_types/Time' +import { GroupBy } from '@tasks/_types/GroupBy' /** * @rest_spec_name tasks.list * @since 2.3.0 - * @stability TODO + * @stability experimental */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { actions?: string | string[] detailed?: boolean group_by?: GroupBy @@ -36,5 +37,4 @@ export interface Request extends RequestBase { timeout?: Time wait_for_completion?: boolean } - body?: {} } diff --git a/specification/task/list/ListTasksResponse.ts b/specification/tasks/list/ListTasksResponse.ts similarity index 91% rename from specification/task/list/ListTasksResponse.ts rename to specification/tasks/list/ListTasksResponse.ts index dad6f22609..a1e773982e 100644 --- a/specification/task/list/ListTasksResponse.ts +++ b/specification/tasks/list/ListTasksResponse.ts @@ -18,7 +18,7 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { Info } from '@task/_types/TaskInfo' +import { Info } from '@tasks/_types/TaskInfo' import { ErrorCause } from '@_types/Errors' import { TaskExecutingNode } from '../_types/TaskExecutingNode' @@ -26,6 +26,6 @@ export class Response { body: { node_failures?: ErrorCause[] nodes?: Dictionary - tasks?: Dictionary | Array + tasks?: Dictionary } } diff --git a/specification/text_structure/find_structure/FindStructureRequest.ts b/specification/text_structure/find_structure/FindStructureRequest.ts index 3086325777..84c9c807aa 100644 --- a/specification/text_structure/find_structure/FindStructureRequest.ts +++ b/specification/text_structure/find_structure/FindStructureRequest.ts @@ -24,10 +24,10 @@ import { Time } from '@_types/Time' /** * @rest_spec_name text_structure.find_structure * @since 7.13.0 - * @stability TODO + * @stability stable */ export interface Request { - query_parameters?: { + query_parameters: { /** The text’s character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, UTF-8, UTF-16LE, windows-1252, or EUC-JP. If this parameter is not specified, the structure finder chooses an appropriate character set. */ charset?: string /** If you have set format to delimited, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", etc. */ @@ -68,5 +68,6 @@ export interface Request { /** The Java time format of the timestamp field in the text. */ timestamp_format?: string } + /** @codegen_name text_files */ body: Array } diff --git a/specification/transform/_types/Transform.ts b/specification/transform/_types/Transform.ts index 76dd439337..55a773111b 100644 --- a/specification/transform/_types/Transform.ts +++ b/specification/transform/_types/Transform.ts @@ -32,11 +32,14 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Time } from '@_types/Time' export class Destination { - /** The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform. */ + /** + * The destination index for the transform. The mappings of the destination index are deduced based on the source + * fields when possible. If alternate mappings are required, use the create index API prior to starting the + * transform. + */ index?: IndexName /** * The unique identifier for an ingest pipeline. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html */ pipeline?: string } @@ -49,10 +52,19 @@ export class Latest { } export class Pivot { - /** @aliases aggs */ + /** + * Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket + * script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, + * min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted + * average. + * @aliases aggs + */ aggregations?: Dictionary - group_by: Dictionary - max_page_search_size?: integer + /** + * Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are + * currently supported: date histogram, geotile grid, histogram, terms. + */ + group_by?: Dictionary } /** @@ -70,13 +82,16 @@ export class PivotGroupByContainer { */ export class RetentionPolicyContainer { /** Specifies that the transform uses a time field to set the retention policy. */ - time: RetentionPolicy + time?: RetentionPolicy } export class RetentionPolicy { /** The date field that is used to calculate the age of the document. */ field: Field - /** Specifies the maximum age of a document in the destination index. Documents that are older than the configured value are removed from the destination index. */ + /** + * Specifies the maximum age of a document in the destination index. Documents that are older than the configured + * value are removed from the destination index. + */ max_age: Time } @@ -85,31 +100,48 @@ export class RetentionPolicy { */ export class Settings { /** - * Defines if dates in the ouput should be written as ISO formatted string (default) or as millis since epoch. epoch_millis has been the default for transforms created before version 7.11. For compatible output set this to true. + * Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align + * checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the + * transform config. As a result, less document updates in the destination index will be performed thus improving + * overall performance. + * @server_default true + */ + align_checkpoints?: boolean + /** + * Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was + * the default for transforms created before version 7.11. For compatible output set this value to `true`. * @server_default false */ dates_as_epoch_millis?: boolean /** - * Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling. + * Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a + * wait time between search requests. The default value is null, which disables throttling. */ docs_per_second?: float /** - * Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 10,000. + * Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker + * exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the + * maximum is `65,536`. * @server_default 500 */ max_page_search_size?: integer } export class Source { - /**The source indices for the transform. */ + /** + * The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an + * array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for + * example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If + * any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. + */ index: Indices /** * A query clause that retrieves a subset of data from the source index. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html */ query?: QueryContainer /** - * Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data nodes, including remote nodes, must be 7.12 or later. + * Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data + * nodes, including remote nodes, must be 7.12 or later. * @since 7.12.0 */ runtime_mappings?: RuntimeFields @@ -122,12 +154,19 @@ export class Sync {} */ export class SyncContainer { /** Specifies that the transform uses a time field to synchronize the source and destination indices. */ - time: TimeSync + time?: TimeSync } export class TimeSync { - /** The time delay between the current time and the latest input data time. */ + /** + * The time delay between the current time and the latest input data time. + * @server_default 60s + */ delay?: Time - /** The date field that is used to identify new documents in the source. */ + /** + * The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field + * that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it + * accounts for data transmission delays. + */ field: Field } diff --git a/specification/transform/delete_transform/DeleteTransformRequest.ts b/specification/transform/delete_transform/DeleteTransformRequest.ts index 9234bc58e8..fa4d2da388 100644 --- a/specification/transform/delete_transform/DeleteTransformRequest.ts +++ b/specification/transform/delete_transform/DeleteTransformRequest.ts @@ -18,18 +18,34 @@ */ import { RequestBase } from '@_types/Base' -import { Name } from '@_types/common' +import { Id } from '@_types/common' +import { Time } from '@_types/Time' /** + * Deletes a transform. * @rest_spec_name transform.delete_transform * @since 7.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_transform */ export interface Request extends RequestBase { - path_parts?: { - transform_id: Name + path_parts: { + /** + * Identifier for the transform. + */ + transform_id: Id } - query_parameters?: { + query_parameters: { + /** + * If this value is false, the transform must be stopped before it can be deleted. If true, the transform is + * deleted regardless of its current state. + * @server_default false + */ force?: boolean + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time } } diff --git a/specification/transform/get_transform/GetTransformRequest.ts b/specification/transform/get_transform/GetTransformRequest.ts index f593b6e431..be247ded26 100644 --- a/specification/transform/get_transform/GetTransformRequest.ts +++ b/specification/transform/get_transform/GetTransformRequest.ts @@ -18,22 +18,55 @@ */ import { RequestBase } from '@_types/Base' -import { Name } from '@_types/common' +import { Name, Names } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves configuration information for transforms. * @rest_spec_name transform.get_transform * @since 7.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_transform */ export interface Request extends RequestBase { - path_parts?: { - transform_id?: Name + path_parts: { + /** + * Identifier for the transform. It can be a transform identifier or a + * wildcard expression. You can get information for all transforms by using + * `_all`, by specifying `*` as the ``, or by omitting the + * ``. + */ + transform_id?: Names } - query_parameters?: { + query_parameters: { + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no transforms that match. + * 2. Contains the _all string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * If this parameter is false, the request returns a 404 status code when + * there are no matches or only partial matches. + * @server_default true + */ allow_no_match?: boolean + /** + * Skips the specified number of transforms. + * @server_default 0 + */ from?: integer + /** + * Specifies the maximum number of transforms to obtain. + * @server_default 100 + */ size?: integer + /** + * Excludes fields that were automatically added when creating the + * transform. This allows the configuration to be in an acceptable format to + * be retrieved and then added to another cluster. + * @server_default false + */ exclude_generated?: boolean } } diff --git a/specification/transform/get_transform/GetTransformResponse.ts b/specification/transform/get_transform/GetTransformResponse.ts index 3e61b2c6ba..30818e603c 100644 --- a/specification/transform/get_transform/GetTransformResponse.ts +++ b/specification/transform/get_transform/GetTransformResponse.ts @@ -18,8 +18,8 @@ */ import { long } from '@_types/Numeric' -import { Transform } from '@_types/Transform' +import { TransformSummary } from './types' export class Response { - body: { count: long; transforms: Transform[] } + body: { count: long; transforms: TransformSummary[] } } diff --git a/specification/transform/get_transform/types.ts b/specification/transform/get_transform/types.ts new file mode 100644 index 0000000000..54d1953461 --- /dev/null +++ b/specification/transform/get_transform/types.ts @@ -0,0 +1,50 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Destination } from '@global/reindex/types' +import { + Latest, + Pivot, + Settings, + Source, + SyncContainer +} from '@transform/_types/Transform' +import { Id, Metadata, VersionString } from '@_types/common' +import { EpochMillis, Time } from '@_types/Time' + +export class TransformSummary { + /** The destination for the transform. */ + dest: Destination + /** Free text description of the transform. */ + description?: string + frequency?: Time + id: Id + /** The pivot method transforms the data by aggregating and grouping it. */ + pivot?: Pivot + /** Defines optional transform settings. */ + settings?: Settings + /** The source of the data for the transform. */ + source: Source + /** Defines the properties transforms require to run continuously. */ + sync?: SyncContainer + create_time?: EpochMillis + version?: VersionString + latest?: Latest + _meta?: Metadata +} diff --git a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts index 22e3e778b9..fae6cafc89 100644 --- a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts +++ b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts @@ -18,21 +18,49 @@ */ import { RequestBase } from '@_types/Base' -import { Name } from '@_types/common' +import { Names } from '@_types/common' import { long } from '@_types/Numeric' /** + * Retrieves usage information for transforms. * @rest_spec_name transform.get_transform_stats * @since 7.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges monitor_transform + * @index_privileges read, view_index_metadata */ export interface Request extends RequestBase { - path_parts?: { - transform_id: Name + path_parts: { + /** + * Identifier for the transform. It can be a transform identifier or a + * wildcard expression. You can get information for all transforms by using + * `_all`, by specifying `*` as the ``, or by omitting the + * ``. + */ + transform_id: Names } - query_parameters?: { + query_parameters: { + /** + * Specifies what to do when the request: + * + * 1. Contains wildcard expressions and there are no transforms that match. + * 2. Contains the _all string or no identifiers and there are no matches. + * 3. Contains wildcard expressions and there are only partial matches. + * + * If this parameter is false, the request returns a 404 status code when + * there are no matches or only partial matches. + * @server_default true + */ allow_no_match?: boolean + /** + * Skips the specified number of transforms. + * @server_default 0 + */ from?: long + /** + * Specifies the maximum number of transforms to obtain. + * @server_default 100 + */ size?: long } } diff --git a/specification/transform/preview_transform/PreviewTransformRequest.ts b/specification/transform/preview_transform/PreviewTransformRequest.ts index 03bc88ce71..9b0c74b799 100644 --- a/specification/transform/preview_transform/PreviewTransformRequest.ts +++ b/specification/transform/preview_transform/PreviewTransformRequest.ts @@ -26,35 +26,81 @@ import { SyncContainer } from '@transform/_types/Transform' import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Previews a transform. + * + * It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + * generates a list of mappings and settings for the destination index. These values are determined based on the field + * types of the source index and the transform aggregations. * @rest_spec_name transform.preview_transform * @since 7.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_transform + * @index_privileges read, view_index_metadata */ export interface Request extends RequestBase { - body?: { - /** The destination for the transform. */ + path_parts: { + /** + * Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform + * configuration details in the request body. + */ + transform_id?: Id + } + query_parameters: { + /** + * Period to wait for a response. If no response is received before the + * timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time + } + body: { + /** + * The destination for the transform. + */ dest?: Destination - /** Free text description of the transform. */ + /** + * Free text description of the transform. + */ description?: string /** - * The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. + * The interval between checks for changes in the source indices when the + * transform is running continuously. Also determines the retry interval in + * the event of transient failures while the transform is searching or + * indexing. The minimum value is 1s and the maximum is 1h. * @server_default 1m */ frequency?: Time - /** The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data. */ + /** + * The pivot method transforms the data by aggregating and grouping it. + * These objects define the group by fields and the aggregation to reduce + * the data. + */ pivot?: Pivot - /** The source of the data for the transform. */ + /** + * The source of the data for the transform. + */ source?: Source - /** Defines optional transform settings. */ + /** + * Defines optional transform settings. + */ settings?: Settings - /** Defines the properties transforms require to run continuously. */ + /** + * Defines the properties transforms require to run continuously. + */ sync?: SyncContainer - /** Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. */ + /** + * Defines a retention policy for the transform. Data that meets the defined + * criteria is deleted from the destination index. + */ retention_policy?: RetentionPolicyContainer - /** The latest method transforms the data by finding the latest document for each unique key. */ + /** + * The latest method transforms the data by finding the latest document for + * each unique key. + */ latest?: Latest } } diff --git a/specification/transform/put_transform/PutTransformRequest.ts b/specification/transform/put_transform/PutTransformRequest.ts index 32918c8b74..06c8c7f3e2 100644 --- a/specification/transform/put_transform/PutTransformRequest.ts +++ b/specification/transform/put_transform/PutTransformRequest.ts @@ -16,21 +16,107 @@ * specific language governing permissions and limitations * under the License. */ -import { Request as PreviewTransformRequest } from '@transform/preview_transform/PreviewTransformRequest' + +import { Destination, Source } from '@global/reindex/types' +import { + Latest, + Pivot, + RetentionPolicyContainer, + Settings, + SyncContainer +} from '@transform/_types/Transform' +import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' +import { Time } from '@_types/Time' +import { Dictionary } from '@spec_utils/Dictionary' /** + * Creates a transform. + * + * A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + * a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + * unique row per entity. + * + * You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + * you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in + * the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values + * in the latest object. + * + * You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and + * `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the + * transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + * those roles do not have the required privileges on the source and destination indices, the transform fails when it + * attempts unauthorized operations. + * + * NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + * `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + * not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not + * give users any privileges on `.data-frame-internal*` indices. + * * @rest_spec_name transform.put_transform * @since 7.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_transform + * @index_privileges create_index, read, index, view_index_metadata */ -export interface Request extends PreviewTransformRequest { +export interface Request extends RequestBase { path_parts: { - /** Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. */ + /** Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), + * hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. + */ transform_id: Id } - query_parameters?: { - /** When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created. */ + query_parameters: { + /** + * When the transform is created, a series of validations occur to ensure its success. For example, there is a + * check for the existence of the source indices and a check that the destination index is not part of the source + * index pattern. You can use this parameter to skip the checks, for example when the source index does not exist + * until after the transform is created. The validations are always run when you start the transform, however, with + * the exception of privilege checks. + * @server_default false + */ defer_validation?: boolean + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time + } + body: { + /** The destination for the transform. */ + dest: Destination + /** Free text description of the transform. */ + description?: string + /** + * The interval between checks for changes in the source indices when the transform is running continuously. Also + * determines the retry interval in the event of transient failures while the transform is searching or indexing. + * The minimum value is `1s` and the maximum is `1h`. + * @server_default 1m + */ + frequency?: Time + /** + * The latest method transforms the data by finding the latest document for each unique key. + */ + latest?: Latest + /** + * Defines optional transform metadata. + */ + _meta?: Dictionary + /** + * The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields + * and the aggregation to reduce the data. + */ + pivot?: Pivot + /** + * Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the + * destination index. + */ + retention_policy?: RetentionPolicyContainer + /** Defines optional transform settings. */ + settings?: Settings + /** The source of the data for the transform. */ + source: Source + /** Defines the properties transforms require to run continuously. */ + sync?: SyncContainer } } diff --git a/specification/transform/start_transform/StartTransformRequest.ts b/specification/transform/start_transform/StartTransformRequest.ts index 5ab864e220..43cccefa2e 100644 --- a/specification/transform/start_transform/StartTransformRequest.ts +++ b/specification/transform/start_transform/StartTransformRequest.ts @@ -18,19 +18,44 @@ */ import { RequestBase } from '@_types/Base' -import { Name } from '@_types/common' +import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Starts a transform. + * + * When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is + * set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping + * definitions for the destination index from the source indices and the transform aggregations. If fields in the + * destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), + * the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + * mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + * start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + * in a pivot transform. + * + * When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + * created the transform, they occur when you start the transform—​with the exception of privilege checks. When + * Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + * time of creation and uses those same roles. If those roles do not have the required privileges on the source and + * destination indices, the transform fails when it attempts unauthorized operations. * @rest_spec_name transform.start_transform * @since 7.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_transform + * @index_privileges read, view_index_metadata */ export interface Request extends RequestBase { - path_parts?: { - transform_id: Name + path_parts: { + /** + * Identifier for the transform. + */ + transform_id: Id } - query_parameters?: { + query_parameters: { + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ timeout?: Time } } diff --git a/specification/transform/stop_transform/StopTransformRequest.ts b/specification/transform/stop_transform/StopTransformRequest.ts index 9cc1d5a2bd..9ff07af8e7 100644 --- a/specification/transform/stop_transform/StopTransformRequest.ts +++ b/specification/transform/stop_transform/StopTransformRequest.ts @@ -22,19 +22,55 @@ import { Name } from '@_types/common' import { Time } from '@_types/Time' /** + * Stops one or more transforms. * @rest_spec_name transform.stop_transform * @since 7.5.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_transform */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. + * To stop all transforms, use `_all` or `*` as the identifier. + */ transform_id: Name } - query_parameters?: { + query_parameters: { + /** + * Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; + * contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there + * are only partial matches. + * + * If it is true, the API returns a successful acknowledgement message when there are no matches. When there are + * only partial matches, the API stops the appropriate transforms. + * + * If it is false, the request returns a 404 status code when there are no matches or only partial matches. + * @server_default true + */ allow_no_match?: boolean + /** + * If it is true, the API forcefully stops the transforms. + * @server_default false + */ force?: boolean + /** + * Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the + * timeout expires, the request returns a timeout exception. However, the request continues processing and + * eventually moves the transform to a STOPPED state. + * @server_default 30s */ timeout?: Time + /** + * If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, + * the transform stops as soon as possible. + * @server_default false + */ wait_for_checkpoint?: boolean + /** + * If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns + * immediately and the indexer is stopped asynchronously in the background. + * @server_default false + */ wait_for_completion?: boolean } } diff --git a/specification/transform/update_transform/UpdateTransformRequest.ts b/specification/transform/update_transform/UpdateTransformRequest.ts index 375304933f..03edd152fd 100644 --- a/specification/transform/update_transform/UpdateTransformRequest.ts +++ b/specification/transform/update_transform/UpdateTransformRequest.ts @@ -17,11 +17,84 @@ * under the License. */ -import { Request as PutTransformRequest } from '@transform/put_transform/PutTransformRequest' +import { Destination, Source } from '@global/reindex/types' +import { + RetentionPolicyContainer, + Settings, + SyncContainer +} from '@transform/_types/Transform' +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' +import { Time } from '@_types/Time' /** + * Updates certain properties of a transform. + * + * All updated properties except `description` do not take effect until after the transform starts the next checkpoint, + * thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` + * privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When + * Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + * time of update and runs with those privileges. * @rest_spec_name transform.update_transform * @since 7.2.0 - * @stability TODO + * @stability stable + * @cluster_privileges manage_transform + * @index_privileges read, index, view_index_metadata */ -export interface Request extends PutTransformRequest {} +export interface Request extends RequestBase { + path_parts: { + /** + * Identifier for the transform. + */ + transform_id: Id + } + query_parameters: { + /** + * When true, deferrable validations are not run. This behavior may be + * desired if the source index does not exist until after the transform is + * created. + */ + defer_validation?: boolean + /** + * Period to wait for a response. If no response is received before the + * timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Time + } + body: { + /** + * The destination for the transform. + */ + dest?: Destination + /** + * Free text description of the transform. + */ + description?: string + /** + * The interval between checks for changes in the source indices when the + * transform is running continuously. Also determines the retry interval in + * the event of transient failures while the transform is searching or + * indexing. The minimum value is 1s and the maximum is 1h. + * @server_default 1m + */ + frequency?: Time + /** + * The source of the data for the transform. + */ + source?: Source + /** + * Defines optional transform settings. + */ + settings?: Settings + /** + * Defines the properties transforms require to run continuously. + */ + sync?: SyncContainer + /** + * Defines a retention policy for the transform. Data that meets the defined + * criteria is deleted from the destination index. + */ + retention_policy?: RetentionPolicyContainer + } +} diff --git a/specification/transform/update_transform/UpdateTransformResponse.ts b/specification/transform/update_transform/UpdateTransformResponse.ts index 82294e2c5d..d17ee752a4 100644 --- a/specification/transform/update_transform/UpdateTransformResponse.ts +++ b/specification/transform/update_transform/UpdateTransformResponse.ts @@ -18,7 +18,13 @@ */ import { Destination, Source } from '@global/reindex/types' -import { Pivot, Settings, SyncContainer } from '@transform/_types/Transform' +import { + Latest, + Pivot, + RetentionPolicyContainer, + Settings, + SyncContainer +} from '@transform/_types/Transform' import { Id, VersionString } from '@_types/common' import { long } from '@_types/Numeric' import { Time } from '@_types/Time' @@ -31,7 +37,9 @@ export class Response { dest: Destination frequency: Time id: Id - pivot: Pivot + latest?: Latest + pivot?: Pivot + retention_policy?: RetentionPolicyContainer settings: Settings source: Source sync?: SyncContainer diff --git a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts new file mode 100644 index 0000000000..8babee7278 --- /dev/null +++ b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts @@ -0,0 +1,49 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { Time } from '@_types/Time' + +/** + * Upgrades all transforms. + * This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It + * also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not + * affect the source and destination indices. The upgrade also does not affect the roles that transforms use when + * Elasticsearch security features are enabled; the role used to read source data and write to the destination index + * remains unchanged. + * @rest_spec_name transform.upgrade_transforms + * @since 7.16.0 + * @stability stable + * @cluster_privileges manage_transform + */ +export interface Request extends RequestBase { + query_parameters: { + /** + * When true, the request checks for updates but does not run them. + * @server_default false + */ + dry_run?: boolean + /** + * Period to wait for a response. If no response is received before the timeout expires, the request fails and + * returns an error. + * @server_default 30s + */ + timeout?: Time + } +} diff --git a/specification/transform/upgrade_transforms/UpgradeTransformsResponse.ts b/specification/transform/upgrade_transforms/UpgradeTransformsResponse.ts new file mode 100644 index 0000000000..3ae7d04521 --- /dev/null +++ b/specification/transform/upgrade_transforms/UpgradeTransformsResponse.ts @@ -0,0 +1,34 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { integer } from '@_types/Numeric' +/* +import { long } from '@_types/Numeric' +import { Transform } from '@_types/Transform' +*/ +export class Response { + body: { + /** The number of transforms that need to be upgraded. */ + needs_update: integer + /** The number of transforms that don’t require upgrading. */ + no_action: integer + /** The number of transforms that have been upgraded. */ + updated: integer + } +} diff --git a/specification/tsconfig.json b/specification/tsconfig.json index 8d15d664e3..b9081a8dac 100644 --- a/specification/tsconfig.json +++ b/specification/tsconfig.json @@ -47,7 +47,7 @@ "@snapshot/*": ["snapshot/*"], "@sql/*": ["sql/*"], "@ssl/*": ["ssl/*"], - "@task/*": ["task/*"], + "@tasks/*": ["tasks/*"], "@text_structure/*": ["text_structure/*"], "@transform/*": ["transform/*"], "@watcher/*": ["watcher/*"], diff --git a/specification/watcher/_types/Action.ts b/specification/watcher/_types/Action.ts index 7b491ae4c7..8ce2b7a9b1 100644 --- a/specification/watcher/_types/Action.ts +++ b/specification/watcher/_types/Action.ts @@ -19,6 +19,7 @@ import { Dictionary } from '@spec_utils/Dictionary' import { IndexName, Name } from '@_types/common' +import { Host } from '@_types/Networking' import { integer } from '@_types/Numeric' import { DateString, EpochMillis, Time } from '@_types/Time' import { TransformContainer } from '@_types/Transform' @@ -36,6 +37,13 @@ export class Action { transform?: TransformContainer index?: Index logging?: Logging + /** @since 7.14.0 */ + webhook?: ActionWebhook +} + +export class ActionWebhook { + host: Host + port: integer } export type Actions = Dictionary diff --git a/specification/watcher/_types/Actions.ts b/specification/watcher/_types/Actions.ts index 7dc135941d..f344f095be 100644 --- a/specification/watcher/_types/Actions.ts +++ b/specification/watcher/_types/Actions.ts @@ -18,7 +18,14 @@ */ // PageDuty ----------------------------- // -import { HttpHeaders, Id, IndexName, Type, VersionNumber } from '@_types/common' +import { + HttpHeaders, + Id, + IndexName, + Refresh, + Type, + VersionNumber +} from '@_types/common' import { integer } from '@_types/Numeric' import { Result } from '@_types/Result' import { DateString } from '@_types/Time' @@ -158,6 +165,7 @@ export class Email { export class Index { index: IndexName doc_id?: Id + refresh?: Refresh } export class IndexResult { @@ -176,8 +184,9 @@ export class IndexResultSummary { // Logging ------------------------------ // export class Logging { - level: string + level?: string text: string + category?: string } export class LoggingResult { diff --git a/specification/watcher/_types/Conditions.ts b/specification/watcher/_types/Conditions.ts index 65a7650d72..7a9f77b965 100644 --- a/specification/watcher/_types/Conditions.ts +++ b/specification/watcher/_types/Conditions.ts @@ -17,44 +17,43 @@ * under the License. */ -import { Dictionary } from '@spec_utils/Dictionary' +import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' +import { FieldValue } from '@_types/common' +import { AdditionalProperty } from '@spec_utils/behaviors' export class AlwaysCondition {} -export class ArrayCompareCondition { - array_path: string - comparison: string - path: string +export class ArrayCompareOpParams { quantifier: Quantifier - value: UserDefinedValue + value: FieldValue } -export class CompareCondition { - comparison?: string - path?: string - value?: UserDefinedValue - 'ctx.payload.match'?: CompareContextPayloadCondition - 'ctx.payload.value'?: CompareContextPayloadCondition +export class ArrayCompareCondition + implements AdditionalProperty +{ + path: string } -export class CompareContextPayloadCondition { - eq?: UserDefinedValue - lt?: UserDefinedValue - gt?: UserDefinedValue - lte?: UserDefinedValue - gte?: UserDefinedValue +export enum ConditionOp { + not_eq, + eq, + lt, + gt, + lte, + gte } -export class Condition {} - /** * @variants container */ export class ConditionContainer { always?: AlwaysCondition - array_compare?: ArrayCompareCondition - compare?: CompareCondition + array_compare?: SingleKeyDictionary + compare?: SingleKeyDictionary< + string, + SingleKeyDictionary + > never?: NeverCondition script?: ScriptCondition } diff --git a/specification/watcher/_types/Input.ts b/specification/watcher/_types/Input.ts index d09b9372f5..8e34f59638 100644 --- a/specification/watcher/_types/Input.ts +++ b/specification/watcher/_types/Input.ts @@ -18,11 +18,11 @@ */ import { Request as SearchTemplateRequest } from '@global/search_template/SearchTemplateRequest' -import { Dictionary } from '@spec_utils/Dictionary' +import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { - ExpandWildcards, IndexName, + IndicesOptions, Password, SearchType, Username @@ -33,7 +33,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Time } from '@_types/Time' export class ChainInput { - inputs: InputContainer[] + inputs: Array> } export enum ConnectionScheme { @@ -42,7 +42,6 @@ export enum ConnectionScheme { } export class HttpInput { - http?: HttpInput extract?: string[] request?: HttpInputRequestDefinition response_content_type?: ResponseContentType @@ -86,13 +85,6 @@ export class HttpInputRequestDefinition { url?: string } -export class IndicesOptions { - allow_no_indices: boolean - expand_wildcards: ExpandWildcards - ignore_unavailable: boolean - ignore_throttled?: boolean -} - export class Input {} /** diff --git a/specification/watcher/_types/Schedule.ts b/specification/watcher/_types/Schedule.ts index 374dd29e25..59f87630db 100644 --- a/specification/watcher/_types/Schedule.ts +++ b/specification/watcher/_types/Schedule.ts @@ -20,14 +20,18 @@ import { integer, long } from '@_types/Numeric' import { DateString, Time } from '@_types/Time' -export class Schedule {} +// TODO remove +// export class Schedule {} +// export class ScheduleBase {} -export class ScheduleBase {} - -export class CronExpression extends ScheduleBase {} +/** + * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/cron-expressions.html + */ +export type CronExpression = string +//export class CronExpression extends ScheduleBase {} export class DailySchedule { - at: string[] | TimeOfDay + at: TimeOfDay[] } export enum Day { @@ -44,16 +48,22 @@ export class HourlySchedule { minute: integer[] } -export class Interval extends ScheduleBase { +export class Interval { + // extends ScheduleBase { factor: long unit: IntervalUnit } export enum IntervalUnit { + /** @codegen_name second */ s = 0, + /** @codegen_name minute */ m = 1, + /** @codegen_name hour */ h = 2, + /** @codegen_name day */ d = 3, + /** @codegen_name week */ w = 4 } @@ -86,11 +96,14 @@ export class ScheduleContainer { } export class ScheduleTriggerEvent { - scheduled_time: DateString | string - triggered_time?: DateString | string + scheduled_time: DateString + triggered_time?: DateString } -export class TimeOfDay { +/** @codegen_names text, hour_minute */ +export type TimeOfDay = string | HourAndMinute + +export class HourAndMinute { hour: integer[] minute: integer[] } diff --git a/specification/watcher/_types/Trigger.ts b/specification/watcher/_types/Trigger.ts index 8a8ea640fc..96bff42476 100644 --- a/specification/watcher/_types/Trigger.ts +++ b/specification/watcher/_types/Trigger.ts @@ -24,7 +24,7 @@ import { ScheduleContainer, ScheduleTriggerEvent } from './Schedule' * @variants container */ export class TriggerContainer { - schedule: ScheduleContainer + schedule?: ScheduleContainer } export class TriggerEvent {} @@ -33,7 +33,7 @@ export class TriggerEvent {} * @variants container */ export class TriggerEventContainer { - schedule: ScheduleTriggerEvent + schedule?: ScheduleTriggerEvent } export class TriggerEventResult { diff --git a/specification/watcher/_types/Watch.ts b/specification/watcher/_types/Watch.ts index 1669ddbaf7..1c3a030ff4 100644 --- a/specification/watcher/_types/Watch.ts +++ b/specification/watcher/_types/Watch.ts @@ -18,8 +18,14 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { IndexName, Metadata, VersionNumber } from '@_types/common' -import { long } from '@_types/Numeric' +import { + Id, + IndexName, + Metadata, + SequenceNumber, + VersionNumber +} from '@_types/common' +import { integer, long } from '@_types/Numeric' import { DateString } from '@_types/Time' import { TransformContainer } from '@_types/Transform' import { Action, Actions } from './Action' @@ -48,3 +54,11 @@ export class WatchStatus { version: VersionNumber execution_state?: string // TODO find execution states in export enum in server codebase } + +export class QueryWatch { + _id: Id + status?: WatchStatus + watch?: Watch + _primary_term?: integer + _seq_no?: SequenceNumber +} diff --git a/specification/watcher/ack_watch/WatcherAckWatchRequest.ts b/specification/watcher/ack_watch/WatcherAckWatchRequest.ts index 1b2d965b00..46d15042e0 100644 --- a/specification/watcher/ack_watch/WatcherAckWatchRequest.ts +++ b/specification/watcher/ack_watch/WatcherAckWatchRequest.ts @@ -23,10 +23,10 @@ import { Name, Names } from '@_types/common' /** * @rest_spec_name watcher.ack_watch * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { watch_id: Name action_id?: Names } diff --git a/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts b/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts index 3b127e9fe1..86dce436c3 100644 --- a/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts +++ b/specification/watcher/activate_watch/WatcherActivateWatchRequest.ts @@ -23,12 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name watcher.activate_watch * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { watch_id: Name } - query_parameters?: {} - body?: {} } diff --git a/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts b/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts index be6d96f8cf..19cd2aad6a 100644 --- a/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts +++ b/specification/watcher/deactivate_watch/DeactivateWatchRequest.ts @@ -23,12 +23,10 @@ import { Name } from '@_types/common' /** * @rest_spec_name watcher.deactivate_watch * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { watch_id: Name } - query_parameters?: {} - body?: {} } diff --git a/specification/watcher/delete_watch/DeleteWatchRequest.ts b/specification/watcher/delete_watch/DeleteWatchRequest.ts index 6e56fdc2e6..4687b078e6 100644 --- a/specification/watcher/delete_watch/DeleteWatchRequest.ts +++ b/specification/watcher/delete_watch/DeleteWatchRequest.ts @@ -23,7 +23,7 @@ import { Name } from '@_types/common' /** * @rest_spec_name watcher.delete_watch * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts b/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts index 805ce8158d..4f6eac2715 100644 --- a/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts +++ b/specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts @@ -28,16 +28,16 @@ import { Id } from '@_types/common' /** * @rest_spec_name watcher.execute_watch * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id?: Id } - query_parameters?: { + query_parameters: { debug?: boolean } - body?: { + body: { action_modes?: Dictionary alternative_input?: Dictionary ignore_condition?: boolean diff --git a/specification/watcher/get_watch/GetWatchRequest.ts b/specification/watcher/get_watch/GetWatchRequest.ts index 6babf65118..78afa634c9 100644 --- a/specification/watcher/get_watch/GetWatchRequest.ts +++ b/specification/watcher/get_watch/GetWatchRequest.ts @@ -23,7 +23,7 @@ import { Name } from '@_types/common' /** * @rest_spec_name watcher.get_watch * @since 5.6.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/watcher/put_watch/WatcherPutWatchRequest.ts b/specification/watcher/put_watch/WatcherPutWatchRequest.ts index e7715acbe9..25e33dcba5 100644 --- a/specification/watcher/put_watch/WatcherPutWatchRequest.ts +++ b/specification/watcher/put_watch/WatcherPutWatchRequest.ts @@ -23,26 +23,26 @@ import { ConditionContainer } from '@watcher/_types/Conditions' import { InputContainer } from '@watcher/_types/Input' import { TriggerContainer } from '@watcher/_types/Trigger' import { RequestBase } from '@_types/Base' -import { Id, Metadata, VersionNumber } from '@_types/common' +import { Id, Metadata, VersionNumber, SequenceNumber } from '@_types/common' import { long } from '@_types/Numeric' import { TransformContainer } from '@_types/Transform' /** * @rest_spec_name watcher.put_watch * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { id: Id } - query_parameters?: { + query_parameters: { active?: boolean if_primary_term?: long - if_sequence_number?: long + if_seq_no?: SequenceNumber version?: VersionNumber } - body?: { + body: { actions?: Dictionary condition?: ConditionContainer input?: InputContainer diff --git a/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts b/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts index 43c92afcdd..41eca74426 100644 --- a/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts +++ b/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts @@ -17,21 +17,33 @@ * under the License. */ +import { Sort, SortResults } from '@_types/sort' import { RequestBase } from '@_types/Base' +import { integer } from '@_types/Numeric' +import { QueryContainer } from '@_types/query_dsl/abstractions' /** * @rest_spec_name watcher.query_watches * @since 7.11.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { - stub_a: string - } - query_parameters?: { - stub_b: string - } - body?: { - stub_c: string + body: { + /** + * The offset from the first result to fetch. Needs to be non-negative. + * @server_default 0 + */ + from?: integer + /** + * The number of hits to return. Needs to be non-negative. + * @server_default 10 + */ + size?: integer + /** Optional, query filter watches to be returned. */ + query?: QueryContainer + /** Optional sort definition. */ + sort?: Sort + /** Optional search After to do pagination using last hit’s sort values. */ + search_after?: SortResults } } diff --git a/specification/watcher/query_watches/WatcherQueryWatchesResponse.ts b/specification/watcher/query_watches/WatcherQueryWatchesResponse.ts index 25b5bd6764..8f74eaa37e 100644 --- a/specification/watcher/query_watches/WatcherQueryWatchesResponse.ts +++ b/specification/watcher/query_watches/WatcherQueryWatchesResponse.ts @@ -17,8 +17,12 @@ * under the License. */ +import { QueryWatch } from '../_types/Watch' import { integer } from '@_types/Numeric' export class Response { - body: { stub: integer } + body: { + count: integer + watches: QueryWatch[] + } } diff --git a/specification/watcher/start/WatcherStartRequest.ts b/specification/watcher/start/WatcherStartRequest.ts index 5b7a2df2a4..c44d47b25b 100644 --- a/specification/watcher/start/WatcherStartRequest.ts +++ b/specification/watcher/start/WatcherStartRequest.ts @@ -22,9 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name watcher.start * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends RequestBase {} diff --git a/specification/watcher/stats/WatcherStatsRequest.ts b/specification/watcher/stats/WatcherStatsRequest.ts index d5a20345e1..ae473cf6f2 100644 --- a/specification/watcher/stats/WatcherStatsRequest.ts +++ b/specification/watcher/stats/WatcherStatsRequest.ts @@ -23,14 +23,24 @@ import { WatcherMetric } from './types' /** * @rest_spec_name watcher.stats * @since 5.5.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - path_parts?: { + path_parts: { + /** + * Defines which additional metrics are included in the response. + */ metric?: WatcherMetric | WatcherMetric[] } - query_parameters?: { + query_parameters: { + /** + * Defines whether stack traces are generated for each watch that is running. + * @server_default false + */ emit_stacktraces?: boolean + /** + * Defines which additional metrics are included in the response. + */ metric?: WatcherMetric | WatcherMetric[] } } diff --git a/specification/watcher/stats/WatcherStatsResponse.ts b/specification/watcher/stats/WatcherStatsResponse.ts index 71f624ed01..85dd1db1d1 100644 --- a/specification/watcher/stats/WatcherStatsResponse.ts +++ b/specification/watcher/stats/WatcherStatsResponse.ts @@ -23,7 +23,7 @@ import { WatcherNodeStats } from './types' export class Response { body: { - /** @identifier node_stats */ + /** @codegen_name node_stats */ _nodes: NodeStatistics cluster_name: Name manually_stopped: boolean diff --git a/specification/watcher/stats/types.ts b/specification/watcher/stats/types.ts index 77b62856f3..12c26cda07 100644 --- a/specification/watcher/stats/types.ts +++ b/specification/watcher/stats/types.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { long } from '@_types/Numeric' import { DateString } from '@_types/Time' +// Identical to DatafeedState, but kept separate as they're different enums in ES export enum WatcherState { stopped = 0, starting = 1, @@ -39,6 +40,7 @@ export class WatcherNodeStats { } export enum WatcherMetric { + /** @aliases all */ '_all' = 0, 'queued_watches' = 1, 'current_watches' = 2, diff --git a/specification/watcher/stop/WatcherStopRequest.ts b/specification/watcher/stop/WatcherStopRequest.ts index 1feccb5063..e2007130df 100644 --- a/specification/watcher/stop/WatcherStopRequest.ts +++ b/specification/watcher/stop/WatcherStopRequest.ts @@ -22,9 +22,6 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name watcher.stop * @since 0.0.0 - * @stability TODO + * @stability stable */ -export interface Request extends RequestBase { - query_parameters?: {} - body?: {} -} +export interface Request extends RequestBase {} diff --git a/specification/xpack/info/XPackInfoRequest.ts b/specification/xpack/info/XPackInfoRequest.ts index c053e54664..84c82c532f 100644 --- a/specification/xpack/info/XPackInfoRequest.ts +++ b/specification/xpack/info/XPackInfoRequest.ts @@ -22,10 +22,10 @@ import { RequestBase } from '@_types/Base' /** * @rest_spec_name xpack.info * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { categories?: string[] } } diff --git a/specification/xpack/info/types.ts b/specification/xpack/info/types.ts index 8c8bd943d2..d9a3d6168f 100644 --- a/specification/xpack/info/types.ts +++ b/specification/xpack/info/types.ts @@ -64,7 +64,7 @@ export class Features { spatial: Feature sql: Feature transform: Feature - vectors: Feature + vectors?: Feature voting_only: Feature watcher: Feature } diff --git a/specification/xpack/usage/XPackUsageRequest.ts b/specification/xpack/usage/XPackUsageRequest.ts index 0bf545d941..1318afad52 100644 --- a/specification/xpack/usage/XPackUsageRequest.ts +++ b/specification/xpack/usage/XPackUsageRequest.ts @@ -23,10 +23,10 @@ import { Time } from '@_types/Time' /** * @rest_spec_name xpack.usage * @since 0.0.0 - * @stability TODO + * @stability stable */ export interface Request extends RequestBase { - query_parameters?: { + query_parameters: { master_timeout?: Time } } diff --git a/specification/xpack/usage/XPackUsageResponse.ts b/specification/xpack/usage/XPackUsageResponse.ts index 45c06d44bb..298fd40451 100644 --- a/specification/xpack/usage/XPackUsageResponse.ts +++ b/specification/xpack/usage/XPackUsageResponse.ts @@ -65,7 +65,7 @@ export class Response { slm: Slm sql: Sql transform: Base - vectors: Vector + vectors?: Vector voting_only: Base } } diff --git a/specification/xpack/usage/types.ts b/specification/xpack/usage/types.ts index 5eaa6dff1c..cdf07145bb 100644 --- a/specification/xpack/usage/types.ts +++ b/specification/xpack/usage/types.ts @@ -19,7 +19,7 @@ import { Phases } from '@ilm/_types/Phase' import { Statistics } from '@slm/_types/SnapshotLifecycle' -import { Dictionary } from '@spec_utils/Dictionary' +import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary' import { ByteSize, EmptyObject, Field, Name } from '@_types/common' import { Job, JobStatistics } from '@ml/_types/Job' import { integer, long, uint, ulong } from '@_types/Numeric' @@ -38,17 +38,6 @@ export class FeatureToggle { enabled: boolean } -export class BaseUrlConfig { - url_name: string - url_value: string -} - -export class KibanaUrlConfig extends BaseUrlConfig { - time_range?: string -} - -export type UrlConfig = BaseUrlConfig | KibanaUrlConfig - export class AlertingExecution { actions: Dictionary } @@ -213,6 +202,7 @@ export class MlInferenceTrainedModelsCount { total: long prepackaged: long other: long + pass_through?: long regression: long classification: long } @@ -323,11 +313,18 @@ export class FrozenIndices extends Base { indices_count: long } +export class JobUsage { + count: integer + created_by: Dictionary + detectors: JobStatistics + forecasts: MlJobForecasts + model_size: JobStatistics +} + export class MachineLearning extends Base { datafeeds: Dictionary - // TODO: xPack marks the entire Job definition as optional - // while the MlJob has many required properties. - jobs: Dictionary + /** Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs. */ + jobs: Dictionary node_count: integer data_frame_analytics_jobs: MlDataFrameAnalyticsJobs inference: MlInference diff --git a/typescript-generator/package-lock.json b/typescript-generator/package-lock.json new file mode 100644 index 0000000000..ba70d00640 --- /dev/null +++ b/typescript-generator/package-lock.json @@ -0,0 +1,5522 @@ +{ + "name": "typescript-generator", + "version": "1.0.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "typescript-generator", + "version": "1.0.0", + "license": "Apache-2.0", + "dependencies": { + "typescript": "^4.5.5" + }, + "devDependencies": { + "@types/node": "^17.0.12", + "ts-node": "^10.4.0", + "ts-standard": "^11.0.0" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "dependencies": { + "@babel/highlight": "^7.10.4" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.16.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz", + "integrity": "sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw==", + "dev": true, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.16.10", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.10.tgz", + "integrity": "sha512-5FnTQLSLswEj6IkgVw5KusNUUFY9ZGqe/TRFnP/BKYHYgfh7tc+C7mwiy95/yNP7Dh9x580Vv8r7u7ZfTBFxdw==", + "dev": true, + "dependencies": { + "@babel/helper-validator-identifier": "^7.16.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight/node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/@babel/highlight/node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "node_modules/@babel/highlight/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/@babel/highlight/node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@cspotcode/source-map-consumer": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", + "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "dev": true, + "engines": { + "node": ">= 12" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", + "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-consumer": "0.8.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", + "integrity": "sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw==", + "dev": true, + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.5.0.tgz", + "integrity": "sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==", + "dev": true, + "dependencies": { + "@humanwhocodes/object-schema": "^1.2.0", + "debug": "^4.1.1", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz", + "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==", + "dev": true + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", + "integrity": "sha512-6XFfSQmMgq0CFLY1MslA/CPUfhIL919M1rMsa5lP2P097N2Wd1sSX0tx1u4olM16fLNhtHZpRhedZJphNJqmZg==", + "dev": true + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.9.tgz", + "integrity": "sha512-/yBMcem+fbvhSREH+s14YJi18sp7J9jpuhYByADT2rypfajMZZN4WQ6zBGgBKp53NKmqI36wFYDb3yaMPurITw==", + "dev": true + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.1.tgz", + "integrity": "sha512-509r2+yARFfHHE7T6Puu2jjkoycftovhXRqW328PDXTVGKihlb1P8Z9mMZH04ebyajfRY7dedfGynlrFHJUQCg==", + "dev": true + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.2.tgz", + "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", + "dev": true + }, + "node_modules/@types/json-schema": { + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", + "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==", + "dev": true + }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", + "dev": true + }, + "node_modules/@types/node": { + "version": "17.0.12", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.12.tgz", + "integrity": "sha512-4YpbAsnJXWYK/fpTVFlMIcUIho2AYCi4wg5aNPrG1ng7fn/1/RZfCIpRCiBX+12RVa34RluilnvCqD+g3KiSiA==", + "dev": true + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.33.0.tgz", + "integrity": "sha512-aINiAxGVdOl1eJyVjaWn/YcVAq4Gi/Yo35qHGCnqbWVz61g39D0h23veY/MA0rFFGfxK7TySg2uwDeNv+JgVpg==", + "dev": true, + "dependencies": { + "@typescript-eslint/experimental-utils": "4.33.0", + "@typescript-eslint/scope-manager": "4.33.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "ignore": "^5.1.8", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/experimental-utils": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.33.0.tgz", + "integrity": "sha512-zeQjOoES5JFjTnAhI5QY7ZviczMzDptls15GFsI6jyUOq0kOf9+WonkhtlIhh0RgHRnqj5gdNxW5j1EvAyYg6Q==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "*" + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.33.0.tgz", + "integrity": "sha512-ZohdsbXadjGBSK0/r+d87X0SBmKzOq4/S5nzK6SBgJspFo9/CUDJ7hjayuze+JK7CZQLDMroqytp7pOcFKTxZA==", + "dev": true, + "dependencies": { + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "debug": "^4.3.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.33.0.tgz", + "integrity": "sha512-5IfJHpgTsTZuONKbODctL4kKuQje/bzBRkwHE8UOZ4f89Zeddg+EGZs8PD8NcN4LdM3ygHWYB3ukPAYjvl/qbQ==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/types": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.33.0.tgz", + "integrity": "sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ==", + "dev": true, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.33.0.tgz", + "integrity": "sha512-rkWRY1MPFzjwnEVHsxGemDzqqddw2QbTJlICPD9p9I9LfsO8fdmfQPOX3uKfUaGRDFJbfrtm/sXhVXN4E+bzCA==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz", + "integrity": "sha512-uqi/2aSz9g2ftcHWf8uLPJA70rUv6yuMW5Bohw+bwcuzaxQIHaKFZCKGoGXIrc9vkTJ3+0txM73K0Hq3d5wgIg==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.33.0", + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/acorn": { + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", + "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/array-includes": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", + "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "is-string": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz", + "integrity": "sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flatmap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", + "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "dependencies": { + "fill-range": "^7.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/debug": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz", + "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true + }, + "node_modules/define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "dependencies": { + "object-keys": "^1.0.12" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "node_modules/enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "dependencies": { + "ansi-colors": "^4.1.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-abstract": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz", + "integrity": "sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "get-symbol-description": "^1.0.0", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "is-callable": "^1.2.4", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.1", + "is-string": "^1.0.7", + "is-weakref": "^1.0.1", + "object-inspect": "^1.11.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint": { + "version": "7.32.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.32.0.tgz", + "integrity": "sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA==", + "dev": true, + "dependencies": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.3", + "@humanwhocodes/config-array": "^0.5.0", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-config-standard": { + "version": "16.0.3", + "resolved": "https://registry.npmjs.org/eslint-config-standard/-/eslint-config-standard-16.0.3.tgz", + "integrity": "sha512-x4fmJL5hGqNJKGHSjnLdgA6U6h1YW/G2dW9fA+cyVur4SK6lyue8+UgNKWlZtUDTXvgKDD/Oa3GQjmB5kjtVvg==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "peerDependencies": { + "eslint": "^7.12.1", + "eslint-plugin-import": "^2.22.1", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^4.2.1 || ^5.0.0" + } + }, + "node_modules/eslint-config-standard-jsx": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-jsx/-/eslint-config-standard-jsx-10.0.0.tgz", + "integrity": "sha512-hLeA2f5e06W1xyr/93/QJulN/rLbUVUmqTlexv9PRKHFwEC9ffJcH2LvJhMoEqYQBEYafedgGZXH2W8NUpt5lA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "peerDependencies": { + "eslint": "^7.12.1", + "eslint-plugin-react": "^7.21.5" + } + }, + "node_modules/eslint-config-standard-with-typescript": { + "version": "21.0.1", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-21.0.1.tgz", + "integrity": "sha512-FeiMHljEJ346Y0I/HpAymNKdrgKEpHpcg/D93FvPHWfCzbT4QyUJba/0FwntZeGLXfUiWDSeKmdJD597d9wwiw==", + "dev": true, + "dependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint-config-standard": "^16.0.0" + }, + "peerDependencies": { + "@typescript-eslint/eslint-plugin": "^4.0.1", + "eslint": "^7.12.1", + "eslint-plugin-import": "^2.22.1", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^4.2.1 || ^5.0.0", + "typescript": "^3.9 || ^4.0.0" + } + }, + "node_modules/eslint-import-resolver-node": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz", + "integrity": "sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw==", + "dev": true, + "dependencies": { + "debug": "^3.2.7", + "resolve": "^1.20.0" + } + }, + "node_modules/eslint-import-resolver-node/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-module-utils": { + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.2.tgz", + "integrity": "sha512-zquepFnWCY2ISMFwD/DqzaM++H+7PDzOpUvotJWm/y1BAFt5R4oeULgdrTejKqLkz7MA/tgstsUMNYc7wNdTrg==", + "dev": true, + "dependencies": { + "debug": "^3.2.7", + "find-up": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-es": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-3.0.1.tgz", + "integrity": "sha512-GUmAsJaN4Fc7Gbtl8uOBlayo2DqhwWvEzykMHSCZHU3XdJ+NSzzZcVhXh3VxX5icqQ+oQdIEawXX8xkR3mIFmQ==", + "dev": true, + "dependencies": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=4.19.1" + } + }, + "node_modules/eslint-plugin-es/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint-plugin-es/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-plugin-import": { + "version": "2.25.4", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz", + "integrity": "sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.4", + "array.prototype.flat": "^1.2.5", + "debug": "^2.6.9", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.6", + "eslint-module-utils": "^2.7.2", + "has": "^1.0.3", + "is-core-module": "^2.8.0", + "is-glob": "^4.0.3", + "minimatch": "^3.0.4", + "object.values": "^1.1.5", + "resolve": "^1.20.0", + "tsconfig-paths": "^3.12.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8" + } + }, + "node_modules/eslint-plugin-import/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "dev": true + }, + "node_modules/eslint-plugin-node": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz", + "integrity": "sha512-oUwtPJ1W0SKD0Tr+wqu92c5xuCeQqB3hSCHasn/ZgjFdA9iDGNkNf2Zi9ztY7X+hNuMib23LNGRm6+uN+KLE3g==", + "dev": true, + "dependencies": { + "eslint-plugin-es": "^3.0.0", + "eslint-utils": "^2.0.0", + "ignore": "^5.1.1", + "minimatch": "^3.0.4", + "resolve": "^1.10.1", + "semver": "^6.1.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "peerDependencies": { + "eslint": ">=5.16.0" + } + }, + "node_modules/eslint-plugin-node/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint-plugin-node/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-plugin-node/node_modules/semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/eslint-plugin-promise": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-5.2.0.tgz", + "integrity": "sha512-SftLb1pUG01QYq2A/hGAWfDRXqYD82zE7j7TopDOyNdU+7SvvoXREls/+PRTY17vUXzXnZA/zfnyKgRH6x4JJw==", + "dev": true, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "peerDependencies": { + "eslint": "^7.0.0" + } + }, + "node_modules/eslint-plugin-react": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.28.0.tgz", + "integrity": "sha512-IOlFIRHzWfEQQKcAD4iyYDndHwTQiCMcJVJjxempf203jnNLUnW34AXLrV33+nEXoifJE2ZEGmcjKPL8957eSw==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.4", + "array.prototype.flatmap": "^1.2.5", + "doctrine": "^2.1.0", + "estraverse": "^5.3.0", + "jsx-ast-utils": "^2.4.1 || ^3.0.0", + "minimatch": "^3.0.4", + "object.entries": "^1.1.5", + "object.fromentries": "^2.0.5", + "object.hasown": "^1.1.0", + "object.values": "^1.1.5", + "prop-types": "^15.7.2", + "resolve": "^2.0.0-next.3", + "semver": "^6.3.0", + "string.prototype.matchall": "^4.0.6" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8" + } + }, + "node_modules/eslint-plugin-react/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-plugin-react/node_modules/resolve": { + "version": "2.0.0-next.3", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.3.tgz", + "integrity": "sha512-W8LucSynKUIDu9ylraa7ueVZ7hc0uAgJBxVsQSKOXOyle8a93qXhcz+XAXZ8bIq2d6i4Ehddn6Evt+0/UwKk6Q==", + "dev": true, + "dependencies": { + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/eslint-plugin-react/node_modules/semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/eslint-scope/node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint/node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "dependencies": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/espree/node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/espree/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/fast-deep-equal": { + "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 + }, + "node_modules/fast-glob": { + "version": "3.2.11", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.11.tgz", + "integrity": "sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true + }, + "node_modules/fastq": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", + "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-up": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", + "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", + "dev": true, + "dependencies": { + "locate-path": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "dependencies": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flatted": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.4.tgz", + "integrity": "sha512-8/sOawo8tJ4QOBX8YlQBMxL8+RLZfxMQOif9o0KUKTNTjMYElWPE0r/m5VNFxTRd0NSw8qSy8dajrwX4RYI1Hw==", + "dev": true + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "node_modules/function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "node_modules/functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, + "node_modules/get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-stdin": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz", + "integrity": "sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/get-symbol-description": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", + "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/globals": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.12.0.tgz", + "integrity": "sha512-uS8X6lSKN2JumVoXrbUz+uG4BYG+eiawqm3qFcT7ammfbUHeCBoJMlHcec/S3krSk73/AE/f0szYFmgAA3kYZg==", + "dev": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.9", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.9.tgz", + "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==", + "dev": true + }, + "node_modules/has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", + "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/ignore": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", + "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", + "dev": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "node_modules/internal-slot": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz", + "integrity": "sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.1.0", + "has": "^1.0.3", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "node_modules/is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "dependencies": { + "has-bigints": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", + "integrity": "sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-core-module": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", + "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "dev": true, + "dependencies": { + "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-negative-zero": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", + "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-number-object": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz", + "integrity": "sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", + "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-parse-better-errors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", + "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", + "dev": true + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", + "dev": true + }, + "node_modules/json5": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", + "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "dev": true, + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/jsx-ast-utils": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.1.tgz", + "integrity": "sha512-uP5vu8xfy2F9A6LGC22KO7e2/vGTS1MhP+18f++ZNlf0Ohaxbc9nIEwHAsejlJKyzfZzU5UIhe5ItYkitcZnZA==", + "dev": true, + "dependencies": { + "array-includes": "^3.1.3", + "object.assign": "^4.1.2" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/load-json-file": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-5.3.0.tgz", + "integrity": "sha512-cJGP40Jc/VXUsp8/OrnyKyTZ1y6v/dphm3bioS+RrKXjK2BB6wHUd6JptZEFDGgGahMT+InnZO5i1Ei9mpC8Bw==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.15", + "parse-json": "^4.0.0", + "pify": "^4.0.1", + "strip-bom": "^3.0.0", + "type-fest": "^0.3.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/load-json-file/node_modules/type-fest": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.3.1.tgz", + "integrity": "sha512-cUGJnCdr4STbePCgqNFbpVNCepa+kAVohJs1sLhxzdH+gnEoOd8VhbYa7pD3zZYGiURWM2xzEII3fQcRizDkYQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/locate-path": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", + "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", + "dev": true, + "dependencies": { + "p-locate": "^2.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "node_modules/lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dev": true, + "dependencies": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", + "dev": true + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.0.tgz", + "integrity": "sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.entries": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.5.tgz", + "integrity": "sha512-TyxmjUoZggd4OrrU1W66FMDG6CuqJxsFvymeyXI51+vQLN67zYfZseptRge703kKQdo4uccgAKebXFcRCzk4+g==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.fromentries": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.5.tgz", + "integrity": "sha512-CAyG5mWQRRiBU57Re4FKoTBjXfDoNwdFVH2Y1tS9PqCsfUTymAohOkEMSG3aRNKmv4lV3O7p1et7c187q6bynw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.hasown": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", + "integrity": "sha512-MhjYRfj3GBlhSkDHo6QmvgjRLXQ2zndabdf3nX0yTyZK9rPfxb6uRpAac8HXNLy1GpqWtZ81Qh4v3uOls2sRAg==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.values": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz", + "integrity": "sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/p-limit": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", + "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", + "dev": true, + "dependencies": { + "p-try": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/p-locate": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", + "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", + "dev": true, + "dependencies": { + "p-limit": "^1.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/p-try": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", + "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", + "dev": true, + "dependencies": { + "error-ex": "^1.3.1", + "json-parse-better-errors": "^1.0.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pkg-conf/-/pkg-conf-3.1.0.tgz", + "integrity": "sha512-m0OTbR/5VPNPqO1ph6Fqbj7Hv6QU7gR/tQW40ZqrL1rjgCU85W6C1bJn0BItuJqnR98PWzw7Z8hHeChD1WrgdQ==", + "dev": true, + "dependencies": { + "find-up": "^3.0.0", + "load-json-file": "^5.2.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-conf/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-conf/node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dev": true, + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "node_modules/punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "dev": true + }, + "node_modules/regexp.prototype.flags": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", + "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "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==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/resolve": { + "version": "1.22.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz", + "integrity": "sha512-Hhtrw0nLeSrFQ7phPp4OOcVjLPIeMnRlr5mcnVuMe7M/7eBn98A3hmFRLoFo3DLZkivSYwhRUJTyPyWAk56WLw==", + "dev": true, + "dependencies": { + "is-core-module": "^2.8.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true + }, + "node_modules/standard-engine": { + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/standard-engine/-/standard-engine-14.0.1.tgz", + "integrity": "sha512-7FEzDwmHDOGva7r9ifOzD3BGdTbA7ujJ50afLVdW/tK14zQEptJjbFuUfn50irqdHDcTbNh0DTIoMPynMCXb0Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "xdg-basedir": "^4.0.0" + }, + "engines": { + "node": ">=8.10" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string.prototype.matchall": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.6.tgz", + "integrity": "sha512-6WgDX8HmQqvEd7J+G6VtAahhsQIssiZ8zl7zKh1VDMFyL3hRTJP4FTNA3RbIp2TOQ9AYNDcc7e3fH0Qbup+DBg==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "regexp.prototype.flags": "^1.3.1", + "side-channel": "^1.0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/table": { + "version": "6.8.0", + "resolved": "https://registry.npmjs.org/table/-/table-6.8.0.tgz", + "integrity": "sha512-s/fitrbVeEyHKFa7mFdkuQMWlH1Wgw/yEXMt5xACT4ZpzWFluehAxRtUUQKPuWhaLAWhFcVx6w3oC8VKaUfPGA==", + "dev": true, + "dependencies": { + "ajv": "^8.0.1", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.3", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/table/node_modules/ajv": { + "version": "8.9.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.9.0.tgz", + "integrity": "sha512-qOKJyNj/h+OWx7s5DePL6Zu1KeM9jPZhwBqs+7DzP6bGOvqzVCSf0xueYmVuaC/oQ/VtS2zLMLHdQFbkka+XDQ==", + "dev": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/table/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==", + "dev": true + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/ts-node": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.4.0.tgz", + "integrity": "sha512-g0FlPvvCXSIO1JDF6S232P5jPYqBkRL9qly81ZgAOSU7rwI0stphCgd2kLiCrU9DjQCrJMWEqcNSjQL02s6d8A==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-support": "0.7.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/ts-standard": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/ts-standard/-/ts-standard-11.0.0.tgz", + "integrity": "sha512-fe+PCOM6JTMIcG1Smr8BQJztUi3dc/SDJMqezxNAL8pe/0+h0shK0+fNPTuF1hMVMYO+O53Wtp9WQHqj0GJtMw==", + "dev": true, + "dependencies": { + "@typescript-eslint/eslint-plugin": "^4.26.1", + "eslint": "^7.28.0", + "eslint-config-standard": "^16.0.3", + "eslint-config-standard-jsx": "^10.0.0", + "eslint-config-standard-with-typescript": "^21.0.1", + "eslint-plugin-import": "^2.23.4", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^5.1.0", + "eslint-plugin-react": "^7.24.0", + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "standard-engine": "^14.0.1" + }, + "bin": { + "ts-standard": "bin/cmd.js" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "typescript": ">=3.8" + } + }, + "node_modules/tsconfig-paths": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.12.0.tgz", + "integrity": "sha512-e5adrnOYT6zqVnWqZu7i/BQ3BnhzvGbjEjejFXO20lKIKpwTaupkCPgEfv4GZK1IBciJUEhYs3J3p75FdaTFVg==", + "dev": true, + "dependencies": { + "@types/json5": "^0.0.29", + "json5": "^1.0.1", + "minimist": "^1.2.0", + "strip-bom": "^3.0.0" + } + }, + "node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "node_modules/tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "dependencies": { + "tslib": "^1.8.1" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" + } + }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typescript": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", + "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "node_modules/xdg-basedir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", + "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "engines": { + "node": ">=6" + } + } + }, + "dependencies": { + "@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "requires": { + "@babel/highlight": "^7.10.4" + } + }, + "@babel/helper-validator-identifier": { + "version": "7.16.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz", + "integrity": "sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw==", + "dev": true + }, + "@babel/highlight": { + "version": "7.16.10", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.10.tgz", + "integrity": "sha512-5FnTQLSLswEj6IkgVw5KusNUUFY9ZGqe/TRFnP/BKYHYgfh7tc+C7mwiy95/yNP7Dh9x580Vv8r7u7ZfTBFxdw==", + "dev": true, + "requires": { + "@babel/helper-validator-identifier": "^7.16.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "@cspotcode/source-map-consumer": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", + "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "dev": true + }, + "@cspotcode/source-map-support": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", + "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "dev": true, + "requires": { + "@cspotcode/source-map-consumer": "0.8.0" + } + }, + "@eslint/eslintrc": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", + "integrity": "sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw==", + "dev": true, + "requires": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "dependencies": { + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true + } + } + }, + "@humanwhocodes/config-array": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.5.0.tgz", + "integrity": "sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==", + "dev": true, + "requires": { + "@humanwhocodes/object-schema": "^1.2.0", + "debug": "^4.1.1", + "minimatch": "^3.0.4" + } + }, + "@humanwhocodes/object-schema": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz", + "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==", + "dev": true + }, + "@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + } + }, + "@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true + }, + "@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "requires": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + } + }, + "@tsconfig/node10": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", + "integrity": "sha512-6XFfSQmMgq0CFLY1MslA/CPUfhIL919M1rMsa5lP2P097N2Wd1sSX0tx1u4olM16fLNhtHZpRhedZJphNJqmZg==", + "dev": true + }, + "@tsconfig/node12": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.9.tgz", + "integrity": "sha512-/yBMcem+fbvhSREH+s14YJi18sp7J9jpuhYByADT2rypfajMZZN4WQ6zBGgBKp53NKmqI36wFYDb3yaMPurITw==", + "dev": true + }, + "@tsconfig/node14": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.1.tgz", + "integrity": "sha512-509r2+yARFfHHE7T6Puu2jjkoycftovhXRqW328PDXTVGKihlb1P8Z9mMZH04ebyajfRY7dedfGynlrFHJUQCg==", + "dev": true + }, + "@tsconfig/node16": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.2.tgz", + "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", + "dev": true + }, + "@types/json-schema": { + "version": "7.0.9", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", + "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==", + "dev": true + }, + "@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", + "dev": true + }, + "@types/node": { + "version": "17.0.12", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.12.tgz", + "integrity": "sha512-4YpbAsnJXWYK/fpTVFlMIcUIho2AYCi4wg5aNPrG1ng7fn/1/RZfCIpRCiBX+12RVa34RluilnvCqD+g3KiSiA==", + "dev": true + }, + "@typescript-eslint/eslint-plugin": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.33.0.tgz", + "integrity": "sha512-aINiAxGVdOl1eJyVjaWn/YcVAq4Gi/Yo35qHGCnqbWVz61g39D0h23veY/MA0rFFGfxK7TySg2uwDeNv+JgVpg==", + "dev": true, + "requires": { + "@typescript-eslint/experimental-utils": "4.33.0", + "@typescript-eslint/scope-manager": "4.33.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "ignore": "^5.1.8", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + } + }, + "@typescript-eslint/experimental-utils": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.33.0.tgz", + "integrity": "sha512-zeQjOoES5JFjTnAhI5QY7ZviczMzDptls15GFsI6jyUOq0kOf9+WonkhtlIhh0RgHRnqj5gdNxW5j1EvAyYg6Q==", + "dev": true, + "requires": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + } + }, + "@typescript-eslint/parser": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.33.0.tgz", + "integrity": "sha512-ZohdsbXadjGBSK0/r+d87X0SBmKzOq4/S5nzK6SBgJspFo9/CUDJ7hjayuze+JK7CZQLDMroqytp7pOcFKTxZA==", + "dev": true, + "requires": { + "@typescript-eslint/scope-manager": "4.33.0", + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/typescript-estree": "4.33.0", + "debug": "^4.3.1" + } + }, + "@typescript-eslint/scope-manager": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.33.0.tgz", + "integrity": "sha512-5IfJHpgTsTZuONKbODctL4kKuQje/bzBRkwHE8UOZ4f89Zeddg+EGZs8PD8NcN4LdM3ygHWYB3ukPAYjvl/qbQ==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0" + } + }, + "@typescript-eslint/types": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.33.0.tgz", + "integrity": "sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ==", + "dev": true + }, + "@typescript-eslint/typescript-estree": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.33.0.tgz", + "integrity": "sha512-rkWRY1MPFzjwnEVHsxGemDzqqddw2QbTJlICPD9p9I9LfsO8fdmfQPOX3uKfUaGRDFJbfrtm/sXhVXN4E+bzCA==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.33.0", + "@typescript-eslint/visitor-keys": "4.33.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + } + }, + "@typescript-eslint/visitor-keys": { + "version": "4.33.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz", + "integrity": "sha512-uqi/2aSz9g2ftcHWf8uLPJA70rUv6yuMW5Bohw+bwcuzaxQIHaKFZCKGoGXIrc9vkTJ3+0txM73K0Hq3d5wgIg==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.33.0", + "eslint-visitor-keys": "^2.0.0" + } + }, + "acorn": { + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", + "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ==", + "dev": true + }, + "acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "requires": {} + }, + "acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "dev": true + }, + "ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true + }, + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true + }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, + "argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "requires": { + "sprintf-js": "~1.0.2" + } + }, + "array-includes": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz", + "integrity": "sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "is-string": "^1.0.7" + } + }, + "array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true + }, + "array.prototype.flat": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz", + "integrity": "sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + } + }, + "array.prototype.flatmap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.2.5.tgz", + "integrity": "sha512-08u6rVyi1Lj7oqWbS9nUxliETrtIROT4XGTA4D/LWGten6E3ocm7cy9SIrmNHOL5XVbVuckUp3X6Xyg8/zpvHA==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.0" + } + }, + "astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true + }, + "balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "call-bind": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", + "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + } + }, + "callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true + }, + "chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, + "debug": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz", + "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true + }, + "define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "requires": { + "object-keys": "^1.0.12" + } + }, + "diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true + }, + "dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "requires": { + "path-type": "^4.0.0" + } + }, + "doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "requires": { + "ansi-colors": "^4.1.1" + } + }, + "error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "requires": { + "is-arrayish": "^0.2.1" + } + }, + "es-abstract": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz", + "integrity": "sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "get-symbol-description": "^1.0.0", + "has": "^1.0.3", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "is-callable": "^1.2.4", + "is-negative-zero": "^2.0.1", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.1", + "is-string": "^1.0.7", + "is-weakref": "^1.0.1", + "object-inspect": "^1.11.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + } + }, + "es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true + }, + "eslint": { + "version": "7.32.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.32.0.tgz", + "integrity": "sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA==", + "dev": true, + "requires": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.3", + "@humanwhocodes/config-array": "^0.5.0", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "dependencies": { + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true + } + } + }, + "eslint-config-standard": { + "version": "16.0.3", + "resolved": "https://registry.npmjs.org/eslint-config-standard/-/eslint-config-standard-16.0.3.tgz", + "integrity": "sha512-x4fmJL5hGqNJKGHSjnLdgA6U6h1YW/G2dW9fA+cyVur4SK6lyue8+UgNKWlZtUDTXvgKDD/Oa3GQjmB5kjtVvg==", + "dev": true, + "requires": {} + }, + "eslint-config-standard-jsx": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-jsx/-/eslint-config-standard-jsx-10.0.0.tgz", + "integrity": "sha512-hLeA2f5e06W1xyr/93/QJulN/rLbUVUmqTlexv9PRKHFwEC9ffJcH2LvJhMoEqYQBEYafedgGZXH2W8NUpt5lA==", + "dev": true, + "requires": {} + }, + "eslint-config-standard-with-typescript": { + "version": "21.0.1", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-21.0.1.tgz", + "integrity": "sha512-FeiMHljEJ346Y0I/HpAymNKdrgKEpHpcg/D93FvPHWfCzbT4QyUJba/0FwntZeGLXfUiWDSeKmdJD597d9wwiw==", + "dev": true, + "requires": { + "@typescript-eslint/parser": "^4.0.0", + "eslint-config-standard": "^16.0.0" + } + }, + "eslint-import-resolver-node": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz", + "integrity": "sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw==", + "dev": true, + "requires": { + "debug": "^3.2.7", + "resolve": "^1.20.0" + }, + "dependencies": { + "debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + } + } + }, + "eslint-module-utils": { + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.2.tgz", + "integrity": "sha512-zquepFnWCY2ISMFwD/DqzaM++H+7PDzOpUvotJWm/y1BAFt5R4oeULgdrTejKqLkz7MA/tgstsUMNYc7wNdTrg==", + "dev": true, + "requires": { + "debug": "^3.2.7", + "find-up": "^2.1.0" + }, + "dependencies": { + "debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + } + } + }, + "eslint-plugin-es": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-3.0.1.tgz", + "integrity": "sha512-GUmAsJaN4Fc7Gbtl8uOBlayo2DqhwWvEzykMHSCZHU3XdJ+NSzzZcVhXh3VxX5icqQ+oQdIEawXX8xkR3mIFmQ==", + "dev": true, + "requires": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "dependencies": { + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + } + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "eslint-plugin-import": { + "version": "2.25.4", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz", + "integrity": "sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA==", + "dev": true, + "requires": { + "array-includes": "^3.1.4", + "array.prototype.flat": "^1.2.5", + "debug": "^2.6.9", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.6", + "eslint-module-utils": "^2.7.2", + "has": "^1.0.3", + "is-core-module": "^2.8.0", + "is-glob": "^4.0.3", + "minimatch": "^3.0.4", + "object.values": "^1.1.5", + "resolve": "^1.20.0", + "tsconfig-paths": "^3.12.0" + }, + "dependencies": { + "debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + }, + "doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "dev": true + } + } + }, + "eslint-plugin-node": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz", + "integrity": "sha512-oUwtPJ1W0SKD0Tr+wqu92c5xuCeQqB3hSCHasn/ZgjFdA9iDGNkNf2Zi9ztY7X+hNuMib23LNGRm6+uN+KLE3g==", + "dev": true, + "requires": { + "eslint-plugin-es": "^3.0.0", + "eslint-utils": "^2.0.0", + "ignore": "^5.1.1", + "minimatch": "^3.0.4", + "resolve": "^1.10.1", + "semver": "^6.1.0" + }, + "dependencies": { + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + } + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true + } + } + }, + "eslint-plugin-promise": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-5.2.0.tgz", + "integrity": "sha512-SftLb1pUG01QYq2A/hGAWfDRXqYD82zE7j7TopDOyNdU+7SvvoXREls/+PRTY17vUXzXnZA/zfnyKgRH6x4JJw==", + "dev": true, + "requires": {} + }, + "eslint-plugin-react": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.28.0.tgz", + "integrity": "sha512-IOlFIRHzWfEQQKcAD4iyYDndHwTQiCMcJVJjxempf203jnNLUnW34AXLrV33+nEXoifJE2ZEGmcjKPL8957eSw==", + "dev": true, + "requires": { + "array-includes": "^3.1.4", + "array.prototype.flatmap": "^1.2.5", + "doctrine": "^2.1.0", + "estraverse": "^5.3.0", + "jsx-ast-utils": "^2.4.1 || ^3.0.0", + "minimatch": "^3.0.4", + "object.entries": "^1.1.5", + "object.fromentries": "^2.0.5", + "object.hasown": "^1.1.0", + "object.values": "^1.1.5", + "prop-types": "^15.7.2", + "resolve": "^2.0.0-next.3", + "semver": "^6.3.0", + "string.prototype.matchall": "^4.0.6" + }, + "dependencies": { + "doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "resolve": { + "version": "2.0.0-next.3", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.3.tgz", + "integrity": "sha512-W8LucSynKUIDu9ylraa7ueVZ7hc0uAgJBxVsQSKOXOyle8a93qXhcz+XAXZ8bIq2d6i4Ehddn6Evt+0/UwKk6Q==", + "dev": true, + "requires": { + "is-core-module": "^2.2.0", + "path-parse": "^1.0.6" + } + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true + } + } + }, + "eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "requires": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "dependencies": { + "estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true + } + } + }, + "eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^2.0.0" + } + }, + "eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true + }, + "espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "requires": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "dependencies": { + "acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true + } + } + }, + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true + }, + "esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "requires": { + "estraverse": "^5.1.0" + } + }, + "esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "requires": { + "estraverse": "^5.2.0" + } + }, + "estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true + }, + "esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true + }, + "fast-deep-equal": { + "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 + }, + "fast-glob": { + "version": "3.2.11", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.11.tgz", + "integrity": "sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + } + }, + "fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true + }, + "fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true + }, + "fastq": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", + "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, + "requires": { + "reusify": "^1.0.4" + } + }, + "file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "requires": { + "flat-cache": "^3.0.4" + } + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "find-up": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", + "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", + "dev": true, + "requires": { + "locate-path": "^2.0.0" + } + }, + "flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "requires": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + } + }, + "flatted": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.4.tgz", + "integrity": "sha512-8/sOawo8tJ4QOBX8YlQBMxL8+RLZfxMQOif9o0KUKTNTjMYElWPE0r/m5VNFxTRd0NSw8qSy8dajrwX4RYI1Hw==", + "dev": true + }, + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, + "get-intrinsic": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz", + "integrity": "sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + } + }, + "get-stdin": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz", + "integrity": "sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==", + "dev": true + }, + "get-symbol-description": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", + "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + } + }, + "glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "requires": { + "is-glob": "^4.0.1" + } + }, + "globals": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.12.0.tgz", + "integrity": "sha512-uS8X6lSKN2JumVoXrbUz+uG4BYG+eiawqm3qFcT7ammfbUHeCBoJMlHcec/S3krSk73/AE/f0szYFmgAA3kYZg==", + "dev": true, + "requires": { + "type-fest": "^0.20.2" + } + }, + "globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "requires": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + } + }, + "graceful-fs": { + "version": "4.2.9", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.9.tgz", + "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==", + "dev": true + }, + "has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "requires": { + "function-bind": "^1.1.1" + } + }, + "has-bigints": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz", + "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "has-symbols": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.2.tgz", + "integrity": "sha512-chXa79rL/UC2KlX17jo3vRGz0azaWEx5tGqZg5pO3NUyEJVB17dMruQlzCCOfUvElghKcm5194+BCRvi2Rv/Gw==", + "dev": true + }, + "has-tostringtag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", + "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + }, + "ignore": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", + "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "dev": true + }, + "import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "requires": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + } + }, + "imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", + "dev": true + }, + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "requires": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "internal-slot": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz", + "integrity": "sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==", + "dev": true, + "requires": { + "get-intrinsic": "^1.1.0", + "has": "^1.0.3", + "side-channel": "^1.0.4" + } + }, + "is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "requires": { + "has-bigints": "^1.0.1" + } + }, + "is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-callable": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", + "integrity": "sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w==", + "dev": true + }, + "is-core-module": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.8.1.tgz", + "integrity": "sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, + "is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true + }, + "is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "requires": { + "is-extglob": "^2.1.1" + } + }, + "is-negative-zero": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", + "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "is-number-object": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz", + "integrity": "sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-shared-array-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz", + "integrity": "sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA==", + "dev": true + }, + "is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + }, + "is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2" + } + }, + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true + }, + "js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "json-parse-better-errors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", + "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==", + "dev": true + }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + }, + "json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", + "dev": true + }, + "json5": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", + "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "dev": true, + "requires": { + "minimist": "^1.2.0" + } + }, + "jsx-ast-utils": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.1.tgz", + "integrity": "sha512-uP5vu8xfy2F9A6LGC22KO7e2/vGTS1MhP+18f++ZNlf0Ohaxbc9nIEwHAsejlJKyzfZzU5UIhe5ItYkitcZnZA==", + "dev": true, + "requires": { + "array-includes": "^3.1.3", + "object.assign": "^4.1.2" + } + }, + "levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "requires": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + } + }, + "load-json-file": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-5.3.0.tgz", + "integrity": "sha512-cJGP40Jc/VXUsp8/OrnyKyTZ1y6v/dphm3bioS+RrKXjK2BB6wHUd6JptZEFDGgGahMT+InnZO5i1Ei9mpC8Bw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.15", + "parse-json": "^4.0.0", + "pify": "^4.0.1", + "strip-bom": "^3.0.0", + "type-fest": "^0.3.0" + }, + "dependencies": { + "type-fest": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.3.1.tgz", + "integrity": "sha512-cUGJnCdr4STbePCgqNFbpVNCepa+kAVohJs1sLhxzdH+gnEoOd8VhbYa7pD3zZYGiURWM2xzEII3fQcRizDkYQ==", + "dev": true + } + } + }, + "locate-path": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", + "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", + "dev": true, + "requires": { + "p-locate": "^2.0.0", + "path-exists": "^3.0.0" + } + }, + "lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true + }, + "lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true + }, + "loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "requires": { + "js-tokens": "^3.0.0 || ^4.0.0" + } + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, + "merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true + }, + "micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + } + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", + "dev": true + }, + "object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true + }, + "object-inspect": { + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.0.tgz", + "integrity": "sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g==", + "dev": true + }, + "object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true + }, + "object.assign": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz", + "integrity": "sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + }, + "object.entries": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.5.tgz", + "integrity": "sha512-TyxmjUoZggd4OrrU1W66FMDG6CuqJxsFvymeyXI51+vQLN67zYfZseptRge703kKQdo4uccgAKebXFcRCzk4+g==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "object.fromentries": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.5.tgz", + "integrity": "sha512-CAyG5mWQRRiBU57Re4FKoTBjXfDoNwdFVH2Y1tS9PqCsfUTymAohOkEMSG3aRNKmv4lV3O7p1et7c187q6bynw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "object.hasown": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.0.tgz", + "integrity": "sha512-MhjYRfj3GBlhSkDHo6QmvgjRLXQ2zndabdf3nX0yTyZK9rPfxb6uRpAac8HXNLy1GpqWtZ81Qh4v3uOls2sRAg==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "object.values": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz", + "integrity": "sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "requires": { + "wrappy": "1" + } + }, + "optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "requires": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + } + }, + "p-limit": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", + "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", + "dev": true, + "requires": { + "p-try": "^1.0.0" + } + }, + "p-locate": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", + "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", + "dev": true, + "requires": { + "p-limit": "^1.1.0" + } + }, + "p-try": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", + "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", + "dev": true + }, + "parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "requires": { + "callsites": "^3.0.0" + } + }, + "parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", + "dev": true, + "requires": { + "error-ex": "^1.3.1", + "json-parse-better-errors": "^1.0.1" + } + }, + "path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true + }, + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true + }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, + "path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true + }, + "path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true + }, + "picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true + }, + "pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true + }, + "pkg-conf": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pkg-conf/-/pkg-conf-3.1.0.tgz", + "integrity": "sha512-m0OTbR/5VPNPqO1ph6Fqbj7Hv6QU7gR/tQW40ZqrL1rjgCU85W6C1bJn0BItuJqnR98PWzw7Z8hHeChD1WrgdQ==", + "dev": true, + "requires": { + "find-up": "^3.0.0", + "load-json-file": "^5.2.0" + }, + "dependencies": { + "find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "requires": { + "locate-path": "^3.0.0" + } + }, + "locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "requires": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + } + }, + "p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "requires": { + "p-limit": "^2.0.0" + } + }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + } + } + }, + "prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true + }, + "progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true + }, + "prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dev": true, + "requires": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true + }, + "queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true + }, + "react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "dev": true + }, + "regexp.prototype.flags": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz", + "integrity": "sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true + }, + "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==", + "dev": true + }, + "resolve": { + "version": "1.22.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz", + "integrity": "sha512-Hhtrw0nLeSrFQ7phPp4OOcVjLPIeMnRlr5mcnVuMe7M/7eBn98A3hmFRLoFo3DLZkivSYwhRUJTyPyWAk56WLw==", + "dev": true, + "requires": { + "is-core-module": "^2.8.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + } + }, + "resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true + }, + "reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true + }, + "rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "requires": { + "glob": "^7.1.3" + } + }, + "run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "requires": { + "queue-microtask": "^1.2.2" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + }, + "side-channel": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", + "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + } + }, + "slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true + }, + "slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + }, + "sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true + }, + "standard-engine": { + "version": "14.0.1", + "resolved": "https://registry.npmjs.org/standard-engine/-/standard-engine-14.0.1.tgz", + "integrity": "sha512-7FEzDwmHDOGva7r9ifOzD3BGdTbA7ujJ50afLVdW/tK14zQEptJjbFuUfn50irqdHDcTbNh0DTIoMPynMCXb0Q==", + "dev": true, + "requires": { + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "xdg-basedir": "^4.0.0" + } + }, + "string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "requires": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + } + }, + "string.prototype.matchall": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.6.tgz", + "integrity": "sha512-6WgDX8HmQqvEd7J+G6VtAahhsQIssiZ8zl7zKh1VDMFyL3hRTJP4FTNA3RbIp2TOQ9AYNDcc7e3fH0Qbup+DBg==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1", + "get-intrinsic": "^1.1.1", + "has-symbols": "^1.0.2", + "internal-slot": "^1.0.3", + "regexp.prototype.flags": "^1.3.1", + "side-channel": "^1.0.4" + } + }, + "string.prototype.trimend": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz", + "integrity": "sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "string.prototype.trimstart": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz", + "integrity": "sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.1" + } + }, + "strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", + "dev": true + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true + }, + "table": { + "version": "6.8.0", + "resolved": "https://registry.npmjs.org/table/-/table-6.8.0.tgz", + "integrity": "sha512-s/fitrbVeEyHKFa7mFdkuQMWlH1Wgw/yEXMt5xACT4ZpzWFluehAxRtUUQKPuWhaLAWhFcVx6w3oC8VKaUfPGA==", + "dev": true, + "requires": { + "ajv": "^8.0.1", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.3", + "strip-ansi": "^6.0.1" + }, + "dependencies": { + "ajv": { + "version": "8.9.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.9.0.tgz", + "integrity": "sha512-qOKJyNj/h+OWx7s5DePL6Zu1KeM9jPZhwBqs+7DzP6bGOvqzVCSf0xueYmVuaC/oQ/VtS2zLMLHdQFbkka+XDQ==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + } + }, + "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==", + "dev": true + } + } + }, + "text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + }, + "ts-node": { + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.4.0.tgz", + "integrity": "sha512-g0FlPvvCXSIO1JDF6S232P5jPYqBkRL9qly81ZgAOSU7rwI0stphCgd2kLiCrU9DjQCrJMWEqcNSjQL02s6d8A==", + "dev": true, + "requires": { + "@cspotcode/source-map-support": "0.7.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "yn": "3.1.1" + } + }, + "ts-standard": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/ts-standard/-/ts-standard-11.0.0.tgz", + "integrity": "sha512-fe+PCOM6JTMIcG1Smr8BQJztUi3dc/SDJMqezxNAL8pe/0+h0shK0+fNPTuF1hMVMYO+O53Wtp9WQHqj0GJtMw==", + "dev": true, + "requires": { + "@typescript-eslint/eslint-plugin": "^4.26.1", + "eslint": "^7.28.0", + "eslint-config-standard": "^16.0.3", + "eslint-config-standard-jsx": "^10.0.0", + "eslint-config-standard-with-typescript": "^21.0.1", + "eslint-plugin-import": "^2.23.4", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^5.1.0", + "eslint-plugin-react": "^7.24.0", + "get-stdin": "^8.0.0", + "minimist": "^1.2.5", + "pkg-conf": "^3.1.0", + "standard-engine": "^14.0.1" + } + }, + "tsconfig-paths": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.12.0.tgz", + "integrity": "sha512-e5adrnOYT6zqVnWqZu7i/BQ3BnhzvGbjEjejFXO20lKIKpwTaupkCPgEfv4GZK1IBciJUEhYs3J3p75FdaTFVg==", + "dev": true, + "requires": { + "@types/json5": "^0.0.29", + "json5": "^1.0.1", + "minimist": "^1.2.0", + "strip-bom": "^3.0.0" + } + }, + "tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true + }, + "tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "requires": { + "tslib": "^1.8.1" + } + }, + "type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "requires": { + "prelude-ls": "^1.2.1" + } + }, + "type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true + }, + "typescript": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", + "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==" + }, + "unbox-primitive": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", + "integrity": "sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw==", + "dev": true, + "requires": { + "function-bind": "^1.1.1", + "has-bigints": "^1.0.1", + "has-symbols": "^1.0.2", + "which-boxed-primitive": "^1.0.2" + } + }, + "uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "requires": { + "punycode": "^2.1.0" + } + }, + "v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true + }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } + }, + "which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "requires": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + } + }, + "word-wrap": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", + "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "dev": true + }, + "wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "xdg-basedir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", + "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", + "dev": true + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + }, + "yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true + } + } +} diff --git a/typescript-generator/package.json b/typescript-generator/package.json index 0f63f56798..b3c0bdbe63 100644 --- a/typescript-generator/package.json +++ b/typescript-generator/package.json @@ -3,15 +3,16 @@ "version": "1.0.0", "private": true, "description": "", - "main": "index.js", + "main": "src/index.ts", "scripts": { - "start": "ts-node index.ts && npm run is-valid-output", - "client": "ts-node client.ts", - "kibana": "KIBANA=true ts-node client.ts", - "lint": "ts-standard", - "lint:fix": "ts-standard --fix", + "start": "ts-node src/index.ts && npm run is-valid-output", + "client": "ts-node src/client.ts", + "kibana": "KIBANA=true ts-node src/client.ts", + "lint": "ts-standard src", + "lint:fix": "ts-standard --fix src", "is-valid-output": "tsc --noEmit", - "test": "npm run lint" + "test": "npm run lint", + "build": "rm -rf lib && tsc" }, "engines": { "node": ">=14" @@ -20,11 +21,11 @@ "author": "", "license": "Apache-2.0", "devDependencies": { - "@types/node": "^14.14.41", - "ts-node": "^9.1.1", - "ts-standard": "^10.0.0" + "@types/node": "^17.0.12", + "ts-node": "^10.4.0", + "ts-standard": "^11.0.0" }, "dependencies": { - "typescript": "^4.1.5" + "typescript": "^4.5.5" } } diff --git a/typescript-generator/client.ts b/typescript-generator/src/client.ts similarity index 98% rename from typescript-generator/client.ts rename to typescript-generator/src/client.ts index 1147c36135..a274c47ddc 100644 --- a/typescript-generator/client.ts +++ b/typescript-generator/src/client.ts @@ -20,9 +20,9 @@ import assert from 'assert' import { writeFileSync, readFileSync } from 'fs' import { join } from 'path' -import * as M from '../compiler/model/metamodel' +import * as M from './metamodel' -const model: M.Model = JSON.parse(readFileSync(join(__dirname, '..', 'output', 'schema', 'schema.json'), 'utf8')) +const model: M.Model = JSON.parse(readFileSync(join(__dirname, '..', '..', 'output', 'schema', 'schema.json'), 'utf8')) const clientDefinitions = `/* * Licensed to Elasticsearch B.V. under one or more contributor @@ -399,7 +399,7 @@ export { } function createName (type: M.TypeName): string { - if (type.namespace === 'internal') return type.name + if (type.namespace === '_builtins') return type.name const namespace = strip(type.namespace).replace(/_([a-z])/g, k => k[1].toUpperCase()) return `${namespace.split('.').map(TitleCase).join('')}${type.name}` diff --git a/typescript-generator/index.ts b/typescript-generator/src/index.ts similarity index 65% rename from typescript-generator/index.ts rename to typescript-generator/src/index.ts index ad4412c33c..a2c0fb1592 100644 --- a/typescript-generator/index.ts +++ b/typescript-generator/src/index.ts @@ -22,15 +22,15 @@ import assert from 'assert' import { writeFileSync, readFileSync } from 'fs' import { join } from 'path' -import * as M from '../compiler/model/metamodel' +import * as M from './metamodel' -const model: M.Model = JSON.parse(readFileSync(join(__dirname, '..', 'output', 'schema', 'schema.json'), 'utf8')) +const model: M.Model = JSON.parse(readFileSync(join(__dirname, '..', '..', 'output', 'schema', 'schema.json'), 'utf8')) // We don't skip `CommonQueryParameters` and `CommonCatQueryParameters` // behaviors because we ue them for sharing common query parameters // among most requests. const skipBehaviors = [ - 'AdditionalProperties', 'AdditionalProperty' + 'AdditionalProperties', 'AdditionalProperty', 'OverloadOf' ] let definitions = `/* @@ -59,7 +59,7 @@ for (const type of model.types) { } writeFileSync( - join(__dirname, '..', 'output', 'typescript', 'types.ts'), + join(__dirname, '..', '..', 'output', 'typescript', 'types.ts'), definitions, 'utf8' ) @@ -115,6 +115,10 @@ function buildValue (type: M.ValueOf, openGenerics?: string[], origin?: M.TypeNa } } + if (type.type.name === 'binary' && type.type.namespace === '_builtins') { + return 'ArrayBuffer' + } + return `${createName(type.type)}${buildGenerics(type.generics, openGenerics)}` case 'array_of': return type.value.kind === 'union_of' || getShortcutType(type.value) != null @@ -122,8 +126,10 @@ function buildValue (type: M.ValueOf, openGenerics?: string[], origin?: M.TypeNa : `${buildValue(type.value, openGenerics)}[]` case 'union_of': return type.items.map(t => buildValue(t, openGenerics, origin)).join(' | ') - case 'dictionary_of': - return `Record<${buildValue(type.key, openGenerics)}, ${buildValue(type.value, openGenerics)}>` + case 'dictionary_of': { + const result = `Record<${buildValue(type.key, openGenerics)}, ${buildValue(type.value, openGenerics)}>` + return type.singleKey ? `Partial<${result}>` : result + } case 'user_defined_value': return 'any' case 'literal_value': @@ -157,6 +163,23 @@ function buildInherits (type: M.Interface | M.Request | M.Response, openGenerics const interfaces = (type.implements ?? []).filter(type => !skipBehaviors.includes(type.type.name)) const behaviors = (type.behaviors ?? []).filter(type => !skipBehaviors.includes(type.type.name)) const extendAll = inherits.concat(interfaces).concat(behaviors) + // do not extend from empty interfaces + .filter(inherit => { + for (const type of model.types) { + if (inherit.type.name === type.name.name && inherit.type.namespace === type.name.namespace) { + switch (type.kind) { + case 'interface': + return type.properties.length > 0 || type.inherits != null || type.implements != null || type.behaviors != null || type.generics != null + case 'request': + case 'response': + return true + default: + return false + } + } + } + return true + }) if (extendAll.length === 0) return '' return ` extends ${extendAll.map(buildInheritType).join(', ')}` @@ -171,12 +194,19 @@ function buildInterface (type: M.Interface): string { } const openGenerics = type.generics?.map(t => t.name) ?? [] - let code = `export interface ${createName(type.name)}${buildGenerics(type.generics, openGenerics)}${buildInherits(type, openGenerics)} {\n` - for (const property of type.properties) { - code += ` ${cleanPropertyName(property.name)}${required(property)}: ${buildValue(property.type, openGenerics)}\n` - if (Array.isArray(property.aliases)) { - for (const alias of property.aliases) { - code += ` ${cleanPropertyName(alias)}${required(property)}: ${buildValue(property.type, openGenerics)}\n` + const inherits = buildInherits(type, openGenerics) + let code = `export interface ${createName(type.name)}${buildGenerics(type.generics, openGenerics)}${inherits} {\n` + if (type.properties.length === 0 && type.attachedBehaviors == null && inherits.length === 0) { + if (process.env.KIBANA == null) { + code += ' [key: string]: never\n' + } + } else { + for (const property of type.properties) { + code += ` ${cleanPropertyName(property.name)}${required(property)}: ${buildValue(property.type, openGenerics)}\n` + if (Array.isArray(property.aliases)) { + for (const alias of property.aliases) { + code += ` ${cleanPropertyName(alias)}${required(property)}: ${buildValue(property.type, openGenerics)}\n` + } } } } @@ -196,6 +226,9 @@ function implementsBehavior (type: M.Interface): boolean { if (type.name.name.endsWith('Base')) { return false } + if (type.attachedBehaviors.includes('OverloadOf')) { + return false + } return type.attachedBehaviors.length > 0 } return type.name.name === 'DictionaryResponseBase' @@ -218,36 +251,81 @@ function buildBehaviorInterface (type: M.Interface): string { } } +// Handling additional properties has some caveats. There are 3 ways of defining an interface with additional dyamic properties: +// +// 1. +// interface Foo { +// prop: string +// [key: string]: string +// } +// +// 2. +// interface FooBase { +// prop: string +// } +// type Foo = FooBase & { [key: string]: string } +// +// 3. +// interface FooBase { +// prop: string +// } +// type Foo = FooBase | { [key: string]: number } +// +// 4. +// interface Foo { +// prop: string +// [key: string]: number | string +// } +// +// 1. and 2. are (almost) the same, the important thing is that the dynamic key can also describe every static key, +// in other words, the type of the static keys must be a subset of the type of the dynamic keys. +// If this is not possible, then we should use options 3. +// The best solution for now is 2, where we create an union of all the possible types for the dynamic keys +// (we must use an intersection because option 1 won't work with optional properties). +// The only drawback is that we might allow some type that won't work in the dynamic keys. +// Furthermore, we must take into account the types of the extended class properties (if present). +// The main difference with this approaches comes when you are actually using the types. 1 and 2 are good when +// you are reading an object of that type, while 3 is good when you are writing an object of that type. function serializeAdditionalPropertiesType (type: M.Interface): string { const dictionaryOf = lookupBehavior(type, 'AdditionalProperties') ?? lookupBehavior(type, 'AdditionalProperty') if (dictionaryOf == null) throw new Error(`Unknown implements ${type.name.name}`) - let code = `export interface ${createName(type.name)}Keys${buildGenerics(type.generics)}${buildInherits(type)} {\n` - - function required (property: M.Property): string { - return property.required ? '' : '?' - } - + const extendedPropertyTypes = getAllExtendedPropertyTypes(type.inherits) const openGenerics = type.generics?.map(t => t.name) ?? [] + let code = `export interface ${createName(type.name)}Keys${buildGenerics(type.generics)}${buildInherits(type)} {\n` + const types: Array = [] for (const property of type.properties) { code += ` ${cleanPropertyName(property.name)}${required(property)}: ${buildValue(property.type, openGenerics)}\n` + types.push(buildValue(property.type, openGenerics)) } code += '}\n' - code += `export type ${createName(type.name)}${buildGenerics(type.generics, openGenerics)} = ${createName(type.name)}Keys${buildGenerics(type.generics, openGenerics, true)} |\n` - code += ` { ${buildIndexer(dictionaryOf, openGenerics)} }\n` + + // user_defined_value can always "contain" every other type + if (Array.isArray(dictionaryOf.generics) && dictionaryOf.generics[1].kind === 'user_defined_value') { + code += `export type ${createName(type.name)}${buildGenerics(type.generics)} = ${createName(type.name)}Keys${buildGenerics(type.generics, openGenerics, true)}\n & { [property: string]: any }\n` + } else { + const dynamicTypes = Array.isArray(dictionaryOf.generics) + ? [...new Set([buildValue(dictionaryOf.generics[1], openGenerics)].concat(types).concat(extendedPropertyTypes))] + : [...new Set(types.concat(extendedPropertyTypes))] + code += `export type ${createName(type.name)}${buildGenerics(type.generics)} = ${createName(type.name)}Keys${buildGenerics(type.generics, openGenerics, true)}\n & { [property: string]: ${dynamicTypes.join(' | ')} }\n` + } return code - function buildIndexer (type: M.Inherits, openGenerics: string[]): string { - if (!Array.isArray(type.generics)) return '' - assert(type.generics.length === 2) - return `[property: string]: ${buildGeneric(type.generics[1])}` - - // generics can either be a value/instance_of or a named generics - function buildGeneric (type: M.ValueOf): string | number | boolean { - const t = typeof type === 'string' ? type : buildValue(type, openGenerics) - // indexers do not allow type aliases so here we translate known - // type aliases back to string - return t === 'AggregateName' ? 'string' : t + function getAllExtendedPropertyTypes (inherit?: M.Inherits): Array { + if (inherit == null) return [] + const extendedInterface = model.types.find(type => inherit.type.name === type.name.name && inherit.type.namespace === type.name.namespace) + assert(extendedInterface != null, `Can't find extended type for ${inherit.type.namespace}.${inherit.type.name}`) + assert(extendedInterface.kind === 'interface', `We should be extending from another interface, instead got: ${extendedInterface.kind}`) + const openGenerics = extendedInterface.generics?.map(t => t.name) ?? [] + const types: Array = [] + for (const property of extendedInterface.properties) { + types.push(buildValue(property.type, openGenerics)) } + types.push(...getAllExtendedPropertyTypes(extendedInterface.inherits)) + return [...new Set(types)] + } + + function required (property: M.Property): string { + return property.required ? '' : '?' } } @@ -270,20 +348,25 @@ function buildRequest (type: M.Request): string { const openGenerics = type.generics?.map(t => t.name) ?? [] let code = `export interface ${createName(type.name)}${buildGenerics(type.generics, openGenerics)}${buildInherits(type, openGenerics)} {\n` for (const property of type.path) { - code += ` ${cleanPropertyName(property.name)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` + code += ` ${cleanPropertyName(property.codegenName ?? property.name)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` } // It might happen that the same property is present in both // path and query parameters, we should keep only one - const pathPropertiesNames = type.path.map(property => property.name) + const pathPropertiesNames = type.path.map(property => property.codegenName ?? property.name) for (const property of type.query) { if (pathPropertiesNames.includes(property.name)) continue - code += ` ${cleanPropertyName(property.name)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` + code += ` ${cleanPropertyName(property.codegenName ?? property.name)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` } if (type.body.kind === 'properties' && type.body.properties.length > 0) { code += ` body${isBodyRequired() ? '' : '?'}: {\n` for (const property of type.body.properties) { code += ` ${cleanPropertyName(property.name)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` + if (Array.isArray(property.aliases)) { + for (const alias of property.aliases) { + code += ` ${cleanPropertyName(alias)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` + } + } } code += ' }\n' } else if (type.body.kind === 'value') { @@ -309,6 +392,11 @@ function buildResponse (type: M.Response): string { let code = `export interface ${createName(type.name)}${buildGenerics(type.generics, openGenerics)}${buildInherits(type, openGenerics)} {\n` for (const property of type.body.properties) { code += ` ${cleanPropertyName(property.name)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` + if (Array.isArray(property.aliases)) { + for (const alias of property.aliases) { + code += ` ${cleanPropertyName(alias)}${property.required ? '' : '?'}: ${buildValue(property.type, openGenerics)}\n` + } + } } code += '}\n' return code @@ -320,16 +408,33 @@ function buildResponse (type: M.Response): string { } function buildEnum (type: M.Enum): string { - return `export type ${createName(type.name)} = ${type.members.map(m => `'${m.name}'`).join(' | ')}\n` + // Flatten all items names and aliases + const names = type.members.reduce((accum, item) => { + accum.push(item.name) + if (item.aliases == null) { + return accum + } else { + return accum.concat(item.aliases) + } + }, new Array()) + + // Also allow plain boolean values if the enum contains 'true' and 'false' + const boolean = (names.includes('true') && names.includes('false')) ? 'boolean | ' : '' + + return `export type ${createName(type.name)} = ${boolean}${names.map(m => `'${m}'`).join(' | ')}\n` } function buildTypeAlias (type: M.TypeAlias): string { + // A lot of yaml tests use numbers for document ids, even if it really should be a string + if (type.name.name === 'Id' && type.name.namespace === '_types') { + return 'export type Id = string | number\n' + } const openGenerics = type.generics?.map(t => t.name) ?? [] return `export type ${createName(type.name)}${buildGenerics(type.generics)} = ${buildValue(type.type, openGenerics)}\n` } function createName (type: M.TypeName): string { - if (type.namespace === 'internal') return type.name + if (type.namespace === '_builtins') return type.name const namespace = strip(type.namespace).replace(/_([a-z])/g, k => k[1].toUpperCase()) return `${namespace.split('.').map(TitleCase).join('')}${type.name}` diff --git a/compiler/model/metamodel.ts b/typescript-generator/src/metamodel.ts similarity index 84% rename from compiler/model/metamodel.ts rename to typescript-generator/src/metamodel.ts index 1a557c5ce0..71a8a1a54f 100644 --- a/compiler/model/metamodel.ts +++ b/typescript-generator/src/metamodel.ts @@ -36,6 +36,15 @@ export class TypeName { name: string } +/** + * Location of an item. The path is relative to the "specification" directory, e.g "_types/common.ts" + */ +export class SourceLocation { + path: string + startLine: number + endLine: number +} + // ------------------------------------------------------------------------------------------------ // Value types @@ -125,18 +134,22 @@ export class Property { required: boolean description?: string docUrl?: string + docId?: string since?: string - serverDefault?: boolean | string | number + serverDefault?: boolean | string | number | string[] | number[] deprecation?: Deprecation + stability?: Stability /** * If specified takes precedence over `name` when generating code. `name` is always the value * to be sent over the wire */ - identifier?: string + codegenName?: string /** An optional set of aliases for `name` */ aliases?: string[] /** If the enclosing class is a variants container, is this a property of the container and not a variant? */ containerProperty?: boolean + /** If this property has a quirk that needs special attention, give a short explanation about it */ + esQuirk?: string } // ------------------------------------------------------------------------------------------------ @@ -155,23 +168,47 @@ export abstract class BaseType { /** Link to public documentation */ docUrl?: string deprecation?: Deprecation + /** If this endpoint has a quirk that needs special attention, give a short explanation about it */ + esQuirk?: string kind: string /** Variant name for externally tagged variants */ variantName?: string + /** + * Additional identifiers for use by code generators. Usage depends on the actual type: + * - on unions (modeled as alias(union_of)), these are identifiers for the union members + * - for additional properties, this is the name of the dict that holds these properties + * - for additional property, this is the name of the key and value fields that hold the + * additional property + */ + codegenNames?: string[] + /** Location in the API spec where this type is defined */ + specLocation: SourceLocation } export type Variants = ExternalTag | InternalTag | Container -export class ExternalTag { +export class VariantBase { + /** + * Is this variant type open to extensions? Default to false. Used for variants that can + * be extended with plugins. If true, target clients should allow for additional variants + * with a variant tag outside the ones defined in the spec and arbitrary data as the value. + */ + nonExhaustive?: boolean +} + +export class ExternalTag extends VariantBase { kind: 'external_tag' } -export class InternalTag { +export class InternalTag extends VariantBase { kind: 'internal_tag' - tag: string // Name of the property that holds the variant tag + /* Name of the property that holds the variant tag */ + tag: string + /* Default value for the variant tag if it's missing */ + defaultTag?: string } -export class Container { +export class Container extends VariantBase { kind: 'container' } @@ -265,6 +302,7 @@ export type Body = ValueBody | PropertiesBody | NoBody export class ValueBody { kind: 'value' value: ValueOf + codegenName?: string } export class PropertiesBody { @@ -286,11 +324,13 @@ export class NoBody { export class EnumMember { /** The identifier to use for this enum */ name: string + /** An optional set of aliases for `name` */ + aliases?: string[] /** * If specified takes precedence over `name` when generating code. `name` is always the value * to be sent over the wire */ - identifier?: string + codegenName?: string description?: string deprecation?: Deprecation since?: string @@ -321,8 +361,7 @@ export class TypeAlias extends BaseType { export enum Stability { stable = 'stable', beta = 'beta', - experimental = 'experimental', - TODO = 'TODO' + experimental = 'experimental' } export enum Visibility { public = 'public', @@ -339,6 +378,7 @@ export class Endpoint { name: string description: string docUrl: string + docId?: string deprecation?: Deprecation /** @@ -363,8 +403,13 @@ export class Endpoint { since?: string stability?: Stability visibility?: Visibility - accept?: string[] - contentType?: string[] + featureFlag?: string + requestMediaType?: string[] + responseMediaType?: string[] + privileges?: { + index?: string[] + cluster?: string[] + } } export class UrlTemplate { diff --git a/typescript-generator/tsconfig.json b/typescript-generator/tsconfig.json index 23b79adb5a..0246118347 100644 --- a/typescript-generator/tsconfig.json +++ b/typescript-generator/tsconfig.json @@ -6,7 +6,7 @@ "esModuleInterop": true, "isolatedModules": false, "jsx": "react", - "outDir": "lib/src", + "outDir": "lib", "experimentalDecorators": true, "emitDecoratorMetadata": true, "strictNullChecks": true, @@ -20,6 +20,9 @@ }, "compileOnSave": true, "buildOnSave": true, + "exclude": [ + "compiler" + ], "include": [ "." ]